User Manuals: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
* A [[Basic Tutorial]] on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra.
* A [[Basic Tutorial]] on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra.
* A first start has been made at https://docs.openpetra.org/ and https://handbuch.openpetra.de/
* A first start has been made at https://docs.openpetra.org/ and https://handbuch.openpetra.de/
See [[Application_Help|Application Help]] for another form of documentation for OpenPetra.


==Goals of OpenPetra User Guides==
==Goals of OpenPetra User Guides==
===Content===
===Content===
* Should provide thorough instructions and answers on how to use OpenPetra effectively.
* Should provide thorough instructions and answers on how to use OpenPetra effectively.
===Format===
* A separate User Guide for each of the OpenPetra Modules should be created.
* A 'General User Guide' for a general introduction to OpenPetra should be created.


===Portable===
===Portable===
Line 23: Line 16:


===Authoring of User Guides===
===Authoring of User Guides===
====In this wiki====
====Using Sphinx====
The plan is to write the content of the User Guides here in the wiki, and to then  create PDF files from it (see 'Creation of User Guides' below).
The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.
 
[[Start page for the actual content of the User Guides]]
 
TODO: instructions about how to organise chapters, topics, screenshots etc.
 
 
=====Creation of User Guides=====
The content of the wiki pages from page [[Start page for the actual content of the User Guides]] onwards will first need to be exported in an automated way and end up in an ''intermediate format'' (quite possibly [http://www.sagehill.net/docbookxsl/preface.html DocBook]).
From that intermediate format nicely layed out ''PDF files'' will need to be created.
This will make it possible to view the User Guides on any operating system.
 
The 'nice layout' could be reached
* manually
** by editing the DocBook intermediate format manually, e.g. using an WYSIWG editor for DocBook files such as [[http://www.syntext.com/downloads/serna-free/ Syntex Serna Free]], or OpenOffice. For OpenOffice, import filters for the DocBook format exist, and also conversion utilities that convert the DocBook format into OpenOffice's native OpenDocument format.
* automatically
** by using tools which apply XSL transformations to create a nice layout and which result in PDF files (similar to the process which [[FLOSS Manuals]] uses).
 
TODO: Details


See https://docs.openpetra.org/contributions/index.html for more details!


==== Possible Alternative: FLOSS Manuals====
Sphinx projects can be published at https://readthedocs.org/
See [[FLOSS Manuals]]

Latest revision as of 06:29, 10 September 2022

Overview

At this point in time, there are no comprehensive User Guides for OpenPetra users available.

Current Options

Goals of OpenPetra User Guides

Content

  • Should provide thorough instructions and answers on how to use OpenPetra effectively.

Portable

  • User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format.


Authoring of User Guides

Using Sphinx

The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.

See https://docs.openpetra.org/contributions/index.html for more details!

Sphinx projects can be published at https://readthedocs.org/

Retrieved from ‘https://wiki.openpetra.org/index.php?title=User_Manuals&oldid=4923’