Task #48382: Non-rst documentation for display on docs.typo3.org
Cheat Sheet of Page Render JS / CSS Includes
|Priority:||Should have||Due date:|
|Assignee:||Chris topher||% Done:||
SteffenK created a Cheat Sheet for TypoScript usage of page includes:
It is based on TYPO3 4.3.
What shall we do with this one?Francois:
- Could be made a bit nicer and released as a simple PDF file.
- Long term: There are other cheat sheets on the web - maybe we could collect them at some point. It could be a new section in the Documentation branch of typo3.org.
- I created this PDF out of the file: http://wiki.typo3.org/wiki/images/1/16/T3_pageinclude_sheet.pdf
- TSref appears to me being the best place to put this information, unless there is another spot...
|related to TypoScript Reference (TSref) - Task #39684: stdWrap visual overview||Resolved||2012-08-10|
Updated by Chris topher about 2 years ago
- Status changed from New to Needs Feedback
thanks for creating the PDF.
I agree that these contents somehow belong to TSref. I propose to put them to an Appendix and maybe add a note in the "What's new" chapter, so that it gets a bit more of peoples' attention.
As the original file is based on TYPO3 4.3 and TSref is already updated for TYPO3 4.5, the cheat sheet will have to be revised for 4.5 before it is integrated.
Can you also have a look at that?
Updated by Fabien Udriot about 2 years ago
The author of the PDF is Steffen K. not me.
There are a few Cheat Sheets going around (Fluid, Extbase,...)
That makes me think we could have a documentation project / section called "cheatsheets" and collect them into it. Just an idea...
I propose to put them to an Appendix
Updated by Francois Suter about 2 years ago
For me the main issue is that we can't include a PDF in a reST file ;-)
I see the following possibilities:
- we recreate Steffen's cheat sheet as a kind of table inside the reST file (an appendix is indeed fine)
- we recreate it as an image (it definitely won't be possible to create a cheat sheet with reST without defining a specific rendering for such stuff)
- we keep it as a PDF and link to it. This requires having some central place (i.e. where the URL does not change).
Except for the first possibility, it would also warrant relooking such cheat sheets to improve their looks, but it's not high priority for now.
Updated by Chris topher about 1 month ago
- Subject changed from What to do with the Cheat Sheet of Page Render JS / CSS Includes? to Cheat Sheet of Page Render JS / CSS Includes
Updated by Chris topher 30 days ago
- Status changed from Needs Feedback to Resolved
- Assignee set to Chris topher
- % Done changed from 0 to 100
I have created the page http://docs.typo3.org/typo3cms/CheatSheets.html on docs.typo3.org and this sheet is now part of our collection!
If you have more of them, keep them coming! :-)