Initial upload - store what we have.

Documentation/Images/index.txt

@@ -0,0 +1,64 @@
+
+.. created by: E:\toolsmb\Scripts\generateImgIndexTxtForRst.py
+
+
+.. existing images:
+.. | |image next|
+.. | |image previous|
+.. | |image selectAdaptiveWidthLayout|
+.. | |image selectFixedWidthLayout|
+.. | |image up|
+
+
+.. existing images:
+  next
+  ====
+
+  |image next|
+
+  previous
+  ========
+
+  |image previous|
+
+  selectAdaptiveWidthLayout
+  =========================
+
+  |image selectAdaptiveWidthLayout|
+
+  selectFixedWidthLayout
+  ======================
+
+  |image selectFixedWidthLayout|
+
+  up
+  ==
+
+  |image up|
+
+
+.. |image next| image:: Images/next.png
+   :alt: image next.png
+   :width: 168px
+   :height: 123px
+
+.. |image previous| image:: Images/previous.png
+   :alt: image previous.png
+   :width: 163px
+   :height: 134px
+
+.. |image selectAdaptiveWidthLayout| image:: Images/selectAdaptiveWidthLayout.png
+   :alt: image selectAdaptiveWidthLayout.png
+   :width: 264px
+   :height: 148px
+
+.. |image selectFixedWidthLayout| image:: Images/selectFixedWidthLayout.png
+   :alt: image selectFixedWidthLayout.png
+   :width: 207px
+   :height: 150px
+
+.. |image up| image:: Images/up.png
+   :alt: image up.png
+   :width: 239px
+   :height: 136px
+

Documentation/Includes.txt

