Commit 4c5b3b62 authored by Rafael Ostertag's avatar Rafael Ostertag
Browse files

Merge remote-tracking branch 'origin/master' into raos_work

parents 044851ce 031adc03
......@@ -24,6 +24,9 @@ qfq.zip:
clean:
rm -f qfq_$(PKG_VERSION).zip
update-qfq-doc:
rsync -av --delete --exclude=_make --exclude=_static extension/Documentation/ ../qfq-doc/Documentation/
git-revision: make-dist-dir
echo $(GIT_REVISION_LONG) > $(DISTDIR)/revision.git
......
......@@ -16,7 +16,9 @@ See: https://w3.math.uzh.ch/qfq/
Documentation
-------------
See the documentation provided with the exentions inside Typo3 or the latest version
under https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/Index.html
See the documentation provided with the exentions inside Typo3
<your Typo3 installation>/typo3conf/ext/qfq/Documentation/html/Index.html
Or the latest stable version under https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/Index.html
Neuer Build
===========
* snpashot: Wird ein Tag vergeben der mit 'v' beginnt, erzeugt das automatisch ein Build in 'snapshot' (w3.math.uzh.ch/qfq)
* nightly: Ein Commit in den den Masterbranch erzeugt automatisch in der Nacht ein 'nightly' Build (w3.math.uzh.ch/qfq)
* CR commmitet immer in den Master Branch
* release: Wird ein Tag vergeben (alle Branches) der mit 'v' beginnt, erzeugt das automatisch ein Build in 'snapshot' (https://w3.math.uzh.ch/qfq)
* snpashot: Jeder Commit (egal welcher Branch) erzeugt einen Snapshot.
* nightly: Nach einem Commit auf Branch 'master' wird um 23:55 'nightly' Build erstellt (https://w3.math.uzh.ch/qfq).
* CR commmittet immer in den Master Branch
Neue Versionsnummer
===================
......@@ -17,11 +18,11 @@ Neue Versionsnummer
2) In folgenden Files anpassen:
Auto: ./setVersion.sh MAJOR MINOR MICRO
Auto: ./setVersion.sh MAJOR MINOR MICRO
Manuell:
* extension/Documentation/_make/conf.py: release, version
* extension/Documentation/Settings.yml: version
* extension/Documentation/Settings.cfg: version
* extension/ext_emconf.php: version
3) Im Projektverzeichnis:
......@@ -44,3 +45,13 @@ git push -u origin v0.17.0
7) In T3 Instanz Dokumentation rendern lassen.
T3 6.2: Admin Tools > Extension Manager > QFQ > Doku HTML: rechts oben 'Render Documentation'
Update Doku auf docs.typo3.org
==============================
https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/
1) Im `qfq` Projektverzeichnis: make update-qfq-doc
2) In `qfq-doc` Projektverzeichnis wechseln und auf github einchechen:
git commit -a
git push # User: math-uzh, PW: <kpit>
......@@ -123,7 +123,8 @@ Setup
* Copy/rename the file *<Documentroot>/typo3conf/ext/<ext_dir>/config.example.qfq.ini* to
*<Documentroot>/typo3conf/config.qfq.ini* and configure the necessary values: `config.qfq.ini`_
The configuration file is outside the extension directory to not loose it during updates.
* Play the SQL File *<ext_dir>/qfq/sql/formEditor.sql* to fill the database with the *FormEditor* records.
* When the QFQ Extension is called the first time on the Typo3 Frontend, the file *<ext_dir>/qfq/sql/formEditor.sql* will
played and fills the database with the *FormEditor* records. This also happens automatically after each software update of QFQ.
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.
::
......@@ -221,6 +222,8 @@ config.qfq.ini
| SHOW_DEBUG_INFO | SHOW_DEBUG_INFO=auto | Possible values: auto|yes|no. For 'auto': If a BE User is logged in, |
| | | debug information will be shown on the fronend. |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| REDIRECT_ALL_MAIL_TO | REDIRECT_ALL_MAIL_TO=john@doe.com | If set, redirect all QFQ generated mails (Form, Report) to the specified. |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CSS_LINK_CLASS_INTERNA L | CSS_LINK_CLASS_INTERNAL=internal | CSS class name of links which points to internal tagets |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CSS_LINK_CLASS_EXTERNAL | CSS_LINK_CLASS_EXTERNAL=external | CSS class name of links which points to internal tagets |
......@@ -432,7 +435,9 @@ QFQ Keywords (Bodytext)
Debug
^^^^^
* config.ini: *SHOW_DEBUG_INFO = yes|no|auto*
`config.qfq.ini`_
* *SHOW_DEBUG_INFO = yes|no|auto*
* *yes*:
......@@ -452,6 +457,18 @@ Debug
* *SHOW_DEBUG_INFO = yes* (BE session exist)
* *SHOW_DEBUG_INFO = no* (no BE session)
.. _REDIRECT_ALL_MAIL_TO:
* *REDIRECT_ALL_MAIL_TO=john@doe.com*
* During the development, it might be helpful to configure a 'catch all' email address, which QFQ uses as the final receiver
instead of the original intended one.
* The setting will:
* Replace the 'To' with the configured one.
* Clear 'CC' and 'Bcc'
* Write a note and the original configured receiver at the top of the email body.
.. _variables:
......@@ -522,7 +539,8 @@ To protect the web application the following `escape` types are available:
* In `config.qfq.ini`_ a global `ESCAPE_TYPE_DEFAULT` can be defined. The configured escape type applies to all substituted
variables, who do not contain a *specific* escape type.
* Additionally a `defaultEscapeType` can be defined per `Form` (separate field in the Form Editor). This overwrites the
global definition of `config.qfq.ini`.
global definition of `config.qfq.ini`. By default, every `Form.defaultEscapeType` = 'c' (=config), which means the settin
in `config.qfq.ini`_.
* To suppress a default escape type, define the `escape type` = '-' on the specific variable. E.g.: `{{name:FE:alnumx:-}}`.
Sanitize class
......@@ -2530,6 +2548,7 @@ Type: sendmail
* To use values of the submitted form, use the STORE_FORM. E.g. `{{name:F:allbut}}`
* To use the `id` of a new created or already existing one, use the STORE_RECORD. E.g. `{{id:R}}`
* For debugging, please check `REDIRECT_ALL_MAIL_TO`_.
.. _dynamic-update:
......@@ -4125,6 +4144,8 @@ This will send an email with subject *Latest News* from company@example.com to c
using a realname for customer2 and customer3 and suppress generating of OoO answer if any receiver is on vacation.
Additional the CEO as well as backup will receive the mail via CC and BCC.
For debugging, please check `REDIRECT_ALL_MAIL_TO`_.
Column: _img
^^^^^^^^^^^^
......
=========================================
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
.. ==================================================
.. Header hierachy
.. ==
.. --
.. ^^
.. ''
.. ;;
.. ,,
..
.. --------------------------------------------------
.. Best Practice T3 reST https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _release:
Release
......@@ -216,7 +235,7 @@ Bug Fixes
^^^^^^^^^
* Dynamic Update has been broken since implementing of 'element-update' (#3180). Now both methods, 'element-update' and 'form-update' should be fine.
* qfq-bs.css.less: Fixed problem with 'typeahead input elements' not expanded to Bootstrap column width. Changed
* qfq-bs.css.less: Fixed problem with 'typeahead input elements' not expanded to Bootstrap column width. Changed
Layout/Design Typeahead drop-down box. Add hoover for the drop-down box with a blue background
* AbstractBuildForm.php: #3374 - textarea elements now contains 'maxlength' attribute.
* BuildFormBootstrap.php: wrapping of optional 'submitButtonText' now done with the 'per form' values.
......
[general]
project = QFQ - Quick Form Query
version = 0.17
release = 0.17.1
t3author = Carsten Rose
copyright = since 2017 by the author
description = This is a short description
of what it's all about.
It should not be more than a few sentences.
; 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_builds = 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
# 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: 2017
project: QFQ Extension
version: 0.17.0
release: 0.17.0
latex_documents:
- - Index
- qfq.tex
- QFQ Extension
- Carsten Rose
- manual
latex_elements:
papersize: a4paper
pointsize: 10pt
preamble: \usepackage{typo3}
intersphinx_mapping:
t3tsref:
- http://docs.typo3.org/typo3cms/TyposcriptReference/
- null
t3start:
- http://docs.typo3.org/typo3cms/GettingStartedTutorial/
- null
t3editors:
- http://docs.typo3.org/typo3cms/EditorsTutorial/
- null
...
......@@ -59,7 +59,7 @@ copyright = u'2017, Carsten Rose'
# The short X.Y version.
version = '0.17'
# The full version, including alpha/beta/rc tags.
release = '0.17.0'
release = '0.17.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
@echo off
echo.
echo.
echo Building single file HTML version in build/singlehtml ...
call make.bat singlehtml
echo.
echo.
echo Building HTML version in build/html ...
call make.bat html
echo.
echo.
echo Starting build/html/Index.html in browser ...
start build\html\Index.html
echo.
echo.
echo Finished.
pause
\ No newline at end of file
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXOPTS%" == "" (
set SPHINXOPTS=-c . -a -E -w ./_not_versioned/warnings.txt
)
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=/var/www/html/crose/qfq-jqw/typo3temp/tx_sphinx/sphinx-doc/bin/sphinx-build
)
set PAPER=a4
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% ..
set I18NSPHINXOPTS=%SPHINXOPTS% ..
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
: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. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Projectname.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Projectname.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
What does it do?
================
First of all, if you have any idea how this template can be improved, please, drop a note to our team_. Documentation is written in reST format. Please, refer to Help writing reStructuredText to get some insight regarding syntax and existing reST editors on the market.
.. _team: https://forge.typo3.org/projects/typo3v4-official_extension_template/issues
Here should be given a brief overview of the extension. What does it do? What problem does it solve? Who is interested in this? Basically the document includes everything people need to know to decide, if they should go on with this extension.