Mailinglist Archive: opensuse-doc (50 mails)

< Previous Next >
Re: [opensuse-doc] Online Manual input source
  • From: Thomas Schraitle <thomas.schraitle@xxxxxxx>
  • Date: Tue, 8 May 2007 19:28:14 +0200
  • Message-id: <200705081928.14695.thomas.schraitle@xxxxxxx>
Hi Hylton,

welcome to opensuse-doc! :-)

On Dienstag, 8. Mai 2007, Hylton Conacher (ZR1HPC) wrote:
> >
> > Have you looked into the Lessons for Lizards project?  It might be an
> > excellent way to get the information you consider important into an
> > easily-accessible format.....
>
> I have, and find that it is not categorised and as structured as I
> would have expected and the menu is faar too long as I am almost sure
> many of the subheadings could be grouped under a single parent heading.

We have started it only a few months ago so it takes time everybody get 
used to it. It might look a bit unbalanced.


> > .... The plan is to provide LfL on an equal footing to
> > our internally-produced manuals, so it definitely would be somewhere
> > even newbies could find it.
>
> With this in mind ie that newies and Windows users will be reading LFL,
> it needs to be far more structured so that it is easy to navigate an
> item a newbie is searching for assistance on.

Do you have something special in mind? I am very interested in listing to 
your suggestions. Could you elaborate your ideas a bit more? Is it the 
structure itself or the content of some articles, or anything else?


> > The in-house documentation team is willing to help you get started
> > contributing articles and help with conversion to docbook if needed.
>
> I would be interested in joining the DUSE Documentation Team and
> lending a hand, learning lots but producing a better customer
> experience. I cannot say I know Linux, but I know more about Linux than
> the average Windows user and I have a willingness to learn. I'm 
> thinking of perhaps writing a few pages on tips that I would be
> interested in ie I'd establish the tip but ask that I can then pose
> questions on the opensuse list and also to the documentation team to
> obtain the information I need to complete the tip.

That's a fair deal. :-) There are lots of task to improve LfL, you do not 
have to be necessarily a writer. For more details look here:

  http://developer.novell.com/wiki/index.php/Lfl/Tasks


> I notice that Openoffice.org 2.04 can save in Docbook format and I
> wonder if the template is available in .odt format? I'd have a later
> version of OOo but I haven't been able to get Yast to find a newer
> source.

We didn't create a template in OpenOffice.org. When I tried it last time 
it created a pretty flat structure. Unfortunatly it takes some time and 
XML experience to adapt it to the LfL structure depending it how your 
original document looks like. I don't think this makes sense.
 
However, if you would like to write something, I would suggest to have a 
look at the LfL template, at

 https://forgesvn1.novell.com/viewsvn/lfl/trunk/common/xml/

It's a DocBook-XML file and the preferred format. The file contains the 
basic structure for writing any articles, so you can use it as a start. 
If you feel uncomfortable with this format you can also write in plain 
text and ask for any volunteer to convert it. Please read also the "Quick 
Start for Writers":

 http://developer.novell.com/wiki/index.php/Lfl/Quick_Start_for_Writers

And of course, if you have any special questions don't hesitate to ask on 
this mailinglist. :-)


> [...]

Thanks for asking! :-)



Bye,
Tom

-- 
----------------------------------------------------------------------
SUSE LINUX Products GmbH   >o)   
Maxfeldstrasse 5           /\\   Documentation Specialist
90409 Nuernberg, Germany  _\_v   http://en.opensuse.org/Documentation_Team
SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG N├╝rnberg)
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-doc+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-doc+help@xxxxxxxxxxxx

< Previous Next >