Commits

Anonymous committed 604c739

[xemacsweb PATCH] Improve Makefile, improve About/Website.content <uwvgi9blu.fsf@ecf.teradyne.com>

Comments (0)

Files changed (4)

+2000-09-12  Adrian Aichner  <aichner@ecf.teradyne.com>
+
+	* Website.content: Avoid undesired genpage content tag expansion.
+	Add hint to guidelines how to avoid this.  Merge back indentation
+	changes from Website.html.
+
 2000-09-11  Adrian Aichner  <aichner@ecf.teradyne.com>
 
 	* Website.content: Document .content file structure and conversion

About/Website.content

               <a href="http://cvs.sourceforge.net/cgi-bin/cvsweb.cgi/?cvsroot=xemacs">browsed</a>
               by anyone.</p>
             <p>Only developers can commit their changes to the
-            repository themselves.  Here is the <a
-            href="http://sourceforge.net/project/memberlist.php?group_id=11">current
-            list of developers</a>.</p>
+              repository themselves.  Here is the <a
+                                                     href="http://sourceforge.net/project/memberlist.php?group_id=11">current
+                list of developers</a>.</p>
             <p>Sources can be checked out into a local working
-            directory according to <a
-            href="http://sourceforge.net/cvs/?group_id=11">these
-            instructions</a>.</p>
+              directory according to <a
+                                        href="http://sourceforge.net/cvs/?group_id=11">these
+                instructions</a>.</p>
             <dl>
               <!-- one of (DD DT) -->
               <dt><strong>anonymously</strong></dt>
               genpage is run by the <a href="http://cvs.sourceforge.net/cgi-bin/cvsweb.cgi/xemacsweb/Makefile?cvsroot=xemacs">xemacsweb/Makefile</a>
               according to the configuration defined in <a href="http://cvs.sourceforge.net/cgi-bin/cvsweb.cgi/xemacsweb/genpage.conf?cvsroot=xemacs">xemacsweb/genpage.conf</a>.</p>
             <p>You may run this Makefile in your local xemacsweb
-            working directory, provided you have
-            <strong>XEmacs</strong> (including the
-            <strong>PSGML</strong> package), <strong>perl5</strong>
-            and <strong>GNU make</strong> installed.  genpage itself
-            is found in xemacsweb/genpage/bin/genpage, but the
-            Makefile knows that.  On Windows NT you will also need to
-            install Cygwin for the Makefile to run.</p>
+              working directory, provided you have
+              <strong>XEmacs</strong> (including the
+              <strong>PSGML</strong> package), <strong>perl5</strong>
+              and <strong>GNU make</strong> installed.  genpage itself
+              is found in xemacsweb/genpage/bin/genpage, but the
+              Makefile knows that.  On Windows NT you will also need to
+              install Cygwin for the Makefile to run.</p>
             <p>We currently use genpage version 1.0.7, imported on a
               vendor branch.  Local changes were necessary to make it
               work for the XEmacs site, and to make it work on Windows
               <dt><strong>Create .content files for new documentation</strong></dt>
               <dd>
                 <p>All new documents should be .content files to be
-                processed by genpage.  Just create the new file in
-                xemacsweb or any of its sub-directories and run
-                <strong>make all</strong> in the top-level directory
-                (xemacsweb).  This will generate a .html file by the
-                same name and validate it using XEmacs/PSGML.</p>
+                  processed by genpage.  Just create the new file in
+                  xemacsweb or any of its sub-directories and run
+                  <strong>make all</strong> in the top-level directory
+                  (xemacsweb).  This will generate a .html file by the
+                  same name and validate it using XEmacs/PSGML.</p>
                 <p>Here is what a minimal .content file looks like:</p>
                 <table border="1">
                   <tbody>
                       <!-- one of (TD TH) -->
                       <td>
                         <pre>
-%title%
+<!-- _GP_ qq{%title%} -->
 Title of Your Document
-%author%
+<!-- _GP_ qq{%author%} -->
 Your Name
-%main%
+<!-- _GP_ qq{%main%} -->
 Any text including HTML tags.  This text will be embedded in the
 specified genpage template.  It is equivalent to the contents of the
 &lt;body&gt;...&lt;/body&gt; section of a corresponding HTML
                     </tr>
                   </tbody>
                 </table>
-                <p></p>
+                <p>When you need to avoid substitution of <a
+                                                             href="../genpage/www/index.html#7">genpage content
+                    tags</a> in .content files (like I did in the table
+                  above) you may use following trick:</p>
+                <pre>
+&lt;!-- _GP_ qq{%title%} --&gt;
+                </pre>
+                <p>
+                  Above genpage command returns the string-quoted
+                  genpage content tag as a string.</p>
               </dd>
               <dt><strong>Generate .content files from existing .html documents</strong></dt>
               <dd>
+2000-09-12  Adrian Aichner  <aichner@ecf.teradyne.com>
+
+	* Makefile: Avoid rebuilding genpage release documentation each
+	time by means of a genpage-time-stamp.
+	* Makefile (htdocs): Depends on genpage-time-stamp and
+	htdocs-time-stam now.
+	* Makefile (validate): Cosmetic change.
+	* Makefile (htdocs-time-stamp): Renamed from genpage-time-stamp,
+	which is used for genpage release documentation now.
+	* Makefile (clean): Remove updated list of time-stamp files.
+
 2000-09-11  Adrian Aichner  <aichner@ecf.teradyne.com>
 
 	* Makefile: Add XEmacs mode specification: -*-Makefile-*-
 	$(XEMACS) $(FLAGS) -f batch-byte-compile $<
 
 # APA: Default target (first to occur in file):
-htdocs: $(ELCS) gp genpage-time-stamp
+htdocs: $(ELCS) genpage-time-stamp htdocs-time-stamp
 
-validate:  htdocs validate-time-stamp
+validate: htdocs validate-time-stamp
 
-# APA: Build the genpage documentation
-gp:
+# APA: Build the genpage documentation.  Maintain a timestamp to avoid
+# needless re-generation of genpage release documentation.
+# APA: The genpage/content/index.content is not the only dependency,
+# but any improvements should go into the genpage/Makefile itself and
+# be integrated with a genpage release.
+genpage-time-stamp: genpage/content/index.content
 	cd genpage;	$(MAKE) gp
+	touch genpage-time-stamp
 
 all: validate
 
 # APA: When contentdir and outputdir are the same then, and only then,
 # genpage depends only on content files.  Copying of all other files
 # (from contentdir to outputdir) is not necessary in this case.
-genpage-time-stamp: $(CONTENT_FILES) template.html
+htdocs-time-stamp: $(CONTENT_FILES) template.html
 	perl ./genpage/bin/genpage -p $(GENPAGE_CONF) -o "."
-	touch genpage-time-stamp
+	touch htdocs-time-stamp
 
 # APA: Validate only files younger than time-stamp file created by
 # previous validation
 clean:
 	find . -name "*.content" -print | perl -ne "{ chomp; s/\.content/.html*/; unlink; }"
 	rm genpage-time-stamp
+	rm htdocs-time-stamp
 	rm validate-time-stamp
 
 # End of xemacsweb Makefile