Recent Changes · Search:

Support the Project

Wikipublisher

PmWiki

edit SideBar

Wikipublisher.TypesettingEngine History

Hide minor edits - Show changes to output

16 June 2008 at 10:54 AM by John Rankin - clarify wording
Changed lines 1-2 from:
T;he audience for this page; is new [[Wikipublisher]] users. To turn Web pages into print documents, we have to do several things at once:
to:
T;he audience for this page; is new [[Wikipublisher]] users. To turn Web pages into print documents, we have to do several things:
Changed lines 15-16 from:
To see what Wikipublisher does, readers may wish to typeset this page, print it on a duplex printer from a {pdf|portable document format} viewer, and study it alongside the Web page.
to:
To see what Wikipublisher does, readers may wish to typeset this page, print it on a duplex printer from a {`PDF|portable document format} viewer, and study it alongside the Web page.
Deleted lines 33-34:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup [@`.@] (backtick-period) at the start of the line.
Changed lines 35-36 from:
Within each page, the engine slots each heading into the overall hierarchy. For example, the first heading on ''Section A Page'' becomes a subsection, the first heading on ''Subsection 1 Page'' becomes a sub-subsection. It treats heading depths as ''relative'' elements. That is, authors can use any combination of heading levels and it will work out where these fit in the hierarchy. The first heading on ''Section A Page'' might be <h2> while the first heading on ''Section B Page'' might be <h3>; both headings become subsections. Lower level headings become lower level hierarchy elements: chapter (books only), section, subsection, sub-subsection, paragraph and sub-paragraph. It recognises at most ''3 levels'' of heading on a page.
to:
Within each page, the engine slots each heading into the overall hierarchy. For example, the first heading on ''Section A Page'' becomes a subsection, the first heading on ''Subsection 1 Page'' becomes a sub-subsection. It treats heading depths as ''relative'' elements. That is, authors can use any combination of heading levels and it will work out where these fit in the hierarchy. The first heading on ''Section A Page'' might be <h2> while the first heading on ''Section B Page'' might be <h3>; both headings become subsections. Lower level headings become lower level hierarchy elements, up to ''3 levels'' of heading on a page.
Changed line 48 from:
||[=(:typeset-trail:)=]||trail page ||article style output || ||
to:
||[=(:typeset-trail:)=]||trail page ||article style output ||HomePage ||
Changed line 74 from:
When printed, the pdf of this document ''should'' be centred on the paper, with equal left and right margins. The bottom margin is 3 mm deeper than the top. Hold a page up to the light; the recto and verso text ''should'' line up exactly. On A4 paper, the line length ''should'' be 125 mm and the distance between top and bottom rules 240 mm. In some pdf viewers, the text may be offset horizontally or vertically, and the text area may be shrunk. If so, you may need to adjust the viewer's print settings. The fix depends on the viewer; for example in Acrobat Reader, make sure page scaling is set to "None".
to:
When printed, the `PDF of this document ''should'' be centred on the paper, with equal left and right margins. The bottom margin is 3 mm deeper than the top. Hold a page up to the light; the recto and verso text ''should'' line up exactly. On A4 paper, the line length ''should'' be 125 mm and the distance between top and bottom rules 240 mm. In some `PDF viewers, the text may be offset horizontally or vertically, and the text area may be shrunk. If so, you may need to adjust the viewer's print settings. The fix depends on the viewer; for example in Acrobat Reader, make sure page scaling is set to "None".
13 September 2007 at 06:57 PM by John Rankin - describe typesetting engine
Changed line 76 from:
When printed, the pdf of this document ''should'' be centred on the paper, with equal left, right, top and bottom margins. Hold a page up to the light; the recto and verso text ''should'' line up exactly. On A4 paper, the line length ''should'' be 125 mm and the distance between top and bottom rules 240 mm. In some pdf viewers, the text may be offset horizontally or vertically, and the text area may be shrunk. If so, you may need to adjust the viewer's print settings. The fix depends on the viewer; for example in Acrobat Reader, make sure page scaling is set to "None".
to:
When printed, the pdf of this document ''should'' be centred on the paper, with equal left and right margins. The bottom margin is 3 mm deeper than the top. Hold a page up to the light; the recto and verso text ''should'' line up exactly. On A4 paper, the line length ''should'' be 125 mm and the distance between top and bottom rules 240 mm. In some pdf viewers, the text may be offset horizontally or vertically, and the text area may be shrunk. If so, you may need to adjust the viewer's print settings. The fix depends on the viewer; for example in Acrobat Reader, make sure page scaling is set to "None".
13 September 2007 at 09:38 AM by John Rankin - describe typesetting engine
Changed lines 15-16 from:
Typeset this page, print it on a duplex printer from your {pdf|portable document format} viewer, and study it alongside the Web page. The pages ''should'' have equal left, right, top and bottom margins. Hold a page up to the light; the recto and verso text ''should'' line up exactly. If not, you may need to adjust the print settings in your pdf viewer.
to:
To see what Wikipublisher does, readers may wish to typeset this page, print it on a duplex printer from a {pdf|portable document format} viewer, and study it alongside the Web page.
Changed lines 74-76 from:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements. Pages are laid out for optimal readability and comprehension -- they are also rather beautiful, although this is a secondary consideration!
to:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements. Pages are laid out for optimal readability and comprehension -- they are also rather beautiful, although this is a secondary consideration!

