Patch to devel docs pages



Hello. I would like to submit this patch for the gtk-doc changes.
a.
? gnome-doc-macro.el
? gtkdoc-changes.diff
? installer.log.20031121070946
Index: api-help.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/api-help.html,v
retrieving revision 1.9
diff -u -r1.9 api-help.html
--- api-help.html	11 Apr 2002 14:02:14 -0000	1.9
+++ api-help.html	3 Dec 2003 22:39:51 -0000
@@ -43,24 +43,17 @@
       </tr>
       <tr>
         <td>
-          You will also need to grab the gtk-doc scripts so that
-          you can actually build all the necessary file you need.
-          You should go to the <a href= 
+          You will also need to install the gtk-doc (or gtkdoc,
+          depending on your OS) package so that you can build
+          the documentation.  Go to the <a href=
           "http://www.gtk.org/rdp/download.html";>GTK+ reference
           download page</a> to get the necessary tools.
         </td>
       </tr>
       <tr>
         <td>
-          There are a couple of documents contained here that
-          explain the gtk-doc system and how to use it for writing
-          the API. These documents are from the GTK API project at
-          <a href="http://www.gtk.org/rdp/";>
-          http://www.gtk.org/rdp/</a>. Included are: The <a href= 
-          "authors.html">Authors</a> document for API authors, and
-          the <a href="gtkapi.html">GTK-API</a> document which
-          includes the style guide. The GNOME API project is
-          following the same standards that the GTK API project is.
+          For a step-by-step guide to writing API documentation, 
+          see the <a "authors.html">Authors</a> document.
         </td>
       </tr>
       <tr>
@@ -69,8 +62,7 @@
           where other writers can help you with any problems you
           might be having. To find out how to join the list go to
           the <a href= 
-          "http://mail.gnome.org/";>GNOME
-          Mailing Lists</a> page.
+          "http://mail.gnome.org/";>GNOME Mailing Lists</a> page.
         </td>
       </tr>
     </table>
