* src/plugins/CmdRef.py (write_ref): Only write itemizedlist if

there is any contents for it.
* doc/gramps-manual/C/cmdplug.xml: Update to a valid docbook.
* doc/gramps-manual/C/usage.xml: Add manual on the Narrative web
page generator.


svn: r5351
This commit is contained in:
Alex Roitman 2005-10-27 04:14:53 +00:00
parent 10a9b1bb35
commit bbd14d34cd
4 changed files with 431 additions and 263 deletions

View File

@ -1,3 +1,10 @@
2005-10-26 Alex Roitman <shura@gramps-project.org>
* src/plugins/CmdRef.py (write_ref): Only write itemizedlist if
there is any contents for it.
* doc/gramps-manual/C/cmdplug.xml: Update to a valid docbook.
* doc/gramps-manual/C/usage.xml: Add manual on the Narrative web
page generator.
2005-10-25 Don Allingham <don@gramps-project.org>
* src/latin_utf8.py: removed
* src/Makefile.am: remove latin_utf8.py

View File

@ -106,8 +106,6 @@
<term><command>id</command>: =ID</term>
<listitem>
<para>Gramps ID of a central person. MANDATORY</para>
<itemizedlist>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
@ -194,25 +192,6 @@
</variablelist>
</sect3>
<sect3 id="cmdplug-id6">
<title>Book Report</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>book</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bookname</command>: =name</term>
<listitem>
<para>Name of the book. MANDATORY</para>
<itemizedlist>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id7">
<title>Descendant Graph</title>
<variablelist>
<varlistentry>
@ -223,35 +202,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id8">
<title>Descendant Wall Chart</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>descend_chart2</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>singlep</command>: =0/1</term>
<listitem>
<para>Whether to scale to fit on a single page.</para>
<orderedlist>
<listitem><para>Do not scale to fit</para></listitem>
<listitem><para>Scale to fit</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>title</command>: =str</term>
<listitem>
<para>Title string for the report</para>
<para>Value: <userinput>Whatever String You Wish</userinput></para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id9">
<sect3 id="cmdplug-id7">
<title>Descendant Report</title>
<variablelist>
<varlistentry>
@ -262,7 +213,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id10">
<sect3 id="cmdplug-id8">
<title>Detailed Ancestral Report</title>
<variablelist>
<varlistentry>
@ -281,16 +232,6 @@
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>listc</command>: =0/1</term>
<listitem>
<para>Whether to list children.</para>
<orderedlist>
<listitem><para>Do not list children</para></listitem>
<listitem><para>List children</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>incsources</command>: =0/1</term>
<listitem>
@ -352,12 +293,12 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>firstnameiop</command>: =0/1</term>
<term><command>listc</command>: =0/1</term>
<listitem>
<para>Whether to use first names instead of pronouns</para>
<para>Whether to list children.</para>
<orderedlist>
<listitem><para>Do not use first names</para></listitem>
<listitem><para>Use first names</para></listitem>
<listitem><para>Do not list children</para></listitem>
<listitem><para>List children</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
@ -413,7 +354,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id11">
<sect3 id="cmdplug-id9">
<title>Detailed Descendant Report</title>
<variablelist>
<varlistentry>
@ -432,16 +373,6 @@
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>listc</command>: =0/1</term>
<listitem>
<para>Whether to list children.</para>
<orderedlist>
<listitem><para>Do not list children</para></listitem>
<listitem><para>List children</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>incsources</command>: =0/1</term>
<listitem>
@ -503,12 +434,12 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>firstnameiop</command>: =0/1</term>
<term><command>listc</command>: =0/1</term>
<listitem>
<para>Whether to use first names instead of pronouns</para>
<para>Whether to list children.</para>
<orderedlist>
<listitem><para>Do not use first names</para></listitem>
<listitem><para>Use first names</para></listitem>
<listitem><para>Do not list children</para></listitem>
<listitem><para>List children</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
@ -522,6 +453,16 @@
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>usenick</command>: =0/1</term>
<listitem>
<para>Whether to use the nick name as the first name.</para>
<orderedlist>
<listitem><para>Do not use nick name</para></listitem>
<listitem><para>Use nick name</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>incnotes</command>: =0/1</term>
<listitem>
@ -554,7 +495,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id12">
<sect3 id="cmdplug-id10">
<title>Family Group Report</title>
<variablelist>
<varlistentry>
@ -572,7 +513,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id13">
<sect3 id="cmdplug-id11">
<title>Fan Chart</title>
<variablelist>
<varlistentry>
@ -583,7 +524,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id14">
<sect3 id="cmdplug-id12">
<title>FTM Style Ancestor Report</title>
<variablelist>
<varlistentry>
@ -594,7 +535,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id15">
<sect3 id="cmdplug-id13">
<title>FTM Style Descendant Report</title>
<variablelist>
<varlistentry>
@ -605,7 +546,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id16">
<sect3 id="cmdplug-id14">
<title>Relationship Graph</title>
<variablelist>
<varlistentry>
@ -775,7 +716,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id17">
<sect3 id="cmdplug-id15">
<title>Relationship Graph</title>
<variablelist>
<varlistentry>
@ -945,7 +886,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id18">
<sect3 id="cmdplug-id16">
<title>Complete Individual Report</title>
<variablelist>
<varlistentry>
@ -966,7 +907,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id19">
<sect3 id="cmdplug-id17">
<title>Individual Summary</title>
<variablelist>
<varlistentry>
@ -977,7 +918,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id20">
<sect3 id="cmdplug-id18">
<title>Generate Web Site (deprecated)</title>
<variablelist>
<varlistentry>
@ -1167,6 +1108,51 @@
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id19">
<title>Book Report</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>book</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bookname</command>: =name</term>
<listitem>
<para>Name of the book. MANDATORY</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id20">
<title>Descendant Wall Chart</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>descend_chart2</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>singlep</command>: =0/1</term>
<listitem>
<para>Whether to scale to fit on a single page.</para>
<orderedlist>
<listitem><para>Do not scale to fit</para></listitem>
<listitem><para>Scale to fit</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>title</command>: =str</term>
<listitem>
<para>Title string for the report</para>
<para>Value: <userinput>Whatever String You Wish</userinput></para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
<sect2 id="cmdplug-tools">
@ -1184,8 +1170,6 @@
<term><command>id</command>: =ID</term>
<listitem>
<para>Gramps ID of a central person.</para>
<itemizedlist>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
@ -1227,73 +1211,6 @@
</variablelist>
</sect3>
<sect3 id="cmdplug-id24">
<title>Checkpoint the database</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>chkpoint</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>crcmd</command>: =str</term>
<listitem>
<para>Custom command line for retrieval</para>
<para>Value: <userinput>Custom command string</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cacmd</command>: =str</term>
<listitem>
<para>Custom command line for archiving</para>
<para>Value: <userinput>Custom command string</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>archive</command>: =0/1</term>
<listitem>
<para>Whether to archive or retrieve.</para>
<orderedlist>
<listitem><para>Retrieve</para></listitem>
<listitem><para>Archive</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>rcs</command>: =0/1</term>
<listitem>
<para>Whether to use RCS (ignores custom commands).</para>
<orderedlist>
<listitem><para>Do not use RCS</para></listitem>
<listitem><para>Use RCS</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id25">
<title>Dumps gender statistics</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>dgenstats</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id26">
<title>Rebuild secondary indices</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>rebuild</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id27">
<title>Reorder GRAMPS IDs</title>
<variablelist>
<varlistentry>
@ -1304,75 +1221,7 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id28">
<title>Generate Testcases for persons and families</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>testcasegenerator</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>dates</command>: =0/1</term>
<listitem>
<para>Whether to create test for date handling.</para>
<orderedlist>
<listitem><para>Skip test</para></listitem>
<listitem><para>Create date tests</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>person_count</command>: =int</term>
<listitem>
<para>Number of dummy persons to generate</para>
<para>Value: <userinput>Number of persons</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>no_trans</command>: =0/1</term>
<listitem>
<para>Wheter to use one transaction or multiple small ones</para>
<orderedlist>
<listitem><para>One transaction</para></listitem>
<listitem><para>Multiple transactions</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>long_names</command>: =0/1</term>
<listitem>
<para>Wheter to create short or long names</para>
<orderedlist>
<listitem><para>Short names</para></listitem>
<listitem><para>Long names</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bugs</command>: =0/1</term>
<listitem>
<para>Whether to create invalid database references.</para>
<orderedlist>
<listitem><para>Skip test</para></listitem>
<listitem><para>Create invalid Database references</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>persons</command>: =0/1</term>
<listitem>
<para>Whether to create a bunch of dummy persons</para>
<orderedlist>
<listitem><para>Dont create persons</para></listitem>
<listitem><para>Create dummy persons</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id29">
<sect3 id="cmdplug-id25">
<title>Verify the database</title>
<variablelist>
<varlistentry>
@ -1491,6 +1340,161 @@
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id26">
<title>Generate Testcases for persons and families</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>testcasegenerator</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>dates</command>: =0/1</term>
<listitem>
<para>Whether to create test for date handling.</para>
<orderedlist>
<listitem><para>Skip test</para></listitem>
<listitem><para>Create date tests</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>person_count</command>: =int</term>
<listitem>
<para>Number of dummy persons to generate</para>
<para>Value: <userinput>Number of persons</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>no_trans</command>: =0/1</term>
<listitem>
<para>Wheter to use one transaction or multiple small ones</para>
<orderedlist>
<listitem><para>One transaction</para></listitem>
<listitem><para>Multiple transactions</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>long_names</command>: =0/1</term>
<listitem>
<para>Wheter to create short or long names</para>
<orderedlist>
<listitem><para>Short names</para></listitem>
<listitem><para>Long names</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bugs</command>: =0/1</term>
<listitem>
<para>Whether to create invalid database references.</para>
<orderedlist>
<listitem><para>Skip test</para></listitem>
<listitem><para>Create invalid Database references</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>persons</command>: =0/1</term>
<listitem>
<para>Whether to create a bunch of dummy persons</para>
<orderedlist>
<listitem><para>Dont create persons</para></listitem>
<listitem><para>Create dummy persons</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>add_serial</command>: =0/1</term>
<listitem>
<para>Wheter to add a serial number to every text field</para>
<orderedlist>
<listitem><para>No serial</para></listitem>
<listitem><para>Add serial number</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>specialchars</command>: =0/1</term>
<listitem>
<para>Wheter to ass some special characters to every text field</para>
<orderedlist>
<listitem><para>No special characters</para></listitem>
<listitem><para>Add special characters</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id27">
<title>Checkpoint the database</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>chkpoint</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>crcmd</command>: =str</term>
<listitem>
<para>Custom command line for retrieval</para>
<para>Value: <userinput>Custom command string</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cacmd</command>: =str</term>
<listitem>
<para>Custom command line for archiving</para>
<para>Value: <userinput>Custom command string</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>archive</command>: =0/1</term>
<listitem>
<para>Whether to archive or retrieve.</para>
<orderedlist>
<listitem><para>Retrieve</para></listitem>
<listitem><para>Archive</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>rcs</command>: =0/1</term>
<listitem>
<para>Whether to use RCS (ignores custom commands).</para>
<orderedlist>
<listitem><para>Do not use RCS</para></listitem>
<listitem><para>Use RCS</para></listitem>
</orderedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id28">
<title>Rebuild secondary indices</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>rebuild</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id29">
<title>Dumps gender statistics</title>
<variablelist>
<varlistentry>
<term><command>name</command>:</term>
<listitem>
<para>dgenstats</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdplug-id30">
<title>Generate Commandline Plugin Reference</title>
<variablelist>

