[TYPO3-doc] Cross-linking to Doxygen

[Xavier Perseguers]

Hi all,

As Fabien gave me access to api.typo3.org, I could successfully deploy
my generation script (reworked as a Phing task).

This means that you may now cross-link to the TYPO3 API! It is generated
for TYPO3 6.x versions solely.

How to cross-link
=================

You need to add an intersphinx mapping. Please define *only* the version
you need, and not every one as it will (as of today) slow down the
rendering for nothing.

Settings.yml configuration for TYPO3 stable (currently 6.1):

conf.py
  copyright: 2013
  project: Your project
  version: 1.0
  release: 1.0.0
  intersphinx_mapping:
    t3cmsapi:
    - http://typo3.org/api/typo3cms/
    - null


Settings.yml configuration for TYPO3 master:

conf.py
  copyright: 2013
  project: Your project
  version: 1.0
  release: 1.0.0
  intersphinx_mapping:
    t3cmsapidev:
    - http://api.typo3.org/typo3cms/master/html/
    - null

Additional info on [1]. Beware, if you need to cross-link to official
manuals as well, you need to reconfigure mapping in Settings.yml as
well. See (again) [1].

In your documentation, you may either link to a given class:

	See :ref:`t3cmsapi:TYPO3\\CMS\\Core\\Utility\\GeneralUtility` for
standard API methods.

You prefer to link to a method? No problem either:

	You may send an email with
:ref:`t3cmsapi:TYPO3\\CMS\\Core\\Utility\\MailUtility::mail`.

A few additional anchors are created as well (available as
:ref:`t3cmsapi:<anchor>`):

- modindex => Classes (tab "Classes" in Doxygen)
- genindex => Class Index (Doxygen: Classes > Class List)
- start => Homepage of Doxygen-based API
- namespaces
- hierarchy
- functions
- functions-func
- variables
- deprecated
- todo
- test
- pages
- examples

Note: some of these anchors may not be available if corresponding
information is not generated by Doxygen.

What we will highly need is an index browser. See [2] if you want to help.


[1]
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/UsersManual/DocsTypo3Org/Index.html#docs-typo3-org-crosslink
[2] http://forge.typo3.org/issues/51280

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org