Home Wiki > openSUSE:Documentation team
Sign up | Login

openSUSE:Documentation team

tagline: From openSUSE

Introduction

We are a group of dedicated people writing and maintaining the openSUSE/SUSE Linux manuals. We collect input from all kinds of sources available to us.

Communicate

Reaching out to us is pretty easy. If you have typos, questions, suggestions or simply want to say hello, these are the places to go:

Members


  • Vanessa Wallfahrer
  • Stefan Knorr

How to contribute

1) The easy way (wiki style): Go to http://activedoc.opensuse.org/

2) The more involved way (docbook style):

Check out our gentle intro on How to contribute to openSUSE Documentation.

If you are an EMACS user, you may find our Docbook macros for Emacs useful.

Where to get our manuals

Our manuals are shipped with each product, be it openSUSE or a business related product. The manuals are also available for download on the official documentation page.

  • openSUSE comes with a lot of manuals in HTML and PDF format with a current page count of almost 2000 pages. The official list is now maintained in List of manuals.

For information where to find the manuals on your installation media, refer to the release notes.

susedoc package

Icon-cleanup.png This article is in need of attention because it does not follow our wiki guidelines. .
The successor to susedoc is daps and the following section describes susedoc.

.
If you want to contribute, please read the rules for this wiki and if you have any questions, don't hesitate to contact the wiki team, we are more then willing to help you! :-)

To create and publish our manuals, we use open source tools: The manuals are written in XML, using the Novdoc DTD, a subset of DocBook (see http://www.docbook.org). The XML source files are validated by xmllint, processed by xsltproc, and converted into XSL-FO using a customized version of Norman Walsh's stylesheets. The final PDF is formatted through XEP from RenderX.

Since SUSE Linux 10.1, we also ship the XML source files of our manuals. Find them in the opensuse-manual_LANGUAGE package on the installation media (or download it from http://download.opensuse.org/source/distribution/12.2/repo/oss/suse/src/). Unpack the .src.rpm and find the XML files in several tarballs (*tar.bz2) which you can unpack to get the source files for the respective manual.

The documentation environment we use to create and publish our manuals is developed and maintained by us and released under GPL. It is also available as susedoc*.rpm package (see also our SVN on http://svn.opensuse.org/viewvc/opensuse-doc/trunk/tools/docmaker/) and shipped with the openSUSE distro. Install and use it, if you like (it also works with FOP instead of XEP)  :).

Get the latest susedoc*.rpm package from the openSUSE Build Service (it is located under openSUSE_RELEASE/noarch/).

Related projects