diff --git a/.gitignore b/.gitignore index a582212e0689392793bb1889e7e27a221769b68c..858ce5104242459ed04bbb83ba56e7eea78b684a 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ # but we add it here for convenience) *~ *.bak +*.bkp *.idea *.project *.swp diff --git a/Documentation-develop/CODEMIRROR.md b/Documentation-develop/CODEMIRROR.md index c4ba382ee8591dd2a6c323464667de856477ea55..723da849481af544947aab5c25a4436e06aac410 100644 --- a/Documentation-develop/CODEMIRROR.md +++ b/Documentation-develop/CODEMIRROR.md @@ -36,9 +36,8 @@ QFQ Mode QFQ Mode was programmed by a member of the qfq development team (Elias Villiger) as a CodeMirror 5 syntax highlighting mode. -Its main functionality is in the qfq.js file and includes syntax -parsing and highlighting, hinting, and customizing a few options -for qfq syntax. +Its main functionality is in the `javascript/src/Helper/codemirror/qfq.js` file and includes syntax +parsing and highlighting, hinting, and customizing a few options for qfq syntax. In addition, a number of preexisting codemirror extensions (addons) are delivered with qfq, such as matchbrackets, match-highlighting, etc. @@ -88,7 +87,7 @@ or avoid hitting the spacebar after entering the word. ### Other features -Some other details are configured in the `qfq.js` file, such as key +Some other details are configured in the `javascript/src/Helper/codemirror/qfq.js` file, such as key bindings for indentation (see End User Documentation). Some of the functions in `qfq.js` are shared by various of the features, which is why they are all packaged in one file. diff --git a/Documentation/Images/feCMsyntax.png b/Documentation/Images/feCMsyntax.png new file mode 100644 index 0000000000000000000000000000000000000000..de1d72a8d720910d09350be31a0a25de95de0113 Binary files /dev/null and b/Documentation/Images/feCMsyntax.png differ diff --git a/Documentation/Images/feEdit.png b/Documentation/Images/feEdit.png new file mode 100644 index 0000000000000000000000000000000000000000..357cf77b7001758541df8f5d4a3fff6845b23d51 Binary files /dev/null and b/Documentation/Images/feEdit.png differ diff --git a/Documentation/Report.rst b/Documentation/Report.rst index 9bb9079b840741c4b0c6f75aca0d148fe814bcee..1e4c09c267f91cc5b5b20748ad8981425866687b 100644 --- a/Documentation/Report.rst +++ b/Documentation/Report.rst @@ -306,22 +306,22 @@ Note: :ref:`debug` information will only be shown with *showDebugInfo: yes* in : .. _`inline-report`: Frontend Report editing ---------------------- +----------------------- -For quick changes it can be bothersome to go to the TYPO3 backend to update the page content and reload the page. -For this reason, QFQ offers an frontend report editing feature (previously called inline report editing) -whenever there is a TYPO3 BE user logged in. A small -link symbol will appear on the right-hand side of each report record. Please note that the TYPO3 Frontend cache -is also deleted upon each report save. +An alternative to T3 backend content editing is the QFQ frontend report editor (previously called inline report editing). +Whenever a TYPO3 BE user is logged in, a small button is shown in the frontend on the right-hand side where the QFQ report +is rendered. -In order for the report editing to work, QFQ needs to be able to access the T3 database. This database -is assumed to be accessible with the same credentials as specified with indexQfq. +.. figure:: ./Images/feEdit.png +.. :class: with-border + +On save, the TYPO3 frontend cache is purged. The frontend editor uses QFQ syntax highlighting / suggestions (be sure to include +the appropriate files in :ref:`setup`). -QFQ implements its own codemirror syntax highlighting. In the backend it should work out of factory. -To enjoy QFQ syntax highlighting with all its features in the frontend report editing, be sure to include -the appropriate files in :ref:`setup`. +.. figure:: ./Images/feCMsyntax.png +.. :class: with-border -A few helpful shortcuts in the codemirror editor: +Shortcuts: +----------------+------------------------------------------------------------------------------------+ | Ctrl+Z | Undo previous action, can also be used to undo auto capitalization of SQL keywords | +----------------+------------------------------------------------------------------------------------+