typo3-documentation/docstypo3org-homepage

This repository holds the content of the starting page and the "glue" pages for the official TYPO3 documentation on https://docs.typo3.org. For help and support on TYPO3, please see: https://typo3.org/help/

docstypo3org-homepage's Issues

Should we create a "Getting started with extension development" tutorial?

The "Extbase book" used to be the walkthrough for extension development, but there are 2 problems:

• It is about writing (mostly) plugins with Extbase / Fluid in a very specific way. There are lots of extension which have a different goal and do not use Extbase or even Fluid
• There are some things missing, e.g. setting up the development environment, giving the beginner some information, what types of extensions there are, when to use Extbase when not, having a complete walkthrough of creating a small extension without the (unnecessary) overhead of walking through explanations of Extbase.

Some things are already listed in the "Extension Development" chapter in TYPO3 Explained, starting with '"STEPS TOWARDS CREATING AN EXTENSION" but this is not something you can just point a beginner to and then rest assured they have everything they need.

Branch out other version branches?

Instead of adding links to other versions on indiviudal pages which must be updated manually, it would be consistent to create version branches for this repo as well and be able to automatically link to other versions of manuals.

Create landing page for wiki redirect

We need a landing page as entry point for redirects from the old wiki to the new documentation. Basically, all wiki pages that have not been migrated should redirect to this page.

Link "TYPO3 CMS Core ChangeLog (latest)" broken

The link to TYPO3 CMS Core ChangeLog (latest) is broken
https://docs.typo3.org/typo3cms/References/Index.html#references

Not sure where this should link to. https://docs.typo3.org/typo3cms/extensions/core/8-dev ?

Bug: Copy&Paste button in code blocks adds line numbers

https://docs.typo3.org/p/georgringer/news/main/en-us/Tutorials/BestPractice/Routing/Index.html#id5

Copy:

Paste:

Cleanup overview tables

Subitle: Make TYPO3 docs landing pages look less like Work in Progress

This manual and especially the pages "Guides and Tutorials" and "References" are very prominent and important. They might be the first place someone looks who is new to TYPO3. For TYPO3 marketing purposes and in the intention of providing the best guidance, especially for new users, I think it is very important to clean up this page and make it look less like work-in-progress. I realize, there is still a lot of work to do, not every manual is in a final state and there are far less people working on things than are needed, but this page does not necessarily have to reflect that.

I think we should try to come up with pragmatic solutions for fixing this asap.

Proposal

• Remove outdated manuals and WIP manuals (or better remove WIP tag if no longer applicable) from this list. If the WIP manual is the only thing we have, so be it. Strip it down to the basics and do the WIP work in a different place.
• remove comment "The Extbase book" because it is redundant
• remove or replace comment "Very unsufficient, but better than nothing." because it looks bad and is not helpful
• If manuals are really hopelessly outdated and considered harmful, remove them entirely from this list. Maybe even remove them entirely
• Possilby create another lists for old, deprecated and wip manuals.

Example:

For example, currently we have:

People wanting to learn will be confused, ok there are 2 manuals. Why? One is "better than nothing", where should I start? And get a bad first impression of TYPO3 docs. What??? Why don't they maintain their documentation?

This could look like this:

• change "Very unsufficient, but better than nothing." to a more descriptive phrase, e.g. "outdated", remove the book entirely from this list (if it is really so outdated) and move it to the old / deprecated / wip list
• remove comment "The extbase book", because the title already says it all

Create information about scope of "Site Package Tutorial" versus "Templating Tutorial"

Both tutorials have a similar scope. Is the currently listed information sufficient for new users to make a choice which one to read and in which order?

Integrate frontend templates and TYPO3 configuration in your own sitepackage extension using the Fluid templating engine. [read more]

The tutorial now teaches templating with FLUIDTEMPLATE (recommended) in its master branch

If possible, can someone write a text, what is the difference between these tutorials, what is the scope, that would be helpful for new users? Tip: Don't just focus on what the tutorial teaches, look at it from the perspective of what someone might want to do.

The information could be added to the page Integrators in "Getting Started Tutorial" "Next Steps" as well.

Add useful information about Extbase / Fluid documentation in List of Tutorials / Guides