When printed, the pdf of this document ''should'' be centred on the paper, with equal left, right, top and bottom margins. Hold a page up to the light; the recto and verso text ''should'' line up exactly. On A4 paper, the line length ''should'' be 125 mm and the distance between top and bottom rules 240 mm. In some pdf viewers, the text may be offset horizontally or vertically, and the text area may be shrunk. If so, you may need to adjust the viewer's print settings. The fix depends on the viewer; for example in Acrobat Reader, make sure page scaling is set to "None".
12 September 2007 at 08:55 PM by John Rankin - describe typesetting engine
Changed lines 34-35 from:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup @@[=`.=]@@ (backtick-period) at the start of the line.
to:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup [@`.@] (backtick-period) at the start of the line.
12 September 2007 at 08:50 PM by John Rankin - describe typesetting engine
Changed lines 34-35 from:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup '@[=`.=]@' (backtick-period) at the start of the line.
to:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup @@[=`.=]@@ (backtick-period) at the start of the line.
12 September 2007 at 08:47 PM by John Rankin - describe typesetting engine
Changed lines 1-2 from:
T;o turn Web pages into print documents;, we have to do several things at once:
to:
T;he audience for this page; is new [[Wikipublisher]] users. To turn Web pages into print documents, we have to do several things at once:
Changed line 22 from:
The basic building blocks are ''lists'' and ''headings''. To assemble several pages into a single document, make a list of page names:
to:
The basic building blocks are ''lists'' and ''headings''. To assemble several pages into a single document, make a list of page names (i.e. a [[PmWiki/Wiki Trail(s)]]):
Changed lines 34-35 from:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup [=`.=] (backtick-period) at the start of the line.
to:
If you want to omit a list item from the hierarchy, use the "invisible stop" markup '@[=`.=]@' (backtick-period) at the start of the line.
Changed lines 39-40 from:
If you use headings on a trail page, these are treated as section markers and first level list items become subsections. On trail pages, it recognises ''one level'' of heading only.
to:
If you use headings to break up your list of page names, these are treated as section markers and first level list items become subsections. When expanding and typesetting such a trail page, it builds ''one level'' of heading into the hierarchy only.
Changed lines 69-71 from:
Authors can control whether headings are numbered, and the depth of numbering in the hierarchy. A heading ''always'' stays on the same page as the paragraph following. Authors can request a table of contents, a list of figures, and a list of tables. The engine also supports indexes, but this feature is not yet implemented.
to:
Authors can control whether headings are numbered, and the depth of numbering in the hierarchy, using the ''autonumber'' option setting. A heading ''always'' stays on the same page as the paragraph following. Authors can request a table of contents, a list of figures, and a list of tables. The engine also supports indexes, but this feature is not yet implemented.
12 September 2007 at 07:28 PM by John Rankin - describe typesetting engine
Changed lines 43-44 from:
To tell the engine which document class to use when typesetting a page, we use a typeset directive. These are listed in the TAB(directives).
to:
To tell the engine which document class to use when typesetting a page, we use a typeset directive. These are listed in TAB(directives).
Changed lines 69-71 from:
Authors can control whether headings are numbered, and the depth of numbering in the hierarchy. A heading ''always'' stays on the same page as the paragraph following. Authors can request a table of contents, a list of figures, and a list of tables. The engine supports indexes, but this feature is not yet implemented.
to:
Authors can control whether headings are numbered, and the depth of numbering in the hierarchy. A heading ''always'' stays on the same page as the paragraph following. Authors can request a table of contents, a list of figures, and a list of tables. The engine also supports indexes, but this feature is not yet implemented.
Changed line 74 from:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements. Pages are laid out for optimal readability and comprehension -- although a secondary consideration, they are also beautiful!
to:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements. Pages are laid out for optimal readability and comprehension -- they are also rather beautiful, although this is a secondary consideration!
12 September 2007 at 07:21 PM by John Rankin - describe typesetting engine
Changed lines 5-6 from:
# apply a document class suitable for the desired output, such as letters, articles, reports, and books
to:
# apply a document class suitable for the desired output, such as letters, articles, reports, or books
Added lines 15-16:
Typeset this page, print it on a duplex printer from your {pdf|portable document format} viewer, and study it alongside the Web page. The pages ''should'' have equal left, right, top and bottom margins. Hold a page up to the light; the recto and verso text ''should'' line up exactly. If not, you may need to adjust the print settings in your pdf viewer.
Changed lines 43-45 from:
To tell the engine which document class to use when typesetting a page, we use a typeset directive. These are listed in the table.

