SourceFormatAnalysis
Which Source Format?
- X/HTML
- LaTeX
- Docbok
- Mallard
Requirements
- Delivery format: x/html
- Translation through Launchpad (which means po files)
- Localization of Images
- Build system in place
- Nice to have: output format pdf (if we need it, let's clearly identify why.)
- Nice to have: output format docbook (yelp displays 4.5 docbook)
- Nice to have: output format epub
- Nice to have: output format validatable with a single command to help author's submit content that doesn't *break* the build.
- Nice to have: native unicode source
- Nice to have: developers writing the manual have some experience with it already
- Nice to have: produces good HTML, since this is the main delivery format
Source Formats
HTML
Delivery format: x/html—(kylen) xhtml via xml2po. html don't know of anything.
Translation through Launchpad (which means po files)—(kylen) yes, if xhtml and xml2po
Localization of Images—unknown
Build system in place—unknown
output format pdf—yes
output format docbook—unknown
output format epub— yes, with calibre tools
source validatable with a single command—yes, via html5lib or web
native unicode source—yes
writer previous experience—very likely yes
produces good HTML—yes, by definition
LaTeX
Delivery format: x/html—no
Translation through Launchpad (which means po files)—yes, using po4a
Localization of Images—yes
Build system in place—yes
output format pdf—yes
output format docbook—no
output format epub—no
source validatable with a single command—yes
native unicode source—yes
writer previous experience-likely no
produces good HTML-no
Docbook
Delivery format: x/html-Yes
Translation through Launchpad-Yes xml2po for pos files and LPs po
Localization of Images-yes, for ex: doctemplate
Build system in place-yes, doctemplate
Output format pdf-yes, doctemplate
Output format docbook-yes, doctemplate
Output format epub-yes, doctemplate
Source validatable with a single command-yes, xmllint (docbook 4.X)
Native unicode source-yes
Writer previous experience-likely no. (debatable, Shane, Kyle and Belinda seem to have it)
produces good HTML-yes. docbook is highly customizable. doctemplate produces two varieties at the moment. Design and navigation with css, javascript, or plain.
Mallard
1. Delivery format: x/html (kylen) Yes
2. Translation through Launchpad (which means po files) (kylen) yes, because Mallard is xml, so xml2po
3. Localization of Images uncertain
4. Build system in place uncertain
5. output format pdf (kylen) no?
6. output format docbook (kylen) no?
7. output format epub (kylen) no?
8. source validatable with a single command yes, xmllint
9. native unicode source yes
10. writer previous experience likely no
11. produces good HTML ?
DesktopTeam/10.10/DeveloperManual/SourceFormatAnalysis (last edited 2011-01-25 14:26:55 by c-24-91-83-115)