Mailinglist Archive: opensuse-doc (46 mails)

< Previous Next >
Re: [opensuse-doc] LfL RFC
  • From: Thomas Schraitle <thomas.schraitle@xxxxxxx>
  • Date: Wed, 27 Dec 2006 18:19:01 +0100
  • Message-id: <200612271819.01814.thomas.schraitle@xxxxxxx>

On Wednesday 27 December 2006 11:27, Rebecca Walter wrote:
> [...]
> Unless I am wrong here, I think it is also possible to build only a
> portion of the book, like just a chapter or maybe even a part. Toms,
> is this true with LfL? Can a user build just an HTML or PDF of a part?

You are right, Rebecca. It is possible to build a chapter, appendix, part
or the whole book:

1. To build to whole book:
make pdf

2. To build the chapter only with an id=foo:
make ROOTID=foo pdf

(Same rules applies for HTML.)

However, at the moment it is not possible to build a PDF from a
single "lesson", because a lessons consist of sect1s. If I remember
correctly, the current stylesheets can not create a PDF from a single
sect1. You have to select the surrounding chapter. By the way, HTML is
not restricted.

> If the book as one entity starts getting too large and complicated, we
> can always consider splitting it or consider other possibilities like
> making it possible to tag texts after the intended user level so
> someone could make a book with only the texts aimed at their level
> included. My understanding is that this is technically possible but
> not implemented. The sources can get complicated if we start making
> these divisions within a text. But Toms can also explain this better.

I will try it. :)

You are right, Rebecca. Of course, it would be possible to include all the
bells and whistles that DocBook provides. However, our intention was to
make it as easy as possible.

To provide some technical background from Rebecca's example you could add
on every sect1 (lesson) the attribute "userlevel". This attribute gives a
hint of how difficult is this lesson. It can have any of the
values "easy", "medium" or "difficult". With the help of our XML build
mechanics it is possible just to render the "easy" lessons. Or
the "medium" ones. Or for experts the "difficult" lessons. Or create a
book with everything in it.

DocBook provides more of these features. However, you have to be careful
not to overuse it. For the start we choose a very simple approach.
BUT: From my perspective, it's better to have content (lessons) than to
take care of these technical details. These details can be discussed and
implemented later. We need content! :-)

> > [...]
> > Did I mention that is my favorite
> > vocabulary.
> I occasionally use less common words in my first draft without thinking
> about it. I use the online Merriam Webster as my first point for quick
> checks, but if I want stuff beyond that, I tend to refer to one of my
> reference books. But maybe it would be a good idea to add a list of
> useful online references somewhere in the LfL project wiki?

Yes, please. :-) Maybe a page "Help for Contributors"?


SUSE LINUX Products GmbH >o) Documentation Team
Maxfeldstrasse 5 /\\ Technical Editor
90409 Nuernberg, Germany _\_v
To unsubscribe, e-mail: opensuse-doc+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-doc+help@xxxxxxxxxxxx

< Previous Next >