Project Mallard

Doug Smythies dsmythies at telus.net
Sat May 18 03:50:28 UTC 2013


On 2013.05.17 19:02 John Kim wrote:

> Hello,
> Please excuse me if my technical language usage is awkward.
> Hopefully, I'll get better in time.
> Yesterday, I branched saucy-docs. Today, I decided to look
> at a .page file.

> At the header of every .page file, I noticed that it has the
> header for Project Mallard.  How is the Ubuntu documentation
> website use Project Mallard?

The master files for Ubuntu-docs are written in Mallard markup
language in English. (Master files for some other docs projects are
written in DocBook.)

Once broken down strings segments are translated, other
languages .page files can be compiled.

For what is posted on help.ubuntu.com, the various languages .page
files, including the master files, are "compiled" into HTML and
re-organized such that internet browsers will automatically pull
the correct language version based on your language setting.
(only for Ubuntu Desktop Help, so far. We are considering posting
all available languages for the serverguide in the next cycle)

For more information please refer to the building page [1].
And note that page is reasonably up to date.

> Though these files are all in
> .html, what is behind the color and style of the Ubuntu docs?
> I'm sure CSS and Javascript is involved, but to what extent?  

The color and style, or "theme", is for consistency over all web pages.
You can find some remnants of the old theme around (have a look at
the 10.04 help pages).

Yes, css files and javascript is involved. To what extent, I am not sure.
I only look in depth at stuff that is broken, and haven't had to look
into the .js and .css files that much. (besides I mainly work on the
serverguide.)

[1] https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/BuildingDocumentation

... Doug





More information about the ubuntu-doc mailing list