[Python-modules-commits] r3729 - in /packages/pubtal/trunk/debian: changelog updateSite.sgml
rodrigogc-guest at users.alioth.debian.org
rodrigogc-guest at users.alioth.debian.org
Sat Nov 24 02:58:52 UTC 2007
Author: rodrigogc-guest
Date: Sat Nov 24 02:58:52 2007
New Revision: 3729
URL: http://svn.debian.org/wsvn/python-modules/?sc=1&rev=3729
Log:
Clean up updateSite.sgml to use proper DocBook with no warnings.
Modified:
packages/pubtal/trunk/debian/changelog
packages/pubtal/trunk/debian/updateSite.sgml
Modified: packages/pubtal/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/python-modules/packages/pubtal/trunk/debian/changelog?rev=3729&op=diff
==============================================================================
--- packages/pubtal/trunk/debian/changelog (original)
+++ packages/pubtal/trunk/debian/changelog Sat Nov 24 02:58:52 2007
@@ -9,8 +9,9 @@
* We have no shared libs, there's no need to call dh_strip and dh_shlibdeps.
* Use pubtal.manpages and pubtal.links files instead of manually specifying
the names, and instead of manually linking them.
+ * Clean up updateSite.sgml to use proper DocBook with no warnings.
- -- Luis Rodrigo Gallardo Cruz <rodrigo at nul-unu.com> Fri, 23 Nov 2007 19:53:57 -0600
+ -- Luis Rodrigo Gallardo Cruz <rodrigo at nul-unu.com> Fri, 23 Nov 2007 20:57:06 -0600
pubtal (3.2.0-2) unstable; urgency=low
Modified: packages/pubtal/trunk/debian/updateSite.sgml
URL: http://svn.debian.org/wsvn/python-modules/packages/pubtal/trunk/debian/updateSite.sgml?rev=3729&op=diff
==============================================================================
--- packages/pubtal/trunk/debian/updateSite.sgml (original)
+++ packages/pubtal/trunk/debian/updateSite.sgml Sat Nov 24 02:58:52 2007
@@ -33,6 +33,9 @@
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY html "<acronym>HTML</acronym>">
+
+ <!ENTITY uploadSite "<command>uploadSite</command>">
+ <!ENTITY updateSite "<command>updateSite</command>">
]>
<refentry>
@@ -57,19 +60,16 @@
&dhsection;
</refmeta>
<refnamediv>
- <refname>updateSite.py</refname>
-
- <refpurpose>Generate a web site from content and
- templates</refpurpose>
- <refname>uploadSite.py</refname>
- <refpurpose>Upload a web site to its destination</refpurpose>
+ <refname>PubTal</refname>
+ <refpurpose>Generate a web site from content and templates, and
+ upload it to its destination</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>updateSite.py</command>
+ &updateSite;
<arg>options</arg>
- <arg choice="no"><replaceable>site.config</replaceable></arg>
+ <arg choice="req"><replaceable>site.config</replaceable></arg>
<group>
<arg><replaceable>content-dir</replaceable></arg>
<arg><replaceable>content-type</replaceable></arg>
@@ -82,10 +82,10 @@
</cmdsynopsis>
<cmdsynopsis>
- <command>uploadSite.py</command>
+ &uploadSite;
<arg>options</arg>
- <arg choice="no"><replaceable>site.config</replaceable></arg>
+ <arg choice="req"><replaceable>site.config</replaceable></arg>
<group>
<arg><replaceable>destination-dir</replaceable></arg>
<arg><replaceable>destination-file</replaceable></arg>
@@ -97,26 +97,25 @@
<refsect1>
<title>DESCRIPTION</title>
- <para>This manual page documents briefly the
- <command>updateSite.py</command> and <command>uploadSite.py</command>
- commands.</para>
+ <para>This manual page documents briefly the &updateSite; and
+ &uploadSite; commands from the PubTal package</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.
Instead, it has documentation in &html; format;
see below.</para>
- <para><command>updateSite.py</command> generates &html; pages
+ <para>&updateSite; generates &html; pages
starting from a series of content files and templates written in
the <acronym>ZPT</acronym> language.</para>
<para>The command takes a minimum of one parameter, the location of
the website configuration file.</para>
- <para>The updateSite.py command first reads in the configuration file
+ <para>The &updateSite; command first reads in the configuration file
and so locates the content, template, and destination directories
(defaulting to content, template, and dest respectively). If only
- one parameter is passed to updateSite.py, it will then find each
+ one parameter is passed to &updateSite;, it will then find each
file under the content directory and build the corresponding
output files.</para>
@@ -127,23 +126,24 @@
in the content directory (or one of its children), then just that
file will be built.</para>
- <para>Take for example:</para>
-
- <command>updateSite.py new-site/site.config new-site/content/index.txt
-new-site/content/examples/</command>
-
- <para>This will build the index.txt file into index.html and all
- content files under content/examples/ will be built into their
- corresponding output files.</para>
-
-
- <para><command>uploadSite.py</command> uploads the generated
+ <para>Take for example:
+
+ <userinput>
+ updateSite new-site/site.config new-site/content/index.txt new-site/content/examples/
+ </userinput>
+
+ This will build the index.txt file into index.html and all
+ content files under content/examples/ will be built into their
+ corresponding output files.
+ </para>
+
+ <para>&uploadSite; uploads the generated
pages. This takes a minimum of one parameter, the location of the
website configuration file.</para>
- <para>The uploadSite.py command first reads in the configuration
+ <para>The &uploadSite; command first reads in the configuration
file and so locates the destination directories. If only one
- parameter is passed to uploadSite.py, it will then find each file
+ parameter is passed to &uploadSite;, it will then find each file
under the destination directory that needs to be uploaded. The
logic used to determine whether a file needs to be uploaded is
explained in the Uploading section.</para>
@@ -156,14 +156,14 @@
children), then just that file will be considered for
upload.</para>
- <para>Take for example:</para>
-
- <para><command>uploadSite.py new-site/site.config
- new-site/dest/index.html new-site/dest/examples/</command></para>
-
- <para>This will examine the index.html file and all files under
+ <para>Take for example:
+
+ <userinput>
+ uploadSite new-site/site.config new-site/dest/index.html new-site/dest/examples/
+ </userinput>
+
+ This will examine the index.html file and all files under
dest/examples/ when determining what files to upload.</para>
-
</refsect1>
<refsect1>
@@ -172,59 +172,138 @@
<para>A summary of options is included below. For a complete
description, see the &html; documentation.</para>
- <para>Options for <command>updateSite.py</command></para>
+ <para>Options for &updateSite;</para>
<variablelist>
- <varlistentry><term><option>-h</option>
- <option>--help</option></term>
- <listitem>Prints out the help description for the
- command.</listitem>
- </varlistentry>
- <varlistentry><term><option>-a</option>
- <option>--all</option></term>
- <listitem>Builds all classes of content, not just content in
- the "normal" class.</listitem>
- </varlistentry>
- <varlistentry><term><option>--class</option> classParams</term>
- <listitem>Builds all classes given as supplied in a comma
- separated list.</listitem>
- </varlistentry>
- <varlistentry><term><option>--logging</option></term>
- <listitem>Turns on logging.</listitem>
- </varlistentry>
- <varlistentry><term><option>--logfile</option> name</term>
- <listitem>Logs to the file "name" (defaults to
- updateSite.log).</listitem>
- </varlistentry>
- <varlistentry><term><option>--debug</option></term>
- <listitem>Turns on debug logging; implies
- <option>--logging</option>.</listitem>
- </varlistentry>
- <varlistentry><term><option>--debug-simpletal</option></term>
- <listitem>Turns on debug logging of SimpleTAL, implies
- <option>--logging</option>.</listitem>
+ <varlistentry>
+ <term>
+ <option>-h</option>
+ </term>
+ <term>
+ <option>--help</option>
+ </term>
+ <listitem><para>
+ Prints out the help description for the command.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-a</option>
+ </term>
+ <term>
+ <option>--all</option>
+ </term>
+ <listitem><para>
+ Builds all classes of content, not just content in the "normal" class.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--class classParams</option>
+ </term>
+ <listitem><para>
+ Builds all classes given as supplied in a comma separated list.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--logging</option>
+ </term>
+ <listitem><para>
+ Turns on logging.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--logfile name</option>
+ </term>
+ <listitem><para>
+ Logs to the file "name" (defaults to updateSite.log).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--debug</option>
+ </term>
+ <listitem><para>
+ Turns on debug logging; implies <option>--logging</option>.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--debug-simpletal</option>
+ </term>
+ <listitem><para>
+ Turns on debug logging of SimpleTAL, implies <option>--logging</option>.
+ </para></listitem>
</varlistentry>
</variablelist>
- <para>Options for <command>uploadSite.py</command></para>
+ <para>Options for &uploadSite;</para>
<variablelist>
- <varlistentry><term><option>-h</option>
- <option>--help</option></term>
- <listitem>Prints out the help description for the command.</listitem></varlistentry>
- <varlistentry><term><option>-a</option>
- <option>--all</option></term>
- <listitem>Checks all files are uploaded, not just PubTal generated ones.</listitem></varlistentry>
- <varlistentry><term><option>--force</option></term>
- <listitem>Uploads files even if PubTal thinks they are up-to-date.</listitem></varlistentry>
- <varlistentry><term><option>--dry-run</option></term>
- <listitem>Prints out what would have been done, but takes no action.</listitem></varlistentry>
- <varlistentry><term><option>--logging</option></term>
- <listitem>Turns on logging.</listitem></varlistentry>
- <varlistentry><term><option>--logfile</option> name</term>
- <listitem>Logs to the file "name" (defaults to updateSite.log).</listitem></varlistentry>
- <varlistentry><term><option>--debug</option></term>
- <listitem>Turns on debug logging; implies --logging.</listitem></varlistentry>
+ <varlistentry>
+ <term>
+ <option>-h</option>
+ </term>
+ <term>
+ <option>--help</option>
+ </term>
+ <listitem><para>
+ Prints out the help description for the command.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-a</option>
+ </term>
+ <term>
+ <option>--all</option>
+ </term>
+ <listitem><para>
+ Checks all files are uploaded, not just PubTal generated ones.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--force</option>
+ </term>
+ <listitem><para>
+ Uploads files even if PubTal thinks they are up-to-date.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--dry-run</option>
+ </term>
+ <listitem><para>
+ Prints out what would have been done, but takes no action.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--logging</option>
+ </term>
+ <listitem><para>
+ Turns on logging.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--logfile name</option>
+ </term>
+ <listitem><para>
+ Logs to the file "name" (defaults to updateSite.log).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--debug</option>
+ </term>
+ <listitem><para>
+ Turns on debug logging; implies <option>--logging</option>.
+ </para></listitem>
+ </varlistentry>
</variablelist>
</refsect1>
@@ -241,14 +320,13 @@
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
- the terms of the &gnu; General Public License, Version 2 any
- later version published by the Free Software Foundation.
+ the terms of the &gnu; General Public License, Version 2 or any
+ later version published by the Free Software Foundation.
</para>
- <para>
- On Debian systems, the complete text of the GNU General Public
- License can be found in /usr/share/common-licenses/GPL.
- </para>
-
+ <para>
+ On Debian systems, the complete text of the GNU General Public
+ License can be found in /usr/share/common-licenses/GPL.
+ </para>
</refsect1>
</refentry>
More information about the Python-modules-commits
mailing list