Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEW: Provide introductory text for fluid #94

Open
sypets opened this issue Feb 3, 2018 · 2 comments

Comments

@sypets
Copy link
Contributor

commented Feb 3, 2018

Most manuals provide some introductory explanation in a section "Introduction". The introductory text for fluid here is very short (https://docs.typo3.org/typo3cms/ExtbaseGuide/Fluid/Index.html) and then the guide jumps right in with specifics.

Some introductory text might include:

  • What is it used for
  • Some explanation about fluid_styled_content
  • Some explanations about FLUIDTEMPLATE
  • How the core uses fluid
  • How extensions can use fluid
  • Naming conventions (e.g. Templates, Partials, Layouts), CamelCase for files
  • What's in a fluid file (XML, namespaces, sections, partials view helpers)
  • How does the rendering and caching work internally?
  • Hints for Performance

Ok, maybe not so introductory, but nice to have.

@marble

This comment has been minimized.

Copy link
Member

commented Feb 3, 2018

To give this a wider audience I've transferred parts to here:
https://docs.typo3.org/typo3cms/TellMeSomethingAbout/Topics/Fluid.html

Think of it as a starter to trigger collaboration. Once we have an introduction this should go into a dedicated Fluid manual.

My 2 cents.

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Feb 3, 2018

If we use this area as a scratchpad to later transfer it to the Extbase / Fluid guide, that's a good thing.

But having half-finished manuals on docs.typo3.org, is that so good? People will land there via the search engines and it looks ... well unfinished. Or is it possible to exclude it from the search engines (robots.txt) for now?

Or could we have a place where work-in-progess is being done and transfer the stuff when finished?

DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018
TASK: Provide introductory for fluid
Use same basic structure as already done for extbase.
Also add further information where to find information about fluid.

This resolves issue #92.
DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018
TASK: Provide introductory for fluid
Use same basic structure as already done for extbase.
Also add further information where to find information about fluid.

This resolves issue #92.

@DanielSiepmann DanielSiepmann self-assigned this May 11, 2018

DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018
TASK: Provide introductory for fluid
Use same basic structure as already done for extbase.
Also add further information where to find information about fluid.

This resolves issue #92.
DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018
DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018
DanielSiepmann referenced this issue in TYPO3-Documentation/TYPO3CMS-Guide-Extbase May 11, 2018

@sypets sypets transferred this issue from TYPO3-Documentation/TYPO3CMS-Guide-Extbase Jun 25, 2019

@sypets sypets reopened this Jun 25, 2019

@sypets sypets added this to To do in Fluid Documentation Initiative via automation Jun 25, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
You can’t perform that action at this time.