Mallard sample - integrating custom content

[Jim Campbell]

Hi All,

Per my prior message to the mailing list, I thought I'd provide some sample
Mallard documentation, and show how custom content can be integrated into
Mallard docs with almost no effort.

First, download the sample docs for xfce4-screenshooter (
http://j1m.net/?attachment_id=153 ), and extract them.  Also download the
attached "custom OEM content" file that I've attached to this message, but
do not place the "custom oem content" file into the same folder as the
screenshooter docs.

>From the terminal, navigate to the xfce4-screenshooter folder, and then
enter "yelp help/C/".  The docs should display in yelp.  Once you've checked
them out, close yelp.

Then copy the "custom OEM content" file into the help/C/ folder, and re-run
the "yelp help/C/" command.  The custom OEM content document should be
included in the original docs without any modification of the upstream doc.
 Also, a link is included from the custom OEM content page back to the main
page.

This example shows how easy it is to add simple, plugin-style additions to
docs, but with just a *little* additional effort you could add in entire
custom sections with multiple custom pages.  (You would just need to create
a new section in the index.page document, and then link the new set of
custom docs to that section.)  The links between the upstream/original
documents and the downstream/custom documents are generated automatically.

This is just a simple demonstration, but I wanted for people to see how this
works.  Let me know if you have any questions.

Jim
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20100120/27a7cf88/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: custom-oem-content.page
Type: application/octet-stream
Size: 694 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20100120/27a7cf88/attachment.obj>