[pybliographer] Tweaked the new manual, repaired links etc.
- From: Mario Blättermann <mariobl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pybliographer] Tweaked the new manual, repaired links etc.
- Date: Mon, 22 Nov 2010 20:26:30 +0000 (UTC)
commit 84af128da55c2e94c3da3317089ebff70e52cd5f
Author: Mario Blättermann <mariobl gnome org>
Date: Mon Nov 22 21:23:45 2010 +0100
Tweaked the new manual, repaired links etc.
help/C/command-line.page | 15 +----------
help/C/gettingstarted.page | 53 ++++++++++++++++++++++++++-------------
help/C/gui-edit.page | 6 ++--
help/C/gui-formats.page | 6 ++--
help/C/gui-navigating.page | 4 +-
help/C/gui-opening.page | 2 +-
help/C/gui-pubmed.page | 4 +-
help/C/gui-searching.page | 2 +-
help/C/gui-settings.page | 9 ++++---
help/C/gui-sorting.page | 2 +-
help/C/gui-styles.page | 12 ++++----
help/C/index.page | 6 ++++-
help/C/scripting-existing.page | 2 +-
13 files changed, 66 insertions(+), 57 deletions(-)
---
diff --git a/help/C/command-line.page b/help/C/command-line.page
index af7c3dc..3e69c30 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#usage"/>
+ <link type="guide" xref="index#advusage"/>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<desc>
Using <app>Pybliographer</app> with a terminal.
@@ -82,17 +82,4 @@
</screen>
- <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>
-
-
</page>
diff --git a/help/C/gettingstarted.page b/help/C/gettingstarted.page
index 019b223..76a6bf2 100644
--- a/help/C/gettingstarted.page
+++ b/help/C/gettingstarted.page
@@ -40,32 +40,49 @@
<p>
You can start <app>Pybliographer</app> in the following ways:
</p>
- <list>
- <item><p>Graphical mode</p>
- <desc>
+ <section>
+ <title>Graphical mode</title>
+ <p>
To start <app>Pybliographer</app> in graphical mode from a
command line, type the following command, then press
<key>Return</key>: <cmd>pybliographic</cmd>.
For more information on the graphical interface, see
<link xref="gui"/>.
- </desc>
- </item>
- <item><p>Command line mode</p>
- <desc>
+ </p>
+ </section>
+
+ <section>
+ <title>Command line mode</title>
+ <p>
You can start <app>Pybliographic</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"/>.
- </desc>
- </item>
- <item><p>From the GNOME menu</p>
- <desc>
- If the desktop file of the package is correctly installed in
- your sytem, you can find a launcher under the GNOME menu to
- start the graphical interface of <app>Pybliographer</app>.
- </desc>
- </item>
- </list>
+ 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>
+ <title>From the GNOME menu</title>
+ <p>
+ If the <file>*.desktop</file> file of the package is correctly
+ installed in your sytem, you can find a launcher under the GNOME menu
+ to start the graphical interface of <app>Pybliographer</app>.
+ </p>
+ </section>
</section>
diff --git a/help/C/gui-edit.page b/help/C/gui-edit.page
index f65ebab..cffc795 100644
--- a/help/C/gui-edit.page
+++ b/help/C/gui-edit.page
@@ -31,7 +31,7 @@
The Edition window
</media></p>
- <p>The edition window is represented in <link xref="figedit" />.
+ <p>The edition window is represented in the figure above.
On the right of each field, a symbol indicates if <app>Pybliographer</app>
has been able to render all the information given in that field. For
example, a BibTeX field containing an unknown command name cannot
@@ -42,7 +42,7 @@
<note type="warning">
<p>If you edit such an entry, you can loose the additional
information it contained. To avoid this, consider using native
- editing (see <link xref="gui-edit-native" />).</p>
+ editing (see <link xref="gui-edit#gui-edit-native" />).</p>
</note>
<p>To edit the entries, simply type the corresponding text, without
@@ -64,7 +64,7 @@
<em>URL</em> field with a given type of entry, it is
possible to assign an url to an entry (e.g. the
location of the pdf version of an article or the address of a
- website). See <link xref="figediturl" />. More information about
+ website). See the window below. More information about
the association of fields can be found in
<link xref="gui-settings" />.</p>
</note>
diff --git a/help/C/gui-formats.page b/help/C/gui-formats.page
index 8eeb41f..b475cf5 100644
--- a/help/C/gui-formats.page
+++ b/help/C/gui-formats.page
@@ -25,8 +25,8 @@
<title>Saving selected entries in different formats</title>
<p>Selected entries can be saved in different formats using
- the <guiseq><gui>Cite</gui><gui>Format...</gui></guiseq> menu item
- (<link xref="figformat" />).
+ the <guiseq><gui>Cite</gui><gui>Format...</gui></guiseq> menu item,
+ see the following window:
</p>
<p><media type="image" mime="image/png" src="figures/format.png">
@@ -38,7 +38,7 @@
to a bibliographic style, either in HTML, LaTeX, Raw or Text format.
The <app>Pybliographer</app> package contains some bibliographic styles,
but own styles can also be created easily. See also
- <link xref="script-scripting-existing-pybformat" />.</p>
+ <link xref="scripting-existing#script-scripting-existing-pybformat" />.</p>
</page>
diff --git a/help/C/gui-navigating.page b/help/C/gui-navigating.page
index b67fa17..82d7496 100644
--- a/help/C/gui-navigating.page
+++ b/help/C/gui-navigating.page
@@ -25,7 +25,7 @@
<title>Navigating in the entries</title>
<p>Once you have opened a database, or started to create a new one, the
- main window (see <link xref="figmain" />) displays a list of all the
+ main window (see the picture below) displays a list of all the
entries on the top part of it. The fields displayed here can be configured
under the <guiseq><gui>Settings</gui><gui>Preferences</gui></guiseq>
menu item.</p>
@@ -50,7 +50,7 @@
<guiseq><gui>Resource</gui></guiseq> pop up menu provided for the item list.
If an item contains one or more viewable fields (like url) containing
viewable resources, it is marked with an icon at the left edge of the
- item in the upper part of the main window (see <link href="figmain" />).
+ item in the upper part of the main window (see the picture below).
</p>
<note style="tip">
diff --git a/help/C/gui-opening.page b/help/C/gui-opening.page
index ca9bb8e..b20ad41 100644
--- a/help/C/gui-opening.page
+++ b/help/C/gui-opening.page
@@ -32,7 +32,7 @@
Opening a database
</media></p>
- <p>A file selection dialog will pop up (see <link xref="figopen"/>) and
+ <p>A file selection dialog will pop up (see the picture above) and
let you select a file. The type of the database can also be selected.
Opening an existing database, the type can be guessed if you select
<gui>- According to file suffix -</gui>.
diff --git a/help/C/gui-pubmed.page b/help/C/gui-pubmed.page
index 9c3bde7..87dabf0 100644
--- a/help/C/gui-pubmed.page
+++ b/help/C/gui-pubmed.page
@@ -27,14 +27,14 @@
<p>With <app>Pybliographic</app>, it is possible to perform a Medline search.
To use this option, click on the <guiseq><gui>File</gui><gui>Medline query...
</gui></guiseq> menu item. The upcoming window is represented in
- <link xref="figmed" />.</p>
+ the picture below.</p>
<p><media type="image" mime="image/png" src="figures/medline.png">
Medline query
</media></p>
<p>The keyword, you are looking for, should be written into the
- <em>Search PubMed for</em> field. As it can be seen in <link xref="figmed" />,
+ <em>Search PubMed for</em> field. As it can be seen in the picture above,
a number of options (limitations) can be set, which can help to obtain
an optimal search result. The matched references, resulted in by the query,
appear in the main window as a new database.</p>
diff --git a/help/C/gui-searching.page b/help/C/gui-searching.page
index aa5dcb1..4c3b9e6 100644
--- a/help/C/gui-searching.page
+++ b/help/C/gui-searching.page
@@ -28,7 +28,7 @@
For searching you can use the quick search entry of the toolbar or the
search dialog. To open the search dialog, click on <guiseq><gui>Edit</gui>
<gui>Search</gui></guiseq> in the menu. The dialog that appears (see
- <link xref="figsearch"/>) displays a search form at the top.</p>
+ the picture below) displays a search form at the top.</p>
<p><media type="image" mime="image/png" src="figures/search.png">
The Search dialog
diff --git a/help/C/gui-settings.page b/help/C/gui-settings.page
index 516437b..d92c750 100644
--- a/help/C/gui-settings.page
+++ b/help/C/gui-settings.page
@@ -4,7 +4,7 @@
id="gui-settings">
<info>
- <link type="guide" xref="gui"/>
+ <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.
@@ -30,7 +30,7 @@
<section id="gui-settings-fields">
<title>Entry types and field names configuration</title>
- <p><media id="figfields" type="image" mime="image/png" src="figures/fields.png">
+ <p><media type="image" mime="image/png" src="figures/fields.png">
Configuration of fields and entry types
</media></p>
@@ -38,9 +38,10 @@
</guiseq> menu item, it is possible to add or remove fields, to set their
type, and to define which fields should be associated with a given type of
entry. In addition, the mandatory and optional fields are also can
- be varied. In <link xref="figfields"/>, as an example, the association of
- the Article entry type can be seen.</p>
+ 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 id="gui-settings-pref">
<title>Preferences</title>
diff --git a/help/C/gui-sorting.page b/help/C/gui-sorting.page
index df41167..29b4429 100644
--- a/help/C/gui-sorting.page
+++ b/help/C/gui-sorting.page
@@ -28,7 +28,7 @@
provides some rudimentary way of sorting a database. A much
powerful method is to open the sort dialog (in <guiseq>
<gui>Edit</gui><gui>Sort</gui></guiseq>). This menu, displayed in
- <link xref="figsort" />, gives a list of fields which can be used as sort
+ 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:
<list>
diff --git a/help/C/gui-styles.page b/help/C/gui-styles.page
index 06e92b1..ad50c16 100644
--- a/help/C/gui-styles.page
+++ b/help/C/gui-styles.page
@@ -4,7 +4,7 @@
id="gui-styles">
<info>
- <link type="guide" xref="gui"/>
+ <link type="guide" xref="index#advusage"/>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<desc>
Creating your own styles for <app>Pybliographer</app>.
@@ -52,14 +52,14 @@
functions, grouped in a module. Let's consider the following
example:</p>
-<code>
+<screen><code>
<module name="generic">
<define field="author">full_authors</define>
<define field="editor">first_last_full_authors</define>
<define field="date">european_date</define>
<define method="keys">string_keys</define>
</module>
-</code>
+</code></screen>
<p>In this example, we require that the
<em>author</em> fields should be formatted by the
@@ -67,10 +67,10 @@
<file>generic</file> module.</p>
<p>Such a module has to be declared in the
- <file>pybrc.py</file> file, by a line like:
+ <file>pybrc.py</file> file, by a line like:</p>
-<code>Autoload.preregister ('style','Generic','Pyblio.Style.Generic')</code>
-</p>
+ <screen><code>Autoload.preregister ('style','Generic','Pyblio.Style.Generic')</code>
+</screen>
<p>The precise definition of the formatting functions is better
explained by looking at the code of <file>Generic.py</file> for example.</p>
diff --git a/help/C/index.page b/help/C/index.page
index 774576e..66316cb 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -4,7 +4,7 @@
id="index">
<info>
- <title type="link">Pybliographer Bibliography manager</title>
+ <title type="link">Pybliographer manual</title>
<title type="text">Pybliographer Bibliography manager</title>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<credit type="author">
@@ -33,6 +33,10 @@
<title>Usage</title>
</section>
+ <section id="advusage" style="2column">
+ <title>Advanced Usage</title>
+ </section>
+
<section id="scripting" style="2column">
<title>The Scripting Language</title>
</section>
diff --git a/help/C/scripting-existing.page b/help/C/scripting-existing.page
index 3988f89..0f8bc34 100644
--- a/help/C/scripting-existing.page
+++ b/help/C/scripting-existing.page
@@ -7,7 +7,7 @@
<link type="guide" xref="index#scripting"/>
<revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
<desc>
- How to use existing scripts.
+ How to use the scripts shipped with <app>Pybliographer</app>.
</desc>
<credit type="author">
<name>Zoltán Kóta</name>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
