From TYPO3Wiki

<< Back to About the Documentation page   (edit)

<< Back to Projects page

[edit]

Main editor: Sylvain
Status: Work in progress

---

Contents 1 About this project 2 Program install 2.1 Doxygen 1.3.8 CVS version 2.1.1 Setting up Doxygen 2.1.2 Doxygen documentation 2.2 TYPO3 3.7.0 CVS version 2.3 MediaWiki CVS version 3 TODO

About this project

A sourceforge project is now open for the DocTEAM. It will be the center for tools development related to TYPO3 documentation.

• https://sourceforge.net/projects/docteam/

Contact Sylvain, if you want your sourceforge's user to be added to the development team.

Even this project is about a TYPO3, it could be useful to produce documentation for other project. The goal is to develop tools to produce and manage documentation. This project area is open to allow DocTEAM involved developer to use CVS and any tools provided by sourceforge.

Main future project:

• Integrate MediaWiki as a TYPO3 extension. To move the documentation wiki into the TYPO3 CMS.

Normal extension develpment are found here:

• http://sourceforge.net/projects/typo3xdev/

It's the early beginning and needs more work.

Program install

Doxygen 1.3.8 CVS version

• Doxygen install, like this one, with the latest CVS version of TYPO3.
  • sf install request
  • SF compile farm server status
  • Compile Farm documentation

• Compiling Doxygen on sourceforge compile farm.
  • Doxygen Installation manual
  • In order to login to the Compile Farm server you must have ssh key pair. You must upload your public key first, using the sourceforge page on your web account first.
  • Compile farm hostname for redhat Shrike is x86-linux2.
  • dot diagram tool
  • doxygen 1.3.8 compiled and uploaded in docteam/bin/ (not tested yet)

Setting up Doxygen

• doxygen 1.2.18 is already present on sourceforge shell server, do not forgetto override the PATH to use the lastest version.
  • in /home/groups/d/do/docteam source the file chpath
  • . chpath
• doxygen -g typo3_doxygen.conf
  • Adding text output to Doxygen MainPage
• Doxygen output result is available http://docteam.sourceforge.net/doxygen_doc/TYPO3/html/

Doxygen documentation

• Doxygen usage
• Getting started

TYPO3 3.7.0 CVS version

• Install TYPO3 3.7.0
  • CVS checkout, done
  • cvs -z3 -d:pserver:anonymous@cvs1:/cvsroot/typo3 co TYPO3core

MediaWiki CVS version

• Install MediaWiki
  • Hacking MediaWiki
  • Installing form CVS
  • CVS checkout, done
  • cvs -z3 -d:pserver:anonymous@cvs1:/cvsroot/wikipedia co -d mediawiki_phase3 phase3

Multiple software in the same database

• MediaWiki Table prefix for db tables

TODO

• Import existing code in CVS
  • document import vim macro
  • a tools I'm proposing to convert wiki to SXW