Novell Home

Lfl/Lessons for Lizards FAQ

From Developer Community

< Back to Lessons for Lizards Home

Contents

General FAQ

What is LFL or “Lessons for Lizards”?

Lessons for Lizards (LfL) is a community cookbook-style book project for the openSUSE distribution licensed under the GNU Free Documentation License (GFDL). It is planned to ship this book with upcoming openSUSE releases on an equal footing with internally produced documentation. Lessons for Lizards covers more specific or exotic topics than the internally produced manuals, such as

  • experimental software
  • third party software
  • third party drivers
  • complex setups (e.g., a router for the home network)


What's the aim of LFL? Why another openSUSE book?

One aim of the LfL project is to enable the openSUSE community to actively participate in the openSUSE documentation. The other aim is to provide a cookbook for beginners and experts with step-by-step recipes and hands-on guides on topics, not covered in the present documenation. The book should be easy to understand and easy to write. In order to enable this goal, Novell provides a technical environment, software and support.


Why yet another openSUSE book?

At present, users can get all sorts of documentation on Linux and openSUSE in particular, ranging from HOWTOs to expert books. However, the documentation team feels the need for a book in cookbook style with step-by-step instructions, because such a guide is hard to find. From our own experience with existing documentation in cookbook-style, we know that such books are most helpful when being in need for hands-on solutions.


What is the license of this project?

All materials in this project are licensed under GNU Free Documentation License.


What is the state of this project?

12/18/2006: We have created the necessary infrastructure with some example documents. However, we need you to write articles about your itching problems to make LfL a real success.


I would rather contribute to the official openSUSE documentation. How?

Our sources, released under the GFDL, are available on openSUSE.org. You can send us patches (via the opensuse-doc mailing list) or use Bugzilla to report errors and improvements.


Where can I get help?

Subscribe to <opensuse-doc@opensuse.org>. The friendly people on this list will answer your questions.
Subscribe | Unsubscribe | Help | Archives


Ok, I am convinced. Where do I sign?

Use the LFL Quickstart for a short introduction.


Which are the administrators behind LfL?

See Documentation Team


What's next?

We suggest the following procedure:

  1. Check first, if the topic is already covered by our openSUSE manuals.
  2. Find a topic about which you would like to write something.
  3. Build a PDF
  4. Write to the opensuse-doc mailinglist to coordinate with others
  5. Install the software needed to build a Lessons for Lizards book
  6. Get the project files
  7. Write your text in DocBook XML
  8. Create your book in PDF or PDF or HTML format
  9. Commit your files to the project


Technical FAQ

Why should I learn DocBook XML?

Why not? ;-)

Write once, publish anywhere. This is the paradigma of creating documents in XML and especially in DocBook. With the help of DocBook you write your text in a format-independent way. Applying a stylesheet to your file creates HTML, PDF or any other format that is supported.

DocBook is also the de-facto standard for writing documentation. The Linux documentation project, KDE, GNOME, Samba,…,—all these projects use DocBook. If you “learn” DocBook, you can use your experience in other projects as well—no need to get used to something completely new.

Actually, you don't have to “learn” DocBook inside out—we provide an easy to fill in XML template and offer examples ready to be used by cut and paste. Whatsmore, our mechanic makes it also very easy to validate your documents. In case of errors, the validator offers detailed error reports. Even more help is available within our Style Guide. Of course, you can also find a lot of tutorials in the Internet. The main sources for DocBook are www.docbook.org and [1].


Can I write in other formats?

Yes. Although we prefer DocBook XML you can write your initial text in ASCII. We will help you to convert it to DocBook/XML, which will make it much easier for you to do future work in DocBook/XML. Please ask on the opensuse-doc mailinglist.


I get lots of warnings when building a PDF. What to do?

As lang as FOP only issues warnings, you can savely ignore them.


I get errors when building a PDF. What to do?

You probably have a wrong FOP and/or Java version installed. Please see the Quickstart for more information.


When building a PDF book, the process stops with XEP_CONFIG_FILE= fop -q tmp/Lessons4Lizards.fo Lessons4Lizards.pdf. What to do?

Please be patient. Depending on your hardware, building a PDF can take a long time. You may check with top in another shell—while the message above is listed, a java process runs.

Novell® Making IT Work As One

© 2008 Novell, Inc. All Rights Reserved.