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

Sphinx: extended doc

parent e8f5c37e
......@@ -144,7 +144,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -57,7 +57,7 @@
<tbody valign="top">
<tr class="field-odd field">
<th class="field-name">Classification:</th>
<td class="field-body">extension_key</td>
<td class="field-body">qfq</td>
</tr>
<tr class="field-even field">
<th class="field-name">Version:</th>
......@@ -69,11 +69,15 @@
</tr>
<tr class="field-even field">
<th class="field-name">Description:</th>
<td class="field-body">enter description.</td>
<td class="field-body">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.
</td>
</tr>
<tr class="field-odd field">
<th class="field-name">Keywords:</th>
<td class="field-body">comma,separated,list,keywords</td>
<td class="field-body">Quick Form Query, Form, Report, SQL, Query, Generator</td>
</tr>
<tr class="field-even field">
<th class="field-name">Copyright:</th>
......@@ -81,12 +85,12 @@
</tr>
<tr class="field-odd field">
<th class="field-name">Author:</th>
<td class="field-body">Rafael Ostertag</td>
<td class="field-body">Carsten Rose</td>
</tr>
<tr class="field-even field">
<th class="field-name">Email:</th>
<td class="field-body"><a class="reference external"
href="mailto:author&#37;&#52;&#48;example&#46;com">author<span>&#64;</span>example<span>&#46;</span>com</a>
href="mailto:carsten&#46;rose&#37;&#52;&#48;math&#46;uzh&#46;ch">carsten<span>&#46;</span>rose<span>&#64;</span>math<span>&#46;</span>uzh<span>&#46;</span>ch</a>
</td>
</tr>
<tr class="field-odd field">
......@@ -97,7 +101,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Rendered:</th>
<td class="field-body">2016-03-02 20:19</td>
<td class="field-body">2016-03-06 12:46</td>
</tr>
</tbody>
</table>
......@@ -112,15 +116,54 @@
<li class="toctree-l1"><a class="reference internal" href="Introduction/Index.html">What
does it do?</a></li>
<li class="toctree-l1"><a class="reference internal" href="UsersManual/Index.html">Users
manual</a>
manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="UsersManual/Form.html">Form</a>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#form-specification">Form
specification</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#variable-incl-mixed-sql-statement">Variable
(incl. mixed SQL Statement)</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#url-parameter">URL Parameter</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#sanitize-class">Sanitize class</a>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#store-prio">Store / prio</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#predefined-variable-names">Predefined
variable names</a>
<ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#sql">SQL</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#id4">Form</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#form-parameter">Form.parameter</a>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#formelement">FormElement</a></li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#class-container">Class: Container</a>
<ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#class-native">Class: Native</a>
<ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="AdministratorManual/Index.html">Administrator
Manual</a>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#class-action">Class: Action</a>
<ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="Links.html">Links</a></li>
</ul>
</div>
......@@ -174,7 +217,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -135,7 +135,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="QFQ Extension 0.1.0 documentation" href="index.html"/>
<link rel="prev" title="Administrator Manual" href="AdministratorManual/Index.html"/>
<link rel="prev" title="Report" href="UsersManual/Report.html"/>
</head>
<body>
<div class="related">
......@@ -34,7 +34,7 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right">
<a href="AdministratorManual/Index.html" title="Administrator Manual"
<a href="UsersManual/Report.html" title="Report"
accesskey="P">previous</a> |
</li>
<li><a href="Index.html">QFQ Extension 0.1.0 documentation</a> &raquo;</li>
......@@ -90,8 +90,8 @@
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="AdministratorManual/Index.html"
title="previous chapter">Administrator Manual</a></p>
<p class="topless"><a href="UsersManual/Report.html"
title="previous chapter">Report</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
......@@ -123,14 +123,14 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right">
<a href="AdministratorManual/Index.html" title="Administrator Manual"
<a href="UsersManual/Report.html" title="Report"
>previous</a> |
</li>
<li><a href="Index.html">QFQ Extension 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -79,12 +79,12 @@
</tr>
<tr class="field-odd field">
<th class="field-name">Autor:</th>
<td class="field-body">Rafael Ostertag</td>
<td class="field-body">Carsten Rose</td>
</tr>
<tr class="field-even field">
<th class="field-name">E-Mail:</th>
<td class="field-body"><a class="reference external"
href="mailto:author&#37;&#52;&#48;example&#46;com">author<span>&#64;</span>example<span>&#46;</span>com</a>
href="mailto:carsten&#46;rose&#37;&#52;&#48;math&#46;uzh&#46;ch">carsten<span>&#46;</span>rose<span>&#64;</span>math<span>&#46;</span>uzh<span>&#46;</span>ch</a>
</td>
</tr>
<tr class="field-odd field">
......@@ -96,7 +96,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Gerendert:</th>
<td class="field-body">2016-03-02 20:19</td>
<td class="field-body">2016-03-04 16:34</td>
</tr>
</tbody>
</table>
......@@ -151,7 +151,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -76,12 +76,12 @@
</tr>
<tr class="field-odd field">
<th class="field-name">Auteur:</th>
<td class="field-body">Rafael Ostertag</td>
<td class="field-body">Carsten Rose</td>
</tr>
<tr class="field-even field">
<th class="field-name">E-mail:</th>
<td class="field-body"><a class="reference external"
href="mailto:author&#37;&#52;&#48;example&#46;com">author<span>&#64;</span>example<span>&#46;</span>com</a>
href="mailto:carsten&#46;rose&#37;&#52;&#48;math&#46;uzh&#46;ch">carsten<span>&#46;</span>rose<span>&#64;</span>math<span>&#46;</span>uzh<span>&#46;</span>ch</a>
</td>
</tr>
<tr class="field-odd field">
......@@ -93,7 +93,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Généré:</th>
<td class="field-body">2016-03-02 20:19</td>
<td class="field-body">2016-03-04 16:34</td>
</tr>
</tbody>
</table>
......@@ -148,7 +148,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -24,7 +24,7 @@
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="QFQ Extension 0.1.0 documentation" href="../index.html"/>
<link rel="next" title="Administrator Manual" href="../AdministratorManual/Index.html"/>
<link rel="next" title="Form" href="Form.html"/>
<link rel="prev" title="What does it do?" href="../Introduction/Index.html"/>
</head>
<body>
......@@ -35,7 +35,7 @@
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right">
<a href="../AdministratorManual/Index.html" title="Administrator Manual"
<a href="Form.html" title="Form"
accesskey="N">next</a> |
</li>
<li class="right">
......@@ -57,54 +57,20 @@
<h1>Users manual<a class="headerlink" href="#users-manual" title="Permalink to this headline"></a>
</h1>
<p>Documentation of how to use the extension, how it works, how to apply it, if it&#8217;s a website
plugin.</p>
<p>Language should be non-technical, explaining, using small examples. Don&#8217;t use to many
acronyms unless they have been explained.</p>
<p>Examples: For the &#8220;News&#8221; plugin this would be a manual showing how to create the news
items, explaining the options etc.</p>
<p>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.</p>
<p>Target group: <strong>Users</strong></p>
<div class="figure">
<a class="reference internal image-reference" href="../_images/BackendView.png"><img
alt="Backend view" src="../_images/BackendView.png" style="width: 500px;"/></a>
<p class="caption">Default Backend view (caption of the image)</p>
<div class="legend">
The Backend view of TYPO3 after the user has clicked on module &#8220;Page&#8221;. (legend
of the image)
</div>
</div>
<div class="section" id="link-to-official-documentation">
<h2>Link to official documentation<a class="headerlink" href="#link-to-official-documentation"
title="Permalink to this headline"></a></h2>
<p>Sphinx makes it easy to link to official TYPO3 documentation:</p>
<ul class="simple">
<li><em class="xref std std-ref">TYPO3 Tutorial for Editors</em></li>
<li><em class="xref std std-ref">Getting Started Tutorial</em></li>
</ul>
<p>and you may even link to a very specific chapter explaining how to <em
class="xref std std-ref">create a browser condition</em> within the TypoScript
Reference.</p>
<p>For a complete reference of available cross-link prefixes, please consult file <tt
class="docutils literal"><span class="pre">_make/conf.py</span></tt>.</p>
<div class="section" id="faq">
<h3>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline"></a></h3>
<p>Possible subsection: FAQ</p>
</div>
</div>
<p>here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is
some content. here is some content.</p>
</div>
......@@ -113,28 +79,14 @@
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../Index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Users manual</a>
<ul>
<li><a class="reference internal" href="#link-to-official-documentation">Link to official
documentation</a>
<ul>
<li><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Introduction/Index.html"
title="previous chapter">What does it do?</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../AdministratorManual/Index.html"
title="next chapter">Administrator Manual</a></p>
<p class="topless"><a href="Form.html"
title="next chapter">Form</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
......@@ -166,7 +118,7 @@
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right">
<a href="../AdministratorManual/Index.html" title="Administrator Manual"
<a href="Form.html" title="Form"
>next</a> |
</li>
<li class="right">
......@@ -177,7 +129,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -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)
FAQ
^^^
......
......@@ -15,7 +15,7 @@ QFQ Extension
.. only:: html
:Classification:
extension_key
qfq
:Version:
|release|
......@@ -24,19 +24,21 @@ QFQ Extension
en
: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:
comma,separated,list,keywords
Quick Form Query, Form, Report, SQL, Query, Generator
:Copyright:
2016
:Author:
Rafael Ostertag
Carsten Rose
:Email:
author@example.com
carsten.rose@math.uzh.ch
:License:
This document is published under the Open Publication License
......@@ -57,5 +59,6 @@ QFQ Extension
Introduction/Index
UsersManual/Index
AdministratorManual/Index
UsersManual/Form
UsersManual/Report
Links
......@@ -33,10 +33,10 @@ QFQ Extension (Deutsch)
2016
:Autor:
Rafael Ostertag
Carsten Rose
:E-Mail:
author@example.com
carsten.rose@math.uzh.ch
:Lizenz:
Dieses Dokument wird unter der Open Content License, siehe
......
......@@ -33,10 +33,10 @@ QFQ Extension (Français)
2016
:Auteur:
Rafael Ostertag
Carsten Rose
:E-mail:
author@example.com
carsten.rose@math.uzh.ch
:Licence:
Ce document est publié sous la licence de contenu libre
......
.. ==================================================
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
......@@ -11,39 +11,10 @@
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
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
here is some content. here is some content. here is some content. here is some content. here is some content. here is some content.
\ No newline at end of file
......@@ -291,7 +291,6 @@ var Search = {
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
}
pulse();
},
......@@ -411,7 +410,6 @@ var Search = {
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
......@@ -474,7 +472,6 @@ var Search = {
Search.status.fadeIn(500);
}
}
displayNextItem();
},
......
......@@ -22,13 +22,13 @@
*/
$(function () {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
......
......@@ -85,7 +85,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
......@@ -2,6 +2,6 @@
# Project: QFQ Extension
# Version: 0.1
# The remainder of this file is compressed using zlib.
xmM
09E@hŭ;
ZF`~$3<ӘTy{/JZel9Xh8J͓9:5̴s Ehf(ޒuN4Zv(~$j*ݏS|Y{k # <Ý@;r6=CM\Jʬ䫖7'|)ah䁜H^
\ No newline at end of file
0EFqBUьm0mZ5n^Ν"#+
/:h5YHINA7ɧޓ<NG)l888SҜ?D]i$i+8mn|l f +ڇt ݱNXwq`suoMk46 "t!2+au d&5}_PR.fwpP$
\ No newline at end of file
......@@ -96,7 +96,7 @@
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Rafael Ostertag.
&copy; Copyright 2016, Carsten Rose.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
......
Markdown is supported
0% or