Task #898
doc_template 1.1.1 -- reloaded
| Status: | Closed | Start date: | 2008-06-28 | |
|---|---|---|---|---|
| Priority: | Could have | Due date: | 2008-07-29 | |
| Assignee: | Susanne Moog | % Done: | 100% |
|
| Category: | - | |||
| Target version: | - | Estimated time: | 0.00 hour | |
| Votes: | 0 |
Description
Susanne, I want to inform all devs that doc_template has a big change and they should use this now. Is the following text good so?
------------
subject: doc_template 1.1.1 -- reloaded
Hello extension-authors,
we, the DocTeam, have made a major update to the template of TYPO3-documentation-manuals.
http://typo3.org/extensions/repository/view/doc_template/1.1.1/
http://typo3.org/documentation/document-library/core-documentation/doc_template/
##Please use this new version - just copy the content of your manuals into the new version and you get the new features.
- fixed typo (thanks to Georg Ringer)
- added TYPO3-logo, chapter-number and chapter-title to the header, for better orientation
- TYPO3-coloring scheme
- added hyperlinking to the TOC (yeah!)
- added PDF as example for the TOC-linking
- Font Tahoma (if you don't use it a good alternative font will be used)
If you have any change requests put it in http://bugs.typo3.org bugtracker / documentation with title prefix "doc_template".
We will use this layout for the core-documents, too, but updating will take some days ... or weeks.
Cheers!
DocTeam
http://forge.typo3.org/projects/show/team-docteam
History
Updated by Daniel Brüßler almost 5 years ago
(and this sentence is also good)
We use this layout also for the core-documents, that needs some days ... some weeks.
Updated by Susanne Moog almost 5 years ago
- Status changed from New to Accepted
hi daniel,
the first text is ok the way it is.
I would change the additional sentence to
"We will use this layout for the core-documents, too, but updating will take some days ... or weeks."
Concerning English grammar I am no expert, so if you want to have a grammar check, ask virgil perhaps?
Updated by Daniel Brüßler almost 5 years ago
- % Done changed from 0 to 80
Updated by Daniel Brüßler almost 5 years ago
- Status changed from Accepted to New
- Assignee changed from Susanne Moog to Virgil Huston
@Susanne: Thanks!!
@Virgil: is this text in good english now?
Updated by Virgil Huston almost 5 years ago
- Status changed from New to Accepted
Updated by Virgil Huston almost 5 years ago
- % Done changed from 80 to 90
I made very minor grammar/punctuation edits
Hello extension-authors,
We, the DocTeam, have made a major update to the template of TYPO3-documentation-manuals.
http://typo3.org/extensions/repository/view/doc_template/1.1.1/
http://typo3.org/documentation/document-library/core-documentation/doc_template/
##Please use this new version - just copy the content of your manuals into the new version and you get the new features.
- fixed typo (thanks to Georg Ringer)
- added TYPO3-logo, chapter-number and chapter-title to the header, for better orientation
- TYPO3-coloring scheme
- added hyperlinking to the TOC (yeah!)
- added PDF as example for the TOC-linking
- Font Tahoma (if you don't use it a good alternative font will be used)
If you have any change requests, put it in http://bugs.typo3.org bugtracker / documentation with title prefix "doc_template".
We will use this layout for the core-documents, too, but updating will take some days ... or weeks.
Cheers!
DocTeam
Virgil: Questions:
Is copying content into the new version an automatic process? Are instructions needed for manual authors?
Updated by Daniel Brüßler almost 5 years ago
Hello Virgil,
that's a very good idea! So I take the manual of the pear-extension this evening and upgrade it while documenting the steps I need. So I can add the steps.
Please check the grammar of that steps, too, when I'm ready with them :-)
Cheers!
Daniel
Updated by Susanne Moog almost 5 years ago
ha, daniel, I was faster (just tested with one of my extensions) ;-):
- copy everything from your old manual except the title page and the table of contents
- delete contents from new manual but leave the title page and the table of contents there
- paste your content and check that formatting is correct and images are in place
- update the page properties with your extension key, e-mail-address and name
- reload the table of content (right click update index table)
- insert your extension key below the document title
- ready.
one more annotation:
should the extension key below the title not be a field from document properties, too?
Updated by Daniel Brüßler almost 5 years ago
@Susanne: thanks for checking it out and finding the problem with the extensionkey!!
---
@all:
I changed it now, so that the document-property "title" is now "EXT:extensionkey" - would be cool to also set the "nice-name" as document-property.
Is there a problem if we use "topic" for the "Nice-name of the extension"?
(@Virgil - is "nice-name" good english or better "human-readable name"?)
Or the field "Info 3"? (not so good because not seeable at first sight)
---
Is this too long for the middle position of the header?
Nice-name of your extension - EXT: extensionkey
---
And: Isn't chapter-numbering needed to give the users good orientation?
Updated by Daniel Brüßler almost 5 years ago
I added also this line:
"keywords: keywords comma-separated"
Updated by Daniel Brüßler almost 5 years ago
sorry, one more :-)
Is it too much for the developers if we add a key for the language?
The problem is that it's called "Info 3" in the list of the document-properties.
language: EN
Updated by Daniel Brüßler almost 5 years ago
- File manual.sxw added
Updated by Daniel Brüßler almost 5 years ago
- File manual.pdf added
Updated by Susanne Moog almost 5 years ago
I'll try to comment everything:
- nice name: like that a lot, looks nicer ;)
- keywords: what for? does this help with finding the extension or what?
- language / info3: why not call the field language instead of info3? just change the field properties.
hope that I haven't forgotten too much...
Updated by Virgil Huston almost 5 years ago
I don't think "nice name" works. I think I would use "readable."
I agree that Chapter numbering is needed.
I agree with using "language" rather than "info 3."
Updated by Daniel Brüßler almost 5 years ago
- Assignee changed from Virgil Huston to Daniel Brüßler
So this is now:
title="EXT: Readable name of your extension"
topic="extensionkey"
info3 has now this key "language (EN, DE, FR, NL, DK, ES, DK, ... )"
and this content: EN
info4 has now this key: "empty"
and no content
extension key is now updated from document properties
Updated by Daniel Brüßler almost 5 years ago
- File manual.sxw added
- Status changed from Accepted to New
- Assignee changed from Daniel Brüßler to Susanne Moog
Susanne, please look at the manual, because there are some problems left I cannot solve.
- what is a good color for chapter-level 5?
- I defined extras/tools chapter-numbering but it's not in use (why?)
- chapter 1 has a number but should not
Cheers!
Daniel
Updated by Daniel Brüßler almost 5 years ago
- File deleted (
manual.sxw)
Updated by Daniel Brüßler almost 5 years ago
- File deleted (
manual.pdf)
Updated by Susanne Moog almost 5 years ago
- File manual.sxw added
- Assignee changed from Susanne Moog to Daniel Brüßler
- fixed numbering
- added bold style for heading 5 (color is ok, is used on typo3.org too)
pls test new version.
Updated by Susanne Moog almost 5 years ago
- Status changed from New to Needs Feedback
Updated by Daniel Brüßler almost 5 years ago
- File deleted (
manual.sxw)
Updated by Daniel Brüßler almost 5 years ago
Traumhaft!!!
Now just the CI-team/ Rasmus Skjoldan has to review it. Michael is already happy with it.
Updated by Daniel Brüßler almost 5 years ago
if rasmus changes something add this sentence¶
Update the document-properties (see file menu) for title, extension key, language, and then add some keywords
upload here¶
https://svn.typo3.org/Teams/DocTeam/
as user docteam
Updated by Daniel Brüßler almost 5 years ago
- % Done changed from 90 to 70
Rasmus has found some problems:
--------------
I have a couple of notes which I believe will make it look even better :)
1) Please avoid centering any text
2) There needs to be a bigger margin-right of the logo at the top
3) The green of the logo looks quite off here - please check that you are using a proper original file
4) All large headers (gray ones) need a larger margin-bottom (0,5 cm)
5) Table of contents need an overhaul - better margins all over
After that I think it will be great!
Best,
Rasmus
--------------
Updated by Susanne Moog almost 5 years ago
- File manual.sxw added
included rasmus changes as I had just a bit spare time ;)
Updated by Daniel Brüßler almost 5 years ago
- % Done changed from 70 to 90
Hey Susanne, Du bist echt ein Geschenk des Himmels!! Ich dachte es ist ein riesen Berg an Arbeit und nun hast Du es schon gemacht. Wow! Ich schau's mir morgen gleich an und lade es morgen gleich ins TER.
Schönen Abend!
Daniel
Updated by Daniel Brüßler almost 5 years ago
- Due date set to 2008-07-29
- Assignee changed from Daniel Brüßler to Susanne Moog
- % Done changed from 90 to 100
So Susanne, I created the PDF and just uploaded it. Contains the new description-text you wrote about tagging.
You can close this after you're read this :-)
Cheers!
Daniel
Updated by Susanne Moog almost 5 years ago
- Status changed from Needs Feedback to Resolved
Updated by Susanne Moog almost 5 years ago
- Status changed from Resolved to Closed
Updated by Chris topher about 2 years ago
- Tracker changed from Support to Task
- Project changed from Documentation to Official Doc Extension Template
- Target version deleted (
sprint 2008/05) - Remaining hours set to 0.0