[TYPO3-dev] Easy way to test extensions manual (?)

Marcus 'biesior' Biesioroff vsbies at wp.pl
Thu Feb 18 15:04:49 CET 2010


ellou' Francois, Daniel and List!

I've got it! yesterday published new version of the ext, with new 
(cleared) version of the manual and thanks to your suggestion at last it 
is rendered perfect!

[1]http://typo3.org/documentation/document-library/extension-manuals/ogonki/1.0.1/view/

There is some method to determine if everything will be all right, 3 
tips that helped me a much (at least I think so :) ):



Tip 1.

The thing that Francois was writing about: paragraph after header, 
although its style is auto changed to "Text body" in fact remains 
"Header x", you can check it in the status bar, on the right or in menu: 
Format > Paragraph > Outline & Numbering.

That helped:
The easiest and fastest way to solve that is just to mark whole text in 
the paragraph and reset its style to default (clear style or default) 
and then set it again to the required (if required)



Tip 2.

Section title in the header of the page (on the right, fetched from H2) 
was empty or wrong when the section header was wrapped with 
trash-paragraphs (that ones which Daniel was writing about and cleared).

That helped:
In this case I was localized "suspected" headers and moved empty 
paragraphs before and after them, also cleared and reset the styles of 
the wrapping paragpraph. What is annoying after clearing I had to close 
and re-open the file to make the names visible... grrr...



Tip 3.

TOC is a KEY! In properly prepared document when you hover the TOC item 
it shows the alt text:
#1.1 Introduction
#1.2 Configuration
etc. As I can see these auto-assigned numbers are used later to generate 
the HTML pages with the same numeration.

In the "wrong" version these alt texts was rendered WITHOUT numeration:
#Indtroduction
#Configuration...



Conclusion:
I think that's the best way to the basic validation ;), I'm also sure, 
that manual should be tuned while TOC items renders with auto numbers 
and they appears in the proper order (without "gaps" in the numbering)

Everybody who has similar problems with his manual's rendering: please 
check in your cases if these tips works, I think that they should be 
added to guidelines of the doc_template, but it's required to confirm 
their value first.


With best regards!

-- 
Marcus 'biesior' Biesioroff
a.k.a. Marek Krawczyk (original)

Polish TYPO3 Community Proud Member
http://typo3.pl




More information about the TYPO3-dev mailing list