Commit 647db12f authored by Carsten  Rose's avatar Carsten Rose
Browse files

Update ReST Syntax URLs. Remove 'extension/Documentation.outdated'. Update...

Update ReST Syntax URLs. Remove 'extension/Documentation.outdated'. Update .gitignore to not commit rendered doc.
parent 0b49ea0d
Pipeline #1905 passed with stages
in 2 minutes and 45 seconds
......@@ -30,6 +30,7 @@ nbprojec
test.json
test.php
*.autosave
/Documentation-GENERATED-temp
/bower_components
/composer.phar
/css
......
......@@ -8,14 +8,16 @@
.. ,,
..
.. --------------------------------------------------
.. Best Practice T3 reST https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/
.. Best Practice T3 reST: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html
.. Reference: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html
.. Italic *italic*are part of key or value
.. Bold **bold**
.. Code ``text``
.. External Links: `Bootstrap <http://getbootstrap.com/>`_
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images ...
.. Add Images: .. image:: ../images/a4.jpg
..
.. Admonitions (https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/#admonitions)
..
.. Admonitions
.. .. note:: .. important:: .. tip:: .. warning::
.. Color: (grey) (orange) (green) (red)
..
......
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in this documentation project (= manual).
.. ==================================================
.. DEFINE SOME TEXT ROLES
.. --------------------------------------------------
.. role:: typoscript(code)
.. role:: ts(typoscript)
:class: typoscript
.. role:: php(code)
.. highlight:: php
.. ==================================================
.. FOR YOUR INFORMATION TEST
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _start:
=============================================================
QFQ Extension
=============================================================
.. only:: html
:Classification:
qfq
:Version:
|release|
:Language:
en
:Description:
The extension offers support to:
* Create HTML Forms by clicking them together,
* 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, Framework, Secure, Mobile Ready, Responsive.
:Copyright:
2017-2019
:Author:
Carsten Rose, Benjamin Baer
:Email:
carsten.rose@math.uzh.ch, benjamin.baer@math.uzh.ch
:License:
This document is published under the Open Publication License
available from http://www.opencontent.org/openpub/
:Rendered:
|today|
The content of this document is related to TYPO3,
a GNU/GPL CMS/Framework available from `www.typo3.org <https://typo3.org/>`__.
**Table of Contents**
.. toctree::
:maxdepth: 4
Manual
Release
Links
README
License
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _links:
Links
-----
:TER:
https://typo3.org/extensions/repository/view/<extension key>
:Bug Tracker:
https://forge.typo3.org/projects/extension-<extension key>/issues
:Git Repository:
https://github.com/<username>/<extension key>
:Contact:
`@<username> <https://twitter.com/your-username>`__
=========================================
TYPO3 Documentation Starter "Public Info"
=========================================
:Repository: https://github.com/T3DocumentationStarter/Public-Info-053
:Published at: https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/
:Writing here: Carsten Rose
[general]
project = QFQ - Quick Form Query
version = 19.5
release = 19.5.1
t3author = Carsten Rose
copyright = since 2017 by the author
description = Documentation for the Typo3 Extension 'QFQ'
; defaults:
# highlight_language = 'php'
# html_use_smartypants = False
# language = None
# master_doc = 'Index'
# pygments_style = 'sphinx'
# source_suffix = ['.rst', '.md']
# todo_include_todos = False
[notify]
about_new_build = carsten.rose@math.uzh.ch
[html_theme_options]
; for theme t3SphinxThemeRtd
# to get the "Edit me on Github Button"
github_branch = master
github_repository = T3DocumentationStarter/Public-Info-053
# planned
github_commit_hash =
github_revision_msg =
# planned
github_sphinx_locale =
# Fille in values to get links in the "Related Links" section at the lower left
project_contact = mailto:carsten.rose@math.uzh.ch
project_discussions =
project_home = https://github.com/T3DocumentationStarter/Public-Info-053
project_issues = https://github.com/T3DocumentationStarter/Public-Info-053/issues
project_repository = https://github.com/T3DocumentationStarter/Public-Info-053
# leave this empty
use_opensearch =
[intersphinx_mapping]
; in this manual we actually use:
# t3api = http://typo3.org/api/typo3cms/
# t3coreapi = http://docs.typo3.org/TYPO3/CoreApiReference
# t3tsconfig = http://docs.typo3.org/typo3cms/TSconfigReference
# t3tssyntax = http://docs.typo3.org/typo3cms/TyposcriptSyntaxReference
# t3api = https://typo3.org/api/typo3cms/
# t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/
# t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/
# t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/
# t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/
# t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/
# t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/
# t3install = https://docs.typo3.org/typo3cms/InstallationGuide/
# t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/
# t3security = https://docs.typo3.org/typo3cms/SecurityGuide/
# t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/
# t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/
# t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/
# t3tca = https://docs.typo3.org/typo3cms/TCAReference/
# t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/
# t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/
# t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/
# t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/
# t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/
# [extensions]
#
# ; Add to list of extensions[] as defined in 'conf.py'.
# ; Mention the extensions you need. Some are loaded automatically
# ; and don't need to be mentioned. Examples:
#
# any_name_1 = sphinx.ext.extlinks
# any_name_2 = sphinx.ext.ifconfig
# any_name_3 = sphinx.ext.intersphinx
# [extlinks]
#
# ; These defaults are set in conf.py
#
# ; Example:
# ; :forge:`12345` will be rendered as
# ; <a href="https://forge.typo3.org/issues/12345">Forge #12345</a>
#
# ; name = url | prefix
#
# forge = https://forge.typo3.org/issues/%s | Forge #
# issue = https://forge.typo3.org/issues/%s | Issue #
# review = https://review.typo3.org/%s' | Review #
# [latex_documents]
#
# ; These defaults are set in conf.py
#
# source_start_file = (master_doc) ; "Index"
# target_name = PROJECT.tex
# title = (project)
# author = (t3author)
# documentclass = "manual"
# [latex_elements]
#
# ; These defaults are set conf.py
#
# papersize = a4paper ; letterpaper | a4paper
# pointsize = 10pt ; 10pt | 11pt | 12pt
# preamble = \\usepackage{typo3} ; Additional stuff for the LaTeX preamble.
#
# ; for more see: # for more see: http://sphinx-doc.org/config.html#confval-latex_elements
# [texinfo_documents]
#
# ; These defaults are set in conf.py
#
# source_start_file = (master_doc) ; 'Index'
# target_name = (t3shortname)
# title = (project)
# author = (t3author)
# dir_menu_entry = (project)
# description = (description) or 'This is project (project)'
# category = Miscellaneous
# [man_pages]
#
# ; These defaults are set in conf.py
#
# source_start_file = (master_doc) ; 'Index'
# name = (project)
# description = (description) or 'This is project (project)'
# authors = (t3author)
# manual_section = 1
# You can set these variables from the command line.
SPHINXOPTS = -c . -a -E -w ./_not_versioned/warnings.txt
SPHINXBUILD = sphinx-build
PAPER = a4
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ..
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ..
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " pdf to make PDF using rst2pdf"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/QFQ Extension.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QFQ Extension.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/QFQ Extension"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QFQ Extension"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
pdf:
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
@echo
@echo "Build finished. The PDF is in $(BUILDDIR)/pdf."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config:
tags:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>License &#8212; QFQ Extension 19.5.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css"/>
<link rel="stylesheet" href="_static/pygments.css" type="text/css"/>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '19.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="prev" title="TYPO3 Documentation Starter “Public Info”" href="README.html"/>
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right">
<a href="README.html" title="TYPO3 Documentation Starter “Public Info”"
accesskey="P">previous</a> |
</li>
<li class="nav-item nav-item-0"><a href="Index.html">QFQ Extension 19.5.0 documentation</a> &#187;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="license">
<span id="id1"></span>
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li>QFQ is licensed under GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007</li>
</ul>
</div>
<div class="section" id="software-distributed-together-with-qfq">
<h1>Software distributed together with QFQ<a class="headerlink"
href="#software-distributed-together-with-qfq"
title="Permalink to this headline"></a></h1>
<ul class="simple">
<li>jQuery - <a class="reference external" href="http://jquery.com">http://jquery.com</a></li>
<li>jQWidgets - <a class="reference external" href="https://www.jqwidgets.com">https://www.jqwidgets.com</a>
</li>
<li>Bootstrap - <a class="reference external" href="http://getbootstrap.com">http://getbootstrap.com</a>
</li>
<li>Fabric.js - <a class="reference external" href="http://fabricjs.com">http://fabricjs.com</a>
</li>
<li>Chart.js - <a class="reference external" href="https://github.com/nnnick/Chart.js.git">https://github.com/nnnick/Chart.js.git</a>
</li>
<li>sendEmail - <a class="reference external" href="https://github.com/mogaal/sendemail">https://github.com/mogaal/sendemail</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="Index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">License</a></li>
<li><a class="reference internal" href="#software-distributed-together-with-qfq">Software distributed
together with QFQ</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="README.html"
title="previous chapter">TYPO3 Documentation Starter &#8220;Public Info&#8221;</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/License.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div