Index: authors.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/authors.html,v
retrieving revision 1.1
diff -u -r1.1 authors.html
--- authors.html	6 Jul 1999 16:06:05 -0000	1.1
+++ authors.html	3 Dec 2003 22:39:51 -0000
@@ -1,245 +1,278 @@
-<h3>Authors</h3>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml"; lang="en-US" xml:lang="en-US">
+  <head>
+    <title>Writing GNOME API Documentation</title>
+    <link rel="icon" type="image/png" href="/images/gnome-16.png" />
+    <link rel="stylesheet" type="text/css" href="/default.css" />
+    <link rel="stylesheet" type="text/css" href="/developer.css" />
+    <style type="text/css">
+      #hdr {
+        background: url("/images/header-bg-mountains01.png") no-repeat;
+        background-color: #d6e7ff;
+      }
+    </style>
+  </head>
+  <body>
+
+    <div id="body">
+
+<h3>Tools and Goals</h3>
+
+<p>
+GNOME API documentation is done using the gtk-doc package, which
+performs two basic tasks. First, it automates the creation of basic
+API documentation from source code and comments.  Second, it provides
+an easy way for people to change and add to the auto-generated
+documentation without having to edit the source code itself.
+</p>
+
+<p>
+The gtk-doc tools are not run by hand: you simply paste a few lines
+into your Makefiles, and then when you run a make install, a set of
+templates and documents are created. If you edit the templates, the
+tools will incorporate those changes into the documents the next time
+you build.
+</p>
+
+<blockquote>
+<b>Tip:</b><br>
+The libglade and gtk+ modules in GNOME CVS are excellent examples of
+GNOME development methods, including gtk-doc usage.
+</blockquote>
+
+<h3>File Formats and Requirements</h3> 
+
+<p> 
+  Final document output is in DocBook XML, just like user
+  documents. The intermediate templates are XML-like but are not
+  well-formed or valid XML documents.
+</p>
+
+<p>
+  The gtk-doc package requires the DocBook stylesheets and the
+  opensp XML/SGML parsing tools, as well as Perl. Emacs users may find
+  it helpful to use the XSL major mode provided by the xslide package.
+</p>
+
+
+<h3>How to Set Up your Module to Use gtk-doc</h3>
+<p>
+These instructions are the same as the ones in the file
+"setting-up.txt" from the gtk-doc module in GNOME CVS. They assume
+that you will be using automake and autoconf.
+</p>
+
+<ol>
+  <li> Install the gtk-doc package. Depending on your distribution, this will be called gtk-doc, gtkdoc, or gtk-doc-tools. </li>
+  <li> Create a directory in which you want your documentation to be
+  built. The most commonly used directory is "docs/reference/".</li>
+  <li> Edit Makefile.am files:
+  <ul>
+    <li> You will need one Makefile.am for each directory you have created.</li>
+    <li> List all subdirectories in the SUBDIRS section.</li>
+    <li> List all extra files in the EXTRA_DIST section.</li>
+    <li> If you want to use XML tags in your code comment blocks, add this line to your docs/reference/Makefile.am:
+    <pre>
+MKDB_OPTIONS= --sgml-mode --output-mode=xml
+    </pre>
+  </li>
+  </ul>
+</li>
+
+<li>Edit your configure.in:
+<ul>
+  <li> Add the line <tt>GTK_DOC_CHECK(1.0)</tt> to call the gtk-doc.m4 macro.</li>
+  <li> Make sure to add the Makefile.am files to your configure.in, so that the autotools will find them during the build.</li>
+</ul>
+</li>
+
+</ol>
+
+<p>
+That's it. When you build the software, the API docs will be generated
+in the docs/reference directory. There are additional options you can
+use-- see the libglade and gtk+ for examples.
+</p>
+
+<blockquote>
+<b>Tip:</b><br>
+  In GNOME projects, general developer documentation is usually stored
+  in the "docs" directory of the project, and API documentation in the
+  "docs/reference" directory. User documentation typically goes into
+  the "help" directory.  
+ </blockquote>
+
+<h3>Commenting your Code to Produce Automated Docs</h3>
+
+<p>
+  When you build your project with gtk-doc, specially formatted
+  comments are read and converted to documentation. What's the special
+  format?
+</p>
+<p> 
+To document a function:
+<ul>
+  <li> Begin a comment block with <b>/**</b> on a line by itself.
+  <li> Begin each line in the block with <b>*</b>
+  <li> The second line of the comment should be the function name.
+  <li> After that, describe parameters. Precede each parameter with an @.
+  <li> Follow parameter descriptions with a blank line and the function description. 
+  <li> End with information about the return value, if any.
+</ul>
+
+<p> If you use emacs, you can add the file <a
+href="http://cvs.gnome.org/registry/file.cgi?file=gtk-doc.el&dir=gtk-doc%2Ftools&rev=&cvsroot=/cvs/gnome&target=_parent&linked_text=null";>tools/gtk-doc.el</a>
+to your .emacs file, and use the shortcuts C-x4h or M-x
+gnome-doc-insert to put the right comment structure in for you.  </p>
+
+<p>The comment block will look like this:</p>
+<blockquote>
+<pre>
+/**
+ * function_name:
+ * @par1:  description of parameter 1. These can extend over more than
+ * one line.
+ * @par2:  description of parameter 2
+ *
+ * The function description goes here.
+ *
+ * Returns: an integer.
+ */</pre>
+</blockquote>
+
+<p>
+  Changes to the template files are recognized every time you rebuild
+  the documentation, but changes to the comment blocks in code are
+  not. To force gtk-doc to rescan the code, remove the *.stamp files
+  in the directory where gtk-doc was called, then rebuild.
+</p>
+
+
+<p>
+  For more detailed style tips, see the <a href="gtkapi.html">GTK
+  Documentation Author Guidelines</a>.
+</p>
+
+<h3>Syntax in Comments and XML</h3>
+
+<p>
+  In the XML templates and in the comment blocks, you can use
+  special syntax to highlight important pieces of information and link to
+  other sections of the document.
+</p>
+<ul>
+<li> Put @ in front of parameters: "the value from @par1 is parsed..."
+<li> Put % in front of constants: "the %CONS1 value defines the..."
+<li> Follow functions or macros that take arguments with parentheses: "differs from function2() in that..."
+<li> Precede GTK widgets, macros that don't take arguments, structs, and enums with #: "checks the #GtkWidget for..." 
+</ul>
+
+<p>
+The final output docs will highlight the words denoted with the
+syntax, and if possible link to the portions of the document where
+they are covered.
+</p>
+
+<h3>Organizing Your Documentation</h3>
+
+<p>
+  By default, gtk-doc structures the documentation it produces using
+  the .h and .c files in your project: each file gets its own section
+  in the document. To adjust the structure to fit your needs, edit the
+  file myproject-sections.txt (the name will vary with your project
+  name, of course).
+</p>
+  To begin a new section or subsection of your document, place a
+  &lt;SECTION&gt; and &lt;SUBSECTION&gt; tag on its own line. Each
+  section or subsection should contain a set of related enums,
+  declarations, functions, or macros. In general, place enums after
+  the first function that uses them.  
+</p> 
+
+<p>
+  If you have private objects that you do not wish to cover in your
+  documentation, add a &lt;SUBSECTION_private&gt; at the end of the
+  section where they appear.  The final output will not include those
+  declarations. In addition, the next time you run the <tt>make
+  templates</tt> command, the declarations will be removed from the
+  template files as well.
+</p>
+
+<h3>XML Syntax in the Template Files</h3>
+
+  <p>
+   DocBook XML allows you a lot of flexibility. A complete DocBook
+   reference is available at <a
+   href="http://docbook.org";>docbook.org</a>, but for the most part,
+   you won't need more than a few tags.
+  </p>
+
+<blockquote>
+<b>Tip:</b><br> The XML template files can be found in the tmpl/
+  directory. If you followed the GNOME default, that will be
+  myproject/docs/reference/tmpl/.
+</blockquote>
+
+<p>
+Some of the most commonly used tags are:
+
+<ul>
+<li><b>&lt;para&gt;:</b> The paragraph tag. Put it around any general piece of text.
+<li> <b>&lt;link&gt;:</b> Link to other items in your document using the XML id (unique within each document). For example:
+   <tt>&lt;link linkend="glib-Hash-Tables">Hash Tables&lt;/link></tt>
+<li> <b>&lt;ulink&gt;:</b> URL link. For example,  <tt>&lt;ulink linkend="http://gnome.org"&gt;Gnome.org&lt;/link&gt;</tt>.
+<li> <b>&lt;example&gt;:</b> An example. The first part of your example should be a &lt;title&gt; tag, followed by one or more of &lt;para&gt; or &lt;programlisting&gt.
+<li> <b>&lt;programlisting&gt;:</b> Put example code in here. It will be formatted verbatim. 
+<li> <b>&lt;itemizedlist&gt;:</b> An itemized list like the &lt;ul&gt; tag in HTML. Each item is marked with &lt;listitem&gt; tags containing &lt;para&gt; tags. It is convenient to consider &lt;listitem&gt&lt;para&gt; as a single tag, since they are always together and nothing can come between them.
+<li> <b>&lt;type&gt;:</b> A data type.
+<li> <b>&lt;structname&gt;:</b> The name of a struct outside the GTK docs. Use the # shortcut for items inside the GTK docs.
+</ul>
+
+<blockquote>
+<b>Tip:</b><br> Normally, greater-than and less-than symbols in comment blocks
+  are converted to "&amp;gt;" and "&amp;lt;" in the XML, for display
+  as &gt; and &lt; in the final, human-readable display.  To use XML
+tags in your comment blocks, use the <tt>--sgml-mode</tt> flag in your
+Makefiles. For example, gtk+ uses the line
+<tt>MKDB_OPTIONS=--sgml-mode --output-format=xml</tt>, denoting that
+when generating DocBook, its output format is XML (the default) and
+that it expects to find tags in the comment blocks inside the code.
+</blockquote>
+
+    </div>
+
+    <div id="sidebar">
+      <p class="section">Navigation</p>
+      @MENU@
+    </div>
+
+<div id="hdr">
+      <a href="http://developer.gnome.org/";><img id="logo" src="/images/gnome-64.png" alt="Home" title="Back to the Gnome Developer's home page" /></a>
+      <p class="none"></p>
+      <div id="hdrNav">
+        <a href="http://www.gnome.org/";>Users</a> &#x00b7;
+        <a href="/"><b>Developers</b></a> &#x00b7;
+        <a href="http://cvs.gnome.org/lxr/";>LXR</a> &#x00b7;
+        <a href="http://cvs.gnome.org/bonsai/";>Bonsai</a> &#x00b7;
+        <a href="http://ftp.gnome.org/pub/GNOME/MIRRORS.html";>FTP</a> &#x00b7;
+        <a href="http://bugzilla.gnome.org/";>Bugzilla</a> &#x00b7;
+        <a href="http://www.gnome.org/softwaremap/";>Software Map</a> &#x00b7;
+        <a href="mailto:webmaster gnome org">Contact</a>
+      </div>
+    </div>
+
+    <div id="copyright">
+      &#x00a9; 2003 by <a href="http://www.gnome.org/";>The GNOME Project</a>
+      <br />
+      Last modified @last_modified@ UTC.
+      <br />
+      <a href="http://validator.w3.org/check/referer";
+        lang="en-AU" xml:lang="en-AU">Optimised</a>
+      for <a href="http://www.w3.org/";>standards</a>.
+      Hosted by <a href="http://www.redhat.com/";>Red Hat</a>.
+    </div>
 
