Difference between revisions of "Documentation/Dashboard/Wiki Books"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
Line 1: Line 1:
 +
{{Documentation/BeingEdited|[[User:Fpe|Fpe]] 17:00, 13 November 2007 (CET)}}
 
=Wiki Books Project=
 
=Wiki Books Project=
 
+
__NOTOC__
 
The objective of this project is to implement a solution that allows compilations of wiki pages to be exported as books in ODF and/or PDF.
 
The objective of this project is to implement a solution that allows compilations of wiki pages to be exported as books in ODF and/or PDF.
  
===Requirements===
+
===Steps===
* Mechanism to define a sequence of wiki pages to make up a book
+
 
* Export wiki pages from the wiki
+
====Define a sequence of wiki pages to make up a book====
* Resolve transcluded content
+
The documentation wiki makes use of [[Template:Documentation/MasterTOC|TOC templates]] to define a wiki book.
* Download images
+
 
* Adjust heading levels
+
====Export wiki pages from the wiki====
* Convert to ODF or XML
+
This includes recursively parsing the pages referenced by the main TOC (for sub-TOCs) and remembering the page level for later heading adjustments.
* ODF: Apply template to ODF (define template)
+
 
* ODF: Load in OOo, adjust layout and export PDF
+
parse(mainTOC)
* XML: Apply template to producs XML-FO
+
 
* XML: Render PDF
+
sub parse(TOC)
 +
  load(TOC)
 +
  foreach entry(TOC)
 +
    parse(entry)
 +
    if contains(subTOC)
 +
      level++
 +
      parse(subTOC)
 +
    endif
 +
  endfor
 +
endsub
 +
 +
 
 +
====Resolve transcluded content====
 +
====Download images====
 +
====Adjust heading levels====
 +
====Convert to ODF or XML====
 +
====ODF: Apply template to ODF (define template)====
 +
====ODF: Load in OOo, adjust layout and export PDF====
 +
====XML: Apply template to producs XML-FO====
 +
====XML: Render PDF====

Revision as of 16:00, 13 November 2007

Template:Documentation/BeingEdited

Wiki Books Project

The objective of this project is to implement a solution that allows compilations of wiki pages to be exported as books in ODF and/or PDF.

Steps

Define a sequence of wiki pages to make up a book

The documentation wiki makes use of TOC templates to define a wiki book.

Export wiki pages from the wiki

This includes recursively parsing the pages referenced by the main TOC (for sub-TOCs) and remembering the page level for later heading adjustments.

parse(mainTOC)
sub parse(TOC)
  load(TOC)
  foreach entry(TOC)
    parse(entry)
    if contains(subTOC)
      level++
      parse(subTOC)
    endif
  endfor
endsub

Resolve transcluded content

Download images

Adjust heading levels

Convert to ODF or XML

ODF: Apply template to ODF (define template)

ODF: Load in OOo, adjust layout and export PDF

XML: Apply template to producs XML-FO

XML: Render PDF

Personal tools