PHPDocWiki : howto

This is the unofficial version of the phpdoc HOWTO.

Table of Contents

About This Document

• Preface

Getting Started

• The PHP Documentation Framework
• Tools and Setup Instructions
  • XSL
  • Linux
  • Windows
• Working with CVS
  • Getting an account
  • Loggin in
  • Checking out from CVS
  • Updating
  • Getting a status of a file
  • Committing changes
  • Adding files
  • Removing files
• About the DocBook Standard

Working with the PHP Documentation

• File Overview
• Conventions
• What to Document?
• Documentation Skeletons
• Information for Translators
  • Joining an existing translation
  • Starting a new translation
  • Transation Tips
  • Tracking the translation
• The phpdoc mailing lists
• User Note Editing Guidelines
• Miscellaneous Notes

Generating Documentation and Validating

• The Makefile
• Validating Changes
• Viewing Your Changes
• Using XSL Stylesheets
• The Online Generation System