||border=1 bordercolor=silver cellpadding=3 cellspacing=0
to:
To tell the engine which document class to use when typesetting a page, we use a typeset directive. These are listed in the TAB(directives).

||border=1 bordercolor=silver cellpadding=3 cellspacing=0 id=directives"typesetting directives"
Changed lines 67-70 from:
The engine automatically inserts standard printed page layout elements, such as running headers and footers. For duplex printing, these are mirrored on odd and even pages. Internal links from one part of the document to another gain page numbers (cross-references). Authors can request a table of contents, a list of figures, and a list of tables. Figures are automatically numbered; tables are numbered only if the table has a caption. Authors can control whether headings are numbered, and the depth of numbering in the hierarchy.

A
heading ''always'' stays on the same page as the paragraph following.
to:
The engine automatically inserts standard printed page layout elements, such as running headers and footers. For duplex printing, these are mirrored on odd and even pages. Internal links from one part of the document to another gain page numbers (page cross-references). Figures are automatically numbered; tables are numbered only if the table has a caption. The engine uses the figure or table number in any references; for example, TAB(directives).

Authors can control whether headings are
numbered, and the depth of numbering in the hierarchy. A heading ''always'' stays on the same page as the paragraph following. Authors can request a table of contents, a list of figures, and a list of tables. The engine supports indexes, but this feature is not yet implemented.
Changed line 74 from:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements.
to:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements. Pages are laid out for optimal readability and comprehension -- although a secondary consideration, they are also beautiful!
12 September 2007 at 06:48 PM by John Rankin - describe typesetting engine
Changed lines 1-3 from:
!!Introduction
To
turn Web pages into print documents, we have to do several things at once:
to:
T;o turn Web pages into print documents;, we have to do several things at once:
Changed lines 15-16 from:
(:typeset-page toc=on:)
to:
(:typeset-page toc=on autonumber=2 :)
Changed line 26 from:
And so on. The hierarchy of the list determines the hierarchy of the document. The engine automatically detects any gaps in the hierarchy and inserts place-holders. For example, if the list starts with a subsection (**), it inserts a dummy section. The author needs to fix these by hand. You can also mix text and page names in the list:
to:
... and so on. The hierarchy of the list determines the hierarchy of the document. The engine automatically detects any gaps in the hierarchy and inserts place-holders. For example, if the list starts with a subsection (**), it inserts a dummy section. The author needs to fix these by hand. You can also mix text and page names in the list:
Changed lines 56-57 from:
Wikipublisher installs a number of template pages in the Site group that control the default layout of printed pages and page collections. For example, the Site/PrintTemplate defines the layout for articles. In addition, authors and readers can:
* create template pages in the current group to over-ride
the site-wide settings
to:
Wikipublisher installs a number of template pages in the Site group, which control the default layout of printed pages and page collections. For example, the Site/PrintTemplate defines metadata values to control the layout for articles. In addition, authors and readers can:
* create template pages in
the current group to over-ride the site-wide metadata settings
Changed lines 61-62 from:
See also Site/PublishTemplate, Site/BookTemplate, Site/IncludeTemplate, Site/LetterTemplate.
to:
See also Site/PublishTemplate, Site/BookTemplate, Site/IncludeTemplate, Site/LetterTemplate. For a list of available typesetting options, see Site/WikipublisherOptions.
Changed lines 65-66 from:
to do...
to:
The engine automatically inserts standard printed page layout elements, such as running headers and footers. For duplex printing, these are mirrored on odd and even pages. Internal links from one part of the document to another gain page numbers (cross-references). Authors can request a table of contents, a list of figures, and a list of tables. Figures are automatically numbered; tables are numbered only if the table has a caption. Authors can control whether headings are numbered, and the depth of numbering in the hierarchy.

