[TYPO3-typo3org] A place for sysext manuals

[Daniel Bruessler]

Hello Michael and Francois,

"doc_extkey" is already in use by the core-docs => we can use this as
convention.

The question is, if it's better for TYPO3, when the sysext-manuals are
available fast (when already in the installation-package) or TYPO3 is as
small as possible (when all sysext-manuals are external doc-extensions).

I see doc_indexed_search has 1.1MB in the moment, that's really much. If
we calc 350kB * 36 [number of sysext], we get 12.3 MB of manuals.

-> Does it matter, if TYPO3 would be 12.3 MB bigger?

Cheers!
Daniel

> Notice that indexed_search has its documentation outsourced into
> "doc_indexed_search" because of the huge size (images etc.).
> 
> Maybe it's possible to change the code so if [extkey] is missing a
> documentation, it will always be found in [doc_extkey] or [extkey_doc].
> Is there such a convention already?
> 
> - michael
> 
> Daniel Bruessler schrieb:
>> Hello Francois,
>>
>> ah - so we should make it similar to extensions in typo3conf/ext/:
>> In the moment it's
>> typo3conf/ext/*/doc/manual.sxw
>>
>> what we need also:
>> typo3/sysext/*/doc/manual.sxw
>>
>> There is already one: sysext/rtehtmlarea/doc/manual.sxw
>>
>> => the TER extensions need to know this path.
>>
>> ter_doc, ter_doc_sxw, ter_doc_docbook
>> I ask Steffen about the current versions of the extensions.
>>
>> Cheers!
>> Daniel
>>
>>> Hi,
>>>
>>>> => should have an own category
>>>>
>>>> Does anybody see a problem when we have a submenu item more
>>>> called "Sysextension Manuals"?
>>> I would quite like a separate section too. The main issue however is
>>> technical. The TER is currently not able to render sysext manuals,
>>> because it doesn't go search for manuals inside the TYPO3 Core. What we
>>> need to define is the best way to gather these manuals and have them
>>> rendered.
>>>
>>> Cheers
>>>
> 
>