Current information in Tutorials & Guides is not helpful, especially for new people:

An extensive walkthrough on extension development for TYPO3 using the Extbase framework and Fluid templating engine. (Warning: is partly outdated and incomplete)

This contains some information about Extbase and Fluid for extension development but is not a comprehensive Guide or Tutorial at this point. Also available a complete ViewHelper reference.

I realize, it's the best be can do at the moment, until someone seriously maintains the "Extbase / Fluid" Guide or Book or the new (hardcover) book comes out, or other resources get created but this is not helpful for new users. The docs are outdated, so what is the alternative? What can they (developers and integrators) read? Where can they go?

Back end Extension Links

I'm encountering a strange Problem with some extensions. In the complete absence of any problem in typo3 log, i can't seem to change
pages in the Back end Modules in some extension ( Extension Builder, Luxletter in this instance).
I've noticed not proper generated link otherwise i don't really have a clue why is this happening.

Current behavior

Generated link

Expected behavior/output

Expected link

TYPO3 versions

10.4.37

Introduce new rubric

How to cover "Frequently asked topics"?

• TYPO3 caching
• structural elements (like gridelements)
• custom content elements
• responsive images
• ckeditor
• code of conduct
  https://www.typo3.net/artikel/kennt-ihr-den-typo3-code-of-conduct/
• ...
  Some topics are typically answered in blogposts.

Just some ideas: Frequently asked topics, TYPO3 journal, magazines, Info Guide, What people ask

Remove "Teams" from menu on Docs homepage?

In the #typo3-documentation channel this was suggested but as far as I know, it was not finally decided.

I would suggest to very clearly differentiate between:

1. What is publicly available and relevant for readers of documentation
2. What is only relevant for contributors (people writing documentation)
3. What is relevant to the teams

If you follow that logic, the DocsTypo3Org-Homepage is a public place for readers. A seperate space for the team is the respective t3o / "Doc Team at work" repo.

Every additional information / link that is not relevant in this very central place only adds to confuse users.

Suggestion

Remove Teams form DocsTypo3Org-Homepage

How these docs should be done.

Here is my opinion as a newbie who just has resigned learning this framework:

• merge all these documents into one, shorten it heavily. Makes it easier for the readers and easier for devs to update them. A good idea is to have automated tests for the code examples.
• Create a full clone of this document for every new framework version, update the docs before you release the new version.

See the Python docs as a reference.

Rendering problem?

There is an error which seems to be already fixed in the source:

• should be "adminpanel", not dashboard twice

• Also, it still links to master, not 10.4

• https://docs.typo3.org/Home/SystemExtensions.html

• https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/edit/master/Documentation/Home/SystemExtensions.rst

Integration SkillDisplay into docs

We should discuss with the education committee how we could integrate SkillDisplay into the docs.

We have different opportunities / ideas:

• "Florian Weiss" told me we could add buttons to pages that contain a link to SkillDisplay, to mark a skill as finished.
• The education committee has his own skill display instance (as staging system). Maybe we can work with this instance as first test integration
• It should be possible to link to Skills from the docs. This can be used to Guide users. This way we might be able to tackle #36, #35 and #22

The following has to happen:

• Establish workflow with Education committee to update links at SkillDisplay. E.g. some links don't contain version numbers, but are for a specific TYPO3 Version. Also linking to latest should be avoided, due to changes of content with next TYPO3 releases.

System extensions page - consistency

todos:

• use card layout
• remove comments
• add description
• add package name

---

Systems extension page: https://docs.typo3.org/Home/SystemExtensions.html

Here #176 @mbrodala made a good point - should we have a comment when extension was added, e.g. for rte_ckeditor:

Documentation added in 2/2019, rte_ckeditor available since TYPO3 8.7 LTS

I think it is not necessary, but we can also think about the structure in general, e.g.

• should comments column be removed?
• should comments be changed to description and contain (short!) description, as already done for fluid_styled_content

Comment: Content Elements based on Fluid

• .... formatted differently entirely?

For beginners, I think it may be helpful to have a description.

Broken links in "How to create translations" container on startpage

There are 2 broken links in the container "How to create translations" on https://docs.typo3.org/

