Help:Books

From OpenTutorials
Revision as of 08:28, 22 May 2009 by AlexanderPico (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

You can collect modules, generate and download a document in one of several formats from modules collections or from single modules, order books from a print-on-demand partner and save module collections for later use or to share them.

Add and remove modules

When you are on a module page, you see a box titled "create a book" on the left. Within this box is a link titled "Add wiki page". Click this link to add the current module (in the currently shown revision) to your collection. If the module has previously been added to the collection you can remove it instead.

Manage the collection

Click "Show collection" to go to the Special:Collection. Here you can manage your collection:

  • Enter a title and a subtitle for the collection;
  • Create chapters;
  • Rearrange the modules and chapters in the collection;
  • Remove modules and chapters from your collection;
  • Sort the collection (chapter-wise);

Download documents

To download a document in PDF, ODT or DocBook format of a single module, just go to the module page and click on the "Download as ..." inside the toolbox on the left.

To download an entire collection as a document, go to the Special:Collection page, choose the desired format and click the "Download" button.

Improving the output

Some modules use wikitext that is not ideal for producing PDFs. One important special case is the use of templates that should look different or be omitted in PDF output.

For example all navigational templates should be excluded from PDFs by adding them to the Exclude in print category (see below). As a rule of thumb, all templates containing content which is not useful in an offline version of the document should be marked for exclusion in PDF exports.

There are two ways to utilize templates for a better PDF output:

Substituting templates

One can override a template with another by creating a alternative template with name "PrintSOMETEMPLATE" where SOMETEMPLATE is the name of the original template.

Excluding templates

Adding it to the special Category:Exclude in print
Templates in the category Exclude in print are omitted from the output.
Using the template blacklist
Templates listed on the template blacklist page are also omitted. The format for this page is in the following form:
 * [[Template:Templatename]]
 * [[Template:SomeOtherTemplatename]]

Order books

You can easily order a book made from your collection. Just click on the links of a print-on-demand partner at the right of the Special:Collection page.

Template:Warning

Save and load collections

You have to be logged-in to save a collection. Go to the Special:Collection page, choose whether you want to save the collection as a subpage of your userpage or as a subpage of Wikibooks:Collections, enter a title and click the save button. Collections are automatically added to the Books category.

If you are on a collection page, the "collection" portlet on the left contains a "Load collection" link to load the shown collection.

Format of saved collection pages

A collection with title "My Collection" and subtitle "Just an Example" consisting of two chapters "Foo" and "Bar" each containing three modules will be saved as a page with the following wikitext:

== My Collection ==
=== Just an Example ===
;Foo
:[[First_module]]
:[[Second_module]]
:[[Third_module]]
;Bar
:[[Fourth_module]]
:[[Fifth_module]]
:[[Sixth_module]]
[[Category:Collections]]

Related Pages