-<b>Tools</b>
-<p>
-<em>gtkdoc-scan</em>
-<p>
-  Scan a set of header files for declarations.
-<p>
-  Usage: gtkdoc-scan --module=MODULE [--output-dir=DIR] FILES
-<p>
-<em>gtkdoc-scanobj</em>
-<p>
-  Compile a C program to get information about GTK+ objects.
-<p>
-  Usage: gtkdoc-scan --module=MODULE
-<p>
-<em>gtkdoc-mktmpl</em>
-<p>
-  Make template files from declaration files
-<p>
-  Usage: gtkdoc-mkhtml --module=MODULE [--output-dir=DIR] 
-<p>
-<em>gtkdoc-mkdb</em>
-<p>
-  Make DocBook output from declaration files and template files.
-<p>
-  Usage: gtkdoc-mkdb --module=MODULE
-<p>
-<em>gtkdoc-mkhtml</em>
-<p>
-  Usage: gtkdoc-mkhtml MODULE DRIVER_FILE
-<p>
-<em>gtkdoc-mkman</em>
-<p>
-  Usage: gtkdoc-mkman 
-<p>
-
-<b>General</b>
-<p>
-The files to edit manually are generated in the tmpl/ directory.
-<p>
-You may find useful information in the GTK tutorial, or the info documentation.
-<p>
-
-You must use <em>&amp;lt;</em> or <em>&amp;gt;</em> instead of '<' and '>'.
-<p>
-The first part of each function/macro/struct etc. description should be
-a very short summary of what it is. This may be used at some point to
-produce a short reference guide which can be printed out.
-<p>
-For macros which return a value just like a function, you must manually
-add a '@Returns: ' field.
-<p>
-You may want to rearrange the functions/macros etc. to split them into
-related sections. To do this rearrange the MODULE-sections.txt
-files. You can also add <SUBSECTION> between functions. Currently this just
-results in a blank line between them in the synopsis.
-<p>
-
-<b>Abbreviations</b>
-<p>
-These are expanded into appropriate DocBook tags, saving a lot of typing.
-I've used the Gnome ones (see gnome.txt) but also added '#'.
-<p>
-  Use function() to refer to functions or macros which take arguments.
-<p>
-  Use @param to refer to parameters. (I've also used this when referring to
-  parameters of other functions, related to the one being described.)
-<p>
-  Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS.
-<p>
-  Use #symbol to refer to other types of symbol, e.g. structs and enums
-    and macros which don't take arguments.
-<p>
-
-
-Useful DocBook Tags
-===================
-<p>
-These are the DocBook tags which I have used or I think could be useful.
-Let me know if I'm doing something wrong!
-<p>
-To link to another section in the GTK docs:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;link linkend="glib-Hash-Tables">Hash Tables&lt;/link>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-  The linkend is the SGML id on the top item of the page you want to link to.
-  For most pages this is currently the part ("gtk", "gdk", glib") and then
-  the page title ("Hash Tables"). For widgets it is just the class name.
-  Spaces and underscores are converted to '-' to conform to SGML.
-<p>
-
-To refer to an external function, e.g. a standard C function:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;function>...&lt;/function> 
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-To include example code:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;example>
-    &lt;title>Using a GHashTable.&lt;/title>
-    &lt;programlisting>
-      ...
-    &lt;/programlisting>
-    &lt;/example>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-  or possibly this, for very short code fragments which don't need a title:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;informalexample>
-    &lt;programlisting>
-      ...
-    &lt;/programlisting>
-    &lt;/informalexample>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-
-To include bulleted lists:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;itemizedlist>
-    &lt;listitem>
-    &lt;para>
-      ...
-    &lt;/para>
-    &lt;/listitem>
-
-    &lt;listitem>
-    &lt;para>
-      ...
-    &lt;/para>
-    &lt;/listitem>
-
-    &lt;/itemizedlist>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-
-To include a note which stands out from the text:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;note>
-    &lt;para>
-      Make sure you free the data after use.
-    &lt;/para>
-    &lt;/note>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-To refer to a type:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;type>unsigned char&lt;/type>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-
-To refer to an external structure (not one described in the GTK docs):
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;structname>XFontStruct&lt;/structname>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-To refer to a field of a structure:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;structfield>len&lt;/structfield>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-To refer to a class name, we could possibly use:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;classname>GtkWidget&lt;/classname>
-       </TD>
-      </TR>
-     </TABLE>
-  but you'll probably be using #GtkWidget instead (to automatically create
-  a link to the GtkWidget page - see the abbreviations above).
-<p>
-To emphasize text:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;emphasis>This is important&lt;/emphasis>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-  but I haven't been using it so far.
-<p>
-
-For filenames use:
-<p>
-<TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="70%">
-      <TR>
-       <TD>
-    &lt;filename>c:\windows&lt;/filename>
-       </TD>
-      </TR>
-     </TABLE>
-<p>
-
-Also, &lt;screenshot>, &lt;option>, 
-<p>
+ </body>
+</html>
Index: devel-doc.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/devel-doc.html,v
retrieving revision 1.7
diff -u -r1.7 devel-doc.html
--- devel-doc.html	7 Feb 2000 19:06:41 -0000	1.7
+++ devel-doc.html	3 Dec 2003 22:39:51 -0000
@@ -12,9 +12,8 @@
     <blockquote>
       <dl>
         <dd>
