SourceFormatAnalysis

Differences between revisions 2 and 3
⇤ ← Revision 2 as of 2011-01-25 06:33:59 →
Size: 2477
Editor: 173-20-49-63
Comment: Added answers to the LaTeX section and cleaned up formatting in that section
← Revision 3 as of 2011-01-25 09:13:16 → ⇥
Size: 3075
Editor: cpc3-dudl10-2-0-cust1011
Comment:
Deletions are marked like this. Additions are marked like this.
Line 20: Line 20:
 10. Nice to have: developers writing the manual have some experience with it already
 11. Nice to have: produces good HTML, since this is the main delivery format
Line 24: Line 26:
1. Delivery format: x/html
(kylen) xhtml via xml2po. html don't know of anything.

2. Translation through Launchpad (which means po files)
(kylen) yes, if xhtml and xml2po

3. Localization of Images
unknown

4. Build system in place
unknown

5. output format pdf
unknown

6. output format docbook
no?

7. output format epub
no?

8. source validatable with a single command
yes, via web

9. native unicode source
yes		  1. '''Delivery format: x/html'''—(kylen) xhtml via xml2po. html don't know of anything.
 2. '''Translation through Launchpad (which means po files)'''—(kylen) yes, if xhtml and xml2po
 3. '''Localization of Images'''—unknown
 4. '''Build system in place'''—unknown
 5. '''output format pdf'''—yes
 6. '''output format docbook'''—unknown
 7. '''output format epub'''— yes, with calibre tools
 8. '''source validatable with a single command'''—yes, via html5lib or web
 9. '''native unicode source'''—yes
 10. '''writer previous experience'''—very likely yes
 11. '''produces good HTML'''—yes, by definition
Line 62: Line 49:
 1. '''writer previous experience'''-likely no
 1. '''produces good HTML'''-unknown
Line 92: Line 81:
10. writer previous experience
likely no

11. produces good HTML
?
Line 120: Line 115:

10. writer previous experience
likely no

11. produces good HTML
?

= Which Source Format? =

  • X/HTML
  • LaTeX
  • Docbok
  • Mallard

Requirements

  1. Delivery format: x/html
  2. Translation through Launchpad (which means po files)
  3. Localization of Images
  4. Build system in place
  5. Nice to have: output format pdf (if we need it, let's clearly identify why.)
  6. Nice to have: output format docbook (yelp displays 4.5 docbook)
  7. Nice to have: output format epub
  8. Nice to have: output format validatable with a single command to help author's submit content that doesn't *break* the build.
  9. Nice to have: native unicode source
  10. Nice to have: developers writing the manual have some experience with it already
  11. Nice to have: produces good HTML, since this is the main delivery format

Source Formats

HTML

  1. Delivery format: x/html—(kylen) xhtml via xml2po. html don't know of anything.

  2. Translation through Launchpad (which means po files)—(kylen) yes, if xhtml and xml2po

  3. Localization of Images—unknown

  4. Build system in place—unknown

  5. output format pdf—yes

  6. output format docbook—unknown

  7. output format epub— yes, with calibre tools

  8. source validatable with a single command—yes, via html5lib or web

  9. native unicode source—yes

  10. writer previous experience—very likely yes

  11. produces good HTML—yes, by definition

LaTeX

  1. Delivery format: x/html—no

  2. Translation through Launchpad (which means po files)—yes, using po4a

  3. Localization of Images—yes

  4. Build system in place—yes

  5. output format pdf—yes

  6. output format docbook—no

  7. output format epub—no

  8. source validatable with a single command—yes

  9. native unicode source—yes

  10. writer previous experience-likely no

  11. produces good HTML-unknown

Docbook

1. Delivery format: x/html (kylen) Yes

2. Translation through Launchpad (which means po files) (kylen) yes

3. Localization of Images (kylen) yes, doctemplate

4. Build system in place (kylen) yes, doctemplate

5. output format pdf (kylen) yes, doctemplate

6. output format docbook (kylen) yes, doctemplate

7. output format epub (kylen) yes, doctemplate

8. source validatable with a single command yes, xmllint (docbook 4.X)

9. native unicode source yes

10. writer previous experience likely no

11. produces good HTML ?

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)