[TYPO3-doc] Small improvements to official documentation template

Hermann Ragaller hermann.ragaller at hrex.de
Thu Sep 9 19:25:52 CEST 2010


I have prepared a few variants of table layouts based on Daniel's input:

http://dl.dropbox.com/u/11186446/tables-1.pdf

My favourite would be #3. If you do all the property-items in boldface, 
I think it becomes a bit too heavy.

As for the other items I am indifferent, but obviously they should be 
defined.

And, of course, in "context-free" text like an URL 1 and l should be 
clearly recognizable.

regards,
Hermann


Am 09.09.2010 17:50, schrieb Daniel Bruessler:
> Hello Francois,
>
> yes, it's very down-to-earth now. So the colors were too much.
>
> What's with the table-header. Isn't it still too "noisy"? It's the same
> font like the "callout boxes" have, but must it be so? I think the most
> important things what we're seeking for, when we look at the TSref pages
> are the keywords on the left side. So it might be better if they're
> better too see and the table-header less.
> =>  please try: the property-items in bold, the table-headers in normal
> font-size
>
> What's with special stuff like filenames, URLs. Is it good to see what
> is an l and what a 1?
>
> What's with navigation-info like Menu>>  User tools>>  User settings>>
> Startup>>  Start up in the following module
> What formatting-style do we use?
>
> Another thing is in-document-navigation. Do we use it?
> Example:
> Use the HowTo at page 13 “HowTo: Update a manual to the new layout”
>
> Cheers!
> Daniel
>
>
>
>> Hi folks,
>>
>> I've got to tell you that I'm really glad I started this thread, because
>> we got into a very fruitful debate about the design of our manuals and I
>> feel like this has lead to some very serious improvements.
>>
>> Here's the next version:
>>
>> http://drp.ly/1GQodq
>>
>> This one contains major changes which address most of the recent remarks:
>>
>> - colors are gone for headings. I stuck to black, plus 60% gray for
>> heading 4 and 5
>> - the font for body text is replaced by a serif font. I went for the
>> very classical Times. I don't consider this to be the most elegant serif
>> font on the block. The choice is open for debate as far as I'm
>> concerned, but we've got to make sure that it's readily available on all
>> platforms and that it's a serious font (some fonts have limited support
>> for characters beyond alphabetical, numbers and a few punctuation signs)
>> - added a bit more indent to code samples and bullet lists, so that they
>> stand out a bit
>>
>> As mentioned earlier I wanted to explore OpenOffice frames to check if
>> that could help manage call-out boxes more safely. It doesn't. Frames
>> are PITA so I decided to stick to the current paragraphs. Copying and
>> pasting works just fine :-)
>>
>> So let's hear your thoughts again, hopefully for the last round of
>> comments (not that I'm complaining, this was extremely constructive).
>>
>> Cheers
>>



More information about the TYPO3-project-documentation mailing list