• 2nd bullet "Supported languages" => https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Localization/Languages.html
• 5th bullet "Internationalization and localization in TYPO3 Explained" => https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Localization/Index.html

I tried to make the changes by myself but unfortunately I have no clue how this linking works.

no verb in sentence

@fsuter It looks like the verb is missing here:

.. sidebar:: New to TYPO3 CMS?

If you are new to TYPO3 CMS, please start by reading the
:ref:Tutorials <tutorials>, which will help you progressively
your knowledge of TYPO3 CMS.

Merge "Guides and Tutorials" and "References"

Proposal:

• Put overview table of guides, tutorials and references on one page (e.g. "TYPO3 manuals")
• redirect the current "Guides and Tutorials" and "References" to this
• Try to keep it down to the minimum (so scrolling is not necessary)
• move old, outdated and WIP manuals to a different list (or better yet remove entirely and redirect links?)

Please, add the password validator: mustInclude = uppercase

Hi!
In the user registration I can use the follow password validations:
plugin.tx_femanager.settings.validation.password.mustInclude = number,letter,special, space

But I need to add there another one validator, which can check the presence of large letters.
That validator can be named like "uppercase" or largeLetter.

It's not difficult. I can do it myself, but I can't update the module afterwards.

'How to publish' link invalid

The link doesn't seem to be valid anymore, it redirects to the Writing Documentation index page.

DocsTypo3Org-Homepage/README.rst

Lines 14 to 15 in 4595662

	:How to: `How to publish
	<https://docs.typo3.org/typo3cms/RenderTYPO3DocumentationGuide/AtTheDocsServer/Administration/AboutTheHomepage/Index.html#manual-intervention-needed>`__

I would open a PR but I don't know where the target is.

Skinning reference exists, but is not linked from start pages and should first be checked if can be removed?

Question: How outdated is this? For which TYPO3 versions does this apply? Should we remove it entirely?

---

Should probably be added to "Outdated Manuals" on https://docs.typo3.org/Home/References.html

• rendered: https://docs.typo3.org/m/typo3/reference-skinning/master/en-us/
• GitHub repo: https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-Skinning/

Related:

• TYPO3-Documentation/TYPO3CMS-Reference-Skinning#2

Logo on "Core Documentation" missing

https://docs.typo3.org/Home/References.html misses the top left logo. It only shows the fallback "TYPO3 Logo".

Linked URL is https://docs.typo3.org/_static/img/typo3-logo.svg and that gives a 404

Many documentation pages in google lead to a not found error

Many links to the documentation page https://docs.typo3.org/ in the google index have stopped working recently.

Example: https://docs.typo3.org/typo3cms/ExtbaseGuide/Fluid/ViewHelper/Case.html

Remove "Community Writings"?

https://docs.typo3.org/CommunityWritings/Index.html#

I was not sure at first, what this chapter is about.

I think it would be a good idea to consider if we should remove this, Apart from the fact that it is all from 2016, there are better or more relevant things available for 2018 and it is a very small subset of things:

• Extensions in the focus
  • there are only very few extensions mentioned here. I don't think ext:devlog is a good choice. There are better options like the logging API or using a debugger. Same goes for templavoila. Why have a very small subset of things?
  • shouldn't this rather go on typo3.org as news or in a blog?
• External blogposts and writing
  • this has been partly replaced by "Tell me something about X"
  • it's a hell of a job to keep these things up-to-date (and we are not doing a superb job of that as it is in the docs, the wiki and elsewhere)
  • why is Let's encrypt linked in there? It is not even TYPO3 specific.

Link for security guide is broken on "Core Documentation"

see: https://docs.typo3.org/typo3cms/References/Index.html

"(OLD) Security Guide" : no link

Security Guide still live for 8.7: https://docs.typo3.org/typo3cms/SecurityGuide/8.7/

Add detailed page for list of Guides, Tutorials and References

Add another detailed page (e.g. "TYPO3 manuals (Details)") with more details about each manual and what to find where. (Question: Can this be generated automatically and obtained from a "description" metadata for each manual. Disadvantage: Probably not rich text for this)

Example: Extbase / Fluid

