Commit 7a609638 authored by Carsten  Rose's avatar Carsten Rose
Browse files

Sphinx: extended doc

parent e8f5c37e
...@@ -34,7 +34,6 @@ How should the extension be set up? E.g. is there a static template to include? ...@@ -34,7 +34,6 @@ How should the extension be set up? E.g. is there a static template to include?
List of extensions within the Extension Manager also shortend as "EM" (legend of the image) List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
FAQ FAQ
^^^ ^^^
......
...@@ -15,7 +15,7 @@ QFQ Extension ...@@ -15,7 +15,7 @@ QFQ Extension
.. only:: html .. only:: html
:Classification: :Classification:
extension_key qfq
:Version: :Version:
|release| |release|
...@@ -24,19 +24,21 @@ QFQ Extension ...@@ -24,19 +24,21 @@ QFQ Extension
en en
:Description: :Description:
enter description. The extension offers support to
a) create HTML Forms by clicking them together,
b) create reports based an SQL queries. The SQL can be nested and offers support for any kind of tags.
:Keywords: :Keywords:
comma,separated,list,keywords Quick Form Query, Form, Report, SQL, Query, Generator
:Copyright: :Copyright:
2016 2016
:Author: :Author:
Rafael Ostertag Carsten Rose
:Email: :Email:
author@example.com carsten.rose@math.uzh.ch
:License: :License:
This document is published under the Open Publication License This document is published under the Open Publication License
...@@ -57,5 +59,6 @@ QFQ Extension ...@@ -57,5 +59,6 @@ QFQ Extension
Introduction/Index Introduction/Index
UsersManual/Index UsersManual/Index
AdministratorManual/Index UsersManual/Form
UsersManual/Report
Links Links
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _start:
=============================================================
QFQ Extension (Deutsch)
=============================================================
.. only:: html
:Klassifikation:
extension_key
:Version:
|release|
:Sprache:
de
:Beschreibung:
Geben Sie eine Beschreibung ein.
:Schlüsselwörter:
komma-getrennte,Liste,von,Schlüsselwörtern
:Copyright:
2016
:Autor:
Rafael Ostertag
:E-Mail:
author@example.com
:Lizenz:
Dieses Dokument wird unter der Open Content License, siehe
http://www.opencontent.org/opl.shtml veröffentlicht.
:Gerendert:
|today|
Der Inhalt dieses Dokuments bezieht sich auf TYPO3,
ein GNU/GPL CMS-Framework auf `www.typo3.org <https://typo3.org/>`__.
**Inhaltsverzeichnis**
.. toctree::
:maxdepth: 3
:titlesonly:
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
How to translate
================
This directory contains the German translation of your documentation.
This is a complete Sphinx project but you may reuse assets from the
main documentation under Documentation/.
If you plan to translate your documentation to German, you should
rename this directory and remove the suffix ".tmpl":
Localization.de_DE.tmpl -> Localization.de_DE
As this file is not needed either, feel free to delete it as well.
Supported languages
===================
Please visit http://sphinx-doc.org/latest/config.html#intl-options for a
list of languages supported by Sphinx.
Please note however that TYPO3 is using locales so you may need to
extend the language code from Sphinx into a proper locale to be used
by TYPO3.
# This is the project specific Settings.yml file.
# Place Sphinx specific build information here.
# Settings given here will replace the settings of 'conf.py'.
---
conf.py:
copyright: 2016
project: QFQ Extension (Deutsch)
version: 0.1
release: 0.1.0
latex_documents:
- - Index
- qfq.tex
- QFQ Extension
- Rafael Ostertag
- manual
latex_elements:
papersize: a4paper
pointsize: 10pt
preamble: \usepackage{typo3}
...
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _start:
=============================================================
QFQ Extension (Français)
=============================================================
.. only:: html
:Classification:
extension_key
:Version:
|release|
:Langue:
fr
:Description:
entrez une description.
:Mots-clés:
list,mots-clés,séparés,par,virgules
:Copyright:
2016
:Auteur:
Rafael Ostertag
:E-mail:
author@example.com
:Licence:
Ce document est publié sous la licence de contenu libre
disponible sur http://www.opencontent.org/opl.shtml
:Généré:
|today|
Le contenu de ce document est en relation avec TYPO3,
un CMS/Framework GNU/GPL disponible sur `www.typo3.org <https://typo3.org/>`__.
**Sommaire**
.. toctree::
:maxdepth: 3
:titlesonly:
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
How to translate
================
This directory contains the French translation of your documentation.
This is a complete Sphinx project but you may reuse assets from the
main documentation under Documentation/.
If you plan to translate your documentation to French, you should
rename this directory and remove the suffix ".tmpl":
Localization.fr_FR.tmpl -> Localization.fr_FR
As this file is not needed either, feel free to delete it as well.
Supported languages
===================
Please visit http://sphinx-doc.org/latest/config.html#intl-options for a
list of languages supported by Sphinx.
Please note however that TYPO3 is using locales so you may need to
extend the language code from Sphinx into a proper locale to be used
by TYPO3.
# This is the project specific Settings.yml file.
# Place Sphinx specific build information here.
# Settings given here will replace the settings of 'conf.py'.
---
conf.py:
copyright: 2016
project: QFQ Extension (Français)
version: 0.1
release: 0.1.0
latex_documents:
- - Index
- qfq.tex
- QFQ Extension
- Rafael Ostertag
- manual
latex_elements:
papersize: a4paper
pointsize: 10pt
preamble: \usepackage{typo3}
...
...@@ -12,7 +12,7 @@ conf.py: ...@@ -12,7 +12,7 @@ conf.py:
- - Index - - Index
- qfq.tex - qfq.tex
- QFQ Extension - QFQ Extension
- Rafael Ostertag - Carsten Rose
- manual - manual
latex_elements: latex_elements:
papersize: a4paper papersize: a4paper
......
This diff is collapsed.
.. ================================================== .. ==================================================
.. FOR YOUR INFORMATION .. FOR YOUR INFORMATION
.. -------------------------------------------------- .. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM. .. -*- coding: utf-8 -*- with BOM.
...@@ -11,39 +11,26 @@ ...@@ -11,39 +11,26 @@
Users manual Users manual
============ ============
Documentation of how to use the extension, how it works, how to apply it, if it's a website plugin. The QFQ extension is activated through tt-content records. One or more tt-content records per page are necessary to render
`forms`, `reports` (exports) or to perform `delete` and `save` commands.
Language should be non-technical, explaining, using small examples. Don't use to many acronyms unless they have been explained. Report & Form: Keywords
-----------------------
Examples: For the "News" plugin this would be a manual showing how to create the news items, explaining the options etc.
Provide screenshots of a neutral Backend such as the Backend of the Introduction Package for instance. Have in mind that the User manual could possibly be re-used in a larger documentation compilation, for example when a company generates a documentation for its client. +---------------+-------------------------------------------------------------------+
| Name | Explanation |
+===============+===================================================================+
| form | Formname defined in ttcontent record bodytext |
| | * fix. E.g.: `form = person` |
| | * via SIP. E.g. `form = {{form}} |
+---------------+-------------------------------------------------------------------+
| debugShowStack| Any exception will show the call stack. E.g. `debugShowStack = 1` |
+---------------+-------------------------------------------------------------------+
Target group: **Users**
.. figure:: ../Images/UserManual/BackendView.png
:width: 500px
:alt: Backend view
Default Backend view (caption of the image)
The Backend view of TYPO3 after the user has clicked on module "Page". (legend of the image)
Link to official documentation
------------------------------
Sphinx makes it easy to link to official TYPO3 documentation:
- :ref:`TYPO3 Tutorial for Editors <t3editors:start>`
- :ref:`Getting Started Tutorial <t3start:start>`
and you may even link to a very specific chapter explaining how to :ref:`create a browser condition <t3tsref:condition-browser>` within the TypoScript Reference.
For a complete reference of available cross-link prefixes, please consult file ``_make/conf.py``.
FAQ
^^^
Possible subsection: FAQ
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _users-manual:
Users manual
============
Documentation of how to use the extension, how it works, how to apply it, if it's a website plugin.
Language should be non-technical, explaining, using small examples. Don't use to many acronyms unless they have been explained.
Examples: For the "News" plugin this would be a manual showing how to create the news items, explaining the options etc.
Provide screenshots of a neutral Backend such as the Backend of the Introduction Package for instance. Have in mind that the User manual could possibly be re-used in a larger documentation compilation, for example when a company generates a documentation for its client.
Target group: **Users**
.. figure:: ../Images/UserManual/BackendView.png
:width: 500px
:alt: Backend view
Default Backend view (caption of the image)
The Backend view of TYPO3 after the user has clicked on module "Page". (legend of the image)
Link to official documentation
------------------------------
Sphinx makes it easy to link to official TYPO3 documentation:
- :ref:`TYPO3 Tutorial for Editors <t3editors:start>`
- :ref:`Getting Started Tutorial <t3start:start>`
and you may even link to a very specific chapter explaining how to :ref:`create a browser condition <t3tsref:condition-browser>` within the TypoScript Reference.
For a complete reference of available cross-link prefixes, please consult file ``_make/conf.py``.
FAQ
^^^
Possible subsection: FAQ
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _users-manual-report:
Report
------
report specific docs
\ No newline at end of file
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:39: SEVERE: Unexpected section title. /home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Form.rst:164: WARNING: Inline interpreted text or phrase reference start-string without end-string.
FAQ
^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:29: ERROR: Figure caption must be a paragraph or empty comment.
.. figure:: ../Images/AdministratorManual/ExtensionManager.png
:width: 500px
:alt: Extension Manager
Extension Manager (caption of the image)
List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
FAQ
^^^
Possible subsection: FAQ
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:None: WARNING: image file not readable: AdministratorManual/../Images/AdministratorManual/ExtensionManager.png:width:500px:alt:ExtensionManager
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/ :maxdepth: 3'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/ :titlesonly:'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. Introduction/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. UsersManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. AdministratorManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:13: WARNING: duplicate label start, other instance in /home/a/crose/PhpstormProjects/qfq/extension/Documentation/Index.rst
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/ :maxdepth: 3'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/ :titlesonly:'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. Introduction/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. UsersManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. AdministratorManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:13: WARNING: duplicate label start, other instance in /home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:: WARNING: document isn't included in any toctree
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:: WARNING: document isn't included in any toctree
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:38: WARNING: undefined label: t3editors:start (if the link has no caption the label must precede a section header)
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:39: WARNING: undefined label: t3start:start (if the link has no caption the label must precede a section header)
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:41: WARNING: undefined label: t3tsref:condition-browser (if the link has no caption the label must precede a section header)
WARNING: html_static_path entry u'/home/a/crose/PhpstormProjects/qfq/extension/Documentation/_make/../_static' does not exist WARNING: html_static_path entry u'/home/a/crose/PhpstormProjects/qfq/extension/Documentation/_make/../_static' does not exist
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment