Translations
Info
All page names need to be in English.
en da  de  fr  it  ja  km  nl  ru  zh

Documentation joblist

From TYPO3Wiki
Jump to: navigation, search
This page belongs to the Documentation Team (category DocTeam)

notice - Note

This is our old todo-list, which now is outdated. As far as it is still helpful, it should be merged into the page DocumentationTeam. --Daniel Brüßler 10:42, 5 June 2008 (CEST)

Here you see our big list, but parted in small & easy steps. We use it all the time, so it's a HOT page. If you need help write here, if you're new here and like to help us, then first talk to us in our newsgroup.

It's really great, if you have some time to help us ;-)

todo

Daniel

http://www.t3one.com/typo3temp/pics/9c28787de4.jpg ---Daniel Brüßler 14:37, 21 January 2008 (CET)

  1. change wiki-renderer for code-block: CSS and div instead of pre:

Key: noIconsBelowSelect
Datatype: boolean
Description: (add after iconsInOptionTags) Note: Disables the rendering of the icons after the select even when icons for the <select>s <option> tags were supplied and iconsInOptionTags was set.

Scope: Display
  1. when PHP5: update to current mediawiki-version (see tips for new parser!), install mm-plugin and sortableTable, see how it's possible to add a new-page-template for an exception, check what's the best way for a soap-service for list of public page-names
  2. install boilerplateselection maybe extension Call-Extension (selection by title "Exception*"), maybe webservice for exception-metadata for T3 5.0 (Robert)
  3. tabbed editor-toolbar: tabs "TabPanel"/ "Basic Tabs"
    1. / Team // Code // Link - Bug - Extension - Tagging // Draft Warning /
    2. general: bold, italic, header, tag, signature, image, headers
  4. update or maybe delete KB
    1. update the template-selection (hint from Michiel Roos)
  5. webservice with Dave for "getExtensionKeysWithState"
  6. finish update wiki-engine: config phpmyadmin, do sqldump, config 1.6.10, integrate extensions and (update wiki-engine from 1.6.8 to 1.6.10)
  7. See how much Jabkubs ideas do help here
  8. Optimize Other-Ressources
  9. regularly work at TYPO3.org_-_improvements in the team
  10. Export Import
    1. change https://wiki.typo3.org/exportimport/ because just export is needed. Documentation how to export using "Mediawiki.txt" export filter XSLT, renderers Plain and Xhtml for extension-Tag. Quotation instead of entity (Mediawiki 2 Xhtml). Remove extension-tag (Mediawiki 2 Plain). Add select-box to choose simpledocbook or docbook4.5 . Upload PEAR-changes to subversion. see also list
    2. links 1, 2, filters
  11. example "pear"
    1. Im OpenOffice Writer "Export" statt "Speichern" anklicken und "Mediawiki.txt" als Format auswählen. Nun "Speichern als Html" auswählen, damit die Grafiken exportiert werden. Den Grafiken nun sinnvolle Namen geben als Prefix Extensionkey und plus dahinter.
    2. "Extension Key: pear" ersetzen durch "Extension Key: <extension>pear</extension> {{stable}}"
    3. Copyright-Meldung ersetzen durch Template ""
    4. TOC löschen oder durch __TOC__ ersetzen
    5. vor Überschrift "Always secure" ist "[[Image:]]" enthalten obwohl das erst nach Überschrift stehen müsste
    6. Die Bilder fehlen was aber eh nicht exportierbar ist
    7. PHP-code zusammenhängend per <PHP> block
    8. deutsche Anführungszeichen durch internationale ersetzen
    9. See mailinglist "t.t.extension-coordination" ersetzen durch link
    10. "bugtracker" durch Link ersetzen
    11. Links bei "Further information" entwirren
    12. PEAR_Info ersetzen durch {{Topic|PEAR LiveUser}}
  12. better external links
    1. {{link|http://5-0.dev.typo3.org/guide/bk03.html|The Definitive Guide to TYPO3 - V5 - for Developers|guide5-dev}}

Virgil

Virgil Huston

Jakub

Jakub

  1. Getting started section to help newbees

todo repository

See the list of all documents what need help

regularly todo

maintenance of content

The wiki is under constant supervision of the DocTeam. If you've found some error, you can correct it directly or contact the documentation Mailing list.

  • Check regularly what tasks of this page are done!
  • Lonely pages
  • Dead end pages
  • It would be great to have some Best Practice sections within the various main sections
  • Fix a rewrite rule for Apache to remove "index.php" from the wiki URL
  • Get new location of About_the_Documentation/ Other pages/ TYPO3 Documentation from Kasper
  • Check if the blocked-pages are always keep blocked - and who cares for them. For example Peter is the author of the project TYPO3_Installation_Basics
TSbyExample update
  • this seems to be the best tool to make it

care for single documents

better guides

  • "and a feeling that there was something I needed to know first" (somebody who tried to start with Modern Template Building)

section Getting started

That's kinda interesting for newbees.

  • check what pages & content of the wiki is outfashioned?
  • check if the subcategory of T3Doc is holding all of that docs
  • check current state of the openoffice-docs & PDFs
  • check what comments on openoffice are not included into the docs


section backend-skins TYPO3-Templates repository

This seems to be a good thing. We could combine some pages what care for that topics.

  • TYPO3 templates repository - the idea is to collect some TYPO3-templates. The repository is the one on typo3.org, that's shure.
  • backend-skin-collection - the idea is to switch to other icons what the admin of a site finds better instead of the original ones. This is an idea of Matthew Manderson.

section About-documentation

missing or wrong:

  • Documentation Matrix/ "Media:Example.ogg"
  • Documentation images/ Image:OOo-images.png

to put into documentation-guide

What does it do?

to be written...

What does it not do?

to be written...

Who is it for?

to be written...

What is a newbie?

to be written...

How to read this documentation

to be written...

Administrator

Design-Templates, helping Templates, subst

  • Add new template: "done" - compare with wikipedia todolists
  • "Helferlein": check what ones should exist in englisch and what german ones sould be deleted
  • create a subst for the following text, because we might need it often: "Hello, because of wiki-spammers the page is blocked in the moment. You can add you contributions here. Your contributions will not get lost, when spammers would try to add their links here, too."

maintenance of the wiki-structure

  • Check regularly what tasks of this page are done!
  • Document-Matrix: New needed cats: ReleaseNotes
  • Team-Pages: All documents that belong to a team should be accessable via its cat
  • Extension-manuals: all pages should belong to the Extension-cat

Agile Projects

  • A fast and simple concept: helps to find contributers
  • Category:HOT documents: these are updated regularly
    • add: Peters 2 documents for editors, Mathews docuement for the newbees, Franz Holzinger with tt_products

Wiki DocBook OpenOffice PDF

direction format why implementation-state 1 2
export DocBook for export to TER2 -- not existing but see Text_Wiki with XHTML-renderer -- / ready: part of MoinMoin-Wiki (!) 1 2
import mediawiki for imports into the current mediawiki ready: Text_Wiki_Mediawiki 1 2
export plaintext good for pasting into an email ready: Text_Wiki with plaintext-renderer 1 2
export Creole for exchange between wiki-engines ready: Text_Wiki_Creole 1 2
import moinmoinwiki for imports into mediawiki ready: Text_Wiki_Mediawiki (python-driven but no problem with hosting) 1 2
export moinmoinwiki (!) for migration of the wiki -- not existing but easy to create -- 1 2
export RSS RDF ATOM for content of Projects and Teams-page -- not existing but easy to create using Text_Wiki with XHTML-renderer -- 1 2

See also:

DocTeam todo: create a diagram for DocumentState and put it into the help-page.

Renderer for Docbook

Template for openoffice: is there any for version 4.2 ... 5.0?

That features are a good starting-point:

Classes:
Text_Wiki_Docbook
Text_Wiki_Parse_Emphasis
Text_Wiki_Parse_Heading
Text_Wiki_Parse_Image
Text_Wiki_Parse_Raw
Text_Wiki_Parse_Table
Text_Wiki_Parse_Url
Files:
Emphasis.php
Heading.php
Image.php
Docbook.php
Raw.php
Table.php
Url.php

Teams-sections, Committees-sections

Support for people who want to add multi-language-pages

But - the main-language is english and we don't want to get chaos with page-names.

problems of the wiki

How I clean-up the wiki

Here some documentation how I do it:

  • see the url Special:RecentChanges regularly
  • klick every "changes" or "div" link and check the content of the page. When it's senseful contribution then let it - otherwise klick "rollback", or delete.
  • when someone created a new wiki-page what has no header or what has no wiki-tags then care for this

It needs 20 to 30 minutes. --Daniel Brüßler 20:29, 6 August 2007 (CEST)

problems with protected pages after wiki-engine-upgrades

The problems are

  • protection-log does not contain the protected pages
  • many pages (since yet I just saw german ones) were broken. Many "</protect"-Tags and a document-part what contain strange chars.

My theory:

  • While one of the last wiki-engine-updates the protection-log went lost! That's the reason an admin/sysop doesn't see what pages are blocked in the moment. For example TemplaVoila is protected, but just registered users are able to recognize that.
  • After the upgrade people maybe could edit the pages and the protection-tags were moved around between some sections.

-> Maybe this happens again with the next upgrade!

--Daniel Brüßler 16:28, 24 September 2006 (CEST)

Poor text search

The text search is really poor, see mailing list thread: http://lists.typo3.org/pipermail/typo3-project-documentation/2004-July/000206.html

Example search without result: (add any example here)

  • CSS
  • bug
  • ext
  • cvs

Some information may be interesting here: https://lists.wikimedia.org/pipermail/mediawiki-l/2004-August/001066.html

Search via google: http://www.google.de/search?hl=en&btnG=Suche&meta=&q=site%3Awiki.typo3.org+TER

Add the german TYPO3-content of the linuxwiki

Check what content of http://linuxwiki.de/Typo3 is worth to move to the german pages De:Main_Page . That pages are not updated for a long time!

Archive

  • installed Boilerplate-extension, added switch for template-selection (the Hook for boilerplate selector is not existing in 1.6.8, we cannot update this mediawiki-version), added also GET-params for FLOW3-exceptions --Daniel Brüßler 00:09, 22 March 2008 (CET)
  • Exceptions for FLOW3 Exception with some examples, geshi-rendering for changelogs via tag "changelog" --Daniel Brüßler 20:38, 14 February 2008 (CET)
  • example-page for Core5-Exception with header, note, categories, 2 tags --Daniel Brüßler 14:24, 21 January 2008 (CET)
  • move CT --Daniel Brüßler 17:28, 18 January 2008 (CET)
  • simplify the documentstate to note-draft-review-publish-ready and find icons & colors, move the pages
  • finish URL_rewriting
  • documentstate draft: tag "{{draft}}" with category Topic/draft and templates Draft + DraftCategory + DraftIcon --Daniel Brüßler 15:54, 11 January 2008 (CET)
  • Projects-header: added link to the most important category, changed the template-tags of the pages using it (around 40 pages) --Daniel Brüßler 15:31, 25 August 2007 (CEST)
  • NO: automatic links to 5-wiki (because to much overload), just as "external links" via a wiki-page
  • install ext, solve languaege-empty/array-problem of version 1.6.8 Qif_conditionals PHP4-version (for #Michiel) --Daniel Brüßler 12:49, 16 August 2007 (CEST)
  • export-import: Template-content shall NOT be removed (50removeStuff/ Mediawiki 2 Plain). Tag-Template-content shall NOT be removed (50removeStuff/ Mediawiki 2 Plain). no "REMOVE"-info for the all other Template-names (Mediawiki 2 Plain). --Daniel Brüßler 18:34, 25 July 2007 (CEST)
  • collect existing docbook-features --Daniel Brüßler 09:54, 27 April 2007 (CEST)
  • check if rights for bottrap-updater optimal, path-config for logfile in extra folder and secure it via htaccess
  • Test per Firefox, add entry for mediawiki in bottrap-wiki and ask if we can switch-off the auto-updater and call it by self when we want to have an update. --Daniel Brüßler 10:30, 3 April 2007 (CEST)
  • register for bottrap and introduce ourselves --Daniel Brüßler 20:42, 1 April 2007 (CEST)
  • change for tag-styling: Template talk:Tag
  • change cat-names of 5'ers: Category_talk:Core Team all!!
  • change: Dev4Team => Core Team (pages, header, category) --Daniel Brüßler 21:40, 19 March 2007 (CET)
  • Update Extension-Template -- Martin Maholtz 19 March 2007 (CET)
  • Optimize Wiki-menu in left box --Daniel Brüßler 17:55, 28 February 2007 (CET)
  • we need versioning for wikipages what are relating to TSref and the sourceforge-diff - see Calendar#Calendar_Base_-_cal_.28beta.29 and De:TSref# Updates/ TSref# Updates
  • Tag Oracle, maybe also MySQL DBAL -t3doc:extensions/dbal PostgreSQL --Daniel Brüßler 22:46, 15 November 2006 (CET)
  • LanguageSwitch: Requirements: Pages in other languages shall have buttons to switch to english - the main language - or to other languages. BUT we're an international team and so all documentation has to be available in english first. THAT's the reason that this switch is not included to the english pages. --Daniel Brüßler 20:32, 3 October 2006 (CEST)
  • teamheaders and team-categories - so that new documents can be added so easy as it should be --Daniel Brüßler 10:42, 3 October 2006 (CEST)
  • Optimizing the wiki-navigation and DocumentState for wiki-pages --Daniel Brüßler 20:52, 30 September 2006 (CEST)
  • support for a document-lifecycle (in the wiki). Now ready, Yeah! --Daniel Brüßler 17:48, 29 September 2006 (CEST) - According to Documentation_workflow, Documentation_Process_-_Problems_and_Resolutions, the very good workflow of wikinews-project., See link: Why usability in Open Source Software is poor


Documents missing


typo3.org documentation pages