NovDoc Usage

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

NovDoc Usage

Bryant, Christian
I'm going to be working on some custom appliances using SUSE Studio.  I love the susedoc style sheets but I'm not clear on the usage requirements and wanted to make sure that I can use susedoc to create manuals for my appliances that look exactly like the actual openSUSE manuals.  I know the code for susedoc is GPL but are there some documentation guidelines for folks like me that have this type of project in mind?

Thank you.

Cheers,

Christian Bryant, UCLA Health System
Project Manager, IT Operations
Medical Information Technology Services (MITS)


IMPORTANT WARNING:  This email (and any attachments) is only intended for the use of the person or entity to which it is addressed, and may contain information that is privileged and confidential.  You, the recipient, are obligated to maintain it in a safe, secure and confidential manner.  Unauthorized redisclosure or failure to maintain confidentiality may subject you to federal and state penalties. If you are not the intended recipient, please immediately notify us by return email, and delete this message from your computer.
--
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: NovDoc Usage

Thomas Schraitle-3
Hi Christian,

On Friday 01 October 2010 Bryant, Christian wrote:
> ... I love the susedoc style sheets

Thanks! :) Actually I'm the person who is in charge of the susedoc package.


> ... but I'm not clear on the usage requirements
> and wanted to make sure that I can use susedoc to create manuals for my
> appliances that look exactly like the actual openSUSE manuals.  I know the
> code for susedoc is GPL but are there some documentation guidelines for
> folks like me that have this type of project in mind?

At the moment, the current project is hosted on BerliOS:

  http://developer.berlios.de/projects/opensuse-docmaker/

If you are interested in the technical background, the following link points
to a PDF which may be useful for you:

  https://svn.berlios.de/svnroot/repos/opensuse-
docmaker/trunk/doc/susemakedoc.pdf

If you have further questions, don't hesitate to let us know on the opensuse-
doc mailinglist. :)


--
Gruß/Regards,
    Thomas Schraitle

----------------------------------------------------------------------
SUSE LINUX Products GmbH   (o<   Documentation Specialist
Maxfeldstrasse 5           /\\  
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: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: NovDoc Usage

Frank Sundermeyer
In reply to this post by Bryant, Christian
On Thu, 30 Sep 2010 15:44:29 -0700 Bryant, Christian wrote:

Hi,

> I'm going to be working on some custom appliances using SUSE Studio.
> I love the susedoc style sheets

BTW: Make sure to install the latest version of susedoc (see toms'
post), we have recently added new and much improved CSS for HTML builds.

> but I'm not clear on the usage
> requirements and wanted to make sure that I can use susedoc to create
> manuals for my appliances that look exactly like the actual openSUSE
> manuals.  I know the code for susedoc is GPL but are there some
> documentation guidelines for folks like me that have this type of
> project in mind?

In addition to what toms already posted, I have made our style guide
available on Berlios:

https://svn.berlios.de/wsvn/opensuse-doc/trunk/documents/styleguide/en/opensuse_documentation_styleguide_r115_2010-10-0-13%3A11.pdf

--
Regards
        Frank

Frank Sundermeyer, Technical Writer, Documentation
SUSE Linux Products GmbH, Maxfeldstr. 5, D-90409 Nuernberg
Tel: +49-911-74053-0, Fax: +49-911-7417755;  http://www.opensuse.org/
SUSE Linux Products GmbH, GF: Markus Rex, HRB 16746 (AG Nuernberg)
"Reality is always controlled by the people who are most insane" Dogbert
--
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

RE: NovDoc Usage

Bryant, Christian
Tom and Frank - Thanks very much for the information.  The style guide is going to be very useful, too.  I've taken a snapshot of the latest code.  Great work, by the way.  I always know I'm home when I crack open a SUSE document ;)

Cheers,

Christian Bryant

-----Original Message-----
From: Frank Sundermeyer [mailto:[hidden email]]
Sent: Friday, October 01, 2010 4:25 AM
To: [hidden email]
Subject: Re: [opensuse-doc] NovDoc Usage

On Thu, 30 Sep 2010 15:44:29 -0700 Bryant, Christian wrote:

Hi,

> I'm going to be working on some custom appliances using SUSE Studio.
> I love the susedoc style sheets

BTW: Make sure to install the latest version of susedoc (see toms'
post), we have recently added new and much improved CSS for HTML builds.

> but I'm not clear on the usage
> requirements and wanted to make sure that I can use susedoc to create
> manuals for my appliances that look exactly like the actual openSUSE
> manuals.  I know the code for susedoc is GPL but are there some
> documentation guidelines for folks like me that have this type of
> project in mind?

In addition to what toms already posted, I have made our style guide
available on Berlios:

https://svn.berlios.de/wsvn/opensuse-doc/trunk/documents/styleguide/en/opensuse_documentation_styleguide_r115_2010-10-0-13%3A11.pdf

--
Regards
        Frank

Frank Sundermeyer, Technical Writer, Documentation
SUSE Linux Products GmbH, Maxfeldstr. 5, D-90409 Nuernberg
Tel: +49-911-74053-0, Fax: +49-911-7417755;  http://www.opensuse.org/
SUSE Linux Products GmbH, GF: Markus Rex, HRB 16746 (AG Nuernberg)
"Reality is always controlled by the people who are most insane" Dogbert
--
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]


IMPORTANT WARNING:  This email (and any attachments) is only intended for the use of the person or entity to which it is addressed, and may contain information that is privileged and confidential.  You, the recipient, are obligated to maintain it in a safe, secure and confidential manner.  Unauthorized redisclosure or failure to maintain confidentiality may subject you to federal and state penalties. If you are not the intended recipient, please immediately notify us by return email, and delete this message from your computer.
--
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]