A heading ''always'' stays on the same page as the paragraph following
.
Changed line 71 from:
to do...
to:
Authors generally don't have to think about this. If you focus on the structure and meaning of the content, it will just work. The print presentation of all markup is configurable; if necessary, your site administrator can change the default settings to address site-specific requirements.
12 September 2007 at 04:32 PM by John Rankin - describe how to typeset
Changed lines 12-15 from:
# re-purpose Web-specific constructs such as links, image alt text, and tool tips

(:description We describe how authors prepare their Web content so that it can be readily re-purposed for print. The typesetting engine uses wiki trail lists and headings to create a structural hierarchy for the output. Authors can choose the most suitable presentation format and control various aspects of the look of the final product. The engine uses the detailed semantics of the content to apply appropriate print styles. It is designed so that authors have to do as little as possible to produce high quality print output; in most cases, it just works. :)
to:
# re-purpose Web constructs such as links, image alt text, and tool tips

(:description We describe how authors prepare their Web content so that it can be readily re-purposed for print. The typesetting engine uses lists and headings to create a structural hierarchy for the output. Authors can choose the most suitable presentation format and control various aspects of the look of the final product. The engine uses the detailed semantics of the content to apply appropriate print styles. It is designed so that authors have to do as little as possible to produce high quality print output; in most cases, it just works. :)
Changed lines 57-70 from:
Wikipublisher installs a number of template pages in the Site group to control the default layout of printed pages. For example, Site.PrintTemplate defines the layout for articles.
to:
Wikipublisher installs a number of template pages in the Site group that control the default layout of printed pages and page collections. For example, the Site/PrintTemplate defines the layout for articles. In addition, authors and readers can:
* create template pages in the current group to over-ride the site-wide settings
* over-ride the template settings with options on the typeset directive; for example, this page's directive includes "toc=on" to generate a table of contents
* press an ''options'' button to over-ride the defaults when requesting a print version

See also Site/PublishTemplate, Site/BookTemplate, Site/IncludeTemplate, Site/LetterTemplate.

!!Create navigation aids

to do...

!!Re-purpose Web constructs

to do..
.
12 September 2007 at 03:52 PM by John Rankin - describe how to typeset
Added line 1:
!!Introduction
Changed lines 14-15 from:
(:description We describe how authors prepare their Web content in such a way that it can be readily re-purposed for print. The typesetting engine uses wiki trail lists and headings to create a structural hierarchy for the output. The author can choose the most suitable presentation format and control various aspects of the look of the final product. The engine uses the detailed semantics of the content to apply appropriate print styles. It is designed so that the author has to do as little as possible to produce high quality print output; in most cases, it just works. :)
to:
(:description We describe how authors prepare their Web content so that it can be readily re-purposed for print. The typesetting engine uses wiki trail lists and headings to create a structural hierarchy for the output. Authors can choose the most suitable presentation format and control various aspects of the look of the final product. The engine uses the detailed semantics of the content to apply appropriate print styles. It is designed so that authors have to do as little as possible to produce high quality print output; in most cases, it just works. :)
Changed lines 53-57 from:
The first 3 directives expand page trails into their constituent parts; the last 2 apply to single pages. The [=(:typeset-trail:)=] directive uses the same "article" document class as [=(:typeset-page:)=]. For more information on the special letter markup, see WriteALetter.
to:
The first 3 directives expand page trails into their constituent parts; the last 2 apply to single pages. The [=(:typeset-trail:)=] directive uses the same "article" document class as [=(:typeset-page:)=]. For more information on the special letter markup, see WriteALetter.

