Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
qfq
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
1
Merge Requests
1
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
typo3
qfq
Commits
9f139b70
Commit
9f139b70
authored
Jul 12, 2020
by
Carsten Rose
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Manual.rst: Add CodingGuideline.rst
parent
7ad19e24
Pipeline
#3605
failed with stages
in 4 minutes and 43 seconds
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
78 additions
and
0 deletions
+78
-0
Documentation/CodingGuideline.rst
Documentation/CodingGuideline.rst
+77
-0
Documentation/index.rst
Documentation/index.rst
+1
-0
No files found.
Documentation/CodingGuideline.rst
0 → 100644
View file @
9f139b70
.. ==================================================
.. ==================================================
.. ==================================================
.. Header hierarchy
.. ==
.. --
.. ^^
.. ""
.. ;;
.. ,,
..
.. --------------------------------------------used to the update the records specified ------
.. 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*
.. Bold **bold**
.. Code ``text``
.. External Links: `Bootstrap <http://getbootstrap.com/>`_
.. Add Images: .. image:: ../Images/a4.jpg
..
..
.. Admonitions
.. .. note:: .. important:: .. tip:: .. warning::
.. Color: (blue) (orange) (green) (red)
..
.. Definition:
.. some text becomes strong (only one line)
.. description has to indented
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _`CodingGuideline`:
Coding Guideline
================
The following is not mandatory but shows some best practices:
Constants
---------
* Define constants in ``Extensions > QFQ > Custom > ...``
* Dynamic values under ``Extensions > QFQ > Dynamic > ...``
QFQ content record
------------------
* Name the record in the header field with:
* Regular content: ``[QFQ] ...``
* Content in the left column: ``[QFQ,L] ...``
* Content in englisch: ``[QFQ,E] ...``
* The first lines should be comments, explaining what the record does and list all passed variables::
#
# Shows list of Persons living in {{country:SE}}
#
# {{country:SE}}
#
* A good practice is to define all possible STORE_SIP Parameter in a SQL at the beginning and to copy the to STORE_RECORD::
10 {
# Normalize variables
sql = SELECT '{{country:SE}}' AS _country
# List selected persons
20.sql = SELECT p.name FROM Person AS p WHERE p.country LIKE '{{country:R}}'
}
* Always comment the queries like shown above.
Documentation/index.rst
View file @
9f139b70
...
...
@@ -86,6 +86,7 @@ This documentation is for the TYPO3 extension **qfq**.
System
ApplicationTest
GeneralTips
CodingGuideline
Release
License
Sitemap
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment