Documentation joblist

From TYPO3Wiki

Jump to: navigation, search
Teams  R&D-Committee This page belongs to DocTeam (Members|Contact). see our current activities
Support for good documentation is our mission.
Note FORGE - http://forge.typo3.org/projects/show/team-docteam

I move this to forge in the moment. --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 ;-)


Contents

Current activities

todo

what do you do, in which order, just add your name and sign below it - add a small photo, if there's one online:

Daniel

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 http://wiki.typo3.org/exportimport/ because just export is needed. See bugtracker. 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 {{DesignTOC}} 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

Eikaa

Eikaa

Matthew

Matthew Manderson

  1. 5-Minutes Newbee-Manual version 061011
  2. TypoScript
  3. Installation

Jakub

Jakub

  1. Getting started section to help newbees

Michiel

Michiel

  • Symbols for the Document workflow (Warning-sign, Notes, and things like this). DONE

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

care for dead links in public openOffice 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

Check Links to this page: Wiki guidelines is not longer part of About-documentation -> moved to Getting started

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

  • new Design-Template: DesignTeam
  • 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
  • Documentation_joblist: cleanup
  • Team-Pages: All documents that belong to a team should be accessable via its cat
  • DocTeam-Pages: cleanup and put HowTos into the HowTo-cat
  • Extension-manuals: all pages should belong to the Extension-cat

Agile Projects

  • A fast and simple concept: helps to find contributers
  • Category:Topic/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 llxml for content of Glossary/Version_0.1 -- not existing but easy to create using Text_Wiki with XHTML-renderer -- 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

spam-problem again - URLs but not wiki-links

  • 13.10.2006: many spam-URLs but not wiki-links
How I clean-up the wiki

Here some documentation how I do it:

  • see the url http://wiki.typo3.org/index.php/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.netfielders.de/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: http://mail.wikipedia.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


Documents missing


typo3.org documentation pages

Retrieved from "http://wiki.typo3.org/index.php/Documentation_joblist"
Personal tools
content
help 'N' beginners