-          The GNOME Developer Documentation project was started to
-          provide documentation for developers about creating
-          applications for GNOME. This documentation includes
+          The GNOME Developer Documentation project produces
+          documentation on creating applications for GNOME, including
           tutorials, guides, and API reference. 
           <p>
             You may read the developer documentation by visiting
@@ -35,13 +34,16 @@
           <b>API Reference</b>
         </dt>
         <dd>
-          You can check out the status of the API documentation on
-          the <a href="/doc/API/api-status.html">API Status
-          Page</a> 
+          The <a href="http://developer.gnome.org/doc/API/";>GNOME API
+          reference</a> is available online and as a series of tarballs. 
+              
           <p>
             If you see a section that needs documentation you think
             you can provide, you can <a href="api-help.html">
-            join</a> the effort.
+            join</a> the effort. You can also write API reference for
+          your own projects. To learn more about writing API
+          documentation in GNOME, check the guide to <a
+          href="authors.html">Writing GNOME API Documentation.</a>
           </p>
         </dd>
       </dl>
@@ -50,12 +52,12 @@
           <b>Programming Guides</b>
         </dt>
         <dd>
-          Programming Guides are in depth, detailed descriptions of
+          Programming Guides are in-depth, detailed descriptions of
           an architecture. This type of documentation should tie
           many elements together to give the developer a deeper
