Experiment: add a new packaged article to Ubuntu Help Center
Kyle Nitzsche
kyle.nitzsche at canonical.com
Fri Jan 22 20:22:12 UTC 2010
As you know, I'd like to promote decoupling ubuntu-docs topics into
separate packages to:
* make it easier to customize parts without forking all content and
thereby losing updates
* facilitate experimentation in small scopes (build/source format/etc)
* ease working with branches (smaller, but more)
* generally position ubuntu-docs more nimbly for all the growth and fun
that is sure to come!
(I realize this notion would imply changes to ubuntu-docs and
ubuntu-translators work flow, from getting/pushing source to building
to index pages, etc. all of which are, I think, doable with care.)
To this end, and as a first proof-of-concept:
* I took my prototype Ubuntu Getting Started Guide (docbook format and
localization fully supported including text and *images*) and packaged it.
(see
http://people.canonical.com/~knitzsche/ubuntu-getting-started-guide/index.html
for the draft English version)
* installed it (en and es) as a normal help app (with omf files, etc.)
* modified yelp's toc (the Ubuntu Help Center home page) to include a
link to it
* launched yelp in English and in Spanish
== Results ==
* user experience is indistinguishable from other ubuntu-docs
articles/books (link on yelp home page)
* localized text
* localized images
* also get build outputs in localized docbook, html, and pdf
== Images of results in yelp ==
ENGLISH
Launch yelp:
* yelp's toc in English with "Getting Started" link added:
http://people.canonical.com/~knitzsche/l10nized.screenshots/en.yelp.toc.png
Click on the Getting Started guide link, and the prototype Getting
Started Guide displays:
*
http://people.canonical.com/~knitzsche/l10nized.screenshots/en.gettingstartedguide.toc.png
Click on the Welcome to Ubuntu link, and that section displays:
*
http://people.canonical.com/~knitzsche/l10nized.screenshots/en.welcometoubuntu.png
SPANISH
Note the test translations here and there, done by inserting "SPANISH:
" into the es.po file in some messages
Launch yelp:
* yelp's toc in Spanish with "Getting Started" link added:
http://people.canonical.com/~knitzsche/l10nized.screenshots/es.yelp.toc.png
(note: "Getting Started is not translated *here* simply because I
didn't modify yelp's es.po for this string)
Click on the Getting Started guide link, and the prototype Getting
Started Guide displays:
*
http://people.canonical.com/~knitzsche/l10nized.screenshots/es.ubuntugettingstarted.toc.png
Click on the "SPANISH: Welcome to Ubuntu!: link, and that section displays:
*
http://people.canonical.com/~knitzsche/l10nized.screenshots/es.welcometoubuntu.png
== Conclusions ==
This demonstrates that:
* topics can be decoupled from the single monolithic ubuntu-docs
package with no change to the user experience
* images can (technically) be easily localized (in this case, using
doctemplate build system)
* l10n works fine
== TRY IT YOURSELF ==
(Don't do this if you don't know how to restore yelp to the previous
version, although the command is below)
Install these two packages (ubuntu-getting-started-guide and yelp):
* add my personal ppa to your software sources:
https://edge.launchpad.net/~knitzsche/+archive/ppa
* sudo apt-get update
* sudo apt-get install yelp
* sudo apt-get install ubuntu-getting-started-guide
Note: afterwards, you probably want to restore your current yelp:
* sudo apt-get install yelp=2.28.0-0ubuntu3
Cheers,
Kyle
More information about the ubuntu-doc
mailing list