[TYPO3-english] How to create backend module for documentation

Thu Oct 31 13:05:27 CET 2013

Hi Xavier,

Thanks for your answer. Unfortunately my TYPO3 is 4.7. I used, in fact, 
the "sphinx" extension in a TYPO3 6.1 to generate the Html version from 
Rest format, and tested the "restdoc" extension too. But now I am trying 
to export all these Htmls to be presented nice. I just tested your 
solution, adding all my Html documentation to 
"my_extension/Resources/Private/Templates/Class/" and link it there, but 
the Css doesn't apply just because of the paths.

I would like to find a nicer solution for that.

Isn't there a chance to sphinx and restdocs are backwards compatible 
with TYPO3 4.7? :(

Thanks in advance,
Sergio

On 30/10/13 15:18, Xavier Perseguers wrote:
> Hi Sergio,
>
> Which version of TYPO3 are you targeting?
>
> I ask this because if you target 6.2, then best practices will arise and
> simply be to show your in-house documentation within the new
> documentation module:
>
> http://docs.typo3.org/typo3cms/extensions/documentation/
>
> If you really need a custom Backend module, you should simply load your
> documentation in an iframe with something like
>
>
> function main() {
> 	$url = 'http://yourwebsite/whatever/documentation.html';
>
> 	$this->content = '<html>
> <head>
> <title>Documentation</title>
> </head>
> <frameset cols="*">
>    <frame src ="' . htmlspecialchars($url) . '" />
> </frameset>
> </html>';
>
> }
>
> HTH
>
> Sergio Catalá wrote:
>> Hi list,
>>
>> can you give me an example of an extbase extension in the TER which adds
>> a simple BE module with Rest documentation?
>>
>> I have installed sphinx extension, I generated my documentation in ReST
>> format, and I converted to PDF and Hhtml. Now I want to link this Html
>> pages in a new backend module. I know how to create a BE module, but I
>> don't know how to link this module to show all my output in Html.
>>
>> Thanks in advance,
>> Sergio
>>