[pybliographer] Mallard migration goes ahead
- From: Mario Blättermann <mariobl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pybliographer] Mallard migration goes ahead
- Date: Fri, 29 Oct 2010 19:26:47 +0000 (UTC)
commit 32bfc0315f58e8be93481789db6fc86a149795c3
Author: Mario Blättermann <mariobl gnome org>
Date: Fri Oct 29 21:24:33 2010 +0200
Mallard migration goes ahead
help/C/gettingstarted.page | 12 +++++
help/C/gui-creating.page | 40 +++++++++++++++++
help/C/gui-navigating.page | 100 ++++++++++++++++++++++++++++++++++++++++++++
help/C/gui-opening.page | 47 ++++++++++++++++++++
help/C/gui-sorting.page | 58 +++++++++++++++++++++++++
help/C/gui.page | 37 ++++++++++++++++
help/C/index.page | 3 +-
7 files changed, 296 insertions(+), 1 deletions(-)
---
diff --git a/help/C/gettingstarted.page b/help/C/gettingstarted.page
index 09d4a5a..f472a21 100644
--- a/help/C/gettingstarted.page
+++ b/help/C/gettingstarted.page
@@ -65,6 +65,18 @@
</desc>
</item>
</list>
+
+ <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>
</page>
diff --git a/help/C/gui-creating.page b/help/C/gui-creating.page
new file mode 100644
index 0000000..e295f88
--- /dev/null
+++ b/help/C/gui-creating.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="gui-creating">
+
+ <info>
+ <link type="guide" xref="gui"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ How to create a new database.
+ </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>Creating a new database</title>
+
+ <p>When <app>Pybliographic</app> is opened, you can immediately begin
+ to create a new database. The type of this database will be determined
+ when you will save it the first time.</p>
+
+ <p>To add a new entry, you can use the <guiseq><gui>Edit</gui>
+ <gui>Add</gui></guiseq> menu, directly the <gui>Add</gui>
+ toolbar button or click with the right button in the list window
+ and select <gui>Add</gui>.
+ </p>
+
+ <p>You will find more information on the main window's usage in
+ <link xref="gui-navigating"/>.</p>
+
+</page>
diff --git a/help/C/gui-navigating.page b/help/C/gui-navigating.page
new file mode 100644
index 0000000..8d288bb
--- /dev/null
+++ b/help/C/gui-navigating.page
@@ -0,0 +1,100 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="gui-navigating">
+
+ <info>
+ <link type="guide" xref="gui"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ Explanations about the graphical interface of <app>Pybliographer</app>.
+ </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>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
+ 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>
+
+ <note style="tip">
+ <p>It is possible to display two types of combined fields:
+ <em>-author/editor</em> and <em>-author/title-</em>.
+ </p>
+ </note>
+
+ <p>Clicking on an entry displays its full content on the lower part of
+ the window. It is also possible to use the arrow keys to navigate in the
+ upper list.
+ </p>
+
+ <p>If an entry contains an <em>URL</em> field, clicking on the small
+ button next to the url, the appropriate application is launched to view
+ the target object (e.g. PDF viewer for pdf files, web browser for http
+ address). See <link xref="gui-edit"/> about how to add an URL field to
+ an entry. Alternatively, you can open the URL with the help of the
+ <guiseq><gui>View</gui><gui>Resource</gui></guiseq> submenu item or the
+ <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" />).
+ </p>
+
+ <note style="tip">
+ <p>You can set the viewable fields and the applications used to view
+ the resources in the <gui>Resource</gui> tab under the
+ <guiseq><gui>Settings</gui><gui>Preferences</gui></guiseq> menu.
+ </p>
+ </note>
+
+
+ <p>Clicking on an entry while pressing the <key>Shift</key> key
+ extends the selection to the clicked entry. A click while pressing
+ the <key>Control</key> key toggles the entry without altering the
+ state of the rest of the selection. With copy and paste, or by
+ drag and drop you can copy one or more selected entries into a
+ new window or database.</p>
+
+ <p><media type="image" mime="image/png" src="figures/main.png">
+ The main window
+ </media></p>
+
+ <p>Clicking the right button of the mouse in the list opens a
+ contextual menu. With this menu you can:</p>
+
+ <list>
+ <item>
+ <p>add a new entry</p>
+ </item>
+ <item>
+ <p>edit the currently selected items</p>
+ </item>
+ <item>
+ <p>view the resource associated with the selected item</p>
+ </item>
+ <item>
+ <p>delete the currently selected items</p>
+ </item>
+ </list>
+
+ <p>Note that some of these menu options can be disabled for a
+ given database or entry, provided that the corresponding action
+ can't be performed.</p>
+
+ <p>By clicking on the column titles of the list, you'll sort
+ the entries according to the corresponding field.</p>
+
+</page>
diff --git a/help/C/gui-opening.page b/help/C/gui-opening.page
new file mode 100644
index 0000000..7bb2134
--- /dev/null
+++ b/help/C/gui-opening.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="gui-opening">
+
+ <info>
+ <link type="guide" xref="gui"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ How to open an existing database..
+ </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>Opening a database</title>
+
+ <p>To open an existing database, click on the <gui>Open</gui> toolbar
+ button or go in the <gui>File</gui> menu, and select <guiseq>
+ <gui>File</gui><gui>Open</gui></guiseq>.</p>
+
+ <p><media type="image" mime="image/png" src="figures/open.png">
+ Opening a database
+ </media></p>
+
+ <p>A file selection dialog will pop up (see <link xref="figopen"/>) 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>.
+ </p>
+ <p>
+ It is also possible to open a file at a remote location (as well as a
+ local file) by typing the URI of the file (e.g. <var>http://my.remote.site/
+ pyblio.bib</var>) using the <gui>Open Location</gui> dialog, which can be
+ invoked by the <guiseq><gui>File</gui><gui>Open Location</gui></guiseq>
+ menu item.
+ </p>
+</page>
diff --git a/help/C/gui-sorting.page b/help/C/gui-sorting.page
new file mode 100644
index 0000000..df41167
--- /dev/null
+++ b/help/C/gui-sorting.page
@@ -0,0 +1,58 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="gui-sorting">
+
+ <info>
+ <link type="guide" xref="gui"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ Customize the sort order of the entries.
+ </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>Sorting</title>
+
+ <p>Clicking on the title of each column in the main index
+ 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
+ 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>
+ <item>
+ <p>Nothing means the field is not in use.</p>
+ </item>
+ <item>
+ <p>A <em>triangle</em>-like symbol means sort in
+ <em>ascending order</em>.</p>
+ </item>
+ <item>
+ <p>An <em>upside down triangle</em>-like symbol
+ 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
+ can be saved by clicking on the <gui>Set as default</gui>
+ button.</p>
+
+<p><media type="image" mime="image/png" src="figures/sort.png">
+The Sort dialog
+</media></p>
+
+</page>
diff --git a/help/C/gui.page b/help/C/gui.page
new file mode 100644
index 0000000..0676ab2
--- /dev/null
+++ b/help/C/gui.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:e="http://projectmallard.org/experimental/";
+ type="guide"
+ id="gui">
+
+ <info>
+ <link type="guide" xref="index#usage"/>
+ <revision pkgversion="3.0" version="0.1" date="2010-10-24" status="incomplete"/>
+ <desc>
+ Explanations about the graphical interface of <app>Pybliographer</app>.
+ </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>The Graphical Interface</title>
+
+ <p>The graphical user interface is called <app>Pybliographic</app>. It
+ provides a simple access to the most common features of the underlying
+ engine, <app>Pybliographer</app> and lets you search, sort and modify
+ bibliographic entries. Moreover, direct insertion of references into
+ <link href="http://www.lyx.org/"; type="http"><app>Lyx</app></link> and
+ <link href="http://kile.sourceforge.net/"; type="http"><app>Kile</app></link>,
+ direct queries on Medline, and saving selected references in different
+ formats are also possible.
+ </p>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 5971e3d..53c7e2d 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -33,7 +33,7 @@
<title>Usage</title>
</section>
- <section id="scritpting" style="2column">
+ <section id="scripting" style="2column">
<title>The Scripting Language</title>
</section>
@@ -44,4 +44,5 @@
<section id="newstyles" style="2column">
<title>Creating New Styles</title>
</section>
+
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
