Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elmar-hinz committed Jun 7, 2016
1 parent 4e348ba commit c28e902
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 26 deletions.
2 changes: 1 addition & 1 deletion Documentation/Administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Administration
==============

Install the extension, clear caches and check of your frontend is rendered as
expected and if you get the advance error feedback in the backend.
expected and if you get the advanced error feedback in the backend.

If anything goes wrong, uninstall and report the issue.

Expand Down
1 change: 1 addition & 0 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,5 @@ Next Generation TypoScript Parser
Administration
Research
LessonsLearned
KnownIssues

43 changes: 18 additions & 25 deletions Documentation/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,32 +25,32 @@ What it is not
No Boost in Performance
-----------------------

The parser is approximately twice as fast as the origional parser, but there
will be no boost of performance, as TypoScript parsing takes just a few
milliseconds at all. You won't feel a difference in speed.
The parsing of TypoScript just takes a few milliseconds. Hence, it's not the
primary goal to speed up the performance but to improve the architecture.
The algorithm is twice as fast as the original algorithm, but with the
split into conditions proprocessor and processor the time is about the same
again.

What it is
==========

Better error detection of the syntax parser
-------------------------------------------
Standalone Usage
----------------

It's possible to use the TypoScript parser standalone outside of the TYPO3 CMS
if you like the TypoScript syntax and want to use it for configuration in other
fields. This is possible with or without the conditions preprocessor.

The syntax parser does already a more precise error detection, than the
origional parser, although the goal of the current milistone is to substitute
the functionality of the original.
Improving the error detection
-----------------------------

* Closing brace in excess.
* Unclosed braces at condition line.
* Unclosed multiline comment at condition line.
* Unclosed multiline value at condition line.
* Unclosed braces at end of template.
* Unclosed multiline comment at end of template.
* Unclosed multiline value at end of template.
The error detection covers the error detection of the origional parser and
tries be be a little better already. Also the displaying
of the line numbers has been worked upon. See Screenshots!

Having done the prove of concept that the replacement can be, advanced
debugging features are planned:
Having done this prove of concept that the replacement of the original syntax
highlighter can be done further debugging features are planned:

* What aditional types of errors can be detected at parsetime already?
* Do syntax highlighting of conditions, instead of printing them in one
color.
* Detect the difference of objects and properties, because only objects are
Expand All @@ -72,13 +72,6 @@ A modern parser makes it more easy to get rid of flaws in TypoScript and to add
new features like if-else conditions, that work the way you are used to from
other languages or enhance error debugging.

Standalone Usage
----------------

It's possible to use the TypoScript parser standalone outside of the TYPO3 CMS
if you like the TypoScript syntax and want to use it for configuration in other
fields.

Condition Preprocessor
----------------------

Expand Down
37 changes: 37 additions & 0 deletions Documentation/KnownIssues.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt

.. _issues:

============
Known Issues
============

No Exeptions are Thrown
=======================

The TypoScript production parser currently doesn't throw execptions. It
expects valid TS as input. The syntax higlighting parser is designed to
inspect TS for mistakes.

The original parser doesn't throw exceptions either. Modules of the backend are
not prepared to catch exeptions from the parser and break if execeptions
would be thrown from insane TS.

Intolerant for Insane TS
========================

The TypoScript production parser will silently break, if feed with insane TS.
It is optimized for speed and is less tolerant for insane TS than the origional
parser.

This means in rare cases code that works for the original parser may break with
the TypoScript production parser. Use the syntax highlighting parser to fix the
TS code.



0 comments on commit c28e902

Please sign in to comment.