Commit 525063cd authored by Carsten  Rose's avatar Carsten Rose
Browse files

sphinx: more doc

new version number 0.1.1
changed author to Carsten Rose on various places
parent 7a609638
......@@ -6,7 +6,7 @@ EXTENSION_CONTENT = Classes Configuration qfq Resources ext_emconf.php ext_local
all: archive t3sphinx
doc: phpdoc jsdoc t3sphinx
doc: phpdoc jsdoc
t3sphinx:
cd extension/Documentation/_make; make html
......
......@@ -55,10 +55,7 @@ QFQ Extension
.. toctree::
:maxdepth: 3
:titlesonly:
Introduction/Index
UsersManual/Index
UsersManual/Form
UsersManual/Report
Links
This diff is collapsed.
.. ==================================================
.. 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/UsersManual/Form.rst:164: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:145: SEVERE: Title level inconsistent:
Store: `CLIENT` - C
^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:180: SEVERE: Title level inconsistent:
Store: `TYPO3` (Bodytext) - T
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:187: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:203: SEVERE: Title level inconsistent:
Store: `FORM` - F
^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:217: SEVERE: Title level inconsistent:
Store: `RECORD` - R
^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:225: SEVERE: Title level inconsistent:
SQL detection
~~~~~~~~~~~~~
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:356: SEVERE: Title level inconsistent:
Type: fieldset
^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:363: SEVERE: Title level inconsistent:
Type: pill
^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:540: SEVERE: Title level inconsistent:
Class: native
^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:545: SEVERE: Title level inconsistent:
Type: checkbox
^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:581: SEVERE: Title level inconsistent:
Type: date
^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:584: SEVERE: Title level inconsistent:
Type: datetime
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:587: SEVERE: Title level inconsistent:
Type: hidden
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:590: SEVERE: Title level inconsistent:
Type: input
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:598: SEVERE: Title level inconsistent:
Type: note
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:601: SEVERE: Title level inconsistent:
Type: radio
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:624: SEVERE: Title level inconsistent:
Type: select
^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:653: SEVERE: Title level inconsistent:
Type: subrecord
^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:683: SEVERE: Title level inconsistent:
Type: string
^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:686: SEVERE: Title level inconsistent:
Type: submit
^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:691: SEVERE: Title level inconsistent:
Type: time
^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:694: SEVERE: Title level inconsistent:
Type: upload
^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:703: SEVERE: Title level inconsistent:
Type: before load
^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:710: SEVERE: Title level inconsistent:
Type: after load
^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:717: SEVERE: Title level inconsistent:
Type: before save
^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:724: SEVERE: Title level inconsistent:
Type: after save
^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:731: SEVERE: Title level inconsistent:
Type: before /after insert
^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:737: SEVERE: Title level inconsistent:
Type: before /after update
^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:743: SEVERE: Title level inconsistent:
Type: before / after delete
^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:749: SEVERE: Title level inconsistent:
Type: addnupdate
^^^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:754: SEVERE: Title level inconsistent:
Type: sendmail
^^^^^^^^^^^^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:771: SEVERE: Title level inconsistent:
A simple example
````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:994: SEVERE: Title level inconsistent:
Overview of reserved column names
`````````````````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1036: SEVERE: Title level inconsistent:
Column: link
````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1129: SEVERE: Title level inconsistent:
Link Examples
'''''''''''''
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1173: SEVERE: Title level inconsistent:
Columns: pageX or PageX
```````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1256: SEVERE: Title level inconsistent:
Column: vertical
````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1311: SEVERE: Title level inconsistent:
Column: mailto
``````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1360: SEVERE: Title level inconsistent:
Column: sendmail
````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1415: SEVERE: Title level inconsistent:
Column: advancedmail
````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1453: SEVERE: Title level inconsistent:
Column: img
```````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1513: SEVERE: Title level inconsistent:
Column: exec
````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1548: SEVERE: Title level inconsistent:
Column: F
`````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1551: SEVERE: Title level inconsistent:
Challenge 1
'''''''''''
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1617: SEVERE: Title level inconsistent:
Challenge 2
'''''''''''
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1635: SEVERE: Title level inconsistent:
Solution
''''''''
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1720: SEVERE: Title level inconsistent:
Include a form directly
```````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1736: SEVERE: Title level inconsistent:
Include a form via link/url
```````````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1759: SEVERE: Title level inconsistent:
Basic Queries
`````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1831: SEVERE: Title level inconsistent:
Accessing the database
``````````````````````
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/UsersManual/Index.rst:1880: SEVERE: Title level inconsistent:
Formating Examples
``````````````````
WARNING: html_static_path entry u'/home/a/crose/PhpstormProjects/qfq/extension/Documentation/_make/../_static' does not exist
......@@ -101,7 +101,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Rendered:</th>
<td class="field-body">2016-03-06 12:46</td>
<td class="field-body">2016-03-07 12:34</td>
</tr>
</tbody>
</table>
......@@ -116,54 +116,77 @@
<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></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">
manual</a>
<ul>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#report-form-keywords">Report
&amp; Form: Keywords</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#form">Form</a>
<ul>
<li class="toctree-l3"><a class="reference internal"
href="UsersManual/Index.html#form-specification">Form
specification</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#variable-incl-mixed-sql-statement">Variable
(incl. mixed SQL Statement)</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#url-parameter">URL
Parameter</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#sanitize-class">Sanitize
class</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#store-prio">Store / prio</a>
</li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#predefined-variable-names">Predefined
variable names</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#sql">SQL</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#id5">Form</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#form-parameter">Form.parameter</a>
</li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#formelement">FormElement</a>
</li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#class-container">Class:
Container</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#class-native">Class:
Native</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#class-action">Class:
Action</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal"
href="UsersManual/Form.html#class-action">Class: Action</a>
<ul class="simple">
<li class="toctree-l1"><a class="reference internal" href="UsersManual/Index.html#report">Report</a>
<ul>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#how-to-create-a-report">How
to create a report</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#syntax">Syntax</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#structure">Structure</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#wrapping-rows-and-columns-level-keys">Wrapping
rows and columns: Level keys</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#processing-of-columns-in-the-sql-result">Processing
of columns in the SQL result</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#include-a-form">Include a
form</a></li>
<li class="toctree-l2"><a class="reference internal"
href="UsersManual/Index.html#examples">Examples</a></li>
</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>
......
......@@ -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="Report" href="UsersManual/Report.html"/>
<link rel="prev" title="Users manual" href="UsersManual/Index.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="UsersManual/Report.html" title="Report"
<a href="UsersManual/Index.html" title="Users manual"
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="UsersManual/Report.html"
title="previous chapter">Report</a></p>
<p class="topless"><a href="UsersManual/Index.html"
title="previous chapter">Users manual</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
......@@ -123,7 +123,7 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right">
<a href="UsersManual/Report.html" title="Report"
<a href="UsersManual/Index.html" title="Users manual"
>previous</a> |
</li>
<li><a href="Index.html">QFQ Extension 0.1.0 documentation</a> &raquo;</li>
......
......@@ -15,7 +15,7 @@ QFQ Extension
.. only:: html
:Classification:
qfq
qfq
:Version:
|release|
......@@ -24,21 +24,21 @@ QFQ Extension
en
: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.
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:
Quick Form Query, Form, Report, SQL, Query, Generator
Quick Form Query, Form, Report, SQL, Query, Generator
:Copyright:
2016
:Author:
Carsten Rose
Carsten Rose
:Email:
carsten.rose@math.uzh.ch
carsten.rose@math.uzh.ch
:License:
This document is published under the Open Publication License
......@@ -55,10 +55,7 @@ QFQ Extension
.. toctree::
:maxdepth: 3
:titlesonly:
Introduction/Index
UsersManual/Index
UsersManual/Form
UsersManual/Report
Links
......@@ -644,7 +644,7 @@
for (; i < length;) {
if (callback.apply(object[i++], args) === false) {
break;
}
}
}
}
......@@ -660,8 +660,8 @@
for (; i < length;) {
if (callback.call(object[i], i, object[i++]) === false) {
break;
}
}
}
}
}
}
......@@ -855,7 +855,7 @@
} else {
fn.call(elems, value);
fn = null;
}
}
}
if (fn) {
......@@ -2045,7 +2045,7 @@
defer.fire();
}
}, 0);
}
}
}
jQuery.extend({
......@@ -2072,7 +2072,7 @@
} else {
jQuery.removeData(elem, key, true);
handleQueueMarkDefer(elem, type, "mark");
}
}
}
},
......@@ -2122,7 +2122,7 @@
if (!queue.length) {
jQuery.removeData(elem, type + "queue " + type + ".run", true);
handleQueueMarkDefer(elem, type, "queue");
}
}
}
});
......@@ -2360,7 +2360,7 @@
for (; i < l; i++) {
if (this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf(className) > -1) {
return true;
}
}
}
return false;
......@@ -2396,8 +2396,8 @@
var self = jQuery(this), val;
if (this.nodeType !== 1) {
return;
}
return;
}
if (isFunction) {
val = value.call(this, i, self.val());
......@@ -2447,7 +2447,7 @@
// Nothing was selected
if (index < 0) {
return null;
}
}
// Loop through all the selected options
i = one ? index : 0;
......@@ -2617,7 +2617,7 @@
get: function (elem, name) {
if (nodeHook && jQuery.nodeName(elem, "button")) {
return nodeHook.get(elem, name);
}
}
return name in elem ?
elem.value :
null;
......@@ -2859,9 +2859,9 @@
set: function (elem, value) {
if (jQuery.isArray(value)) {
return ( elem.checked = jQuery.inArray(jQuery(elem).val(), value) >= 0 );
}
}
});
}
});
});
......@@ -2995,7 +2995,7 @@
if (!handleObj.handler.guid) {
handleObj.handler.guid = handler.guid;
}
}
}
// Add to the element's handler list, delegates in front
if (selector) {
......@@ -3209,7 +3209,7 @@
handle = ontype && cur[ontype];
if (handle && jQuery.acceptData(cur) && handle.apply(cur, data) === false) {
event.preventDefault();
}
}
}
event.type = type;
......@@ -3379,7 +3379,7 @@
event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 );
event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 );
}
}
// Add relatedTarget, if necessary
if (!event.relatedTarget && fromElement) {
......@@ -3441,7 +3441,7 @@
load: {
// Prevent triggered image.load events from bubbling to window.load
noBubble: true
},
},
focus: {