Explain why there are 2 manuals, where should someone start who wants to learn extension development? Perhaps, also refer to the book by Lobacher / Schams or other sources of information.

References to PackageStates.php should be removed / changed for main + 11.5

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.4/Feature-94996-ConsiderAllComposerInstalledExtensionsAsActive.html

• the file is no longer required
• the file is no longer generated
• all extensions will be considered active
• use php vendor/bin/typo3 extensions:setup to setup extensions

grep -r PackageStates.php */Documentation

• TYPO3CMS-Exceptions/Documentation/Exceptions/1338996122.rst:the :file:typo3conf/PackageStates.php manually.
• TYPO3CMS-Exceptions/Documentation/Exceptions/1382276561.rst::file:typo3conf/PackageStates.php and remove the part which belongs to the
• TYPO3CMS-Exceptions/Documentation/Exceptions/1382276561.rst:If deleting :file:PackageStates.php is no option, try using the
• TYPO3CMS-Exceptions/Documentation/Exceptions/1365429673.rst:Open :file:typo3conf/PackageStates.php, look up the extension key and
• TYPO3CMS-Exceptions/Documentation/Exceptions/1365429673.rst::file:PackageStates.php, trying to recover the old version did help in my
• TYPO3CMS-Exceptions/Documentation/Exceptions/1365429673.rst:array part or add it to your file :file:PackageStates.php:
• TYPO3CMS-Exceptions/Documentation/Exceptions/1365429673.rst:You must have a backup copy of the file typo3conf/PackageStates.php .
• TYPO3CMS-Exceptions/Documentation/Exceptions/1365429673.rst:Restore a file PackageStates.php which is compatible under TYPO3 6.2.
• TYPO3CMS-Guide-Installation/Documentation/MigrateToComposer/MigrationSteps.rst:for generating the file :file:typo3conf/PackageStates.php.
• TYPO3CMS-Guide-Installation/Documentation/MigrateToComposer/MigrationSteps.rst:| :file:public/typo3conf/PackageStates.php |
• TYPO3CMS-Reference-CoreApi-sypets/Documentation/ExtensionArchitecture/HowTo/ExtensionManagement.rst: :file:PackageStates.php file. Extensions are loaded in the order they appear in this list.
• TYPO3CMS-Reference-CoreApi-sypets/Documentation/ExtensionArchitecture/HowTo/ExtensionManagement.rst:the order they were listed in :file:PackageStates.php in legacy installations.
• TYPO3CMS-Reference-CoreApi-sypets/Documentation/Testing/WritingFunctional.rst:typo3conf/ext for third party extensions, creates a :file:PackageStates.php and then uses the
• TYPO3CMS-Tutorial-GettingStarted-sypets/Documentation/Extensions/LegacyManagement.rst:extensions manually with :file:PackageStates.php as a last resort, see :ref:uninstall-extension-manually
• TYPO3CMS-Tutorial-GettingStarted-sypets/Documentation/Extensions/LegacyManagement.rst:Since LTS8 this can be done by removing the extensions configuration from the file :file:PackageStates.php
• TYPO3CMS-Tutorial-GettingStarted-sypets/Documentation/Extensions/LegacyManagement.rst:#. Open the file :file:typo3conf/PackageStates.php
• TYPO3CMS-Tutorial-GettingStarted-sypets/Documentation/Extensions/LegacyManagement.rst: :caption: typo3conf/PackageStates.php

Add "How to get help section"

Since docs.typo3.org may be the first place, people come in touch with TYPO3, some of them may actually be needing support.

There is an up-to-date page : https://typo3.org/help/

However, both Slack and Stackoverflow are not immediately easy and intuitive to get used to. There are some caveats, especially with Stackoverflow. Some additional information for both platforms on docs.typo3.org might be a good idea.

StackOverflow:

• add information about what type of questions can be asked: programming related questions. Questions about docs, configuration, etc. may be closed as off-topic. For these questions new answers can no longer be added, but questions still appear in google search results. Example: https://stackoverflow.com/questions/7978045/new-documentation-format-for-typo3-extensions

Provide basic help about using the website

At SwaggerHub I found

Or use an help overlay:

