Documentation

That's a mighty good question. Some are definitely important and should be updated/rewritten. For MTB my idea was to rewrite it with the aim of producing the Introduction Package as a result of the tutorial. It would fit nicely with what we currently have. Obviously, it's a huge work.

In the meantime, I wouldn't hide it. A (new) colleague of used it last week and found it ok, although he had to search around for buttons and such.

FTB is supposed to become a new TemplaVoilà manual. I discussed this with Tolleiv, but he has little time too.

Many other manuals are short and mostly irrelevant. We could probably hide them. There are also some new manuals, which are missing (like TS in 45 minutes). Unfortunately, manipulating the list of manuals requires admin access, so we need to ask some typo3.org admin to do the job. Another possibility would be to tweak extension ter_doc so that it becomes a user tool and not an admin tool, then we could have a controlled access to it. However I - personally - don't want to invest too much time in this. I would rather concentrate on the DocBook migration, which will anyway totally change the display of manuals.

In the meantime, I wouldn't hide it. A (new) colleague of used it last week and found it ok, although he had to search around for buttons and such.

do not hide it +1 :)

I already have:

• checked the page "Document Library":
  • Removed the link to "TypoScript by example".
  • Added links for missing languages of the Installation Guide, Getting Started manual, TSref and TSconfig.
  • Left the links to the other Template Tutorial (Futuristic Template Building) and marked them as outdated.
  • Checked that manuals are mentioned:
    • Added a section for TS45Min, which was not mentioned at all until now
• Renamed the subpages of "Document Library" so that they reflect our categories: Tutorial, Guide and Core Doc.
• Checked that all (current / new) manuals are mentioned on one of the subpages. This cannot be edited in the plugin, but only in the sysfolder, which also holds the categories. Or better: through the ter_doc BE module.
• Subpages "Tutorials" "Guides" and "Core" now also are filled (does not work, if docs are not rendered yet).
  • On the subpages: Replace the texts on the three subpages with the definitions of Tutorial, Guide and Core Doc. See here.
• ...

I still have to

• check that translations are also displayed somehow (fix Russian+Japanese flag)

• Documentation categories themselves are not editable: See #36439.

• How can I create a link to the current version without any special version number in it?

Thanks for what you have already done. I plan to take a second look at that today.

I agree that the three listing pages should be changed to Tutorial, Guides and Core references. But we still have the main problem that they don't display anything currently. I'll prod Jörn again today.

About the links to the current version of a manual, unfortunately they must be done with external links with the full URL, e.g. http://typo3.org/documentation/document-library/guides/doc_guide_install/current/

It's a pity. It's something I hope we can improve after the migration to reST. Or before that if someone wants to invest some effort into it. It could be probably be achieved with an extension like linkhandler or ch_rterecords. It's something that we could check out with the new typo3.org team after the relaunch.

Francois Suter wrote:

About the links to the current version of a manual, unfortunately they must be done with external links with the full URL, e.g. http://typo3.org/documentation/document-library/guides/doc_guide_install/current/

This works, when the extension manual is already rendered on typo3.org.

This is what a link to the table of contents for the current version of a manual looks like:
http://typo3.org/documentation/document-library/core-documentation/doc_core_tsref/current/view/

We would have to access the ter_doc BE module. See #31105. That is working now.

The links to the manuals are created by the ter_doc module. Here is how the categories can be modified manually without access to the module:

• Inside a sysfolder you have to create a "Documentation category" (which will get a category id).
• Then in the sysfolder you need to create an entry under "Manual category" for each extension key, whose manual you want to see in the ter_doc plugin. Give it the category id, in which the manual should show up.
• On the page, where the list of manuals should appear, there is a ter_doc plugin. In that plugin you set the category, for which you want to see the manuals.

And then this does not (yet) work.

I guess the problem is that these manual keys are not registered with the plugin that's supposed to display the list of them on the parent page.

I would suggest that you create the links anyway and we'll check them when we get the listing pages working.