@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in this documentation project (= manual).
+
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+
+.. role::   typoscript(code)
+
+.. role::   ts(typoscript)
+   :class:  typoscript
+
+.. role::   php(code)
+
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,54 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+===========================================
+Welcome to the official TYPO3 Documentation
+===========================================
+
+Page rendered at |today|.
+
+
+Please **choose from the menu above** or go to:
+
+TYPO3 CMS
+=========
+
+* `TYPO3 CMS documentation <http://docs.typo3.org/typo3cms/>`__
+* `TYPO3 CMS extension manuals <http://docs.typo3.org/typo3cms/extensions/>`__
+
+  **Tip:** Also see the *single file version!*
+  The list of :ref:`list-of-typo3-cms-official-manuals` now offers a
+  *single file version* of each manual as well.
+  The rendering may not be perfect as it hasn't been tuned yet. But since
+  having a single file can be advantageous in a lot of situations, they
+  are offered here already as well.
+
+
+
+TYPO3 Flow
+==========
+
+* `TYPO3 Flow Documentation <http://docs.typo3.org/flow/>`__
+
+TYPO3 Neos
+==========
+
+* `TYPO3 Neos Documentation <http://docs.typo3.org/neos/>`__
+
+
+
+Contents of Documentation Overview
+==================================
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   typo3cms/Index
+   Overview/*

Documentation/Overview/Contribute.rst

@@ -0,0 +1,30 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+==============================
+Contribute
+==============================
+
+How can you contribute?
+=======================
+
+Your help is very much appreciated - no matter what way you choose.
+Ways to contribute:
+
+* If you found something good: Write it down and `send us an email! <documentation@typo3.org>`__
+
+* Report issues for a specific manual at `Forge: team-docteam <https://forge.typo3.org/projects/team-docteam/issues>`__ 
+  "where it belongs".
+
+* Report general issues at `Forge: team-doc-rendering. <https://forge.typo3.org/projects/team-doc-rendering/issues>`__
+
+* All *official* manuals are maintained at `git.typo3.org <http://git.typo3.org/Documentation/>`__.
+  Start contributing by using the normal Git/Gerrit review workflow.
+
+* If you want to tell me more ways - write to `Martin <martin.bless@typo3.org>`__
+

Documentation/Overview/ForYourInformation.rst

@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+==============================
+For Your Information
+==============================
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   ForYourInformation/*
+

Documentation/Overview/ForYourInformation/KnownProblems.rst

@@ -0,0 +1,49 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+==============================
+Known Problems
+==============================
+
+
+For Readers
+===========
+
+.. _known-problem-html-content-cut-off:
+
+When HTML content is cut off
+----------------------------
+
+Firefox and wide code-blocks within tables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Firefox does things correctly: It displays wide code-blocks as desired
+and then adjusts column widths of tables appropriately. This may lead
+to hidden content though in fixed width layout.
+See this :ref:`example page <t3api:high-priority-functions>`.
+
+**Tip:**
+Use "adaptive" layout and a wide monitor in that case or switch to
+a different browser.
+
+For Documentation Writers
+=========================
+
+.. _known-problem-1050:
+
+Anonymous Intersphinx Labels
+----------------------------
+
+Currently, 2012-12-03, anonymous intersphinx labels don't work as they
+are not part of object.inv. See sphinx bug report `#1050`__ and the
+`discussion about that`__ in the Sphinx-Users group.
+
+__ https://bitbucket.org/birkenfeld/sphinx/issue/1050
+__ https://groups.google.com/forum/?fromgroups=#!topic/sphinx-users/159KrjLnUpQ
+
+
+

Documentation/Overview/Images.txt

@@ -0,0 +1,31 @@
+
+.. |image next| image:: ../Images/next.png
+   :alt: click on 'next'
+   :class: screenshot-detail
+.. :width: 168px
+.. :height: 123px
+
+.. |image previous| image:: ../Images/previous.png
+   :alt: click on 'previous'
+   :class: screenshot-detail
+.. :width: 163px
+.. :height: 134px
+
+.. |image selectAdaptiveWidthLayout| image:: ../Images/selectAdaptiveWidthLayout.png
+   :alt: select the adaptive width layout
+   :class: screenshot-detail
+.. :width: 264px
+.. :height: 148px
+
+.. |image selectFixedWidthLayout| image:: ../Images/selectFixedWidthLayout.png
+   :alt: select the fixed width layout
+   :class: screenshot-detail
+.. :width: 207px
+.. :height: 150px
+
+.. |image up| image::  ../Images/up.png
+   :alt: click on 'up'
+   :class: screenshot-detail
+
+.. :width: 239px
+.. :height: 136px

Documentation/Overview/Tips.rst

@@ -0,0 +1,95 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+.. include:: Images.txt
+
+==============================
+Tips
+==============================
+
+Travel pages by keyboard
+========================
+
+Each documentation knows about a linear sequence of its pages. Use "Next"
+and "Previous" to move forwards or backwards in that sequence. Or, if
+available, use "Up" to step back to the next higher level of page
+hierarchy. The good news is that these functions are also available 
+from the keyboard by the "access keys".
+
+What's an "access key"?
+-----------------------
+
+  In a web browser, an `access key or accesskey`__ allows a computer 
+  user immediately to jump to a specific part of a web page via the 
+  keyboard.
+
+__ http://en.wikipedia.org/wiki/Accesskey
+
+Unfortunately each browser seems to use `its own modifier`__ to
+make the access key work.
+In most web browsers the user invokes the access key by pressing 
+the "modifier (which often is Alt or Ctrl) simultaneously with the 
+appropriate character on the keyboard. So we have for example:
+
+__ http://en.wikipedia.org/wiki/Accesskey#Access_in_different_browsers
+
+================= ============================== =====================
+OS                Browser                        Modifier
+================= ============================== =====================
+OSX 10.6          Safari, Firefox, Chrome, iCab  ``Ctrl + Alt``
+OSX 10.7          Firefox                        ``Ctrl``
+Win7              Chrome, Safari                 ``Alt``
+Win7              Firefox                        ``Shift + Alt``
+Windows           IE                             ``Alt + <character> <enter>``
+================= ============================== =====================
+
+
+"access key + n": Next page
+---------------------------
+
+Press the "access key + n" or click "Next" to advance to the next 
+page in line. The tooltip shows the title of the page to come.
+
+|image next|
+
+
+"access key + p": Previous page
+-------------------------------
+
+Press the "access key + p" or click "Previous" to go to the page that
+precedes the current page. The tooltip shows the title of that page.
+
+|image previous|
+
+
+"access key + u": Up one level in page hierarchy
+------------------------------------------------
+
+Press the "access key + u" or click "Up" to go back to the superiore 
+page. The tooltip shows the title of that page.
+
+|image up|
+
+
+Layouts
+=======
+
+Fixed width layout
+------------------
+
+Select the fixed width layout:
+
+|image selectFixedWidthLayout|
+
+
+Adaptive width layout
+---------------------
+
+Select the adaptive width layout. Here the width of the page varies
+and adapts to the width of your browser window:
+
+|image selectAdaptiveWidthLayout|
+