diff options
| author | Daniel Veillard <veillard@src.gnome.org> | 2002-04-14 22:04:00 +0000 |
|---|---|---|
| committer | Daniel Veillard <veillard@src.gnome.org> | 2002-04-14 22:04:00 +0000 |
| commit | b757872ded08cb79e9f9f850a50c35540e2c101a (patch) | |
| tree | 0e7ee36ff4049a009c09a64f1e6c9939a12e93b6 /tests/docbook | |
| parent | cd9f735f3be087343d0a3e76414b03326d17e5fc (diff) | |
| download | libxslt-b757872ded08cb79e9f9f850a50c35540e2c101a.tar.gz libxslt-b757872ded08cb79e9f9f850a50c35540e2c101a.tar.bz2 libxslt-b757872ded08cb79e9f9f850a50c35540e2c101a.zip | |
added a specific example for bug #78662 in the regression tests this also
* tests/docs/Makefile.am tests/docs/bug-83.xml
tests/general/Makefile.am tests/general/bug-83.*: added a
specific example for bug #78662 in the regression tests
* tests/docbook/: this also changed a couple of DocBook results
Daniel
Diffstat (limited to 'tests/docbook')
| -rw-r--r-- | tests/docbook/result/html/gdp-handbook.html | 104 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/index.orig | 2 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs02.orig | 22 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs04.orig | 56 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs06.orig | 6 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs07.orig | 4 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs08.orig | 4 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs09.orig | 2 | ||||
| -rw-r--r-- | tests/docbook/result/xtchunk/html/indexs12.orig | 8 |
9 files changed, 104 insertions, 104 deletions
diff --git a/tests/docbook/result/html/gdp-handbook.html b/tests/docbook/result/html/gdp-handbook.html index 70624452..807b8fe2 100644 --- a/tests/docbook/result/html/gdp-handbook.html +++ b/tests/docbook/result/html/gdp-handbook.html @@ -83,7 +83,7 @@ irc.gnome.org is another option for contacting GDP members. </p></div></div><div class="sect2"><a name="notation"></a><div class="titlepage"><div><h3 class="title"><a name="notation"></a>Notation and Conventions</h3></div></div><p> This Handbook uses the following notation: - <div class="informaltable" id="id2772333"><a name="id2772333"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td> + <div class="informaltable" id="id2791779"><a name="id2791779"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td> Directory </td></tr><tr><td><tt>foo.sgml</tt></td><td> Filename @@ -147,7 +147,7 @@ help. The <i>DocTable</i> also allows people to make announcements and suggestions and to discuss issues in the comments section. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2766655"></a>Note</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2787009"></a>Note</h3><p> Note that the information in the <i>DocTable</i> may not always be up-to-date or accurate. When you assign yourself to documenting an @@ -159,7 +159,7 @@ this for documentation, not least of which is the single source nature of SGML. To contribute to the GDP you should learn to use DocBook. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2766742"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2787085"></a>NOTE</h3><p> To get started writing for the GDP you do not need to rush out and learn DocBook - if you feel it is too much to handle for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top"> @@ -173,7 +173,7 @@ that jade is platform dependent (eg. i386), while the other packages are in the <tt>noarch</tt> directory.) You can find more - information on DocBook Tools <a href=" http://sourceware.cygnus.com/docbook-tools/" target="_top">here</a>. + information on DocBook Tools <a href="http://sourceware.cygnus.com/docbook-tools/" target="_top">here</a>. </p><p> If you are an Emacs user you may want to grab the psgml package as well. This is a major mode @@ -205,14 +205,14 @@ your output document appearance subtly vary between the two DTD's. To install the GDP custom DTD with PNG image support by hand: - </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2767156"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2787506"></a> Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the GDP DocBook DTD for PNG support</a> and install it where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that the 3.0 DTD is missing support for the <tt><legalnotice></tt> tag, so it is recommended that you use version 3.1 - </p></li><li style="list-style-type: disc"><p><a name="id2767324"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2787673"></a> Add the new DTD to your SGML CATALOG file. The location of your SGML CATALOG file may vary depending upon your distribution. (On Red Hat it is usually in @@ -290,7 +290,7 @@ V1.1//EN"[]> the command <tt>$</tt><b>db2ps mydocument.sgml</b>, after which you can print out or view the resulting .ps file. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2889222"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2787595"></a>NOTE</h3><p> The html files you get will not look quite the same as the documentation distributed with GNOME unless you have the custom stylesheets installed on your machine. DocBook @@ -341,24 +341,24 @@ V1.1//EN"[]> There are many resources available to help you learn DocBook. The following resources on the web are useful for learning DocBook: - </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2889510"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2910177"></a> <a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman Walsh's <i>DocBook: The Definitive Guide</i>. Online O'Reilly book on using DocBook. Contains an excellent element reference. May be too formal for a beginner. - </p></li><li style="list-style-type: disc"><p><a name="id2889566"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2910232"></a> <a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a> - The Open Source Writers Group's introduction to using DocBook. This is an excellent HOW-TO type article on getting started. - </p></li><li style="list-style-type: disc"><p><a name="id2889607"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2910272"></a> <a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for Hackers</a> - Mark Galassi's introduction to DocBook for hackers. This has to be one of the first introductions to DocBook ever - still as good as it ever was. - </p></li><li style="list-style-type: disc"><p><a name="id2889646"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2910312"></a> <a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top"> FreeBSD Documentation Project Primer for New Contributors</a> - FreeBSD documentation project @@ -371,7 +371,7 @@ V1.1//EN"[]> </p><p> The following sections of this document are designed to help documentation authors write correct and consistent DocBook: - </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2889713"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2910378"></a> <a href="#docbookbasics" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of commonly used DocBook tags. </p></li></ul></div><p> @@ -709,7 +709,7 @@ V1.1//EN"[]> ready for this transistion, it is <i>strongly advised</i> that the documentation writers conform to XML syntax rules. Here are most important differences: - </p><div class="variablelist"><dl><dt><a name="id2892218"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2892236"></a> + </p><div class="variablelist"><dl><dt><a name="id2912882"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2912901"></a> It is possible with some implementations of SGML to use minimizations to close elements in a document by using </>, for example: @@ -720,7 +720,7 @@ V1.1//EN"[]> if you are using Emacs with psgml mode, you can also use menu command Modify->Normalize. - </p></dd><dt><a name="id2892350"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2892370"></a> + </p></dd><dt><a name="id2913014"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2913034"></a> Also, in SGML some tags are allowed not to have closing tags. For example, it is legal for <tt><xref></tt> not to have a closing tag: @@ -730,7 +730,7 @@ V1.1//EN"[]> <tt><tt><xref linkend="someid"/></tt></tt> (note the slash!). - </p></dd><dt><a name="id2892433"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2892453"></a> + </p></dd><dt><a name="id2913097"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2913117"></a> In XML, unlike SGML, tags are case-senstive <tt><title></tt> and <tt><TITLE></tt> are different tags! @@ -796,7 +796,7 @@ V1.1//EN"[]> actual file name (without extension). The result will look like this: <div class="figure"><p><a name="shot1"></a><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"></p></div></div> - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2892961"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2913625"></a>NOTE</h3><p> Notice in this example that the screenshot file name does not include the file type extension -- to find out why, please read <a href="#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>. @@ -844,7 +844,7 @@ make: *** No rule to make target `love'. Stop. Note the use of tags <tt><prompt></tt> and <tt><userinput></tt> for marking system prompt and commands entered by user. - <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2893205"></a>NOTE</h3><p> + <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2913870"></a>NOTE</h3><p> Note that both <tt><programlisting></tt> and <tt><screen></tt> preserve linebreaks, but interpret SGML tags (unlike LaTeX @@ -857,7 +857,7 @@ make: *** No rule to make target `love'. Stop. <tt><itemizedlist></tt>, <tt><orderedlist></tt>, and <tt><variablelist></tt>. - </p><div class="variablelist"><dl><dt><a name="id2893324"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2893344"></a> + </p><div class="variablelist"><dl><dt><a name="id2913989"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2914008"></a> This is the simplest unnumbered list, parallel to <tt><ul></tt> in HTML. Here is an example: <pre class="programlisting"> @@ -888,16 +888,16 @@ make: *** No rule to make target `love'. Stop. </pre> and output: - </p><div class="itemizedlist"><ul><li><p><a name="id2893362"></a> + </p><div class="itemizedlist"><ul><li><p><a name="id2914026"></a> Show backup files -- This will show any backup file that might be on your system. - </p></li><li><p><a name="id2893435"></a> + </p></li><li><p><a name="id2914100"></a> Show hidden files -- This will show all "dot files" or files that begin with a dot. This files typically include configuration files and directories. - </p></li><li><p><a name="id2893467"></a> + </p></li><li><p><a name="id2914132"></a> Mix files and directories -- This option will display files and directories in the order you sort them instead @@ -915,7 +915,7 @@ make: *** No rule to make target `love'. Stop. or -- if none of this applies -- use <a href="#gui" title="GUI elements"><tt><emphasis></tt></a>. - </p></dd><dt><a name="id2893643"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2893662"></a> + </p></dd><dt><a name="id2914308"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2914327"></a> This list is completely analogous to <tt><itemizedlist></tt> and has the same syntax, but it produces numbered list. By default, @@ -928,7 +928,7 @@ make: *** No rule to make target `love'. Stop. <tt>loweralpha</tt>, <tt>upperroman</tt>, <tt>lowerroman</tt>. - </p></dd><dt><a name="id2893742"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2893762"></a> This list is used when each entry is + </p></dd><dt><a name="id2914408"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2914427"></a> This list is used when each entry is rather long, so it should be formatted as a block of text with some subtitle, like a small subsection. The <tt><variablelist></tt> is more complicated @@ -969,25 +969,25 @@ make: *** No rule to make target `love'. Stop. are smart enough to change the numeration (for <tt><orderedlist></tt>) or marks of each entry (in <tt><itemizedlist></tt>) for sub-lists - </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2893925"></a> + </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2914590"></a> <tt><guibutton></tt> -- used for buttons, including checkbuttons and radio buttons - </p></li><li><p><a name="id2893950"></a> + </p></li><li><p><a name="id2914616"></a> <tt><guimenu></tt>, <tt><guisubmenu></tt> --used for top-level menus and submenus respectively, for example <tt> <guisubmenu>Utilities</guisubmenu> submenu of the <guimenu>Main Menu</guimenu></tt> - </p></li><li><p><a name="id2894000"></a> + </p></li><li><p><a name="id2914665"></a> <tt><guimenuitem></tt>--an entry in a menu - </p></li><li><p><a name="id2894026"></a> + </p></li><li><p><a name="id2914691"></a> <tt><guiicon></tt>--an icon - </p></li><li><p><a name="id2894049"></a> + </p></li><li><p><a name="id2914714"></a> <tt><guilabel></tt>--for items which have labels, like tabs, or bounding boxes. - </p></li><li><p><a name="id2894075"></a> + </p></li><li><p><a name="id2914740"></a> <tt><interface></tt>-- for most everything else... a window, a dialog box, the Panel, etc. </p></li></ul></div><p> @@ -1035,35 +1035,35 @@ url="http://www.gnome.org">GNOME Web page</ulink> computer-related things</h4></div></div><p> Here are some tags used to describe operating system-related things: - </p><div class="itemizedlist"><ul><li><p><a name="id2894478"></a> <tt><filename></tt> -- used + </p><div class="itemizedlist"><ul><li><p><a name="id2915144"></a> <tt><filename></tt> -- used for filenames, e.g.<tt><filename></tt> foo.sgml <tt></filename></tt> produces: <tt>foo.sgml</tt>. - </p></li><li><p><a name="id2894533"></a> <tt><filename + </p></li><li><p><a name="id2915199"></a> <tt><filename class="directory"></tt> -- used for directories, e.g.<tt><filename class="directory"></tt>/usr/bin <tt></filename></tt> produces: <tt>/usr/bin</tt>. - </p></li><li><p><a name="id2894594"></a> + </p></li><li><p><a name="id2915260"></a> <tt><application></tt> -- used for application names, e.g. <tt><application></tt>Gnumeric <tt></application></tt> produces: Gnumeric. - </p></li><li><p><a name="id2894649"></a> + </p></li><li><p><a name="id2915315"></a> <tt><envar></tt> -- used for environment variables, e.g. <tt><envar></tt>PATH<tt></envar></tt>. - </p></li><li><p><a name="id2894690"></a> + </p></li><li><p><a name="id2915356"></a> <tt><command></tt> -- used for commands entered on command line, e.g. <tt><command></tt>make install <tt></command></tt> produces: <b>make install</b>. - </p></li><li><p><a name="id2894745"></a> + </p></li><li><p><a name="id2915411"></a> <tt><replaceable></tt> -- used for replaceable text, e.g. <tt><command></tt>db2html<tt><replaceable></tt> @@ -1131,15 +1131,15 @@ url="http://www.gnome.org">GNOME Web page</ulink> is required. </p><p> here is partial list of most commonly used enitites: - </p><div class="itemizedlist"><ul><li><p><a name="id2895223"></a> + </p><div class="itemizedlist"><ul><li><p><a name="id2915888"></a> <tt>&amp;</tt> -- ampersend (&) - </p></li><li><p><a name="id2895242"></a> + </p></li><li><p><a name="id2915907"></a> <tt>&lt;</tt> -- left angle bracket (<) - </p></li><li><p><a name="id2895261"></a> + </p></li><li><p><a name="id2915926"></a> <tt>&copy;</tt> -- copyright sign (©) - </p></li><li><p><a name="id2895280"></a> + </p></li><li><p><a name="id2915945"></a> <tt>&mdash;</tt> -- long dash (--) - </p></li><li><p><a name="id2895299"></a> + </p></li><li><p><a name="id2915964"></a> <tt>&hellip;</tt> -- ellipsis (...) </p></li></ul></div><p> Note that the actual look of the resulting symbols depends @@ -1194,7 +1194,7 @@ url="http://www.gnome.org">GNOME Web page</ulink> each window or panel presented to the user using screenshots (in PNG format only) when appropriate. They should also describe each feature and preference option available. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2895762"></a>Documentation Availability</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2916428"></a>Documentation Availability</h3><p> Applications and applets should not rely on documentation which is only available on the internet. All manuals and other documentation should be packaged with the application or @@ -1205,14 +1205,14 @@ url="http://www.gnome.org">GNOME Web page</ulink> the templates in <a href="#template2-1x" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME versions 1.x and the templates in <a href="#template2-2x" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a> for GNOME versions 2.x. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2895803"></a>Manuals For Large Applications</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2916468"></a>Manuals For Large Applications</h3><p> Manuals for very large applications, such as GNOME Workshop components should be a <tt><book></tt> (and thus use <tt><chapter></tt> for each primary section) , instead of <tt><article></tt> which most applications use(with each primary section being a <tt><sect1></tt>). - </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2895918"></a>Applet Manuals in GNOME 2.0</h3><p> + </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2916583"></a>Applet Manuals in GNOME 2.0</h3><p> Note that applet manuals in GNOME 2.0 are treated in a special way. The manuals for all applets are merged into a single virtual document by Nautilus. For this reason, the header @@ -1228,7 +1228,7 @@ url="http://www.gnome.org">GNOME Web page</ulink> application, as described in <a href="#listingdocsinhelpmenu" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>. Applets should make their manuals available by right-clicking on the applet. - </p></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2896041"></a>Developer Information</h3><p> + </p></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2916707"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> @@ -1260,7 +1260,7 @@ function-reference.html Gnumeric function reference application's name. The application documentation (converted from SGML into HTML with <b>db2html</b>) should be placed in this directory too. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2896232"></a>Note</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2916897"></a>Note</h3><p> If the help files are not present in the correct directory, the menu items will NOT appear when the program is run. </p></div><p> @@ -1286,7 +1286,7 @@ GnomeUIInfo helpmenu[] = { Help menu. When the user selects any of these topics from the Help menu, a help browser will be started with the associated HTML documentation. - </p></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2896401"></a>Developer Information</h3><p> + </p></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2917066"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> @@ -1311,7 +1311,7 @@ if (tmp) { gnome_help_goto(0, tmp); g_free(tmp); } - </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2896539"></a>NOTE</h3><p> + </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2917203"></a>NOTE</h3><p> The example above is in the C language, please refer to other documentation or forums for other GNOME language bindings. </p></div></div><div class="sect1"><a name="packagingappletdocs"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="packagingappletdocs"></a>Packaging Applet Documentation</h2></div></div><div class="sect2"><a name="appletfiles"></a><div class="titlepage"><div><h3 class="title"><a name="appletfiles"></a>Applet Documentation Files</h3></div></div><p> @@ -1348,7 +1348,7 @@ if (tmp) { of the <i>GNOME Applets</i> book, you must remember to add <tt><legalnotice></tt> and <tt><copyright></tt> sections. - </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2896791"></a>Developer Information</h3><p> + </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2917455"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> @@ -1453,7 +1453,7 @@ applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about", </p></div><div class="sect2"><a name="balance"></a><div class="titlepage"><div><h3 class="title"><a name="balance"></a>Achieving a Balanced Style</h3></div></div><p> Just as you need to juggle expert and novice readers, you'll have to juggle a number of other extremes as you write: - <div class="itemizedlist"><ul><li><p><a name="id2897341"></a> + <div class="itemizedlist"><ul><li><p><a name="id2918005"></a> Documents should be complete, yet concise. You should describe every feature, but you'll have decide how much detail is really necessary. It's not, for example, @@ -1463,7 +1463,7 @@ applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about", you spend fewer words on the obvious, you can spend more time clarifying the ambiguous labels and explaining items that are more complex. - </p></li><li><p><a name="id2897368"></a> + </p></li><li><p><a name="id2918033"></a> Be engaging and friendly, yet professional. Games documents may be less formal than productivity application documents (people don't @@ -1472,14 +1472,14 @@ applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about", maintain a standard of style which holds the reader's interest without resorting to jokes and untranslatable allusions or puns. - </p></li><li><p><a name="id2897408"></a> + </p></li><li><p><a name="id2918072"></a> Examples, tips, notes, and screenshots are useful to break up long stretches of text, but too many can get in the way, and make your documents too choppy to read. It's good to provide a screenshot of any dialog windows a user might run into, but if a dialog box has several tabs, it's not usually necessary to have one for each. - </p></li><li><p><a name="id2897432"></a> + </p></li><li><p><a name="id2918096"></a> The GDP strives to have all of its documentation conform to certain standards of style and content, but every document (and every writer) is different. You will need diff --git a/tests/docbook/result/xtchunk/html/index.orig b/tests/docbook/result/xtchunk/html/index.orig index 31dd37fc..f01b83d2 100644 --- a/tests/docbook/result/xtchunk/html/index.orig +++ b/tests/docbook/result/xtchunk/html/index.orig @@ -84,7 +84,7 @@ irc.gnome.org is another option for contacting GDP members. </p></div></div><div class="sect2"><a name="notation"></a><div class="titlepage"><div><h3 class="title"><a name="notation"></a>Notation and Conventions</h3></div></div><p> This Handbook uses the following notation: - <div class="informaltable" id="id2782088"><a name="id2782088"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td> + <div class="informaltable" id="id2801086"><a name="id2801086"></a><table border="0"><colgroup><col><col></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td> Directory </td></tr><tr><td><tt>foo.sgml</tt></td><td> Filename diff --git a/tests/docbook/result/xtchunk/html/indexs02.orig b/tests/docbook/result/xtchunk/html/indexs02.orig index c8094f77..feb9feb7 100644 --- a/tests/docbook/result/xtchunk/html/indexs02.orig +++ b/tests/docbook/result/xtchunk/html/indexs02.orig @@ -42,7 +42,7 @@ help. The <i>DocTable</i> also allows people to make announcements and suggestions and to discuss issues in the comments section. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2780480"></a>Note</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2801723"></a>Note</h3><p> Note that the information in the <i>DocTable</i> may not always be up-to-date or accurate. When you assign yourself to documenting an @@ -54,7 +54,7 @@ this for documentation, not least of which is the single source nature of SGML. To contribute to the GDP you should learn to use DocBook. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2780560"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2801811"></a>NOTE</h3><p> To get started writing for the GDP you do not need to rush out and learn DocBook - if you feel it is too much to handle for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top"> @@ -68,7 +68,7 @@ that jade is platform dependent (eg. i386), while the other packages are in the <tt>noarch</tt> directory.) You can find more - information on DocBook Tools <a href=" http://sourceware.cygnus.com/docbook-tools/" target="_top">here</a>. + information on DocBook Tools <a href="http://sourceware.cygnus.com/docbook-tools/" target="_top">here</a>. </p><p> If you are an Emacs user you may want to grab the psgml package as well. This is a major mode @@ -100,14 +100,14 @@ your output document appearance subtly vary between the two DTD's. To install the GDP custom DTD with PNG image support by hand: - </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2780987"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2802236"></a> Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the GDP DocBook DTD for PNG support</a> and install it where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that the 3.0 DTD is missing support for the <tt><legalnotice></tt> tag, so it is recommended that you use version 3.1 - </p></li><li style="list-style-type: disc"><p><a name="id2781161"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2802403"></a> Add the new DTD to your SGML CATALOG file. The location of your SGML CATALOG file may vary depending upon your distribution. (On Red Hat it is usually in @@ -185,7 +185,7 @@ V1.1//EN"[]> the command <tt>$</tt><b>db2ps mydocument.sgml</b>, after which you can print out or view the resulting .ps file. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2903153"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2802319"></a>NOTE</h3><p> The html files you get will not look quite the same as the documentation distributed with GNOME unless you have the custom stylesheets installed on your machine. DocBook @@ -236,24 +236,24 @@ V1.1//EN"[]> There are many resources available to help you learn DocBook. The following resources on the web are useful for learning DocBook: - </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2903440"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2924182"></a> <a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman Walsh's <i>DocBook: The Definitive Guide</i>. Online O'Reilly book on using DocBook. Contains an excellent element reference. May be too formal for a beginner. - </p></li><li style="list-style-type: disc"><p><a name="id2903496"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2924237"></a> <a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a> - The Open Source Writers Group's introduction to using DocBook. This is an excellent HOW-TO type article on getting started. - </p></li><li style="list-style-type: disc"><p><a name="id2903536"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2924278"></a> <a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for Hackers</a> - Mark Galassi's introduction to DocBook for hackers. This has to be one of the first introductions to DocBook ever - still as good as it ever was. - </p></li><li style="list-style-type: disc"><p><a name="id2903576"></a> + </p></li><li style="list-style-type: disc"><p><a name="id2924317"></a> <a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top"> FreeBSD Documentation Project Primer for New Contributors</a> - FreeBSD documentation project @@ -266,7 +266,7 @@ V1.1//EN"[]> </p><p> The following sections of this document are designed to help documentation authors write correct and consistent DocBook: - </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2903642"></a> + </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2924384"></a> <a href="indexs04.html" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of commonly used DocBook tags. </p></li></ul></div><p> diff --git a/tests/docbook/result/xtchunk/html/indexs04.orig b/tests/docbook/result/xtchunk/html/indexs04.orig index 6bf5b229..14241b11 100644 --- a/tests/docbook/result/xtchunk/html/indexs04.orig +++ b/tests/docbook/result/xtchunk/html/indexs04.orig @@ -72,7 +72,7 @@ ready for this transistion, it is <i>strongly advised</i> that the documentation writers conform to XML syntax rules. Here are most important differences: - </p><div class="variablelist"><dl><dt><a name="id2906147"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2906166"></a> + </p><div class="variablelist"><dl><dt><a name="id2926888"></a><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2926907"></a> It is possible with some implementations of SGML to use minimizations to close elements in a document by using </>, for example: @@ -83,7 +83,7 @@ if you are using Emacs with psgml mode, you can also use menu command Modify->Normalize. - </p></dd><dt><a name="id2906280"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2906299"></a> + </p></dd><dt><a name="id2927021"></a><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2927040"></a> Also, in SGML some tags are allowed not to have closing tags. For example, it is legal for <tt><xref></tt> not to have a closing tag: @@ -93,7 +93,7 @@ <tt><tt><xref linkend="someid"/></tt></tt> (note the slash!). - </p></dd><dt><a name="id2906362"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2906382"></a> + </p></dd><dt><a name="id2927104"></a><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2927123"></a> In XML, unlike SGML, tags are case-senstive <tt><title></tt> and <tt><TITLE></tt> are different tags! @@ -159,7 +159,7 @@ actual file name (without extension). The result will look like this: <div class="figure"><p><a name="shot1"></a><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"></p></div></div> - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2906890"></a>NOTE</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2927632"></a>NOTE</h3><p> Notice in this example that the screenshot file name does not include the file type extension -- to find out why, please read <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>. @@ -207,7 +207,7 @@ make: *** No rule to make target `love'. Stop. Note the use of tags <tt><prompt></tt> and <tt><userinput></tt> for marking system prompt and commands entered by user. - <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2907134"></a>NOTE</h3><p> + <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2927876"></a>NOTE</h3><p> Note that both <tt><programlisting></tt> and <tt><screen></tt> preserve linebreaks, but interpret SGML tags (unlike LaTeX @@ -220,7 +220,7 @@ make: *** No rule to make target `love'. Stop. <tt><itemizedlist></tt>, <tt><orderedlist></tt>, and <tt><variablelist></tt>. - </p><div class="variablelist"><dl><dt><a name="id2907253"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2907273"></a> + </p><div class="variablelist"><dl><dt><a name="id2927995"></a><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2928015"></a> This is the simplest unnumbered list, parallel to <tt><ul></tt> in HTML. Here is an example: <pre class="programlisting"> @@ -251,16 +251,16 @@ make: *** No rule to make target `love'. Stop. </pre> and output: - </p><div class="itemizedlist"><ul><li><p><a name="id2907291"></a> + </p><div class="itemizedlist"><ul><li><p><a name="id2928033"></a> Show backup files -- This will show any backup file that might be on your system. - </p></li><li><p><a name="id2907364"></a> + </p></li><li><p><a name="id2928106"></a> Show hidden files -- This will show all "dot files" or files that begin with a dot. This files typically include configuration files and directories. - </p></li><li><p><a name="id2907396"></a> + </p></li><li><p><a name="id2928138"></a> Mix files and directories -- This option will display files and directories in the order you sort them instead @@ -278,7 +278,7 @@ make: *** No rule to make target `love'. Stop. or -- if none of this applies -- use <a href="indexs04.html#gui" title="GUI elements"><tt><emphasis></tt></a>. - </p></dd><dt><a name="id2907572"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2907591"></a> + </p></dd><dt><a name="id2928315"></a><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2928334"></a> This list is completely analogous to <tt><itemizedlist></tt> and has the same syntax, but it produces numbered list. By default, @@ -291,7 +291,7 @@ make: *** No rule to make target `love'. Stop. <tt>loweralpha</tt>, <tt>upperroman</tt>, <tt>lowerroman</tt>. - </p></dd><dt><a name="id2907672"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2907691"></a> This list is used when each entry is + </p></dd><dt><a name="id2928414"></a><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2928434"></a> This list is used when each entry is rather long, so it should be formatted as a block of text with some subtitle, like a small subsection. The <tt><variablelist></tt> is more complicated @@ -332,25 +332,25 @@ make: *** No rule to make target `love'. Stop. are smart enough to change the numeration (for <tt><orderedlist></tt>) or marks of each entry (in <tt><itemizedlist></tt>) for sub-lists - </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2907854"></a> + </p></div></div><div class="sect2"><a name="inline"></a><div class="titlepage"><div><h3 class="title"><a name="inline"></a>Inline Elements</h3></div></div><div class="sect3"><a name="gui"></a><div class="titlepage"><div><h4 class="title"><a name="gui"></a>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2928596"></a> <tt><guibutton></tt> -- used for buttons, including checkbuttons and radio buttons - </p></li><li><p><a name="id2907880"></a> + </p></li><li><p><a name="id2928622"></a> <tt><guimenu></tt>, <tt><guisubmenu></tt> --used for top-level menus and submenus respectively, for example <tt> <guisubmenu>Utilities</guisubmenu> submenu of the <guimenu>Main Menu</guimenu></tt> - </p></li><li><p><a name="id2907929"></a> + </p></li><li><p><a name="id2928671"></a> <tt><guimenuitem></tt>--an entry in a menu - </p></li><li><p><a name="id2907955"></a> + </p></li><li><p><a name="id2928697"></a> <tt><guiicon></tt>--an icon - </p></li><li><p><a name="id2907978"></a> + </p></li><li><p><a name="id2928721"></a> <tt><guilabel></tt>--for items which have labels, like tabs, or bounding boxes. - </p></li><li><p><a name="id2908004"></a> + </p></li><li><p><a name="id2928746"></a> <tt><interface></tt>-- for most everything else... a window, a dialog box, the Panel, etc. </p></li></ul></div><p> @@ -398,35 +398,35 @@ url="http://www.gnome.org">GNOME Web page</ulink> computer-related things</h4></div></div><p> Here are some tags used to describe operating system-related things: - </p><div class="itemizedlist"><ul><li><p><a name="id2908407"></a> <tt><filename></tt> -- used + </p><div class="itemizedlist"><ul><li><p><a name="id2929150"></a> <tt><filename></tt> -- used for filenames, e.g.<tt><filename></tt> foo.sgml <tt></filename></tt> produces: <tt>foo.sgml</tt>. - </p></li><li><p><a name="id2908462"></a> <tt><filename + </p></li><li><p><a name="id2929205"></a> <tt><filename class="directory"></tt> -- used for directories, e.g.<tt><filename class="directory"></tt>/usr/bin <tt></filename></tt> produces: <tt>/usr/bin</tt>. - </p></li><li><p><a name="id2908524"></a> + </p></li><li><p><a name="id2929266"></a> <tt><application></tt> -- used for application names, e.g. <tt><application></tt>Gnumeric <tt></application></tt> produces: Gnumeric. - </p></li><li><p><a name="id2908579"></a> + </p></li><li><p><a name="id2929321"></a> <tt><envar></tt> -- used for environment variables, e.g. <tt><envar></tt>PATH<tt></envar></tt>. - </p></li><li><p><a name="id2908620"></a> + </p></li><li><p><a name="id2929362"></a> <tt><command></tt> -- used for commands entered on command line, e.g. <tt><command></tt>make install <tt></command></tt> produces: <b>make install</b>. - </p></li><li><p><a name="id2908675"></a> + </p></li><li><p><a name="id2929417"></a> <tt><replaceable></tt> -- used for replaceable text, e.g. <tt><command></tt>db2html<tt><replaceable></tt> @@ -494,15 +494,15 @@ url="http://www.gnome.org">GNOME Web page</ulink> is required. </p><p> here is partial list of most commonly used enitites: - </p><div class="itemizedlist"><ul><li><p><a name="id2909152"></a> + </p><div class="itemizedlist"><ul><li><p><a name="id2929894"></a> <tt>&amp;</tt> -- ampersend (&) - </p></li><li><p><a name="id2909171"></a> + </p></li><li><p><a name="id2929913"></a> <tt>&lt;</tt> -- left angle bracket (<) - </p></li><li><p><a name="id2909190"></a> + </p></li><li><p><a name="id2929932"></a> <tt>&copy;</tt> -- copyright sign (©) - </p></li><li><p><a name="id2909209"></a> + </p></li><li><p><a name="id2929951"></a> <tt>&mdash;</tt> -- long dash (--) - </p></li><li><p><a name="id2909228"></a> + </p></li><li><p><a name="id2929970"></a> <tt>&hellip;</tt> -- ellipsis (...) </p></li></ul></div><p> Note that the actual look of the resulting symbols depends diff --git a/tests/docbook/result/xtchunk/html/indexs06.orig b/tests/docbook/result/xtchunk/html/indexs06.orig index 3f234142..464ff74f 100644 --- a/tests/docbook/result/xtchunk/html/indexs06.orig +++ b/tests/docbook/result/xtchunk/html/indexs06.orig @@ -7,7 +7,7 @@ each window or panel presented to the user using screenshots (in PNG format only) when appropriate. They should also describe each feature and preference option available. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2909692"></a>Documentation Availability</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2930434"></a>Documentation Availability</h3><p> Applications and applets should not rely on documentation which is only available on the internet. All manuals and other documentation should be packaged with the application or @@ -18,14 +18,14 @@ the templates in <a href="apas02.html" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME versions 1.x and the templates in <a href="apas03.html" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a> for GNOME versions 2.x. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2909732"></a>Manuals For Large Applications</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2930474"></a>Manuals For Large Applications</h3><p> Manuals for very large applications, such as GNOME Workshop components should be a <tt><book></tt> (and thus use <tt><chapter></tt> for each primary section) , instead of <tt><article></tt> which most applications use(with each primary section being a <tt><sect1></tt>). - </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2909847"></a>Applet Manuals in GNOME 2.0</h3><p> + </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2930589"></a>Applet Manuals in GNOME 2.0</h3><p> Note that applet manuals in GNOME 2.0 are treated in a special way. The manuals for all applets are merged into a single virtual document by Nautilus. For this reason, the header diff --git a/tests/docbook/result/xtchunk/html/indexs07.orig b/tests/docbook/result/xtchunk/html/indexs07.orig index a8aa2494..50ee6bcb 100644 --- a/tests/docbook/result/xtchunk/html/indexs07.orig +++ b/tests/docbook/result/xtchunk/html/indexs07.orig @@ -1,5 +1,5 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Listing Documents in the Help Menu</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs06.html" title="Writing Application and Applet Manuals"><link rel="next" href="indexs08.html" title="Application Help Buttons"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Listing Documents in the Help Menu</th></tr><tr><td width="20%" align="left"><a href="indexs06.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs08.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2909970"></a>Developer Information</h3><p> +<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Listing Documents in the Help Menu</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs06.html" title="Writing Application and Applet Manuals"><link rel="next" href="indexs08.html" title="Application Help Buttons"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Listing Documents in the Help Menu</th></tr><tr><td width="20%" align="left"><a href="indexs06.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs08.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="listingdocsinhelpmenu"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2930714"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> @@ -31,7 +31,7 @@ function-reference.html Gnumeric function reference application's name. The application documentation (converted from SGML into HTML with <b>db2html</b>) should be placed in this directory too. - </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2910161"></a>Note</h3><p> + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2930903"></a>Note</h3><p> If the help files are not present in the correct directory, the menu items will NOT appear when the program is run. </p></div><p> diff --git a/tests/docbook/result/xtchunk/html/indexs08.orig b/tests/docbook/result/xtchunk/html/indexs08.orig index 093111e0..5ff26f28 100644 --- a/tests/docbook/result/xtchunk/html/indexs08.orig +++ b/tests/docbook/result/xtchunk/html/indexs08.orig @@ -1,5 +1,5 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Application Help Buttons</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs07.html" title="Listing Documents in the Help Menu"><link rel="next" href="indexs09.html" title="Packaging Applet Documentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Application Help Buttons</th></tr><tr><td width="20%" align="left"><a href="indexs07.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs09.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2910330"></a>Developer Information</h3><p> +<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Application Help Buttons</title><meta name="generator" content="DocBook XSL Stylesheets V1.40"><link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="up" href="index.html" title="The GNOME Handbook of Writing Software Documentation"><link rel="previous" href="indexs07.html" title="Listing Documents in the Help Menu"><link rel="next" href="indexs09.html" title="Packaging Applet Documentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Application Help Buttons</th></tr><tr><td width="20%" align="left"><a href="indexs07.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a href="indexs09.html">Next</a></td></tr></table><hr></div><div class="sect1"><a name="applicationhelpbuttons"></a><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2931072"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> @@ -24,7 +24,7 @@ if (tmp) { gnome_help_goto(0, tmp); g_free(tmp); } - </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2910468"></a>NOTE</h3><p> + </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2931210"></a>NOTE</h3><p> The example above is in the C language, please refer to other documentation or forums for other GNOME language bindings. </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a href="indexs07.html">Prev</a> </td><td width="20%" align="center"><a href="index.html">Home</a></td><td width="40%" align="right"> <a href="indexs09.html">Next</a></td></tr><tr><td width="40%" align="left">Listing Documents in the Help Menu </td><td width="20%" align="center"><a href="index.html">Up</a></td><td width="40%" align="right"> Packaging Applet Documentation</td></tr></table></div></body></html> diff --git a/tests/docbook/result/xtchunk/html/indexs09.orig b/tests/docbook/result/xtchunk/html/indexs09.orig index 44698941..065e2399 100644 --- a/tests/docbook/result/xtchunk/html/indexs09.orig +++ b/tests/docbook/result/xtchunk/html/indexs09.orig @@ -33,7 +33,7 @@ of the <i>GNOME Applets</i> book, you must remember to add <tt><legalnotice></tt> and <tt><copyright></tt> sections. - </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2910720"></a>Developer Information</h3><p> + </p></div><div class="sect2"><a name="appletmenu"></a><div class="titlepage"><div><h3 class="title"><a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2931461"></a>Developer Information</h3><p> This section is for developers. Documentation authors generally do not need to know this material. </p></div><p> diff --git a/tests/docbook/result/xtchunk/html/indexs12.orig b/tests/docbook/result/xtchunk/html/indexs12.orig index e7c4585d..ccbe8a66 100644 --- a/tests/docbook/result/xtchunk/html/indexs12.orig +++ b/tests/docbook/result/xtchunk/html/indexs12.orig @@ -34,7 +34,7 @@ </p></div><div class="sect2"><a name="balance"></a><div class="titlepage"><div><h3 class="title"><a name="balance"></a>Achieving a Balanced Style</h3></div></div><p> Just as you need to juggle expert and novice readers, you'll have to juggle a number of other extremes as you write: - <div class="itemizedlist"><ul><li><p><a name="id2911270"></a> + <div class="itemizedlist"><ul><li><p><a name="id2932012"></a> Documents should be complete, yet concise. You should describe every feature, but you'll have decide how much detail is really necessary. It's not, for example, @@ -44,7 +44,7 @@ you spend fewer words on the obvious, you can spend more time clarifying the ambiguous labels and explaining items that are more complex. - </p></li><li><p><a name="id2911298"></a> + </p></li><li><p><a name="id2932039"></a> Be engaging and friendly, yet professional. Games documents may be less formal than productivity application documents (people don't @@ -53,14 +53,14 @@ maintain a standard of style which holds the reader's interest without resorting to jokes and untranslatable allusions or puns. - </p></li><li><p><a name="id2911337"></a> + </p></li><li><p><a name="id2932078"></a> Examples, tips, notes, and screenshots are useful to break up long stretches of text, but too many can get in the way, and make your documents too choppy to read. It's good to provide a screenshot of any dialog windows a user might run into, but if a dialog box has several tabs, it's not usually necessary to have one for each. - </p></li><li><p><a name="id2911361"></a> + </p></li><li><p><a name="id2932102"></a> The GDP strives to have all of its documentation conform to certain standards of style and content, but every document (and every writer) is different. You will need |