View File

@ -4793,50 +4793,206 @@
<sect2 id="rep-web">
<title>Web Page</title>
<para>
This category includes reports producing web sites based on
your data.
<para>The only available report in this category
is the Narrative Web Site report. It generates a
web site (that is, a set of linked web pages), for
a set of selected individuals.
</para>
<sect3 id="rep-web-narr">
<title>Narrative Web Site</title>
<variablelist>
<varlistentry>
<term>Generate Web Site</term>
<term>Introduction</term>
<listitem>
<para>
This report generates web pages, either for a selected
individual (active person) or a set of individuals. The
options for this report are broken down into contents,
privacy, and advanced options. The contents options
include the filter (determine the scope of the database
to consider), destination directory for the images, an
optional short ancestor tree, and a link to the index
page. Privacy options allow you to omit private
records, restrict information on living people, skip
images (either all or only those of living people), and
omit comments and text in source information. Finally,
the advanced options allow you to include the optional
&app; ID, create a GENDEX index, and specify the
extension of the resulting files.
</para>
<para>
&app; 2.0.6 introduced the Narrative Web generator.
The new tool provides considerably more functionality
than the older web generator. Instead of using HTML
templates to customize the pages, CSS style sheets are used.
</para>
<para>
More information is now displayed about each person,
along with information about sources, places, and media
objects. Introduction pages can be added to provide additional
information, such as family history.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Narrative Web Site</term>
<term>Selecting the output</term>
<listitem>
<para>
<para>
Genealogy records can generate a lot of files. Many web
servers have a difficult time with many files in a single
directory. The Narrative Web Generator strives to keep the
number of files per directory to a managable level. To do
this, a hierarchy of directores is created. The generated
files names are not intuitive, but are unique per person.
Subsequent runs will geneate identical file names, making
it easy to replace files.</para>
<para>
By default, the output files are written to the specified
directory. Because of the number of files and directories
that are created, it may be difficult to transfer the files
to an external web host. To aid in this, you may directly
create a gzip'd tar file to more easily upload the data.
This is the format that should be used if you would like
to take advantage of the free genealogy page hosting at the
<ulink url="http://family.gramps-project.org"
type="http">GRAMPS web hosting site</ulink>.</para>
<para>To select the gzip'd tar file, select the <guilabel>Store
web pages in .tar.gz archive</guilabel> option.</para>
</listitem></varlistentry>
This report is an alternative web site generator,
producing the narrative set of web pages. It is still in
development, with the goal of producing a more complete,
better looking, and easily adjustable web site.
<varlistentry>
<term>Applying a filter</term>
<listitem>
<para>
Like the previous web page generator, and most of the other
&app; reports, you can control what is included in the output
by choosing a filter. Several default filters are provided for
you, but you are free to use the Custom Filter Editor tool to
create your own.</para>
<para>Any person matching this filter who is not excluded due
to the privacy rules, will be included in the output. The default
filter includes all people in the database.</para>
</listitem></varlistentry>
</para>
<varlistentry>
<term>Applying a style sheet</term>
<listitem>
<para>GRAMPS provides six built in style sheets for your web page.
Each of these style sheets produces a unique look for your pages.
The generated style sheet is named <filename>narrative.css</filename>.
You may edit this file if you wish to further customize your
site.</para>
<para>
If you make modifications to your style sheet, you need to be aware
the regenerating the pages with the same output directory will
overwrite your changes to this file. To prevent this from happening,
make sure you choose <guilabel>No style sheet</guilabel> for subsequent
runs.</para>
</listitem></varlistentry>
<varlistentry>
<term>Character set encoding</term>
<listitem>
<para>
Because of GRAMPS internationalization ability, the default character
set for the HTML pages is UTF-8. This provides support for virtually
all characters.</para>
<para>The Apache web server is sometimes misconfigured to override
the character set specified in an HTML page. This causes problems with
the UTF-8 character set generated by GRAMPS, distorting characters on
the screen.</para>
<para>If your web server is misconfigured and you do not have priveledge
to fix the configururation, you may solve this problem by overriding the
default character set to match what your web server may be expecting.</para>
</listitem></varlistentry>
<varlistentry>
<term>Copyright notice</term>
<listitem>
<para>International copyright law reserves all rights to your data.
You own the data, and people must get your permission to use it.
In genealogy, however, sharing data is a common ideal. It this case, you
may wish to grant the user more rights.</para>
<para>While the default for GRAMPS is to place a notice indicating that
all rights are reserved, we give you the option to place your site under
one of several of the Create Commons licenses. With a Creative Commons
license, you grant user's certain permission to use your data without
requiring them to contact you directly for permission.</para>
<para>See the <ulink url="http://creativecommons.org/" type="http">Creative
Commons</ulink> web site for more information.</para>
</listitem></varlistentry>
<varlistentry>
<term>Controlling page generation</term>
<listitem>
<para>Three additional pages can be generated by the web page generator.
The Home page is a page that will display an image and a whatever text
you wish. To enable this page, choose a Media Object
from the <guilabel>Home Media/Note ID</guilabel> menu on the <guilabel>Page
Generation</guilabel> tab. If the Media Object contains an image, the image
is displayed at the top of the page. If the Media Object contains a Note,
the Note's text is used for the text of the page. A second page, the
Introduction page, works similarly. Just choose the Media Object in the
<guilabel>Introduction Media/Note ID</guilabel> menu.</para>
<para>If you choose to include a contact page, the researcher information
stored in the database is displayed, along with the information specified
in the <guilabel>Publisher contact/Note ID</guilabel> menu. Please use
this page with caution,
since you may consider your contact information to be private.</para>
</listitem></varlistentry>
<varlistentry>
<term>Privacy</term>
<listitem>
<para>Privacy of personal information is an important issue on the web
today. &app; tries to give you control over the information that is presented.
</para>
<para>&app; provides two options to control the privacy of your information.
If you select the <guilabel>Do not include records marked private</guilabel>
option, any data that is marked as private will not be displayed on the
generated site. If you select <guilabel>Restrict information on living people</guilabel>,
&app; will attempt to determine which people have the potential of still
being alive, and will omit these people from the database. Some countries
have laws that indicate that a certain number of years must pass after
someone's death before information can be published. The <guilabel>Years
to restrict from person's death</guilabel> option allows you to specifiy
how many years a person must be deceased before the information is included.
</para>
<para>Please note that it is your responsibility to double check all
information in the pages for any privacy information. &app; cannot be held
responsible for any privacy issues.</para>
</listitem></varlistentry>
<varlistentry>
<term>Adding custom code your pages</term>
<listitem>
<para>If you are not interested in customizing your pages, you may skip
the section.</para>
<para>The previous web generator allowed you to customize your pages
using HTML templates. Your data would be substituted for certain markers
in the code.</para>
<para>This method proved to be too cumbersome for most users. The Narrative
Web Page Generator introduces a simpler mechanism. On the <guilabel>Page
Generation</guilabel> tab, you may specify text (including HTML code) that
will be inserted into each page, separately for the header and the
footer.</para>
<para>To create this code, you need to create a Media Object marked as an
internal note. To create this, add a new Media Object in the Media View,
and select the internal note option. You may then enter your HTML code.
</para>
<para>
To insert the code from the internal notes into the web pages,
select the appropriate Media Objects from the <guilabel>HTML user
header</guilabel> and <guilabel>HTML user footer</guilabel> menus.
Two div sections will be added to the pages &mdash; userheader and userfooter.
The corresponding HTML code is inserted into the HTML page surrounded by div
markers. You can customize your style sheet to provide additional formatting
and positioning information to control these sections.</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
<!-- ================ Usage Subsection ================================ -->

View File

@ -194,11 +194,12 @@ class CmdRef(Tool.Tool):
% escape(val))
f.write(' </orderedlist>\n')
else:
f.write(' <itemizedlist>\n')
for val in oclass.options_help[arg][2]:
f.write( " <listitem><para>%s</para></listitem>\n"
% escape(val))
f.write(' </itemizedlist>\n')
if oclass.options_help[arg][2]:
f.write(' <itemizedlist>\n')
for val in oclass.options_help[arg][2]:
f.write( " <listitem><para>%s</para>"
"</listitem>\n" % escape(val))
f.write(' </itemizedlist>\n')
else:
f.write(' '
'<para>Value: <userinput>%s</userinput></para>\n'