TYPO3-metaseo icon indicating copy to clipboard operation
TYPO3-metaseo copied to clipboard

Documentation contains constants that doesnt exist.

Open PanadeEdu opened this issue 9 years ago • 3 comments

The Documentation mentions a bunch of constants for Sitemaps and possibly other parts that dont exist.

Example the language seperated sitemap.

PanadeEdu avatar Nov 20 '15 08:11 PanadeEdu

  • Could you please cite which part of the documentation you are referring to?
  • Is the section in question still wrong in the current develop branch? https://github.com/mblaschke/TYPO3-metaseo/tree/develop/Documentation

thomaszbz avatar Nov 20 '15 09:11 thomaszbz

@thomaszbz as stated its the Constant Documentation on Sitemaps: Githup Path: TYPO3-metaseo/Documentation/Constants/Index.rst As far as I looked into the code, I only found the Setting "changeFrequency" in the Configurable Sitemap constants. I assume the suspected Constants are either removed or not implemented yet. I suggest a whole Check of that part of the Documentation.

Another issue with the Constants Documentation is: They provde only speaking names, but should provide also the real Constant name. This makes me have to watch into the Extension code to firgure out what Constants are available.

Still true in Develop branch. I assume it is not the only faulty part.

PanadeEdu avatar Nov 30 '15 12:11 PanadeEdu

Thanks for pointing this out. There might indeed be some constants which are not implemented yet (or implementation has been removed over the time).

I also agree that the real constant names should be available in documentation in a way that users can easily connect all aspects of a constant in simple table (or similar).

For instance, we need to

  • check documentation for correctness and consistency (with implementation) in terms of constants
  • document constants' real names in a manner which is convenient to users (including prefixes!)

thomaszbz avatar Nov 30 '15 19:11 thomaszbz