alexandria-book-collection-manager 0.6.9.pre1

data/share/gnome/help/alexandria/C/about.xml

@@ -0,0 +1,44 @@
+<!-- 
+  This is part of the Alexandria Manual.
+  Copyright (C)  2005  Liam Davison
+  Copyright (C)  2007  Cathal Mc Ginley
+  See the file alexandria.xml for copying conditions.
+-->
+
+<!-- ============= About ================================== -->
+<!-- This section contains info about the program (not docs), such as
+     author's name(s), web page, license, feedback address. This
+     section is optional: primary place for this info is "About.." box of
+     the program. However, if you do wish to include this info in the
+     manual, this is the place to put it. Alternatively, you can put 
+     this information in the title page.-->
+
+<section id="about">
+  <title>About &app;</title>
+
+  <para> 
+    &app; was originally written by Laurent Sansonetti. Many people
+    have contributed to it since it was first released. For a full
+    list of contributors, see the file AUTHORS which came with the
+    program.  It is currently maintained by Joseph Method. To find
+    more information about &app;, please visit the <ulink
+    url="http://alexandria.rubyforge.org/" type="http">&app; Web
+    page</ulink>.
+  </para>
+
+  <para>
+    To report a bug or make a suggestion regarding the &app;
+    application or this manual, follow the directions on the <ulink
+    url="http://alexandria.rubyforge.org/feedback.html"
+    type="http">&app; Feedback web page</ulink>.
+  </para>
+
+  <para>
+    &app; is distributed under the terms of the GNU General Public
+    license as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version. A
+    copy of this license can be found at this <ulink url="ghelp:gpl"
+    type="help">link</ulink>, or in the file COPYING included with the
+    source code of this program.
+  </para>
+</section>

data/share/gnome/help/alexandria/C/adding-books.xml

