ubuntu-developer-manual team mailing list archive
-
ubuntu-developer-manual team
-
Mailing list archive
-
Message #00272
Re: Toolchain
Hi Chris,
(ccing list)
Install doctemplate from doctemplate-team ppa:
https://launchpad.net/~doctemplate-team/+archive/ppa
<https://launchpad.net/%7Edoctemplate-team/+archive/ppa>
Created your main book working dir and go into it.
Get all branches here: https://code.edge.launchpad.net/~ubuntu-developer-manual
<https://code.edge.launchpad.net/%7Eubuntu-developer-manual>
note it is:
* one branch per chapter
* one branch for the book (to build pdfs)
* on branch named customization (this contains common customizations)
(don't get the 'test" branch, that is cruft)
bzr branch a
bzr branch b
(You can script that if you want.)
The book "module" has book.xml that contains xml that points to all chapter
directories. It should be correct at this point. when you add a chapter, you add
it to the book.xml file as the others.
build the book pdf in the book dir with: doctemplate_make_book_pdf
* look in build/ for localized draft pdfs for each linguas in LINGUAS file
build chapter modules by entering a chapter bzr dir created above when you
branched each chapter:
* doctemplate_html (builds one form of html)
* doctemplate_html-site (different html javascript and styling)
* build chapter pdf module with doctemplate_pdf
* builds are for each lingua in LINGUAS file
* all built chapter modules are in build/<type>/<lang>/
* localization (languages and images) fully supported. (only some po files
present by default).
Create new chapter module:
* create dir and go into it
* doctemplate_setup_article (doctemplate chapter modules are actually docbook
articles)
* this creates a sample article in article/sample-article.xml. Only use the
docbook tags that are used in this sample. They are proven to work in all output
types and should suffice.
* add path to chapter module into book.xml
That's a start.
Cheers,
Kyle
On 04/08/2011 02:53 PM, Chris Woollard wrote:
Kyle,
Do you have a script or such like to pull everything down?
Also, how do i compile the manual myself to pdf?
thanks
chris
On 28 February 2011 22:11, Belinda Lopez <belinda.lopez@xxxxxxxxxxxxx
<mailto:belinda.lopez@xxxxxxxxxxxxx>> wrote:
Hi Kevin et al,
thanks for checking in. KyleN has been doing some amazing work on the
doctemplate tool and I've started uploading the converted branches into
the project workspace. We've broken out each chapter into its own branch
and that should make it easier going forward for any contributors to only
have to pull the section they are working on. The new toolchain/workflow
now looks like this:
* Install the doctemplate project PPA: sudo apt-add-repository
ppa:doctemplate-team/ppa
* Update your apt-cache: sudo apt-get update
* install doctemplate: sudo apt-get install doctemplate
This is all that is needed to run the build commands using doctemplate.
All commands start with "doctemplate_" and a tab shows all the available
commands.
If you or anyone wants to start playing with the new branches simply pull
down the section you want to work on - I recommend:
lp:~ubuntu-developer-manual/ubuntu-developer-manual/credits
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/credits>
as a simple section to get familiar with docbook and doctemplate. I'll
also write up more detailed instructions on the wiki for doctemplate.
Keep in mind that we are only using a very small subset of docbook tags
in order to minimize conflicts so please don't add any new tags without
first checking with KyleN.
I should have the remaining sections up soon but I invite you to go ahead
and start reviewing the new branches that I've uploaded:
lp:~ubuntu-developer-manual/ubuntu-developer-manual/quickly
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/quickly>
lp:~ubuntu-developer-manual/ubuntu-developer-manual/glade
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/glade>
lp:~ubuntu-developer-manual/ubuntu-developer-manual/distribution
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/distribution>
lp:~ubuntu-developer-manual/ubuntu-developer-manual/bazaar
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/bazaar>
lp:~ubuntu-developer-manual/ubuntu-developer-manual/launchpad
<https://code.launchpad.net/%7Eubuntu-developer-manual/ubuntu-developer-manual/launchpad>
If you run into any problems just ping me in the quickly channel or if you
think it's a doctemplate issue let KyleN know asap.
thanks!
Dinda
On 02/22/2011 09:53 PM, Kevin Godby wrote:
Hello.
I haven't heard from anyone for a while and wondered whether anyone
has sorted out the new toolchain yet.
Thanks!
--Kevin
_______________________________________________
Mailing list:https://launchpad.net/~ubuntu-developer-manual <https://launchpad.net/%7Eubuntu-developer-manual>
Post to :ubuntu-developer-manual@xxxxxxxxxxxxxxxxxxx <mailto:ubuntu-developer-manual@xxxxxxxxxxxxxxxxxxx>
Unsubscribe :https://launchpad.net/~ubuntu-developer-manual <https://launchpad.net/%7Eubuntu-developer-manual>
More help :https://help.launchpad.net/ListHelp
Education
Canonical
belinda.lopez@xxxxxxxxxxxxx <mailto:belinda.lopez@xxxxxxxxxxxxx>
dinda@xxxxxxxxxx <mailto:dinda@xxxxxxxxxx>
IRC: dinda
Office: Galveston, Texas
--
Ubuntu - Linux for Human Beings
http://www.ubuntu.com
http://www.edubuntu.org
http://www.canonical.com
---------------------------
_______________________________________________
Mailing list: https://launchpad.net/~ubuntu-developer-manual
<https://launchpad.net/%7Eubuntu-developer-manual>
Post to : ubuntu-developer-manual@xxxxxxxxxxxxxxxxxxx
<mailto:ubuntu-developer-manual@xxxxxxxxxxxxxxxxxxx>
Unsubscribe : https://launchpad.net/~ubuntu-developer-manual
<https://launchpad.net/%7Eubuntu-developer-manual>
More help : https://help.launchpad.net/ListHelp
References