[Typo3-typo3org] documentation.typo3.org

Juergen Egeling egeling at punkt.de
Wed Apr 13 12:09:36 CEST 2005

* Robert Lemke <robert at typo3.org> [050413 11:24]:
>  - Keep documentation in the extension directory *locally* (in doc/)
>  - In the extension manager provide two checkboxes:
>     [ ] upload extension
>     [ ] upload documentation
And keep it like it is for download, so one can say:
Download and install doc or just reads the doc online, ...

>  - extension and documentation will be uploaded to different servers
>    (TER / documentation.typo3.org or call it TDR?)
The doc for the EXT on a different server? If so: Why? I would
keep them together, so that you can easily download them for
Or are you talking about other doc?

>  - the documentation site generates multiple formats automatically
Isn't PDF enough. Maybe PDF-A4 and PDF-US-legal (donno if the US
paper format is called that way.) and have HTML online and docbook
and PDF for download. So with docbook anybody could chance it to
whatever he wants it.

>  - how can we keep or improve usability on the typo3.org site?
>    it would be a weird browsing experience to search the extension
>    on one site and read the documentation on the other. 

This is why I would keep it in one place (technically) and maybe
mirror some files from A to B is load is a problem.

>  - what can we learn from other projects?

Most that I know have the DOC downloadable along with the software.
Usually in a format that could be read offline and/or printed.
PDF is a fine format for me, some prepare ASCII and some HTML.

>  - how can we mirror the documentation site? I suggest mirroring only
>    the *end-product*, ie. the html, pdf, xml, sxw files, and not let the
>    mirror sites render these formats from the source format

I would let the EXT together with the doc and not tear it apart.


More information about the TYPO3-team-typo3org mailing list