@@ -0,0 +1,339 @@
+<!-- 
+  This is part of the Alexandria Manual.
+  Copyright (C)  2005  Liam Davison
+  Copyright (C)  2007  Cathal Mc Ginley
+  See the file alexandria.xml for copying conditions.
+-->
+
+<!-- ================ Adding Books ================================ -->
+<!-- Use this section to describe how to use the application to perform
+     the tasks for which the application is designed. -->
+
+<section id="adding-books">
+  <title>Adding Books</title>
+
+  <para>You can add books to &app; in several different ways:
+  <itemizedlist>
+    <listitem><para><xref linkend="add-book-by-isbn"/></para></listitem>
+    <listitem><para><xref linkend="add-book-by-search"/></para></listitem>
+    <listitem><para><xref linkend="add-book-by-barcode-scan"/></para></listitem>
+    <listitem><para><xref linkend="add-book-manually"/></para></listitem>
+  </itemizedlist>
+  </para>
+  
+  <para>You can also import a list of books into &app;:
+  <itemizedlist>
+    <listitem><para><xref linkend="import-library"/></para></listitem>
+  </itemizedlist>
+  </para>
+  
+  <para>&app; will remember which method you prefer, and will
+  automatically select the most recently used method. For instance, if
+  you last added a book by searching for an author, &app; will open
+  the <guilabel>Add Book...</guilabel> dialog with the <guilabel>Add
+  book by author</guilabel> field selected.</para>
+
+  <!-- ================ Adding Books Subsection ====================== -->
+
+  <section id="add-book-by-isbn">
+    <title>To add a book by supplying an ISBN</title>
+
+    <para>If you know the ISBN of the book you wish to add to a
+    library, choose
+    <menuchoice><guimenu>Library</guimenu><guimenuitem>Add
+    Book...</guimenuitem></menuchoice>, or click on the
+    <guibutton>Add</guibutton> button on the toolbar. The
+    <guilabel>Adding a Book</guilabel> dialog is displayed. Type in
+    the ISBN of the book you wish to add, then click
+    <guibutton>Add</guibutton>.</para>
+
+    <figure id="add-by-isbn-fig">
+      <title>&app; Adding a book by ISBN</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_add_by_isbn.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows the &app; Add by ISBN dialogue, allowing you to add a book by searching all online information providers the book with that ISBN.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+
+    <caution>
+      <itemizedlist>
+	<listitem>
+	  <para> 
+	    &app; will validate the ISBN supplied and will warn you if
+	    the number entered is not a valid ISBN.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    &app; supports both 10-digit ISBN and the newer
+	    ISBN-13.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    ISBNs are frequently written with dashes at various
+	    positions to aid legibility, but these are ignored by
+	    &app;.
+	  </para>
+	</listitem>
+      </itemizedlist>
+    </caution>
+    
+    <para>
+      &app; will attempt to fetch the information about the book from
+      online information sources, searching in the order specified in
+      the application preferences.  If the book is found by one of the
+      online providers, it will be added to the currently selected
+      library. To add the book to a different library, select the
+      library name from the <guilabel>Save in </guilabel> drop-down
+      menu. If there is only one library, there will naturally be no
+      choice to be made.
+    </para>
+
+  </section>
+  
+  <!-- ========== Adding books by searching ====== -->
+  <section id="add-book-by-search">
+    <title>To search for a book whose ISBN you do not know</title>
+    
+    <para>If you do not know the ISBN of the book you wish to add, you
+    can specify either the Title, the Authors or the Keywords, and
+    &app; will search your online information provider, such as
+    Amazon, for books that match. You can then select the desired book
+    from the displayed list and click <guibutton>Add</guibutton> to
+    the book to the selected library.</para>
+    
+    <para>With the <guilabel>Adding a Book</guilabel> dialog open,
+    click on the <guilabel>Search</guilabel> checkbox then choose
+    either <guilabel>by title, by authors</guilabel> or <guilabel>by
+    keyword</guilabel> from the drop-down menu. Type in the details of
+    the book you are looking for, then click on
+    <guibutton>Find</guibutton>.</para>
+
+    <figure id="add-by-search-fig">
+      <title>&app; Adding a book by searching</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_search_results.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows the &app; Add by Search dialogue, allowing you to add a book by searching your online information provider for a specific Title, Author or Keyword.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+
+    <para>Where possible, &app; will show thumbnails of the books it
+    finds, making it easier to choose the right book or edition of a
+    book. Select the book you want from the list, and click
+    <guibutton>Add</guibutton>.</para>
+    
+    <tip>
+      <para>You may have to try several different search terms to find
+      the book you want.</para>
+    </tip>
+  </section>
+
+  <!-- ======== Adding books by scanning a barcode ====== -->
+  <section id="add-book-by-barcode-scan">
+    <title>To add a book by scanning its barcode</title>
+    
+    <para>
+      &app; supports CueCat barcode scanners. (At the moment, only
+      unmodified CueCats are supported; support for ordinary barcode
+      scanners is planned.) If you have a USB or PS/2 CueCat barcode
+      scanner attached to your computer, choose
+      <menuchoice><guimenu>Library</guimenu><guimenuitem>Acquire from
+      Scanner</guimenuitem></menuchoice>. Scan each book barcode in
+      turn, and they will be listed in the <guilabel>Acquire from
+      Scanner</guilabel> window.
+    </para>
+
+    <figure id="add-manually-fig">
+      <title>Adding books by scanning ISBN barcodes</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_acquire_from_scanner_process.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows the &app; Acquire from Scanner dialogue, while scanning and then after scanning a book barcode.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+
+    <para>
+      Choose which library you wish to save the books in with the
+      <guilabel>Save in</guilabel> drop-down menu, and click
+      <guibutton>Add</guibutton> to complete the operation.
+    </para>
+  </section>
+
+  <!-- ======== Adding a book manually ================= -->
+  <section id="add-book-manually">
+    <title>To manually add a book</title>
+    
+    <para>Sometimes you will not be able to search for a book
+    online. The book may not not have an ISBN (ISBN numbers only
+    became standard in the 1970s). Perhaps the book is too new, and no
+    information is available online. Or perhaps you simply don't have
+    an Internet connection. &app; allows you to specify all the
+    details of a book - the Title, Authors, cover image and so forth -
+    by supplying them yourself.</para>
+    
+    <para>To manually add a book to a library, choose
+    <menuchoice><guimenu>Library</guimenu><guimenuitem>Add Book
+    Manually</guimenuitem></menuchoice>. The following dialog will
+    appear:
+    </para>
+    
+    <figure id="add-manually-fig">
+      <title>&app; adding a book manually</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_manual_details.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows the &app; Add book manually dialogue, allowing type in all the information for the book yourself.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+
+    <para>This dialogue is very similar to the <guilabel>Edit
+    Book</guilabel> dialog. There are three tabs to this dialogue -
+    <guilabel>General</guilabel>, <guilabel>Loaning</guilabel> and
+    <guilabel>Notes</guilabel>. There is space for you to specify the
+    book title, the ISBN if you know it, the book publisher, the
+    binding (such as Paperback, Hardback, or Audiobook), and the
+    Authors.</para>
+    
+    <tip>
+      <para>To add an author, click on the <guibutton>+</guibutton>
+      next to the author list, then type the name. To remove an
+      author, select the name and click <guibutton>-</guibutton>. To
+      edit a name, click twice on the name.</para>
+    </tip>
+
+    <para>
+      You can also add a set of Tags to a book by entering words or
+      phrases separated by commas. Tags are used as an informal way to
+      note subject information.
+    </para>
+    
+    <para>To supply a book cover image, click on the
+    <guibutton>Cover</guibutton> button. A standard file selection
+    dialogue will open. Navigate to the cover image file on your
+    system - which can be in JPEG or GIF format - and click
+    <guibutton>Open</guibutton>. The image will be scaled to fit into
+    the <guilabel>Edit Book</guilabel> dialogue.</para>
+    
+    <para>You can rate a book by clicking on the stars. To clear the
+    rating, click on the space immediately to the left of the first
+    star.</para>
+    
+    <para>When you have filled in all the information, click on the
+    <guibutton>Add</guibutton> button.</para>
+  </section>
+
+  <!-- =========== Importing a list of books ========== -->
+  <section id="import-library">
+    <title>To import a list of books</title>
+    
+    <para>&app; can import Tellico files, (used by the
+    <application>Tellico</application> application).  It can also
+    import a simple list of ISBNs, fetching the details for each book
+    in turn. To import either a Tellico file or a flat ISBN list,
+    choose
+    <menuchoice><guimenu>Library</guimenu><guimenuitem>Import...</guimenuitem></menuchoice>. Navigate
+    to the appropriate file, and click
+    <guibutton>Import</guibutton>. &app; can automatically determine
+    what type of file is being imported; you can, of course, specify
+    the file format by choosing either <guimenuitem>Archived
+    Tellico</guimenuitem> or <guimenuitem>ISBN List</guimenuitem> from
+    the <guilabel>Autodetect</guilabel> drop-down menu.</para>
+    
+    <figure id="importing-fig">
+      <title>&app; importing a list of ISBNs</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_isbn_import.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows &app; importing a list of ISBNs.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+    
+    <tip>
+      <para>&app; will create a new Library when importing a library -
+      its name will be the same as the filename you imported. &app;
+      will automatically select and highlight this library in the
+      library pane - you can immediately rename this by typing a new
+      name, or accept the default by clicking the left mouse
+      button.</para>
+    </tip>
+
+    <figure id="importing-new-library">
+      <title>Renaming the new library after importing a list of ISBNs</title>
+      <screenshot>
+	<mediaobject>
+	  <imageobject>
+	    <imagedata fileref="figures/adding_books_rename_library_after_import.png" format="PNG"/>
+	  </imageobject>
+	  <!-- EPS versions of the figures are not required at the moment. -->
+	  <!-- 
+	       <imageobject>
+	       <imagedata fileref="figures/image.eps" format="EPS"/>
+	       </imageobject>
+	  -->
+	  <textobject>
+	    <phrase>Shows &app; new library after importing a list of ISBNs.</phrase>
+	  </textobject>
+	</mediaobject>
+      </screenshot>
+    </figure>
+
+  </section>
+</section>