-          understanding of how the architecture works. Unlike
-          tutorials it is not cookbook style but should include
-          examples to help understanding. 
+          understanding of how the architecture works. A programming
+          guide doesn't give cookbook-style instructions, but it
+          should include examples to help understanding.
           <p>
             If you would like to write a programming guide, or you
             have one available please contact the <a href= 
@@ -69,9 +71,10 @@
           <b>Tutorials</b>
         </dt>
         <dd>
-          Tutorials are "cookbook" style documentation. The reader
-          should be able to follow procedures to create a GNOME
-          application or component. 
+          Tutorials are "cookbook" style documentation that leads a
+          reader through a series of steps to create a specific
+          result. The reader should be able to follow the described
+          procedures to create a GNOME application or component.
           <p>
             If you would like to write a tutorial, or you have one
             available please contact the <a href= 
Index: gtkapi.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/gtkapi.html,v
retrieving revision 1.2
diff -u -r1.2 gtkapi.html
--- gtkapi.html	7 Feb 2000 19:06:41 -0000	1.2
+++ gtkapi.html	3 Dec 2003 22:39:51 -0000
@@ -32,7 +32,7 @@
         <div class="NOTE">
           <blockquote class="NOTE">
             <p>
-              <b>NOTE:</b> This is only a draft version. Don't make
+              <b>NOTE:</b> This is a draft. . Don't make
               major changes to your documentation until we've
               agreed on all this.
             </p>
