[pybliographer] Fixes and modifications on the new documentation
- From: Zoltan Kota <zkota src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pybliographer] Fixes and modifications on the new documentation
- Date: Sun, 28 Nov 2010 22:53:50 +0000 (UTC)
commit 4e4d66305accce4aaaa08174fede73e3a7dc8e52
Author: Zoltan Kota <zoltank gmail com>
Date: Sun Nov 28 23:55:00 2010 +0100
Fixes and modifications on the new documentation
help/C/command-line.page | 2 +-
help/C/customization.page | 79 ++++++++++++++++++++++++++++++++++++++++
help/C/gettingstarted.page | 31 ++++++++--------
help/C/gui-settings.page | 64 ++------------------------------
help/C/gui-sorting.page | 4 +-
help/C/scripting-existing.page | 2 +-
6 files changed, 103 insertions(+), 79 deletions(-)
---
diff --git a/help/C/command-line.page b/help/C/command-line.page
index 3e69c30..edc414e 100644
--- a/help/C/command-line.page
+++ b/help/C/command-line.page
@@ -4,7 +4,7 @@
id="command-line">
<info>
- <link type="guide" xref="index#advusage"/>
+ <link type="guide" xref="index#usage"/>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<desc>
Using <app>Pybliographer</app> with a terminal.
diff --git a/help/C/customization.page b/help/C/customization.page
new file mode 100644
index 0000000..b74ba3c
--- /dev/null
+++ b/help/C/customization.page
@@ -0,0 +1,79 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="customization">
+
+ <info>
+ <link type="guide" xref="index#advusage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ How to customize this application to match your needs.
+ </desc>
+ <credit type="author">
+ <name>Zoltán Kóta</name>
+ <email>zoltank gmail com</email>
+ </credit>
+ <credit type="author">
+ <name>Frédéric Gobry</name>
+ <email>frederic gobry epfl ch</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Advanced Configuration</title>
+
+ <p>The configuration system is heavily based on <app>Python</app>'s
+ module system. The configuration files are standard <app>Pybliographer</app>
+ scripts (that is, python code making use of <app>Pybliographer</app>
+ extra classes and functions), whose single special feature is to be
+ automatically parsed at startup or when needed.</p>
+
+ <section id="config-customization-files">
+ <title>Files involved</title>
+
+ <p>The first file to be parsed is <file>${prefix}/share/pybliographer/pybrc.py
+ </file>. It serves as a bootstrap for the general configuration mechanism,
+ and defines:</p>
+
+ <list>
+ <item>
+ <p>the available input and output formats</p>
+ </item>
+
+ <item>
+ <p>where to find the configuration directories.</p>
+ </item>
+ </list>
+
+ <p>A configuration directory holds a list of files which are parsed
+ when needed. For example, if a method requires some configuration data
+ for the bibtex module, it will import the corresponding file in this
+ directory.</p>
+
+ <p> This mechanism allows more flexibility to add new formats:
+ the new format can be installed with a default configuration
+ without messing with the global configuration file. In addition,
+ the program imports only what is needed, decreasing its startup
+ time.</p>
+
+ <p>Finally, if the user provides a file called <file>.pybrc.py</file>
+ in its home directory, this file is then parsed. Of course it can
+ also define a private configuration directory, and override what has
+ been defined before.</p>
+ </section>
+
+ <section id="config-customization-configmodule">
+ <title>The <sys>Config</sys> module</title>
+
+ <p>All the data that can be configured should be handled by the
+ so-called <sys>Config</sys> module. It provides a
+ standard interface to set/get and document configuration
+ items.</p>
+
+ </section>
+
+
+ </page>
+
diff --git a/help/C/gettingstarted.page b/help/C/gettingstarted.page
index 76a6bf2..0760622 100644
--- a/help/C/gettingstarted.page
+++ b/help/C/gettingstarted.page
@@ -49,30 +49,31 @@
For more information on the graphical interface, see
<link xref="gui"/>.
</p>
+
+ <p>It is possible to set the PYBLIOGRAPHER_DATABASE environment
+ variable to an admissible bibliography file in order to open it
+ always on startup, if no files are specified on the command line.
+ Example:</p>
+
+ <screen>
+ <output>bash$ </output><input>export PYBLIOGRAPHER_DATABASE=<var>my/database.bib</var></input>
+ <output>bash$ </output><input>pybliographic</input>
+ </screen>
+ <p>It is equivalent to</p>
+ <screen>
+ <output>bash$ </output><input>pybliographic <var>my/database.bib</var></input>
+ </screen>
+
</section>
<section>
<title>Command line mode</title>
<p>
- You can start <app>Pybliographic</app> also in command
+ You can start <app>Pybliographer</app> also in command
line mode by typing the following command followed by pressing
<key>Return</key>: <cmd>pybliographer</cmd>. For more
information, see <link xref="command-line"/>.</p>
- <p>It is possible to set the PYBLIOGRAPHER_DATABASE environment
- variable to an admissible bibliography file in order to open it
- always on startup, if no files are specified on the command line.
- Example:</p>
-
- <screen>
- <output>bash$ </output><input>export PYBLIOGRAPHER_DATABASE=<var>my/database.bib</var></input>
- <output>bash$ </output><input>pybliographic</input>
- </screen>
- <p>It is equivalent to</p>
- <screen>
- <output>bash$ </output><input>pybliographic <var>my/database.bib</var></input>
- </screen>
-
</section>
<section>
diff --git a/help/C/gui-settings.page b/help/C/gui-settings.page
index d92c750..b853d45 100644
--- a/help/C/gui-settings.page
+++ b/help/C/gui-settings.page
@@ -4,10 +4,10 @@
id="gui-settings">
<info>
- <link type="guide" xref="index#advusage"/>
+ <link type="guide" xref="gui"/>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<desc>
- How to customize this application to match your needs.
+ How to change settings and preferences.
</desc>
<credit type="author">
<name>Zoltán Kóta</name>
@@ -40,9 +40,9 @@
entry. In addition, the mandatory and optional fields are also can
be varied. In the window displayed above, as an example, the association of
the <em>Article</em> entry type can be seen.</p>
- </section>
+ </section>
- <section id="gui-settings-pref">
+ <section id="gui-settings-pref">
<title>Preferences</title>
<p>Clicking on the <guiseq><gui>Settings</gui><gui>Preferences</gui>
@@ -52,62 +52,6 @@
mode, the default type of a newly created entry, and resource configuration.
</p>
</section>
-
- <section>
- <title>Advanced Configuration</title>
-
- <p>The configuration system is heavily based on <app>Python</app>'s
- module system. The configuration files are standard <app>Pybliographer</app>
- scripts (that is, python code making use of <app>Pybliographer</app>
- extra classes and functions), whose single special feature is to be
- automatically parsed at startup or when needed.</p>
-
- <section id="config-customization-files">
- <title>Files involved</title>
-
- <p>The first file to be parsed is <file>${prefix}/share/pybliographer/pybrc.py
- </file>. It serves as a bootstrap for the general configuration mechanism,
- and defines:</p>
-
- <list>
- <item>
- <p>the available input and output formats</p>
- </item>
-
- <item>
- <p>where to find the configuration directories.</p>
- </item>
- </list>
-
- <p>A configuration directory holds a list of files which are parsed
- when needed. For example, if a method requires some configuration data
- for the bibtex module, it will import the corresponding file in this
- directory.</p>
-
- <p> This mechanism allows more flexibility to add new formats:
- the new format can be installed with a default configuration
- without messing with the global configuration file. In addition,
- the program imports only what is needed, decreasing its startup
- time.</p>
-
- <p>Finally, if the user provides a file called <file>.pybrc.py</file>
- in its home directory, this file is then parsed. Of course it can
- also define a private configuration directory, and override what has
- been defined before.</p>
- </section>
-
- <section id="config-customization-configmodule">
- <title>The <classname>Config</classname> module</title>
-
- <p>All the data that can be configured should be handled by the
- so-called <classname>Config</classname> module. It provides a
- standard interface to set/get and document configuration
- items.</p>
-
-
- </section>
- </section>
-
</page>
diff --git a/help/C/gui-sorting.page b/help/C/gui-sorting.page
index 29b4429..1c426af 100644
--- a/help/C/gui-sorting.page
+++ b/help/C/gui-sorting.page
@@ -30,7 +30,7 @@
<gui>Edit</gui><gui>Sort</gui></guiseq>). This menu, displayed in
the picture below, gives a list of fields which can be used as sort
criterions, plus a flag indicating how they are currently used. By clicking
- twice on the item, it is possible to choose how the field will be used:
+ twice on the item, it is possible to choose how the field will be used:</p>
<list>
<item>
<p>Nothing means the field is not in use.</p>
@@ -44,7 +44,7 @@
means sort in <em>descending order</em>.</p>
</item>
</list>
- </p>
+
<p>The order in which the sorting is performed depends on the
order in the list. To modify this order, simply drag and drop an
item to change its position. To make this sort order default, it
diff --git a/help/C/scripting-existing.page b/help/C/scripting-existing.page
index 0f8bc34..692c161 100644
--- a/help/C/scripting-existing.page
+++ b/help/C/scripting-existing.page
@@ -109,7 +109,7 @@
<p><cmd>--format=...</cmd> or <cmd>-f ...</cmd>: specify an
output format (HTML, LaTeX, Raw, Text, Textau, Textnum). Default is
Text. (Textau and Textnum are just slightly modified versions of Text.
- See <link xref="script-scripting-existing-pybtext" /> for more
+ See <link xref="#script-scripting-existing-pybtext" /> for more
details.)</p>
</item>
<item>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