data/share/gnome/help/alexandria/C/alexandria.xml

@@ -0,0 +1,185 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+<!-- SYMBOLIC ENTITIES -->
+<!ENTITY appversion "0.6.2">   <!-- the version of the application -->
+<!ENTITY manrevision "0.0.9">  <!-- the revision number of this manual -->
+<!ENTITY date "December 2007"> <!-- the release date of this manual -->
+<!ENTITY app "<application>Alexandria</application>">
+<!-- the name of the application -->
+<!-- INCLUDED FILES -->
+<!ENTITY introduction SYSTEM "introduction.xml">
+<!ENTITY gettingstarted SYSTEM "getting-started.xml">
+<!ENTITY addingbooks SYSTEM "adding-books.xml">
+<!ENTITY editingbookproperties SYSTEM "editing-book-properties.xml">
+<!ENTITY workingwithlibraries SYSTEM "working-with-libraries.xml">
+<!ENTITY searching SYSTEM "searching.xml">
+<!ENTITY smartlibraries SYSTEM "smart-libraries.xml">
+<!ENTITY exporting SYSTEM "exporting.xml">
+<!ENTITY settings SYSTEM "settings.xml">
+<!ENTITY bugs SYSTEM "bugs.xml">
+<!ENTITY about SYSTEM "about.xml">
+<!-- ENTITY legal SYSTEM "legal.xml" -->
+<!ENTITY gnufdl SYSTEM "gnu-fdl-1.2.xml">
+
+<!-- CHARACTER MNEMONICS -->
+<!ENTITY copy "&#169;"> <!-- copyright sign -->
+]>
+<!--
+  Copyright (C)  2005  Liam Davison
+  Copyright (C)  2007  Cathal Mc Ginley
+
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.2
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+  A copy of the license is included in the section entitled "GNU
+  Free Documentation License" (see the file gnu-fdl-1.2.xml).
+-->
+
+<!-- 
+This document is based upon a GNOME documentation template, designed
+by the GNOME Documentation Project Team.
+-->
+
+<!-- 
+(Do not remove this comment block.)
+Maintained by the GNOME Documentation Project
+http://developer.gnome.org/projects/gdp
+Template version: 2.0 beta
+Template last modified Apr 11, 2002
+-->
+
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+
+  <!-- please do not change the id; for translations, change lang to -->
+  <!-- appropriate code -->
+
+  <articleinfo>
+    <title>&app; Manual</title>
+    
+    <copyright>
+      <year>2007</year>
+      <holder>Cathal Mc Ginley</holder>
+    </copyright>
+    <copyright>
+      <year>2005</year>
+      <holder>Liam Davison</holder>
+    </copyright>
+    <!-- translators: uncomment this:
+	 <copyright>
+	 <year>2007</year>
+	 <holder>TRANSLATOR_NAME (LANGUAGE translation)</holder>
+	 </copyright>
+    -->
+
+    <legalnotice id="legalnotice">
+      <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the GNU Free Documentation License,
+	Version 1.2 or any later version published by the Free Software
+	Foundation; with no Invariant Sections, no Front-Cover Texts,
+	and no Back-Cover Texts. A copy of the license is included in
+	the section entitled <xref linkend="gfdl"/>.
+      </para>
+    </legalnotice>
+
+
+    <authorgroup>
+      <author>
+	<firstname>Liam</firstname>
+	<surname>Davison</surname>
+	<affiliation>
+	  <orgname>&app; documentation writing</orgname>
+	  <address format="linespecific"><email>carnegie@liamjdavison.info</email></address>
+	</affiliation>
+      </author>
+      <othercredit role="maintainer">
+	<firstname>Cathal</firstname> 
+	<surname>Mc Ginley</surname> 
+	<affiliation> 
+	  <orgname>&app; developers</orgname> 
+	  <address format="linespecific"><email>cathal.alexandria@gnostai.org</email></address> 
+	</affiliation>
+	<contrib>Maintenance</contrib>
+      </othercredit>
+      <!-- This is appropriate place for other contributors: translators,
+	   maintainers,  etc. Commented out by default.
+	   
+	   <othercredit role="translator">
+	   <firstname>Latin</firstname> 
+	   <surname>Translator 1</surname> 
+	   <affiliation> 
+	   <orgname>Latin Translation Team</orgname> 
+	   <address> <email>translator@gnome.org</email> </address> 
+	   </affiliation>
+	   <contrib>Latin translation</contrib>
+	   </othercredit>
+      -->
+    </authorgroup>
+
+    <!-- According to GNU FDL, revision history is mandatory if you are -->
+    <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
+    <!-- Remember to remove the &manrevision; entity from the revision entries -->
+    <!-- other than the current revision. -->
+
+    <revhistory>
+      <revision>
+	<revnumber>Alexandria Manual V&manrevision;</revnumber>
+	<date>&date;</date>
+	<revdescription>
+	  <para role="author">Cathal Mc Ginley
+	  <email>cathal.alexandria@gnostai.org</email></para>
+	  <para role="publisher">Alexandria Documentation</para>
+	</revdescription>
+      </revision>
+      <revision>
+	<revnumber>Alexandria Manual V0.0.8</revnumber>
+	<date>November 2005</date>
+	<revdescription>
+	  <para role="author">Liam Davison
+	  <email>carnegie@liamjdavison.info</email></para>
+	  <para role="publisher">Alexandria Documentation</para>
+	</revdescription>
+      </revision>
+    </revhistory>
+
+    <releaseinfo>This manual describes version &appversion; of &app;</releaseinfo>
+
+    <legalnotice id="feedback">
+      <title>Feedback</title>
+
+      <para>Alexandria is not an official part of GNOME. To report a bug
+      or make a suggestion regarding the &app; application or this
+      manual, follow the directions on the <ulink
+      url="http://alexandria.rubyforge.org/feedback.html"
+      type="http">&app; Feedback web page</ulink>.
+      </para>
+
+    </legalnotice>
+    <!-- Translators may also add here feedback address for translations -->
+
+  </articleinfo>
+
+  <indexterm zone="index" significance="preferred">
+    <primary>Alexandria</primary>
+  </indexterm>
+
+  <!-- ============= Document Body ============================= -->
+
+  &introduction;
+  &gettingstarted;
+  &addingbooks;
+  &editingbookproperties;
+  &workingwithlibraries;
+  &searching;
+  &smartlibraries;
+  &exporting;
+  &settings;
+  &bugs;
+  &about;
+
+  &gnufdl;
+
+</article>