Index: tools.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/tools.html,v
retrieving revision 1.11
diff -u -r1.11 tools.html
--- tools.html	25 Aug 2002 00:28:07 -0000	1.11
+++ tools.html	3 Dec 2003 22:39:51 -0000
@@ -79,17 +79,17 @@
     </h4>
     <ul>
       <li>
-        <a href="http://www.gtk.org/rdp/download.html";>Gtk-Doc</a>
-        - The documentation tools used in the GNOME and GTK API
-        Reference docs. You can also read the doc file that
-        accompanies gtk-doc here: <a href="authors.html">
-        "Authors"</a> - a how to for authors (yes you edit the tmpl
-        files not the code).
+        Step-by-step <a href="authors.html">guide for authors</a> of
+      API docs.
       </li>
       <li>
         <a href="http://psgml.sourceforge.net/";>
         psgml</a> - an SGML mode for Emacs
       </li>
+      <li>
+        <a href="http://sourceforge.net/projects/xslide/";>XSLide</a>,
+        an XSL and XML major mode for Emacs.
+      </li>
     </ul>
   </body>
 </html>
Index: user-doc.html
===================================================================
RCS file: /cvs/gnome/web-devel-2/content/arch/doc/user-doc.html,v
retrieving revision 1.7
diff -u -r1.7 user-doc.html
--- user-doc.html	14 Aug 2000 01:23:10 -0000	1.7
+++ user-doc.html	3 Dec 2003 22:39:51 -0000
@@ -22,7 +22,7 @@
      GNOME project you should read the <a href=
      "http://developer.gnome.org/projects/gdp/handbook.html";>GNOME Documentation Project
      Handbook</a>. This will explain the tools, conventions, and
-     methods used in the GDP, including DocBook SGML, CVS, and a host
+     methods used in the GDP, including DocBook XML, CVS, and a host
      of other topics.
     </p>
   </body>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]