!!Define audience-specific settings

Wikipublisher installs a number of template pages in the Site group to control the default layout of printed pages. For example, Site.PrintTemplate defines the layout for articles
.
12 September 2007 at 02:58 PM by John Rankin - describe how to typeset
Added lines 1-52:
To turn Web pages into print documents, we have to do several things at once:

# establish a structural hierarchy of sections, subsections, sub-subsections, and so on

# apply a document class suitable for the desired output, such as letters, articles, reports, and books

# define audience-specific settings, such as paper size and whether to print single- or double-sided

# create navigation aids such as a table of contents and page cross-references

# re-purpose Web-specific constructs such as links, image alt text, and tool tips

(:description We describe how authors prepare their Web content in such a way that it can be readily re-purposed for print. The typesetting engine uses wiki trail lists and headings to create a structural hierarchy for the output. The author can choose the most suitable presentation format and control various aspects of the look of the final product. The engine uses the detailed semantics of the content to apply appropriate print styles. It is designed so that the author has to do as little as possible to produce high quality print output; in most cases, it just works. :)

(:typeset-page toc=on:)

!!Establish a structural hierarchy
!!!Lists

The basic building blocks are ''lists'' and ''headings''. To assemble several pages into a single document, make a list of page names:
* Section A Page
** Subsection 1 Page
** Subsection 2 Page
* Section B Page

And so on. The hierarchy of the list determines the hierarchy of the document. The engine automatically detects any gaps in the hierarchy and inserts place-holders. For example, if the list starts with a subsection (**), it inserts a dummy section. The author needs to fix these by hand. You can also mix text and page names in the list:
* Section A heading text
** Subsection 1 Page
** Subsection 2 Page
* Section B heading text

If you want to omit a list item from the hierarchy, use the "invisible stop" markup [=`.=] (backtick-period) at the start of the line.

!!!Headings
Within each page, the engine slots each heading into the overall hierarchy. For example, the first heading on ''Section A Page'' becomes a subsection, the first heading on ''Subsection 1 Page'' becomes a sub-subsection. It treats heading depths as ''relative'' elements. That is, authors can use any combination of heading levels and it will work out where these fit in the hierarchy. The first heading on ''Section A Page'' might be <h2> while the first heading on ''Section B Page'' might be <h3>; both headings become subsections. Lower level headings become lower level hierarchy elements: chapter (books only), section, subsection, sub-subsection, paragraph and sub-paragraph. It recognises at most ''3 levels'' of heading on a page.

If you use headings on a trail page, these are treated as section markers and first level list items become subsections. On trail pages, it recognises ''one level'' of heading only.

!!Apply a document class

To tell the engine which document class to use when typesetting a page, we use a typeset directive. These are listed in the table.

||border=1 bordercolor=silver cellpadding=3 cellspacing=0
||!Typesetting directives!||
||!directive ||!used on ||!produces ||!example ||
||[=(:typeset:)=]||trail page ||report style output ||[[(WP)Slides]] ||
||[=(:typeset-book:)=]||trail page ||book style output ||UserGuide ||
||[=(:typeset-trail:)=]||trail page ||article style output || ||
||[=(:typeset-page:)=]||any page ||article style output ||this page ||
||[=(:typeset-letter:)=]||letter page ||letter style output ||WelcomeLetter ||

The first 3 directives expand page trails into their constituent parts; the last 2 apply to single pages. The [=(:typeset-trail:)=] directive uses the same "article" document class as [=(:typeset-page:)=]. For more information on the special letter markup, see WriteALetter.
Creative Commons License
Edit · History · Print · Recent Changes · Search · Links
Page last modified on 16 June 2008 at 10:54 AM