Add "Getting started" section?

issue with php file

i just try to use php file with create and lib object but it's now working my typo3 ver is 8^. my typoscript code is # Add bellow typoscrip in setup.ts
lib.jobs = USER
lib.jobs {

# Define external PHP Script file path
includeLibs = fileadmin/functions.php

# Call user function
userFunc = getData->GetNewsCountInCat

}.
could you please let me how to get php code in template file

It would be nice to see the link for the core changelog

https://docs.typo3.org/typo3cms/extensions/core

Question: when pages are printed as pdf they heading seem to be rendered as pictures

When I try to print the pages as pdf, it seems that the headings are rendered as pictures.
Basically this isn't aproblem, but when I try to do some highlighting those headings (h1, h2, ...) can't be hightlighted.

I've tried this with different pdf-creators and browsers, and got always the same results. Even when trying to include the font.

Any idea how this can be overcome?

Background Info
Sometimes it's easier to print the relevant pages to a pdf and highlight those steps which need to be executed upfront.
The headings are relevant as they hold sometimes param's/settings.

case insensitive extension search

Hi folks,

My super duper apple smartphone has this nice feature of writing the first letter as uppercase in an input field. There might be other reasons why the search for extensions needs to be case insensitive.

Is that something which can be done easily in WebRootResources/js/extensions-search.js ?

Feedback from Twitter about start page

https://docs.typo3.org/

On the main documentation page, I’m overwhelmed with too many topics of totally different importance for different people with different interests and skill levels.

https://twitter.com/helhum/status/1246039942003920909

• Install guide
• Docs organizational hints
• Howto create a theme
• Develop extensions
• Configure TYPO3
• Howto create translations
• Contrib to core
• Contrib to docs
  All different target groups and depth.

https://twitter.com/helhum/status/1246042577507356672

Add ViewHelper namespace & examples to auto-generated references

• e.g. https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/backend/9.5/Index.html
• e.g. https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/backend/9.5/Avatar.html

Possible Changes

• add information on Fluid ViewHelper namespace and what needs to be integrated {namespace be=} or xmlns:be=http://typo3.org/ns/...
• add examples on how to use it (probably needs to be defined in ViewHelper implementation first)

Rework left navigation panel for startpage

The following changes should only apply to welcome document

• Remove duplicate link to "home"
• Remove search because it is missleading and does not search the whole documentation
• Remove version selector if there is only one version available

Add information about git / docker method on page "Contribute"

Currently, the Github method is the only method for editing
mentioned on "Contribute".

There are several reasons why the git / docker method might be the better choice:

• For developers, the git / docker method would probbly be the preferred choice because they can work locally with a real IDE / editor and don't have to use the Github Web GUI.
• Preview on Github is insufficient

So it should at least be mentioned here and / or a link added.

Missing link in reference manuals for Core API

https://docs.typo3.org/Home/References.html

Rethink the /typo3cms/extensions page

Rework start page and menu structure

Change order of Tutorials

In the section "Tutorials" it says:

"If you are new to TYPO3 CMS, please go through the tutorials below in the order in which they are listed".

Currently, the site package is at the top. Should be "Getting started" instead.

docs.typo3.org broken when adblocker is installed.

This issue is global accross all TYPO3 websites, and not related to docs.typo3.org but affects typo3 docs as well. Also I could not find another appropriate repository to create an issue for it.

All the TYPO3 websites are broken when adblocker is installed.

Rework start page(s)

• add some main topics to start and link to documentation
• add a "Getting Started" section. Specifically the "Getting Started Tutorial" is not a good general "Getting Started" start. It is mostly an introduction to the backend and focuses heavily on editing (and a little bit configuration). Templating is very thin. There is nothing for developers
• rename "Getting Started Tutorial" to "Backend Tutorial"
• possibly rename "Tell me something about topic x" to "TYPO3 topics" and move it to this repo. Cover major topics in there. Remove non-TYPO3 specific stuff.
• possibly, add a glossar and / or FAQ

Inspiration:

start page

• Start page of Django documentation

getting started

• {Getting started of Django documentation](https://docs.djangoproject.com/en/3.0/intro/)

FAQ

• FAQ of Django documentation