[m-rev.] for review: install release documentation on web page
Simon Taylor
stayl at cs.mu.OZ.AU
Tue Oct 16 03:27:55 AEST 2001
On 12-Oct-2001, Peter Ross <peter.ross at miscrit.be> wrote:
> On Mon, Oct 08, 2001 at 03:40:04PM +1000, Simon Taylor wrote:
> > Index: w3/Makefile
> > ===================================================================
> > @@ -23,6 +25,13 @@
> >
> > target: html
> >
> > +html: globals.inc
> > +
> > +globals.inc: include/globals.inc
> > +
>
> Shouldn't that just be
>
> html: include/globals.inc
The `html: globals.inc' isn't needed, but
`globals.inc: include/globals.inc' is.
> > Index: w3/news/newsdb.inc
> > ===================================================================
> > @@ -282,7 +282,7 @@
> > "The Mercury debugger now includes support for interactive queries.
> > See the \"Interactive query commands\" subsection of the \"Debugger commands\"
> > section of the \"Debugging\" chapter of the
> > -<A HREF=\"http://www.cs.mu.oz.au/research/mercury/information/doc/user_guide_toc.html\">Mercury User's Guide</A>.
> > +<A HREF=\"http://www.cs.mu.oz.au/research/mercury/information/doc-latest/user_guide_toc.html\">Mercury User's Guide</A>.
> > "),
> >
> >
> This URL should be rewritten so that it uses relative links rather than
> a fixed URL.
Done.
> Also I have installed the tool linkchecker on earth, you might want to
> use it to make sure that you got all the links.
Done.
> I would also suggest symlinking doc to doc-latest?
I've decided to replace the manuals in `doc' with a forwarding page
back to the main documentation page, so users can decide for themselves
whether to link to the release or latest documentation.
Simon.
Estimated hours taken: 4
Put the documentation for the current release on the web page,
as well as the documentation for the latest snapshot.
w3/RELEASE_INFO:
Contains `make' variables describing the name and CVS tag of
the current official release.
compiler/notes/release_checklist.html:
w3/RELEASE_INFO needs to be updated for each release.
w3/include/globals.inc.in:
Add a variable containing the name of the current official release.
Add variables containing the locations of the manuals, to avoid
hard-coding them everywhere.
w3/include/globals.inc:
Removed.
w3/Makefile:
Build globals.inc by filling in the name of the current release
in globals.inc.in with the name from RELEASE_INFO.
w3/Makefile.common:
All HTML files depend on globals.inc.
w3/information/Makefile:
Check out and build the documentation for both the
release branch and the main branch.
w3/include/menubar.inc:
w3/information/include/documentation.inc:
Add the release versions of the documentation to the
`Documentation' page and menubar.
w3/information/developers/remote_cvs.html:
w3/information/include/developer.inc:
w3/news/newsdb.inc:
w3/tutorial/defs.m4:
Update the location of the documentation on the web page
(`doc-release' or `doc-latest' rather than just `doc').
--- w3/Makefile
+++ w3/Makefile
@@ -28,2 +27,0 @@
-html: globals.inc
-
--- /dev/null
+++ w3/information/moved_documentation.html
@@ -0,0 +1,12 @@
+<HTML>
+
+<TITLE>The Mercury Project: Documentation</TITLE>
+<BODY bgcolor="#ABCDEF" text="#000000">
+
+The Mercury documentation has <a href="../documentation.html">moved</a>.
+
+</BODY>
+</HTML>
--- w3/include/globals.inc.in
+++ w3/include/globals/inc.in
@@ -1,4 +1,18 @@
<?
$installed_path="/home/mercury5/installed_w3";
$current_release="<RELEASE_VERSION>";
+ $release_doc_dir="$root/information/doc-release";
+ $latest_doc_dir="$root/information/doc-latest";
+ $ref_man_toc="reference_manual_toc.html";
+ $user_guide_toc="user_guide_toc.html";
+ $library_man_toc="library_toc.html";
+ $trans_guide_toc="transition_guide_toc.html";
+ $ref_man_release="$release_doc_dir/$ref_man_toc";
+ $ref_man_latest="$latest_doc_dir/$ref_man_toc";
+ $user_guide_release="$release_doc_dir/$user_guide_toc";
+ $user_guide_latest="$latest_doc_dir/$user_guide_toc";
+ $library_man_release="$release_doc_dir/$library_man_toc";
+ $library_man_latest="$latest_doc_dir/$library_man_toc";
+ $trans_guide_release="$release_doc_dir/$trans_guide_toc";
+ $trans_guide_latest="$latest_doc_dir/$trans_guide_toc";
?>
--- w3/include/menubar.inc
+++ w3/include/menubar.inc
@@ -46,2 +46,2 @@
-   <a href="<?echo $root?>/information/doc-release/reference_manual_toc.html">Version <?echo $current_release?></a><BR>
-   <a href="<?echo $root?>/information/doc-latest/reference_manual_toc.html">Snapshot</a><BR>
+   <a href="<?echo $ref_man_release?>">Version <?echo $current_release?></a><BR>
+   <a href="<?echo $ref_man_latest?>">Snapshot</a><BR>
@@ -49,2 +49,2 @@
- <a href="<?echo $root?>/information/doc-release/user_guide_toc.html">Version <?echo $current_release?></a><BR>
- <a href="<?echo $root?>/information/doc-latest/user_guide_toc.html">Snapshot</a><BR>
+ <a href="<?echo $user_guide_release?>">Version <?echo $current_release?></a><BR>
+ <a href="<?echo $user_guide_latest?>">Snapshot</a><BR>
@@ -52,2 +52,2 @@
- <a href="<?echo $root?>/information/doc-release/library_toc.html">Version <?echo $current_release?></a><BR>
- <a href="<?echo $root?>/information/doc-latest/library_toc.html">Snapshot</a><BR>
+ <a href="<?echo $library_man_release?>">Version <?echo $current_release?></a><BR>
+ <a href="<?echo $library_man_latest?>">Snapshot</a><BR>
@@ -55,2 +55,2 @@
- <a href="<?echo $root?>/information/doc-release/transition_guide_toc.html">Version <?echo $current_release?></a><BR>
- <a href="<?echo $root?>/information/doc-latest/transition_guide_toc.html">Snapshot</a><BR>
+ <a href="<?echo $trans_guide_release?>">Version <?echo $current_release?></a><BR>
+ <a href="<?echo $trans_guide_latest?>">Snapshot</a><BR>
--- w3/information/Makefile
+++ w3/information/Makefile
@@ -28,0 +29,6 @@
+OLD_DOCS = \
+ reference_manual_toc.html \
+ user_guide_toc.html \
+ library_toc.html \
+ transition_guide_toc.html
+
@@ -73,0 +80,14 @@
+ # Keep installing the developer documentation into doc to avoid
+ # breaking people's bookmarks. All links should refer to the copy
+ # in doc-latest. For the manuals, use a forwarding page to the
+ # `Documentation' page so that users can decide for themselves
+ # whether they want to bookmark the release or snapshot documentation.
+ [ -d $(INSTALL_WEBDIR)/doc ] || mkdir $(INSTALL_WEBDIR)/doc
+ $(CP) mercury-latest/mercury/compiler/notes/*.text \
+ mercury-latest/mercury/compiler/notes/*.html \
+ $(INSTALL_WEBDIR)/doc
+ for file in $(OLD_DOCS); do \
+ $(CP) moved_documentation.html $(INSTALL_WEBDIR)/doc/$$file; \
+ done
+ chmod -R a+r,g+w $(INSTALL_WEBDIR)/doc
+ chgrp -R mercury $(INSTALL_WEBDIR)/doc
--- w3/information/include/documentation.inc
+++ w3/information/include/documentation.inc
@@ -1 +1 @@
-<h2>Mercury Documentation</h2>
+<h2><? echo $subtitle ?></h2>
@@ -34 +34 @@
- <a href="doc-release/reference_manual_toc.html">HTML</a> or
+ <a href="<? echo $ref_man_release ?>">HTML</a> or
@@ -37 +37 @@
- <a href="doc-latest/reference_manual_toc.html">HTML</a> or
+ <a href="<? echo $ref_man_latest ?>">HTML</a> or
@@ -49 +49 @@
- <a href="doc-release/user_guide_toc.html">HTML</a> or
+ <a href="<? echo $user_guide_release ?>">HTML</a> or
@@ -52 +52 @@
- <a href="doc-latest/user_guide_toc.html">HTML</a> or
+ <a href="<? echo $user_guide_latest ?>">HTML</a> or
@@ -63 +63 @@
- <a href="doc-release/library_toc.html">HTML</a> or
+ <a href="<? echo $library_man_release ?>">HTML</a> or
@@ -66 +66 @@
- <a href="doc-latest/library_toc.html">HTML</a> or
+ <a href="<? echo $library_man_latest ?>">HTML</a> or
@@ -78 +78 @@
- <a href="doc-release/transition_guide_toc.html">HTML</a> or
+ <a href="<? echo $trans_guide_release ?>">HTML</a> or
@@ -81 +81 @@
- <a href="doc-latest/transition_guide_toc.html">HTML</a> or
+ <a href="<? echo $trans_guide_latest ?>">HTML</a> or
--- w3/news/newsdb.inc
+++ w3/news/newsdb.inc
@@ -285 +285 @@
-<A HREF=\"http://www.cs.mu.oz.au/research/mercury/information/doc-latest/user_guide_toc.html\">Mercury User's Guide</A>.
+<A HREF=\"$user_guide_latest\">Mercury User's Guide</A>.
@@ -290 +290 @@
-"<a href=\"mailto:rwab1 at cl.cam.ac.uk\">Ralph Becket</a>
+"<a href=\"mailto:rafe at cs.mu.oz.au\">Ralph Becket</a>
--------------------------------------------------------------------------
mercury-reviews mailing list
post: mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------
More information about the reviews
mailing list