Recent Changes · Search:

Support the Project

Wikipublisher

PmWiki

edit SideBar

Wikipublisher.WikipublisherIsUnique History

Show minor edits - Show changes to output

30 June 2007 at 11:06 AM by John Rankin - add a challenge
Changed lines 1-2 from:
Turning a long word processing document, designed for print, into a series of linked html pages is hard to do well. The longer the document, the more frequently it changes, the harder it is to sustain a reliable and efficient conversion process. On the other hand, assembling a series of html pages into a form suitable for printing and reading offline -- for example, as a book -- is equally hard. [[Existing solutions -> http://www.alistapart.com/articles/boom]] are daunting and expensive.
to:
[[Wikipublisher]] brings typographic style to Web pages.

Turning a long word processing document, designed for print, into a set of linked html pages is hard to do well. The longer
the document, the more frequently it changes, the harder it is to sustain a reliable and efficient conversion process. On the other hand, assembling a set of html pages into a form suitable for printing and reading offline -- for example, as a book -- is equally hard. [[Existing solutions -> http://www.alistapart.com/articles/boom]] are daunting and expensive.
Changed lines 13-14 from:
* it is 100% open source
to:
* it is 100% open source, open standards
Changed lines 23-24 from:
The printed output will be better quality than 99.9% of word processing documents, every time.
to:
The printed output will be better quality than 99.9% of word processing documents, every time. Use of an intermediate xml structure guarantees a consistent look.
Changed lines 30-31 from:
Latex uses a very clever algorithm to handle text justification -- it optimises inter-word spacing across the entire paragraph, not just the current line. [[Adobe InDesign -> http://www.adobe.com/products/indesign/]] uses the same method. It also pushes punctuation marks like hypens slightly into the right hand margin and makes the space after a full stop wider than the space between words (but not 2 spaces wide). The result -- no rivers of white space running down the printed page; every paragraph is as perfect as it can be.
to:
Latex uses a very clever algorithm to handle text justification -- optimising inter-word space across the entire paragraph, not just the current line. [[Adobe InDesign -> http://www.adobe.com/products/indesign/]] uses the same method. It also pushes punctuation marks like hypens slightly into the right hand margin and makes the space after a full stop wider than the space between words (but not 2 spaces wide). The result -- no rivers of white space running down the printed page; every paragraph is as perfect as it can be.
Changed lines 33-34 from:
Latex does the obvious things -- there is ''never'' a page break after a heading; there is ''always'' extra space above a heading. And Wikipublisher makes sure the page structure is ''always'' section, subsection, subsubsection, ... Latex also does less obvious, but really good, things -- if there isn't room on the current page, tables and figures "float" to the next page and the text flows back to fill the space created. The result -- no split tables, no half-empty pages; every page is as perfect as it can be.
to:
Latex does the obvious things -- there is ''never'' a page break after a heading; there is ''always'' extra space above a heading. And Wikipublisher makes sure the page structure is ''always'' section, subsection, subsubsection, ... Latex also does less obvious, but really good, things -- if there isn't room on the current page, tables and figures "float" to the next page and the text flows back to fill the space created. The result -- no split tables, no half-empty pages, high readability; every page is as perfect as it can be.
Changed lines 36-37 from:
Latex uses ''document classes'' -- template files which control the layout and presentation of all documents in the class. Wikipublisher supports 3 classes: articles for a single web page, reports for page collections, and books (which have chapters). Depending on the class, the output may have a cover page, a table of contents, headers and footers mirrored on odd (recto) and even (verso) pages, numbered headings and subheadings, and so on. Wikipublisher's print metadata makes it easy to change the look within a class -- choose the fontset, chapter style, watermark, and so on.
to:
Latex uses ''document classes'' -- template files which control the layout and presentation of all documents in the class. Wikipublisher supports 3 classes: ''articles'' for a single web page, ''reports'' for page collections, and ''books'' (which have chapters). Depending on the class, the output may have a cover page, a table of contents, headers and footers mirrored on odd (recto) and even (verso) pages, numbered headings and subheadings, and so on. Wikipublisher's print metadata makes it easy to change the look within a class -- choose the fontset, chapter style, watermark, and so on.
Changed lines 46-47 from:
On this site, we have many links between pages, such as a link to the [[testimonials]] page. On the Web, we click and go to the page. However, if we create a report document to publish this current page and the testimonials page, what happens to the link? In print, we want a ''cross-reference'' to the page number. Wikipublisher automatically turns intra-document links into page number references.
to:
On this site, we have many links between pages, such as a link to the [[testimonials]] page. On the Web, we click and go to the page. However, if we create a report document to publish this current page and the testimonials page, what happens to the link? In print, we want a ''cross-reference'' to the page number. Similarly, a table of contents needs to include page numbers. Wikipublisher automatically turns intra-document links into page number references.
Added lines 51-54:
!!The Wikipublisher challenge

{=Competition welcome=}We have been unable to find any other project, open source or proprietary, which can do everything Wikipublisher does. We have never seen a Web page "printable view" produce print output anywhere near the quality of Wikipublisher's pdf output. If you know of any, [[contact]] us!
29 June 2007 at 07:29 PM by John Rankin - explain why Wikipublisher is unique
Added lines 1-49:
Turning a long word processing document, designed for print, into a series of linked html pages is hard to do well. The longer the document, the more frequently it changes, the harder it is to sustain a reliable and efficient conversion process. On the other hand, assembling a series of html pages into a form suitable for printing and reading offline -- for example, as a book -- is equally hard. [[Existing solutions -> http://www.alistapart.com/articles/boom]] are daunting and expensive.

(:description Wikipublisher offers capabilities that no other open source software project offers. Its purpose is to turn collections of Web pages into documents designed to be printed and read offline. It provides all the features readers expect of a printed document and works on-the-fly, from Web to print in 2 mouse-click. :)

(:toc:)

!!Wikipublisher loves print

{=One authoritative source=}[[Wikipublisher]] lets us maintain one authoritative source for both web and print, and generate printed documents on-the-fly. With 2 mouse-clicks, a reader can turn a single web page or page collection into a beautifully typeset print document. This capability is unique in a number of ways:

* it is 100% open source

* it uses [[Latex -> http://www.latex-project.org/]] as the typesetting engine -- the gold standard for electronic publishing

* it supports [[bibliographies]] for scholarly writing (citations and references)

* it understands print metadata -- e.g. 3 clicks to choose US letter paper, serif headings, duplex off

* everything just works -- tables, images, footnotes, page numbers, table of contents, headers and footers, smart quotes, ...

The printed output will be better quality than 99.9% of word processing documents, every time.

!!Why Latex

{=Latex is the gold standard=}For those unfamiliar with Latex, here are some of the things it does for us. The big and familiar idea is that authors focus on meaning, Latex takes care of presentation.

!!!!Perfect paragraphs
Latex uses a very clever algorithm to handle text justification -- it optimises inter-word spacing across the entire paragraph, not just the current line. [[Adobe InDesign -> http://www.adobe.com/products/indesign/]] uses the same method. It also pushes punctuation marks like hypens slightly into the right hand margin and makes the space after a full stop wider than the space between words (but not 2 spaces wide). The result -- no rivers of white space running down the printed page; every paragraph is as perfect as it can be.

!!!!Perfect pages
Latex does the obvious things -- there is ''never'' a page break after a heading; there is ''always'' extra space above a heading. And Wikipublisher makes sure the page structure is ''always'' section, subsection, subsubsection, ... Latex also does less obvious, but really good, things -- if there isn't room on the current page, tables and figures "float" to the next page and the text flows back to fill the space created. The result -- no split tables, no half-empty pages; every page is as perfect as it can be.

!!!!Perfect publishing
Latex uses ''document classes'' -- template files which control the layout and presentation of all documents in the class. Wikipublisher supports 3 classes: articles for a single web page, reports for page collections, and books (which have chapters). Depending on the class, the output may have a cover page, a table of contents, headers and footers mirrored on odd (recto) and even (verso) pages, numbered headings and subheadings, and so on. Wikipublisher's print metadata makes it easy to change the look within a class -- choose the fontset, chapter style, watermark, and so on.

!!It just works

{=Do the right thing=}There are many differences between Web and print presentation; Wikipublisher takes care of them without the author having to think about it. The author doesn't need to be a layout expert. Here are a few examples.

!!!!Footnotes and marginal notes
The address of an [[external link -> http://www.affinity.co.nz/wiki]] is automatically converted into a footnote[^You can also define a plain old footnote.^]. This page also includes markup to produce short marginal notes, highlighting some of the big themes of the page. In print, the convention is to put marginal notes ... in the margin. In particular, in the ''outside'' margin of duplexed pages. Wikipublisher takes care of this automatically. If duplex is off, marginal notes appear in the right margin.

!!!!Page cross-references
On this site, we have many links between pages, such as a link to the [[testimonials]] page. On the Web, we click and go to the page. However, if we create a report document to publish this current page and the testimonials page, what happens to the link? In print, we want a ''cross-reference'' to the page number. Wikipublisher automatically turns intra-document links into page number references.

!!!!Abbreviations
{TINFL|there is no free lunch} is an example of an abbreviation. On the Web, mousing over the abbreviation reveals its meaning. In print, plain English practice is to expand the abbreviation in brackets. Some, more traditional authors prefer to spell out the abbreviation first and put the contracted form in brackets following. Wikipublisher can be configured to do it either way; its default setting is the plain English style.

[^#^]
Creative Commons License
Edit · History · Print · Recent Changes · Search · Links
Page last modified on 09 June 2008 at 04:28 PM