alexandria-book-collection-manager 0.6.9.pre1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (293) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +10 -0
  3. data/.rubocop.yml +68 -0
  4. data/.rubocop_todo.yml +200 -0
  5. data/CHANGELOG.md +23 -0
  6. data/COPYING +339 -0
  7. data/ChangeLog.0 +3598 -0
  8. data/Gemfile +9 -0
  9. data/INSTALL.rdoc +156 -0
  10. data/PACKAGING +36 -0
  11. data/README.md +88 -0
  12. data/RELEASE_CHECKLIST +18 -0
  13. data/Rakefile +264 -0
  14. data/TODO +24 -0
  15. data/alexandria-book-collection-manager.gemspec +35 -0
  16. data/alexandria.desktop.in +10 -0
  17. data/bin/alexandria +82 -0
  18. data/doc/AUTHORS +60 -0
  19. data/doc/BUGS +31 -0
  20. data/doc/FAQ +369 -0
  21. data/doc/HACKING +19 -0
  22. data/doc/NEWS +341 -0
  23. data/doc/alexandria.1 +120 -0
  24. data/doc/cuecat_support.rdoc +67 -0
  25. data/lib/alexandria.rb +85 -0
  26. data/lib/alexandria/about.rb +82 -0
  27. data/lib/alexandria/book_providers.rb +411 -0
  28. data/lib/alexandria/book_providers/adlibris.rb +235 -0
  29. data/lib/alexandria/book_providers/amazon_aws.rb +261 -0
  30. data/lib/alexandria/book_providers/amazon_ecs_util.rb +405 -0
  31. data/lib/alexandria/book_providers/barnes_and_noble.rb +229 -0
  32. data/lib/alexandria/book_providers/bol_it.rb +162 -0
  33. data/lib/alexandria/book_providers/deastore.rb +277 -0
  34. data/lib/alexandria/book_providers/douban.rb +135 -0
  35. data/lib/alexandria/book_providers/ibs_it.rb +149 -0
  36. data/lib/alexandria/book_providers/mcu.rb +177 -0
  37. data/lib/alexandria/book_providers/proxis.rb +205 -0
  38. data/lib/alexandria/book_providers/pseudomarc.rb +185 -0
  39. data/lib/alexandria/book_providers/renaud.rb +142 -0
  40. data/lib/alexandria/book_providers/siciliano.rb +271 -0
  41. data/lib/alexandria/book_providers/thalia.rb +197 -0
  42. data/lib/alexandria/book_providers/web.rb +59 -0
  43. data/lib/alexandria/book_providers/webster_it.rb +173 -0
  44. data/lib/alexandria/book_providers/worldcat.rb +251 -0
  45. data/lib/alexandria/book_providers/z3950.rb +422 -0
  46. data/lib/alexandria/config.rb +8 -0
  47. data/lib/alexandria/console.rb +31 -0
  48. data/lib/alexandria/execution_queue.rb +96 -0
  49. data/lib/alexandria/export_library.rb +536 -0
  50. data/lib/alexandria/import_library.rb +316 -0
  51. data/lib/alexandria/import_library_csv.rb +270 -0
  52. data/lib/alexandria/logging.rb +159 -0
  53. data/lib/alexandria/models/book.rb +72 -0
  54. data/lib/alexandria/models/library.rb +714 -0
  55. data/lib/alexandria/net.rb +53 -0
  56. data/lib/alexandria/preferences.rb +324 -0
  57. data/lib/alexandria/scanners.rb +42 -0
  58. data/lib/alexandria/scanners/cuecat.rb +118 -0
  59. data/lib/alexandria/scanners/keyboard.rb +57 -0
  60. data/lib/alexandria/smart_library.rb +525 -0
  61. data/lib/alexandria/ui.rb +53 -0
  62. data/lib/alexandria/ui/builder_base.rb +43 -0
  63. data/lib/alexandria/ui/callbacks.rb +389 -0
  64. data/lib/alexandria/ui/completion_models.rb +228 -0
  65. data/lib/alexandria/ui/dialogs/about_dialog.rb +59 -0
  66. data/lib/alexandria/ui/dialogs/acquire_dialog.rb +640 -0
  67. data/lib/alexandria/ui/dialogs/alert_dialog.rb +68 -0
  68. data/lib/alexandria/ui/dialogs/bad_isbns_dialog.rb +43 -0
  69. data/lib/alexandria/ui/dialogs/barcode_animation.rb +159 -0
  70. data/lib/alexandria/ui/dialogs/book_properties_dialog.rb +210 -0
  71. data/lib/alexandria/ui/dialogs/book_properties_dialog_base.rb +432 -0
  72. data/lib/alexandria/ui/dialogs/export_dialog.rb +172 -0
  73. data/lib/alexandria/ui/dialogs/import_dialog.rb +205 -0
  74. data/lib/alexandria/ui/dialogs/misc_dialogs.rb +85 -0
  75. data/lib/alexandria/ui/dialogs/new_book_dialog.rb +639 -0
  76. data/lib/alexandria/ui/dialogs/new_book_dialog_manual.rb +153 -0
  77. data/lib/alexandria/ui/dialogs/new_smart_library_dialog.rb +67 -0
  78. data/lib/alexandria/ui/dialogs/preferences_dialog.rb +587 -0
  79. data/lib/alexandria/ui/dialogs/smart_library_properties_dialog.rb +56 -0
  80. data/lib/alexandria/ui/dialogs/smart_library_properties_dialog_base.rb +432 -0
  81. data/lib/alexandria/ui/dndable.rb +81 -0
  82. data/lib/alexandria/ui/gtk_thread_help.rb +88 -0
  83. data/lib/alexandria/ui/icons.rb +100 -0
  84. data/lib/alexandria/ui/iconview.rb +91 -0
  85. data/lib/alexandria/ui/iconview_tooltips.rb +162 -0
  86. data/lib/alexandria/ui/init.rb +93 -0
  87. data/lib/alexandria/ui/libraries_combo.rb +75 -0
  88. data/lib/alexandria/ui/listview.rb +310 -0
  89. data/lib/alexandria/ui/main_app.rb +67 -0
  90. data/lib/alexandria/ui/multi_drag_treeview.rb +150 -0
  91. data/lib/alexandria/ui/sidepane.rb +194 -0
  92. data/lib/alexandria/ui/sound.rb +107 -0
  93. data/lib/alexandria/ui/ui_manager.rb +1308 -0
  94. data/lib/alexandria/undo_manager.rb +78 -0
  95. data/lib/alexandria/utils.rb +30 -0
  96. data/lib/alexandria/version.rb +24 -0
  97. data/lib/alexandria/web_themes.rb +75 -0
  98. data/misc/sounds/README +15 -0
  99. data/misc/sounds/bad_scan.csd +62 -0
  100. data/misc/sounds/good_scan.csd +61 -0
  101. data/misc/sounds/scanning.csd +46 -0
  102. data/po/ChangeLog +488 -0
  103. data/po/Makefile +44 -0
  104. data/po/README +29 -0
  105. data/po/commit-po +72 -0
  106. data/po/cs.po +1437 -0
  107. data/po/cy.po +1521 -0
  108. data/po/de.po +1400 -0
  109. data/po/el.po +1379 -0
  110. data/po/es.po +1376 -0
  111. data/po/fr.po +1420 -0
  112. data/po/ga.po +1359 -0
  113. data/po/gl.po +1397 -0
  114. data/po/it.po +1406 -0
  115. data/po/ja.po +1355 -0
  116. data/po/mk.po +1373 -0
  117. data/po/nb.po +1386 -0
  118. data/po/nl.po +1405 -0
  119. data/po/pl.po +1373 -0
  120. data/po/pt.po +1398 -0
  121. data/po/pt_BR.po +1409 -0
  122. data/po/ru.po +1372 -0
  123. data/po/sk.po +1380 -0
  124. data/po/sv.po +1402 -0
  125. data/po/uk.po +1423 -0
  126. data/po/zh_TW.po +1394 -0
  127. data/schemas/alexandria.schemas +300 -0
  128. data/share/alexandria/glade/acquire_dialog__builder.glade +201 -0
  129. data/share/alexandria/glade/book_properties_dialog__builder.glade +910 -0
  130. data/share/alexandria/glade/main_app__builder.glade +229 -0
  131. data/share/alexandria/glade/new_book_dialog__builder.glade +379 -0
  132. data/share/alexandria/glade/preferences_dialog__builder.glade +733 -0
  133. data/share/alexandria/icons/alexandria.png +0 -0
  134. data/share/alexandria/icons/alexandria_small.png +0 -0
  135. data/share/alexandria/icons/book.png +0 -0
  136. data/share/alexandria/icons/book_icon.png +0 -0
  137. data/share/alexandria/icons/book_small.png +0 -0
  138. data/share/alexandria/icons/cuecat.png +0 -0
  139. data/share/alexandria/icons/cuecat_inactive.png +0 -0
  140. data/share/alexandria/icons/favorite_tag.png +0 -0
  141. data/share/alexandria/icons/less.png +0 -0
  142. data/share/alexandria/icons/library.png +0 -0
  143. data/share/alexandria/icons/library_small.png +0 -0
  144. data/share/alexandria/icons/lookup.png +0 -0
  145. data/share/alexandria/icons/more.png +0 -0
  146. data/share/alexandria/icons/no_cover.png +0 -0
  147. data/share/alexandria/icons/smart_library.png +0 -0
  148. data/share/alexandria/icons/smart_library_small.png +0 -0
  149. data/share/alexandria/icons/star_set.png +0 -0
  150. data/share/alexandria/icons/star_unset.png +0 -0
  151. data/share/alexandria/icons/view_as_icons.png +0 -0
  152. data/share/alexandria/icons/view_as_list.png +0 -0
  153. data/share/alexandria/ui/menus.xml +91 -0
  154. data/share/alexandria/ui/popups.xml +91 -0
  155. data/share/alexandria/web-themes/clean/clean.css +85 -0
  156. data/share/alexandria/web-themes/clean/preview.jpg +0 -0
  157. data/share/alexandria/web-themes/list/list.css +105 -0
  158. data/share/alexandria/web-themes/list/preview.jpg +0 -0
  159. data/share/app-icon/16x16/alexandria.png +0 -0
  160. data/share/app-icon/16x16/alexandria.svg +263 -0
  161. data/share/app-icon/22x22/alexandria.png +0 -0
  162. data/share/app-icon/22x22/alexandria.svg +465 -0
  163. data/share/app-icon/24x24/alexandria.png +0 -0
  164. data/share/app-icon/32x32/alexandria.png +0 -0
  165. data/share/app-icon/32x32/alexandria.svg +813 -0
  166. data/share/app-icon/32x32/alexandria.xpm +241 -0
  167. data/share/app-icon/48x48/alexandria.png +0 -0
  168. data/share/app-icon/scalable/alexandria.svg +700 -0
  169. data/share/gnome/help/alexandria/C/about.xml +44 -0
  170. data/share/gnome/help/alexandria/C/adding-books.xml +339 -0
  171. data/share/gnome/help/alexandria/C/alexandria.xml +185 -0
  172. data/share/gnome/help/alexandria/C/bugs.xml +18 -0
  173. data/share/gnome/help/alexandria/C/editing-book-properties.xml +124 -0
  174. data/share/gnome/help/alexandria/C/exporting.xml +81 -0
  175. data/share/gnome/help/alexandria/C/figures/adding_books_acquire_from_scanner_process.png +0 -0
  176. data/share/gnome/help/alexandria/C/figures/adding_books_add_by_isbn.png +0 -0
  177. data/share/gnome/help/alexandria/C/figures/adding_books_isbn_import.png +0 -0
  178. data/share/gnome/help/alexandria/C/figures/adding_books_manual_details.png +0 -0
  179. data/share/gnome/help/alexandria/C/figures/adding_books_rename_library_after_import.png +0 -0
  180. data/share/gnome/help/alexandria/C/figures/adding_books_search_results.png +0 -0
  181. data/share/gnome/help/alexandria/C/figures/editing_book_properties_info.png +0 -0
  182. data/share/gnome/help/alexandria/C/figures/editing_book_properties_loaning.png +0 -0
  183. data/share/gnome/help/alexandria/C/figures/exporting_information_html.png +0 -0
  184. data/share/gnome/help/alexandria/C/figures/getting_started_first_launched.png +0 -0
  185. data/share/gnome/help/alexandria/C/figures/searching_filtering_views_list_view.png +0 -0
  186. data/share/gnome/help/alexandria/C/figures/searching_filtering_views_list_view_search.png +0 -0
  187. data/share/gnome/help/alexandria/C/figures/settings_providers_new_z3950.png +0 -0
  188. data/share/gnome/help/alexandria/C/figures/smart_libraries_new_smart_library.png +0 -0
  189. data/share/gnome/help/alexandria/C/figures/working_with_libraries_library_pane.png +0 -0
  190. data/share/gnome/help/alexandria/C/getting-started.xml +154 -0
  191. data/share/gnome/help/alexandria/C/gnu-fdl-1.2.xml +543 -0
  192. data/share/gnome/help/alexandria/C/introduction.xml +142 -0
  193. data/share/gnome/help/alexandria/C/searching.xml +90 -0
  194. data/share/gnome/help/alexandria/C/settings.xml +140 -0
  195. data/share/gnome/help/alexandria/C/smart-libraries.xml +160 -0
  196. data/share/gnome/help/alexandria/C/working-with-libraries.xml +76 -0
  197. data/share/gnome/help/alexandria/ChangeLog +99 -0
  198. data/share/gnome/help/alexandria/fr/alexandria.xml +2292 -0
  199. data/share/gnome/help/alexandria/fr/figures/alexandria_add_button.png +0 -0
  200. data/share/gnome/help/alexandria/fr/figures/alexandria_add_by_isbn_1.png +0 -0
  201. data/share/gnome/help/alexandria/fr/figures/alexandria_add_by_search_1.png +0 -0
  202. data/share/gnome/help/alexandria/fr/figures/alexandria_add_manually.png +0 -0
  203. data/share/gnome/help/alexandria/fr/figures/alexandria_add_z3950.png +0 -0
  204. data/share/gnome/help/alexandria/fr/figures/alexandria_close_button.png +0 -0
  205. data/share/gnome/help/alexandria/fr/figures/alexandria_edit_info.png +0 -0
  206. data/share/gnome/help/alexandria/fr/figures/alexandria_export_web_page.png +0 -0
  207. data/share/gnome/help/alexandria/fr/figures/alexandria_importing.png +0 -0
  208. data/share/gnome/help/alexandria/fr/figures/alexandria_library_pane.png +0 -0
  209. data/share/gnome/help/alexandria/fr/figures/alexandria_list_view.png +0 -0
  210. data/share/gnome/help/alexandria/fr/figures/alexandria_list_view_search.png +0 -0
  211. data/share/gnome/help/alexandria/fr/figures/alexandria_loaning.png +0 -0
  212. data/share/gnome/help/alexandria/fr/figures/alexandria_main_window.png +0 -0
  213. data/share/gnome/help/alexandria/fr/figures/alexandria_remove_button.png +0 -0
  214. data/share/gnome/help/alexandria/ja/about.xml +33 -0
  215. data/share/gnome/help/alexandria/ja/adding-books.xml +314 -0
  216. data/share/gnome/help/alexandria/ja/alexandria.xml +172 -0
  217. data/share/gnome/help/alexandria/ja/bugs.xml +11 -0
  218. data/share/gnome/help/alexandria/ja/editing-book-properties.xml +100 -0
  219. data/share/gnome/help/alexandria/ja/exporting.xml +98 -0
  220. data/share/gnome/help/alexandria/ja/figures/adding_books_acquire_from_scanner_process.png +0 -0
  221. data/share/gnome/help/alexandria/ja/figures/adding_books_add_by_isbn.png +0 -0
  222. data/share/gnome/help/alexandria/ja/figures/adding_books_isbn_import.png +0 -0
  223. data/share/gnome/help/alexandria/ja/figures/adding_books_manual_details.png +0 -0
  224. data/share/gnome/help/alexandria/ja/figures/adding_books_rename_library_after_import.png +0 -0
  225. data/share/gnome/help/alexandria/ja/figures/adding_books_search_results.png +0 -0
  226. data/share/gnome/help/alexandria/ja/figures/editing_book_properties_info.png +0 -0
  227. data/share/gnome/help/alexandria/ja/figures/editing_book_properties_loaning.png +0 -0
  228. data/share/gnome/help/alexandria/ja/figures/exporting_information_html.png +0 -0
  229. data/share/gnome/help/alexandria/ja/figures/getting_started_first_launched.png +0 -0
  230. data/share/gnome/help/alexandria/ja/figures/searching_filtering_views_list_view.png +0 -0
  231. data/share/gnome/help/alexandria/ja/figures/searching_filtering_views_list_view_search.png +0 -0
  232. data/share/gnome/help/alexandria/ja/figures/settings_providers_new_z3950.png +0 -0
  233. data/share/gnome/help/alexandria/ja/figures/smart_libraries_new_smart_library.png +0 -0
  234. data/share/gnome/help/alexandria/ja/figures/working_with_libraries_library_pane.png +0 -0
  235. data/share/gnome/help/alexandria/ja/getting-started.xml +144 -0
  236. data/share/gnome/help/alexandria/ja/gnu-fdl-1.2.xml +541 -0
  237. data/share/gnome/help/alexandria/ja/introduction.xml +134 -0
  238. data/share/gnome/help/alexandria/ja/searching.xml +104 -0
  239. data/share/gnome/help/alexandria/ja/settings.xml +129 -0
  240. data/share/gnome/help/alexandria/ja/smart-libraries.xml +140 -0
  241. data/share/gnome/help/alexandria/ja/working-with-libraries.xml +88 -0
  242. data/share/menu/alexandria +7 -0
  243. data/share/omf/alexandria/alexandria-C.omf.in +27 -0
  244. data/share/omf/alexandria/alexandria-fr.omf.in +30 -0
  245. data/share/sounds/alexandria/bad_scan.ogg +0 -0
  246. data/share/sounds/alexandria/bad_scan.wav +0 -0
  247. data/share/sounds/alexandria/good_scan.ogg +0 -0
  248. data/share/sounds/alexandria/good_scan.wav +0 -0
  249. data/share/sounds/alexandria/scanning.ogg +0 -0
  250. data/share/sounds/alexandria/scanning.wav +0 -0
  251. data/spec/alexandria/library_spec.rb +205 -0
  252. data/spec/alexandria/preferences_spec.rb +22 -0
  253. data/spec/alexandria/scanners/cuecat_spec.rb +68 -0
  254. data/spec/alexandria/smart_library_spec.rb +22 -0
  255. data/spec/alexandria/ui/dialogs_spec.rb +90 -0
  256. data/spec/alexandria/ui/iconview_spec.rb +27 -0
  257. data/spec/alexandria/ui/listview_spec.rb +28 -0
  258. data/spec/alexandria/ui/main_app_spec.rb +48 -0
  259. data/spec/alexandria/ui/sidepane_spec.rb +27 -0
  260. data/spec/alexandria/ui/ui_manager_spec.rb +26 -0
  261. data/spec/alexandria/ui/ui_utilities_spec.rb +60 -0
  262. data/spec/alexandria/utilities_spec.rb +50 -0
  263. data/spec/data/libraries/0.6.1-noisbn/My Library/0201398257.yaml +10 -0
  264. data/spec/data/libraries/0.6.1-noisbn/My Library/1565920007.yaml +10 -0
  265. data/spec/data/libraries/0.6.1/My Library/0192812173.yaml +9 -0
  266. data/spec/data/libraries/0.6.1/My Library/0201398257.cover +0 -0
  267. data/spec/data/libraries/0.6.1/My Library/0201398257.yaml +10 -0
  268. data/spec/data/libraries/0.6.1/My Library/1565920007.yaml +10 -0
  269. data/spec/data/libraries/0.6.2/My Library/9780140266146.cover +0 -0
  270. data/spec/data/libraries/0.6.2/My Library/9780140266146.yaml +16 -0
  271. data/spec/data/libraries/0.6.2/My Library/9780140278781.cover +0 -0
  272. data/spec/data/libraries/0.6.2/My Library/9780140278781.yaml +21 -0
  273. data/spec/data/libraries/0.6.2/My Library/9780571147168.cover +0 -0
  274. data/spec/data/libraries/0.6.2/My Library/9780571147168.yaml +20 -0
  275. data/spec/data/libraries/0.6.2/My Library/9780575079038.cover +0 -0
  276. data/spec/data/libraries/0.6.2/My Library/9780575079038.yaml +20 -0
  277. data/spec/data/libraries/0.6.2/My Library/9780755322800.cover +0 -0
  278. data/spec/data/libraries/0.6.2/My Library/9780755322800.yaml +20 -0
  279. data/spec/spec_helper.rb +46 -0
  280. data/tasks/rdoc.rake +6 -0
  281. data/tasks/setup.rb +30 -0
  282. data/tasks/spec.rake +29 -0
  283. data/tasks/test.rake +38 -0
  284. data/test/application_test.rb +39 -0
  285. data/test/book_test.rb +34 -0
  286. data/test/data/isbns.txt +3 -0
  287. data/test/isbn_test.rb +68 -0
  288. data/test/providers_test.rb +254 -0
  289. data/test/test_helper.rb +42 -0
  290. data/util/rake/fileinstall.rb +313 -0
  291. data/util/rake/gettextgenerate.rb +158 -0
  292. data/util/rake/omfgenerate.rb +79 -0
  293. metadata +452 -0
