Recent Changes
Recent Changes · Search:

Report: Publish a page collection with the Wikipublisher Report class

How do I create a properly formatted report, spanning multiple wiki pages?

Casting and smoothing a typeface

As the name implies, the Wikibook Report element provides an XML-based representation of “reports” — that is, a document longer and with more structure than an article, but shorter and simpler than a book. In Wikipublisher, a report is typically used to typeset a trail page, through the (:typeset:) directive, or to typeset the results of a search. For example, to typeset the Tip of the Week collection as a single report, press the Typeset button on that page.

Reports are designed for printing and binding, with the default layout defined in the Site.Publish Template. The layout for reports includes:

  • a title cover page
  • a title verso page, with a legal notice from Site.Print Header
  • optionally, the trail page (auto-generated for search results)
  • a table of contents
  • optionally, a list of figures and list of tables
  • a series of sections; optionally, each section starts a new page
  • mirrored headers and footers on odd and even pages
  • a Site.Print Footer at the end of the report

Text on the cover page can be printed flush left, centred, or flush right. Body copy is offset, with the outside margin wider than the inside. Each level 1 list item in the trail becomes a section, level 2 items become sub-sections, and so on. If the trail page contains headings, the first heading level detected is used to define section headings; first level list items become sub-sections. The text of each list item becomes the heading for the corresponding section.

Wikipublisher supports “invisible stops”. Sometimes, authors want to have headings and list items on the trail page, without these forming part of the report hierarchy. This can be achieved using the invisible stop inline markup — a `. (backtick-period) — at the start of the line. This has no effect on the page output, but tells Wikipublisher to ignore the rest of the line when typesetting the trail. For example:

`.* list item starting with an invisible stop
* another item`. including an invisible stop
  • list item starting with an invisible stop
  • another item including an invisible stop

More generally, when constructing a heading from the text of a list item, Wikipublisher ignores any text after an invisible stop. The second list item above illustrates this. Authors can also typeset “hidden trails”, by wrapping the list of trail stops in a >>comment<< block. This suppresses the trail display, but lets Wikipublisher use the list to build the report.

Category: document type

« 00011 · Edit Form · 00013 »

Page last modified on 11 December 2007 at 01:55 PM