@@ -0,0 +1,18 @@
1
+ <!--
2
+ This is part of the Alexandria Manual.
3
+ Copyright (C) 2005 Liam Davison
4
+ Copyright (C) 2007 Cathal Mc Ginley
5
+ See the file alexandria.xml for copying conditions.
6
+ -->
7
+
8
+ <!-- ============= Bugs ================================== -->
9
+ <!-- This section is optional and is commented out by default.
10
+ You can use it to describe known bugs and limitations of the
11
+ program if there are any - please be frank and list all
12
+ problems you know of.
13
+
14
+ <section id="alexandria-bugs">
15
+ <title>Known Bugs and Limitations</title>
16
+ <para> </para>
17
+ </section>
18
+ -->
@@ -0,0 +1,124 @@
1
+ <!--
2
+ This is part of the Alexandria Manual.
3
+ Copyright (C) 2005 Liam Davison
4
+ Copyright (C) 2007 Cathal Mc Ginley
5
+ See the file alexandria.xml for copying conditions.
6
+ -->
7
+
8
+ <!-- ============= Editing Book Properties Subsection =========== -->
9
+
10
+ <section id="editing-book-properties">
11
+ <title>Editing Book Properties</title>
12
+ <para>You can use &app; to edit and update your book information:
13
+ <itemizedlist>
14
+ <listitem><para><xref linkend="editing-info"/></para></listitem>
15
+ <listitem><para><xref linkend="changing-cover-image"/></para></listitem>
16
+ <listitem><para><xref linkend="loaning-books"/></para></listitem>
17
+ <listitem><para><xref linkend="editing-notes"/></para></listitem>
18
+ </itemizedlist></para>
19
+
20
+ <!-- ======== Editing information ========= -->
21
+ <section id="editing-info">
22
+ <title>Editing basic information</title>
23
+ <para>To edit a book, simply double-click on the book image in the
24
+ main window, or choose
25
+ <menuchoice><guimenu>Library</guimenu><guimenuitem>Properties</guimenuitem></menuchoice>.
26
+ The following window will appear, where you can change the books'
27
+ Title, ISBN, Authors, Publisher, Binding and Rating.</para>
28
+ <figure id="editing-info-fig">
29
+ <title>Editing a book with &app;</title>
30
+ <screenshot>
31
+ <mediaobject>
32
+ <imageobject>
33
+ <imagedata fileref="figures/editing_book_properties_info.png" format="PNG"/>
34
+ </imageobject>
35
+ <!-- EPS versions of the figures are not required at the moment. -->
36
+ <!--
37
+ <imageobject>
38
+ <imagedata fileref="figures/image.eps" format="EPS"/>
39
+ </imageobject>
40
+ -->
41
+ <textobject>
42
+ <phrase>Shows &app; editing a book.</phrase>
43
+ </textobject>
44
+ </mediaobject>
45
+ </screenshot>
46
+ </figure>
47
+ <para>To add a author, click on the <guibutton>+</guibutton> next
48
+ to the author list, then type the new name. To remove an author,
49
+ select the name and click <guibutton>-</guibutton>. To edit a
50
+ name, click twice on the name.</para>
51
+ <tip><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. Your favourite books - those with five stars - will have a small heart icon in the Icon view of the main window.</para></tip>
52
+ </section>
53
+
54
+ <!-- ======== Editing from list view ========= -->
55
+ <section id="editing-from-list-view">
56
+ <title>Editing from the List View</title>
57
+
58
+ <para>You can change the properties for Read, Own and Want from
59
+ the List View by clicking on the check box for the given
60
+ property. As in the book properties dialog, however, clicking on
61
+ Want will have no effect if Own is selected.</para>
62
+
63
+ <para>A book's Rating is not editable directly from the List View
64
+ simply by clicking on the rating stars. However, right-clicking
65
+ from either the List or Icon View will bring up a popup menu, from
66
+ which you can change the Rating of a book. </para>
67
+
68
+ </section>
69
+
70
+ <!-- ======== Changing cover images ========= -->
71
+ <section id="changing-cover-image">
72
+ <title>Changing cover images</title>
73
+ <para>To supply a book cover image, click on the existing cover
74
+ image (or the image of a book if no cover is available). A
75
+ standard file selection dialog will open. Navigate to the cover
76
+ image file on your system - which can be in JPEG, PNG or GIF
77
+ format - and click <guibutton>Open</guibutton>. The image will be
78
+ scaled to fit into the <guilabel>Edit Book</guilabel>
79
+ dialog.</para>
80
+ </section>
81
+
82
+ <!-- ======== Loaning books ========= -->
83
+ <section id="loaning-books">
84
+ <title>Loaning books</title>
85
+ <para>To mark a book as loaned, firstly open the Edit Book dialog
86
+ as in <xref linkend="editing-info"/>. Then click on the
87
+ <guilabel>Loaning</guilabel> tab. Click on the <guilabel>This book
88
+ is loaned</guilabel> checkbox to mark the book as loaned. You can
89
+ fill in the <guilabel>To</guilabel> field to specify who the book
90
+ is loaned to. And click on the <guilabel>Since</guilabel>
91
+ drop-down menu to specify the date the book was loaned on.</para>
92
+ <figure id="loaning-fig">
93
+ <title>Loaning a book in &app;</title>
94
+ <screenshot>
95
+ <mediaobject>
96
+ <imageobject>
97
+ <imagedata fileref="figures/editing_book_properties_loaning.png" format="PNG"/>
98
+ </imageobject>
99
+ <!-- EPS versions of the figures are not required at the moment. -->
100
+ <!--
101
+ <imageobject>
102
+ <imagedata fileref="figures/image.eps" format="EPS"/>
103
+ </imageobject>
104
+ -->
105
+ <textobject>
106
+ <phrase>Shows &app; loaning a book.</phrase>
107
+ </textobject>
108
+ </mediaobject>
109
+ </screenshot>
110
+ </figure>
111
+ </section>
112
+
113
+ <!-- ========== Adding notes ========== -->
114
+ <section id="editing-notes">
115
+ <title>Adding and editing notes</title>
116
+ <para>&app; allows you to store addition notes about your books -
117
+ maybe a personal review, or useful page references. To add or edit
118
+ a note, firstly open the Edit Book dialogue as in <xref
119
+ linkend="editing-info"/>. Then click on the
120
+ <guilabel>Notes</guilabel> tab. You can type your plain-text notes
121
+ in this field.</para>
122
+ </section>
123
+
124
+ </section>
@@ -0,0 +1,81 @@
1
+ <!--
2
+ This is part of the Alexandria Manual.
3
+ Copyright (C) 2005 Liam Davison
4
+ Copyright (C) 2007 Cathal Mc Ginley
5
+ See the file alexandria.xml for copying conditions.
6
+ -->
7
+
8
+ <!-- ============= Exporting information Subsection ============= -->
9
+
10
+ <section id="exporting">
11
+ <title>Exporting Information</title>
12
+ <para>Information in &app; can be exported for use in other applications. Information can be exported in several formats:
13
+ <itemizedlist>
14
+ <listitem><para><xref linkend="exporting-as-onix"/></para></listitem>
15
+ <listitem><para><xref linkend="exporting-as-Tellico"/></para></listitem>
16
+ <listitem><para><xref linkend="exporting-as-bibtex"/></para></listitem>
17
+ <listitem><para><xref linkend="exporting-as-plaintext"/></para></listitem>
18
+ <listitem><para><xref linkend="exporting-as-web-page"/>, using XHTML and CSS stylesheets</para></listitem>
19
+ </itemizedlist>
20
+ </para>
21
+
22
+ <section id="exporting-as-onix">
23
+ <title>Exporting as a compressed ONIX archive</title>
24
+
25
+ <para>
26
+ ONIX is an international standard used by publishers
27
+ and retailers to define information - title, price,
28
+ contributors, reviews and many others - about
29
+ books. For more information about ONIX and its uses,
30
+ see <ulink url="http://www.editeur.org/"
31
+ type="http">http://www.editeur.org/</ulink> .</para>
32
+
33
+ <para>&app; can gather up all your book information and export it as an archived (.tar.bz2) collection of ONIX files (called ONIX messages). To export your library as an ONIX archive, choose <menuchoice><guimenu>Library</guimenu><guimenuitem>Export</guimenuitem></menuchoice> from the main menu, then choose <guimenuitem>Archived ONIX XML (.onix.tbz2)</guimenuitem> from the <guilabel>Export format</guilabel> menu. Specify a file name and a location to save the archive, and press <guibutton>Export</guibutton>.</para>
34
+ </section>
35
+
36
+ <section id="exporting-as-Tellico">
37
+ <title>Exporting as a compressed Tellico file</title>
38
+ <para>Tellico is a standard file format, based on XML, for storing information about book and other collections. &app; can both import and export information in the Tellico format.</para>
39
+ <para>To export your library as a compressed (.tc) file, choose <guimenuitem>Archived Tellico XML (.tc)</guimenuitem> from the <guilabel>Export format</guilabel> menu in the Export dialogue.</para>
40
+ </section>
41
+
42
+ <section id="exporting-as-bibtex">
43
+ <title>Exporting as a BibTeX file</title>
44
+ <para>BibTeX is a LaTeX based file format for storing bibliographic information.</para>
45
+ <para>To export your library as a BibTeX (.bib) file, choose <guimenuitem>BibTeX (.bib)</guimenuitem> from the <guilabel>Export format</guilabel> menu in the Export dialogue.</para>
46
+ </section>
47
+
48
+ <section id="exporting-as-plaintext">
49
+ <title>Exporting a list of ISBNs</title>
50
+ <para>&app; can export a plain test list of ISBNs - perhaps to transfer to another machine. To export a list of ISBNs, choose <guimenuitem>ISBN list (.txt)</guimenuitem> from the <guilabel>Export format</guilabel> menu in the Export dialogue.</para>
51
+ </section>
52
+
53
+ <section id="exporting-as-web-page">
54
+ <title>Exporting a library as a web page</title>
55
+ <para>&app; can create a web page from your book library, listing each book complete with cover images. To do this, it creates a directory of images, an XHMTL web page, and a CSS stylesheet. You can choose from different stylesheets to customise the appearance of the web page.</para>
56
+ <para>To export your library as a web page, <menuchoice><guimenu>Library</guimenu><guimenuitem>Export</guimenuitem></menuchoice> from the main menu, then choose <guimenuitem>HTML Web Page (directory)</guimenuitem> from the <guilabel>Export format</guilabel> menu. Choose a style - or theme - for the web page from the <guimenuitem>Theme</guimenuitem> menu.</para>
57
+ <figure id="export-as-web-page-fig">
58
+ <title>Using &app; to create a web page</title>
59
+ <screenshot>
60
+ <mediaobject>
61
+ <imageobject>
62
+ <imagedata fileref="figures/exporting_information_html.png" format="PNG"/>
63
+ </imageobject>
64
+ <!-- EPS versions of the figures are not required at the moment. -->
65
+ <!--
66
+ <imageobject>
67
+ <imagedata fileref="figures/image.eps" format="EPS"/>
68
+ </imageobject>
69
+ -->
70
+ <textobject>
71
+ <phrase>Shows &app; exporting a library as a web page.</phrase>
72
+ </textobject>
73
+ </mediaobject>
74
+ </screenshot>
75
+ </figure>
76
+ <para>Type in a name for the directory the web page will be saved in, and press the <guibutton>Export</guibutton> to save the files.</para>
77
+ <tip>
78
+ <para>Only one theme, called Clean, is available at present.</para>
79
+ </tip>
80
+ </section>
81
+ </section>
@@ -0,0 +1,154 @@
1
+ <!--
2
+ This is part of the Alexandria Manual.
3
+ Copyright (C) 2005 Liam Davison
4
+ Copyright (C) 2007 Cathal Mc Ginley
5
+ See the file alexandria.xml for copying conditions.
6
+ -->
7
+
8
+ <!-- =========== Getting Started ============================== -->
9
+ <!-- Use the Getting Started section to describe the steps required
10
+ to start the application and to describe the user interface components
11
+ of the application. If there is other information that it is important
12
+ for readers to know before they start using the application, you should
13
+ also include this information here.
14
+ If the information about how to get started is very short, you can
15
+ include it in the Introduction and omit this section. -->
16
+ <section id="getting-started">
17
+ <title>Getting Started</title>
18
+ <section id="start">
19
+ <title>To Start &app;</title>
20
+ <para>You can start <application>&app;</application> in the following ways:
21
+ </para>
22
+ <variablelist>
23
+ <varlistentry>
24
+ <term><guimenu>Applications</guimenu> menu</term>
25
+ <listitem>
26
+ <para>Choose
27
+ <menuchoice>
28
+ <guisubmenu>Office </guisubmenu>
29
+ <guimenuitem>Alexandria Book Collection Manager</guimenuitem>
30
+ </menuchoice>. </para>
31
+ </listitem>
32
+ </varlistentry>
33
+ <varlistentry>
34
+ <term>Command line</term>
35
+ <listitem>
36
+ <para>To start <application>&app;</application> from a command line, type the following command,
37
+ then press <keycap>Return</keycap>:</para>
38
+ <para>
39
+ <command>alexandria</command>
40
+ </para>
41
+ </listitem>
42
+ </varlistentry>
43
+ </variablelist>
44
+ <para>&app; will open the most recently accessed library.</para>
45
+
46
+ </section>
47
+ <section id="when-start">
48
+ <title>When You Start &app;</title>
49
+ <para>When you start <application>&app;</application>, the following window is displayed.</para>
50
+ <!-- ==== Figure ==== -->
51
+ <figure id="mainwindow-fig">
52
+ <title>&app; Start Up Window</title>
53
+ <screenshot>
54
+ <mediaobject>
55
+ <imageobject>
56
+ <imagedata fileref="figures/getting_started_first_launched.png" format="PNG"/>
57
+ </imageobject>
58
+ <!-- EPS versions of the figures are not required at the moment. -->
59
+ <!--
60
+ <imageobject>
61
+ <imagedata fileref="figures/image.eps" format="EPS"/>
62
+ </imageobject>
63
+ -->
64
+ <textobject>
65
+ <phrase>Shows &app; main window. Contains titlebar,
66
+ menubar, toolbar, library list (including smart library
67
+ list) and an empty book display area. Menubar contains Library,
68
+ Edit, View and Help menus. </phrase>
69
+ </textobject>
70
+ </mediaobject>
71
+ </screenshot>
72
+ </figure>
73
+
74
+ <!-- ==== End of Figure ==== -->
75
+ <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
76
+ <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
77
+
78
+ <para>The &app; window contains the following elements:</para>
79
+
80
+ <variablelist>
81
+ <varlistentry>
82
+ <term>Menubar:</term>
83
+
84
+ <listitem>
85
+ <para>
86
+ The menus on the menubar contain all of the commands you need
87
+ to work with libraries and books in &app;.
88
+ </para>
89
+ </listitem>
90
+ </varlistentry>
91
+ <varlistentry>
92
+ <term>Toolbar:</term>
93
+ <listitem>
94
+ <para>The toolbar contains buttons to quickly add new books and
95
+ libraries to <application>&app;</application>, plus a search
96
+ tool to filter books displayed in the main display area.</para>
97
+ </listitem>
98
+ </varlistentry>
99
+
100
+ <varlistentry>
101
+ <term>Library List:</term>
102
+
103
+ <listitem>
104
+ <para>
105
+ The library list pane at the left edge of the window
106
+ displays the different libraries which have been set up in
107
+ &app;. Below the main libraries, there is a list of
108
+ <quote>smart libraries</quote> which are a kind of
109
+ filtered view on the main libraries.
110
+ </para>
111
+
112
+ <para>When &app; starts for the first time, it creates a
113
+ library called <quote>My Library</quote>, and a set of
114
+ useful smart libraries.</para>
115
+
116
+ </listitem>
117
+ </varlistentry>
118
+
119
+ <varlistentry>
120
+ <term>Book display:</term>
121
+
122
+ <listitem>
123
+ <para>
124
+ The main part of the display lists all the books in the
125
+ current library. <application>&app;</application> can display
126
+ your books either in an Icon or List view - the List View,
127
+ similar to that used in the
128
+ <application>Nautilus</application> file manager, displays
129
+ detailed information about each book on separate lines.
130
+ </para>
131
+
132
+ <para>
133
+ In the icon view, your favourite books - rated with five stars
134
+ - will be shown with a heart icon in the top corner.
135
+ </para>
136
+ </listitem>
137
+ </varlistentry>
138
+
139
+ <varlistentry>
140
+ <term>Statusbar:</term>
141
+
142
+ <listitem>
143
+ <para>
144
+ The statusbar displays information about the current
145
+ library in <application>&app;</application>, including
146
+ the number of books, and the number of books which have
147
+ not been rated.
148
+ </para>
149
+ </listitem>
150
+ </varlistentry>
151
+ </variablelist>
152
+
153
+ </section>
154
+ </section>
@@ -0,0 +1,543 @@
1
+ <!--
2
+ Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
3
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4
+ Everyone is permitted to copy and distribute verbatim copies
5
+ of this license document, but changing it is not allowed.
6
+ -->
7
+ <appendix id="gfdl">
8
+ <title>GNU Free Documentation License</title>
9
+ <subtitle>Version 1.2, November 2002</subtitle>
10
+ <para>
11
+ Copyright &copy; 2000, 2001, 2002 Free Software
12
+ Foundation, <abbrev>Inc.</abbrev>
13
+ <address>
14
+ <street>51 Franklin <abbrev>St</abbrev>, Fifth Floor</street>,
15
+ <city>Boston</city>,
16
+ <state><abbrev>MA</abbrev></state> <postcode>02111-1307</postcode>
17
+ <country><abbrev role="initialism">USA</abbrev></country>
18
+ </address>
19
+
20
+ Everyone is permitted to copy and distribute verbatim copies of
21
+ this license document, but changing it is not allowed.
22
+ </para>
23
+
24
+ <appendixinfo>
25
+ <title>GNU Free Documentation License</title>
26
+ <releaseinfo>
27
+ Version 1.2, November 2002
28
+ </releaseinfo>
29
+
30
+ <copyright>
31
+ <year>2000</year>
32
+ <year>2001</year>
33
+ <year>2002</year>
34
+ <holder>Free Software Foundation, <abbrev>Inc.</abbrev></holder>
35
+ </copyright>
36
+
37
+ <corpauthor>
38
+ <surname>Free Software Foundation</surname>
39
+ </corpauthor>
40
+
41
+ <legalnotice id="legalnotice">
42
+ <para>
43
+ Everyone is permitted to copy and distribute verbatim copies
44
+ of this license document, but changing it is not allowed.
45
+ </para>
46
+ </legalnotice>
47
+
48
+ </appendixinfo>
49
+
50
+
51
+ <section id="Preamble" label="0. ">
52
+ <title>PREAMBLE</title>
53
+ <para>
54
+ The purpose of this License is to make a manual, textbook, or other
55
+ functional and useful document "free" in the sense of freedom: to assure
56
+ everyone the effective freedom to copy and redistribute it, with or
57
+ without modifying it, either commercially or noncommercially.
58
+ Secondarily, this License preserves for the author and publisher a way to
59
+ get credit for their work, while not being considered responsible for
60
+ modifications made by others.
61
+ </para>
62
+ <para>
63
+ This License is a kind of "copyleft", which means that derivative works of
64
+ the document must themselves be free in the same sense. It complements
65
+ the GNU General Public License, which is a copyleft license designed for
66
+ free software.
67
+ </para>
68
+ <para>
69
+ We have designed this License in order to use it for manuals for free
70
+ software, because free software needs free documentation: a free program
71
+ should come with manuals providing the same freedoms that the software
72
+ does. But this License is not limited to software manuals; it can be used
73
+ for any textual work, regardless of subject matter or whether it is
74
+ published as a printed book. We recommend this License principally for
75
+ works whose purpose is instruction or reference.</para>
76
+ </section>
77
+ <section id="Definitions" label="1. ">
78
+ <title>APPLICABILITY AND DEFINITIONS</title>
79
+ <para>
80
+ This License applies to any manual or other work, in any medium, that
81
+ contains a notice placed by the copyright holder saying it can be
82
+ distributed under the terms of this License. Such a notice grants a
83
+ world-wide, royalty-free license, unlimited in duration, to use that work
84
+ under the conditions stated herein. The "Document", below, refers to any
85
+ such manual or work. Any member of the public is a licensee, and is
86
+ addressed as "you". You accept the license if you copy, modify or
87
+ distribute the work in a way requiring permission under copyright
88
+ law.
89
+ </para>
90
+ <para>
91
+ A "Modified Version" of the Document means any work containing the
92
+ Document or a portion of it, either copied verbatim, or with modifications
93
+ and/or translated into another language.
94
+ </para>
95
+ <para>
96
+ A "Secondary Section" is a named appendix or a front-matter section of the
97
+ Document that deals exclusively with the relationship of the publishers or
98
+ authors of the Document to the Document's overall subject (or to related
99
+ matters) and contains nothing that could fall directly within that overall
100
+ subject. (Thus, if the Document is in part a textbook of mathematics, a
101
+ Secondary Section may not explain any mathematics.) The relationship
102
+ could be a matter of historical connection with the subject or with
103
+ related matters, or of legal, commercial, philosophical, ethical or
104
+ political position regarding them.
105
+ </para>
106
+ <para>
107
+ The "Invariant Sections" are certain Secondary Sections whose titles are
108
+ designated, as being those of Invariant Sections, in the notice that says
109
+ that the Document is released under this License. If a section does not
110
+ fit the above definition of Secondary then it is not allowed to be
111
+ designated as Invariant. The Document may contain zero Invariant
112
+ Sections. If the Document does not identify any Invariant Sections then
113
+ there are none.
114
+ </para>
115
+ <para>
116
+ The "Cover Texts" are certain short passages of text that are listed, as
117
+ Front-Cover Texts or Back-Cover Texts, in the notice that says that the
118
+ Document is released under this License. A Front-Cover Text may be at
119
+ most 5 words, and a Back-Cover Text may be at most 25 words.
120
+ </para>
121
+ <para>
122
+ A "Transparent" copy of the Document means a machine-readable copy,
123
+ represented in a format whose specification is available to the general
124
+ public, that is suitable for revising the document straightforwardly with
125
+ generic text editors or (for images composed of pixels) generic paint
126
+ programs or (for drawings) some widely available drawing editor, and that
127
+ is suitable for input to text formatters or for automatic translation to a
128
+ variety of formats suitable for input to text formatters. A copy made in
129
+ an otherwise Transparent file format whose markup, or absence of markup,
130
+ has been arranged to thwart or discourage subsequent modification by
131
+ readers is not Transparent. An image format is not Transparent if used
132
+ for any substantial amount of text. A copy that is not "Transparent" is
133
+ called "Opaque".
134
+ </para>
135
+ <para>
136
+ Examples of suitable formats for Transparent copies include plain ASCII
137
+ without markup, Texinfo input format, LaTeX input format, SGML or XML
138
+ using a publicly available DTD, and standard-conforming simple HTML,
139
+ PostScript or PDF designed for human modification. Examples of
140
+ transparent image formats include PNG, XCF and JPG. Opaque formats
141
+ include proprietary formats that can be read and edited only by
142
+ proprietary word processors, SGML or XML for which the DTD and/or
143
+ processing tools are not generally available, and the machine-generated
144
+ HTML, PostScript or PDF produced by some word processors for output
145
+ purposes only.
146
+ </para>
147
+ <para>
148
+ The "Title Page" means, for a printed book, the title page itself, plus
149
+ such following pages as are needed to hold, legibly, the material this
150
+ License requires to appear in the title page. For works in formats which
151
+ do not have any title page as such, "Title Page" means the text near the
152
+ most prominent appearance of the work's title, preceding the beginning of
153
+ the body of the text.
154
+ </para>
155
+ <para>
156
+ A section "Entitled XYZ" means a named subunit of the Document whose title
157
+ either is precisely XYZ or contains XYZ in parentheses following text that
158
+ translates XYZ in another language. (Here XYZ stands for a specific
159
+ section name mentioned below, such as "Acknowledgements", "Dedications",
160
+ "Endorsements", or "History".) To "Preserve the Title" of such a section
161
+ when you modify the Document means that it remains a section "Entitled
162
+ XYZ" according to this definition.
163
+ </para>
164
+ <para>
165
+ The Document may include Warranty Disclaimers next to the notice which
166
+ states that this License applies to the Document. These Warranty
167
+ Disclaimers are considered to be included by reference in this License,
168
+ but only as regards disclaiming warranties: any other implication that
169
+ these Warranty Disclaimers may have is void and has no effect on the
170
+ meaning of this License.
171
+ </para>
172
+ </section>
173
+ <section id="VerbatimCopying" label="2. ">
174
+ <title>VERBATIM COPYING</title>
175
+ <para>
176
+ You may copy and distribute the Document in any medium, either
177
+ commercially or noncommercially, provided that this License, the copyright
178
+ notices, and the license notice saying this License applies to the
179
+ Document are reproduced in all copies, and that you add no other
180
+ conditions whatsoever to those of this License. You may not use technical
181
+ measures to obstruct or control the reading or further copying of the
182
+ copies you make or distribute. However, you may accept compensation in
183
+ exchange for copies. If you distribute a large enough number of copies
184
+ you must also follow the conditions in section 3.
185
+ </para>
186
+ <para>
187
+ You may also lend copies, under the same conditions stated above, and you
188
+ may publicly display copies.
189
+ </para>
190
+ </section>
191
+ <section id="QuantityCopying" label="3. ">
192
+ <title>COPYING IN QUANTITY</title>
193
+ <para>
194
+ If you publish printed copies (or copies in media that commonly have
195
+ printed covers) of the Document, numbering more than 100, and the
196
+ Document's license notice requires Cover Texts, you must enclose the
197
+ copies in covers that carry, clearly and legibly, all these Cover Texts:
198
+ Front-Cover Texts on the front cover, and Back-Cover Texts on the back
199
+ cover. Both covers must also clearly and legibly identify you as the
200
+ publisher of these copies. The front cover must present the full title
201
+ with all words of the title equally prominent and visible. You may add
202
+ other material on the covers in addition. Copying with changes limited to
203
+ the covers, as long as they preserve the title of the Document and satisfy
204
+ these conditions, can be treated as verbatim copying in other
205
+ respects.
206
+ </para>
207
+ <para>
208
+ If the required texts for either cover are too voluminous to fit legibly,
209
+ you should put the first ones listed (as many as fit reasonably) on the
210
+ actual cover, and continue the rest onto adjacent pages.
211
+ </para>
212
+ <para>
213
+ If you publish or distribute Opaque copies of the Document numbering more
214
+ than 100, you must either include a machine-readable Transparent copy
215
+ along with each Opaque copy, or state in or with each Opaque copy a
216
+ computer-network location from which the general network-using public has
217
+ access to download using public-standard network protocols a complete
218
+ Transparent copy of the Document, free of added material. If you use the
219
+ latter option, you must take reasonably prudent steps, when you begin
220
+ distribution of Opaque copies in quantity, to ensure that this Transparent
221
+ copy will remain thus accessible at the stated location until at least one
222
+ year after the last time you distribute an Opaque copy (directly or
223
+ through your agents or retailers) of that edition to the public.
224
+ </para>
225
+ <para>
226
+ It is requested, but not required, that you contact the authors of the
227
+ Document well before redistributing any large number of copies, to give
228
+ them a chance to provide you with an updated version of the
229
+ Document.
230
+ </para>
231
+ </section>
232
+ <section id="Modifications" label="4. ">
233
+ <title>MODIFICATIONS</title>
234
+ <para>
235
+ You may copy and distribute a Modified Version of the Document under the
236
+ conditions of sections 2 and 3 above, provided that you release the
237
+ Modified Version under precisely this License, with the Modified Version
238
+ filling the role of the Document, thus licensing distribution and
239
+ modification of the Modified Version to whoever possesses a copy of it.
240
+ In addition, you must do these things in the Modified Version:
241
+ </para>
242
+ <orderedlist numeration="upperalpha">
243
+ <listitem>
244
+ <simpara>
245
+ Use in the Title Page (and on the covers, if any) a title distinct
246
+ from that of the Document, and from those of previous versions (which
247
+ should, if there were any, be listed in the History section of the
248
+ Document). You may use the same title as a previous version if the
249
+ original publisher of that version gives permission.
250
+ </simpara>
251
+ </listitem>
252
+ <listitem>
253
+ <simpara>
254
+ List on the Title Page, as authors, one or more persons or entities
255
+ responsible for authorship of the modifications in the Modified
256
+ Version, together with at least five of the principal authors of the
257
+ Document (all of its principal authors, if it has fewer than five),
258
+ unless they release you from this requirement.
259
+ </simpara>
260
+ </listitem>
261
+ <listitem>
262
+ <simpara>
263
+ State on the Title page the name of the publisher of the Modified
264
+ Version, as the publisher.
265
+ </simpara>
266
+ </listitem>
267
+ <listitem>
268
+ <simpara>
269
+ Preserve all the copyright notices of the Document.
270
+ </simpara>
271
+ </listitem>
272
+ <listitem>
273
+ <simpara>
274
+ Add an appropriate copyright notice for your modifications adjacent to
275
+ the other copyright notices.
276
+ </simpara>
277
+ </listitem>
278
+ <listitem>
279
+ <simpara>
280
+ Include, immediately after the copyright notices, a license notice
281
+ giving the public permission to use the Modified Version under the
282
+ terms of this License, in the form shown in the Addendum below.
283
+ </simpara>
284
+ </listitem>
285
+ <listitem>
286
+ <simpara>
287
+ Preserve in that license notice the full lists of Invariant Sections
288
+ and required Cover Texts given in the Document's license notice.
289
+ </simpara>
290
+ </listitem>
291
+ <listitem>
292
+ <simpara>
293
+ Include an unaltered copy of this License.
294
+ </simpara>
295
+ </listitem>
296
+ <listitem>
297
+ <simpara>
298
+ Preserve the section Entitled "History", Preserve its Title, and add
299
+ to it an item stating at least the title, year, new authors, and
300
+ publisher of the Modified Version as given on the Title Page. If
301
+ there is no section Entitled "History" in the Document, create one
302
+ stating the title, year, authors, and publisher of the Document as
303
+ given on its Title Page, then add an item describing the Modified
304
+ Version as stated in the previous sentence.
305
+ </simpara>
306
+ </listitem>
307
+ <listitem>
308
+ <simpara>
309
+ Preserve the network location, if any, given in the Document for
310
+ public access to a Transparent copy of the Document, and likewise the
311
+ network locations given in the Document for previous versions it was
312
+ based on. These may be placed in the "History" section. You may omit
313
+ a network location for a work that was published at least four years
314
+ before the Document itself, or if the original publisher of the
315
+ version it refers to gives permission.
316
+ </simpara>
317
+ </listitem>
318
+ <listitem>
319
+ <simpara>
320
+ For any section Entitled "Acknowledgements" or "Dedications", Preserve
321
+ the Title of the section, and preserve in the section all the
322
+ substance and tone of each of the contributor acknowledgements and/or
323
+ dedications given therein.
324
+ </simpara>
325
+ </listitem>
326
+ <listitem>
327
+ <simpara>
328
+ Preserve all the Invariant Sections of the Document, unaltered in
329
+ their text and in their titles. Section numbers or the equivalent are
330
+ not considered part of the section titles.
331
+ </simpara>
332
+ </listitem>
333
+ <listitem>
334
+ <simpara>
335
+ Delete any section Entitled "Endorsements". Such a section may not be
336
+ included in the Modified Version.
337
+ </simpara>
338
+ </listitem>
339
+ <listitem>
340
+ <simpara>
341
+ Do not retitle any existing section to be Entitled "Endorsements" or
342
+ to conflict in title with any Invariant Section.
343
+ </simpara>
344
+ </listitem>
345
+ <listitem>
346
+ <simpara>
347
+ Preserve any Warranty Disclaimers.
348
+ </simpara>
349
+ </listitem>
350
+ </orderedlist>
351
+ <para>
352
+ If the Modified Version includes new front-matter sections or appendices
353
+ that qualify as Secondary Sections and contain no material copied from the
354
+ Document, you may at your option designate some or all of these sections
355
+ as invariant. To do this, add their titles to the list of Invariant
356
+ Sections in the Modified Version's license notice. These titles must be
357
+ distinct from any other section titles.
358
+ </para>
359
+ <para>
360
+ You may add a section Entitled "Endorsements", provided it contains
361
+ nothing but endorsements of your Modified Version by various parties--for
362
+ example, statements of peer review or that the text has been approved by
363
+ an organization as the authoritative definition of a standard.
364
+ </para>
365
+ <para>
366
+ You may add a passage of up to five words as a Front-Cover Text, and a
367
+ passage of up to 25 words as a Back-Cover Text, to the end of the list of
368
+ Cover Texts in the Modified Version. Only one passage of Front-Cover Text
369
+ and one of Back-Cover Text may be added by (or through arrangements made
370
+ by) any one entity. If the Document already includes a cover text for the
371
+ same cover, previously added by you or by arrangement made by the same
372
+ entity you are acting on behalf of, you may not add another; but you may
373
+ replace the old one, on explicit permission from the previous publisher
374
+ that added the old one.
375
+ </para>
376
+ <para>
377
+ The author(s) and publisher(s) of the Document do not by this License give
378
+ permission to use their names for publicity for or to assert or imply
379
+ endorsement of any Modified Version.
380
+ </para>
381
+ </section>
382
+ <section id="Combining" label="5. ">
383
+ <title>COMBINING DOCUMENTS</title>
384
+ <para>
385
+ You may combine the Document with other documents released under this
386
+ License, under the terms defined in section 4 above for modified versions,
387
+ provided that you include in the combination all of the Invariant Sections
388
+ of all of the original documents, unmodified, and list them all as
389
+ Invariant Sections of your combined work in its license notice, and that
390
+ you preserve all their Warranty Disclaimers.
391
+ </para>
392
+ <para>
393
+ The combined work need only contain one copy of this License, and multiple
394
+ identical Invariant Sections may be replaced with a single copy. If there
395
+ are multiple Invariant Sections with the same name but different contents,
396
+ make the title of each such section unique by adding at the end of it, in
397
+ parentheses, the name of the original author or publisher of that section
398
+ if known, or else a unique number. Make the same adjustment to the
399
+ section titles in the list of Invariant Sections in the license notice of
400
+ the combined work.
401
+ </para>
402
+ <para>
403
+ In the combination, you must combine any sections Entitled "History" in
404
+ the various original documents, forming one section Entitled "History";
405
+ likewise combine any sections Entitled "Acknowledgements", and any
406
+ sections Entitled "Dedications". You must delete all sections Entitled
407
+ "Endorsements".
408
+ </para>
409
+ </section>
410
+ <section id="Collections" label="6. ">
411
+ <title>COLLECTIONS OF DOCUMENTS</title>
412
+ <para>
413
+ You may make a collection consisting of the Document and other documents
414
+ released under this License, and replace the individual copies of this
415
+ License in the various documents with a single copy that is included in
416
+ the collection, provided that you follow the rules of this License for
417
+ verbatim copying of each of the documents in all other respects.
418
+ </para>
419
+ <para>
420
+ You may extract a single document from such a collection, and distribute
421
+ it individually under this License, provided you insert a copy of this
422
+ License into the extracted document, and follow this License in all other
423
+ respects regarding verbatim copying of that document.
424
+ </para>
425
+ </section>
426
+ <section id="Aggregation" label="7. ">
427
+ <title>AGGREGATION WITH INDEPENDENT WORKS</title>
428
+ <para>
429
+ A compilation of the Document or its derivatives with other separate and
430
+ independent documents or works, in or on a volume of a storage or
431
+ distribution medium, is called an "aggregate" if the copyright resulting
432
+ from the compilation is not used to limit the legal rights of the
433
+ compilation's users beyond what the individual works permit. When the
434
+ Document is included in an aggregate, this License does not apply to the
435
+ other works in the aggregate which are not themselves derivative works of
436
+ the Document.
437
+ </para>
438
+ <para>
439
+ If the Cover Text requirement of section 3 is applicable to these copies
440
+ of the Document, then if the Document is less than one half of the entire
441
+ aggregate, the Document's Cover Texts may be placed on covers that bracket
442
+ the Document within the aggregate, or the electronic equivalent of covers
443
+ if the Document is in electronic form. Otherwise they must appear on
444
+ printed covers that bracket the whole aggregate.
445
+ </para>
446
+ </section>
447
+ <section id="Translation" label="8. ">
448
+ <title>TRANSLATION</title>
449
+ <para>
450
+ Translation is considered a kind of modification, so you may distribute
451
+ translations of the Document under the terms of section 4. Replacing
452
+ Invariant Sections with translations requires special permission from
453
+ their copyright holders, but you may include translations of some or all
454
+ Invariant Sections in addition to the original versions of these Invariant
455
+ Sections. You may include a translation of this License, and all the
456
+ license notices in the Document, and any Warranty Disclaimers, provided
457
+ that you also include the original English version of this License and the
458
+ original versions of those notices and disclaimers. In case of a
459
+ disagreement between the translation and the original version of this
460
+ License or a notice or disclaimer, the original version will prevail.
461
+ </para>
462
+ <para>
463
+ If a section in the Document is Entitled "Acknowledgements",
464
+ "Dedications", or "History", the requirement (section 4) to Preserve its
465
+ Title (section 1) will typically require changing the actual title.
466
+ </para>
467
+ </section>
468
+ <section id="Termination" label="9. ">
469
+ <title>TERMINATION</title>
470
+ <para>
471
+ You may not copy, modify, sublicense, or distribute the Document except as
472
+ expressly provided for under this License. Any other attempt to copy,
473
+ modify, sublicense or distribute the Document is void, and will
474
+ automatically terminate your rights under this License. However, parties
475
+ who have received copies, or rights, from you under this License will not
476
+ have their licenses terminated so long as such parties remain in full
477
+ compliance.
478
+ </para>
479
+ </section>
480
+ <section id="FutureRevisions" label="10. ">
481
+ <title>FUTURE REVISIONS OF THIS LICENSE</title>
482
+ <para>
483
+ The Free Software Foundation may publish new, revised versions of the GNU
484
+ Free Documentation License from time to time. Such new versions will be
485
+ similar in spirit to the present version, but may differ in detail to
486
+ address new problems or concerns. See <ulink
487
+ url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.
488
+ </para>
489
+ <para>
490
+ Each version of the License is given a distinguishing version number. If
491
+ the Document specifies that a particular numbered version of this License
492
+ "or any later version" applies to it, you have the option of following the
493
+ terms and conditions either of that specified version or of any later
494
+ version that has been published (not as a draft) by the Free Software
495
+ Foundation. If the Document does not specify a version number of this
496
+ License, you may choose any version ever published (not as a draft) by the
497
+ Free Software Foundation.
498
+ </para>
499
+ </section>
500
+ <section id="HowToUse" label="ADDENDUM: ">
501
+ <title>How to use this License for your documents</title>
502
+
503
+ <para>
504
+ To use this License in a document you have written, include a copy of the
505
+ License in the document and put the following copyright and license
506
+ notices just after the title page:
507
+ </para>
508
+ <blockquote>
509
+ <para>
510
+ Copyright &copy; YEAR YOUR NAME.
511
+ </para>
512
+ <para>
513
+ Permission is granted to copy, distribute and/or modify this document
514
+ under the terms of the GNU Free Documentation License, Version 1.2 or
515
+ any later version published by the Free Software Foundation; with no
516
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
517
+ copy of the license is included in the section entitled "GNU Free
518
+ Documentation License".
519
+ </para>
520
+ </blockquote>
521
+ <para>
522
+ If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
523
+ replace the "with...Texts." line with this:
524
+ </para>
525
+ <blockquote>
526
+ <para>
527
+ with the Invariant Sections being LIST THEIR TITLES, with the
528
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
529
+ </para>
530
+ </blockquote>
531
+ <para>
532
+ If you have Invariant Sections without Cover Texts, or some other
533
+ combination of the three, merge those two alternatives to suit the
534
+ situation.
535
+ </para>
536
+ <para>
537
+ If your document contains nontrivial examples of program code, we
538
+ recommend releasing these examples in parallel under your choice of free
539
+ software license, such as the GNU General Public License, to permit their
540
+ use in free software.
541
+ </para>
542
+ </section>
543
+ </appendix>