[FEATURE] Migrate sysext manuals to reST 37/22337/2
authorFrancois Suter <francois@typo3.org>
Mon, 15 Jul 2013 20:28:05 +0000 (22:28 +0200)
committerGeorg Ringer <georg.ringer@gmail.com>
Tue, 16 Jul 2013 04:20:28 +0000 (06:20 +0200)
All system extension manuals are migrated to reStructured Text.
All OpenOffice manuals are removed.

Resolves: #50052
Releases: 6.2
Change-Id: I9d8d9ad433276e6105d9c38b9f2a3b34dc8749f6
Reviewed-on: https://review.typo3.org/22337
Tested-by: Wouter Wolters
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
438 files changed:
typo3/sysext/css_styled_content/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/AboutThisDocument/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Constants/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/BulletList/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Divider/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Header/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Html/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Image/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/InsertRecords/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Mailform/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Media/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Menu/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Plugin/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Search/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Table/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Text/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/TextImage/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Uploads/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Configuration/Setup/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/HowTo/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/ConstantEditor.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/EditTypoScriptProperty.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/ExtensionManager.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/HeaderContentElement.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/ImageContentElement.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/LinkToTop.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/MediaContentElementStructure.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/SectionFrame.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/StaticTemplateInclusion.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/TableContentElement.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/TextContentElement.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/TtContentOverview.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Images/TypoScriptObjectBrowser.png [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Installation/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/OutOfTheBoxCssStyling/Index.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/css_styled_content/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/doc/manual.sxw [deleted file]
typo3/sysext/dbal/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/ConfiguringDatabaseAccess/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/CompatibilityTuning/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/ConfiguringDatabaseAccess/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Bugs/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/ConfigurationHints/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Debug/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Handlercfg/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Mapping/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Memcached/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Configuration/Typo3ConfVars/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/DebugBackendModule/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/DebugBackendModule/DatabaseInformation/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/DebugBackendModule/DebugLog/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/DebugBackendModule/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/DebugBackendModule/SqlCheck/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Extensions/CodingGuidelines/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Extensions/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Extensions/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Extensions/SmallCookbook/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Extensions/SqlStandard/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Faq/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Images/DebugLog.png [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/InstallingWithDbal/DoingTheActualSetup/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/InstallingWithDbal/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/InstallingWithDbal/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/InstallingWithDbal/PreparingSetup/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/ChangingOfTableOrFieldDefinitionsThroughDbal/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/CreatingADatabaseFromWithinTheInstallTool/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/DatabaseCheckInBackend/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/DatabaseSpecificIssues/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/ResultsOfDatabaseComparisonOperations/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/SequencesCollideWithImportedData/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/KnownProblems/SomeFieldNamesAreTooLong/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/dbal/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/To-doList/GeneralTodo/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/To-doList/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/To-doList/NewFeatures/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/Documentation/To-doList/Oracle/Index.rst [new file with mode: 0644]
typo3/sysext/dbal/doc/class.tslib_fe.php.diff [deleted file]
typo3/sysext/dbal/doc/manual.sxw [deleted file]
typo3/sysext/felogin/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Examples/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Hooks/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/ContentElementWizard.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/GeneralSettings.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/MessagesConfiguration.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/RedirectConfiguration.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/UserGroupRedirection.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Images/UserRedirection.png [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/KnownProblems/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/LoginMechanism/Display/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/LoginMechanism/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/LoginMechanism/LoginProcess/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/LoginMechanism/RedirectModes/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/felogin/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/felogin/Documentation/UsersManual/Index.rst [new file with mode: 0644]
typo3/sysext/felogin/doc/manual.sxw [deleted file]
typo3/sysext/form/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/CheatSheet/Images.txt [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/CheatSheet/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Reference/Attributes/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Reference/Functions/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Reference/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Reference/Objects/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/CheatSheetAttributes.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/CheatSheetFilters.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/CheatSheetLayouts.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/CheatSheetRules.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/FormCreationWizad.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/form/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Manual/en/manual.sxw [deleted file]
typo3/sysext/form/Documentation/Resources/Cheatsheet.ods [new file with mode: 0644]
typo3/sysext/form/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/form/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/AnalysingIndexedData/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Configuration/General/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Configuration/Typoscript/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/IndexFulltext/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/IndexGrlist/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/IndexPhash/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/IndexSection/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/DatabaseTables/IndexWordsIndexRel/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/AdvancedSearchOptions.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CategorizationSelector.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CommonIndexingConfigurations.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ComplexScenarioMoreExamples.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ComplexScenarioOverview.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ComplexScenarioPlugin.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerForLinkedFiles.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerLogConfigurationId.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerLogDirectories.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerLogExternal.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerLogFullIndexing.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerLogRecords.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/CrawlerVerfiyIndexing.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/DisableFrontendIndexing.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/FrontendSearchForm.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/FrontendSearchResults.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/GlobalPageDetails.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/GlobalStatistics.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/GroupingConfigurations.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexedSearchPluginType.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexingConfigurationDirectory.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexingConfigurationExternal.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexingConfigurationFullTree.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexingConfigurationRecords.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/IndexingModuleSelection.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/PageIndexingCleanup.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/PageIndexingStatistics.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/RecordConfigurationPlacement.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/VerifyingIndexedDirectories.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/VerifyingIndexedExternals.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/VerifyingIndexedRecords.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ViewResultsBasic.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ViewResultsCategorized.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ViewResultsGrouped.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ViewResultsLocalized.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Images/ViewResultsOrdered.png [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/Configurations/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/CrawlerSetup/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/DisableFrontendIndexing/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/Grouping/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/IndexingDirectories/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/IndexingExternals/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/IndexingFilesSeparately/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/PeriodicIndexingRecords/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/PeriodicIndexingWebsite/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/IndexingConfigurations/ShowingResults/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/KnownProblems/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/AccessRestrictedPages/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/ExternalMedia/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/HowPagesAreIndexed/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/HtmlContent/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/TechnicalDetails/UseOfHashes/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/Documentation/UserManual/Index.rst [new file with mode: 0644]
typo3/sysext/indexed_search/doc/README.txt [deleted file]
typo3/sysext/linkvalidator/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Images/CheckLinksTab.png [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Images/CheckLinksTabVisible.png [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Images/ReportsTab.png [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Images/SchedulerTask.png [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/LargeSites/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/NextSteps/Index.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/linkvalidator/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/linkvalidator/doc/manual.sxw [deleted file]
typo3/sysext/linkvalidator/doc/manual.txt [deleted file]
typo3/sysext/openid/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/openid/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/openid/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/openid/Documentation/Images/BackendUserConfiguration.png [new file with mode: 0644]
typo3/sysext/openid/Documentation/Images/FrontendUserConfiguration.png [new file with mode: 0644]
typo3/sysext/openid/Documentation/Images/YahooOpenIdScreen.png [new file with mode: 0644]
typo3/sysext/openid/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/openid/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/openid/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/openid/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/openid/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/openid/Documentation/UsersManual/Index.rst [new file with mode: 0644]
typo3/sysext/openid/doc/manual.sxw [deleted file]
typo3/sysext/recycler/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Images/RecyclerMainScreen.jpg [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/recycler/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/recycler/doc/manual.sxw [deleted file]
typo3/sysext/rsaauth/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/rsaauth/Documentation/UsersManual/Index.rst [new file with mode: 0644]
typo3/sysext/rsaauth/doc/manual.sxw [deleted file]
typo3/sysext/rtehtmlarea/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/AnchorAccessibility/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/Clickenlarge/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/CustomTags/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/DefaultWebsiteLanguage/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/ExtensionConfiguration/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/FrontEndPlugins/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/InstallingMultipleRtes/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/classes/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/classesAnchor/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/colors/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/fontSizes/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/fonts/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/interfaceConfiguration/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/mutuallyExclusiveClasses/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/userCategory/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/userElements/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/PageTsconfig/userLinks/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/ServerConfiguration/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/ToolbarElements/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Configuration/UserTsconfig/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Copyright/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Default/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Demo/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Image/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Minimal/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/DefaultConfigurations/Typical/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Installation/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/FirefoxExtensionNoscript/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/GzipCachingProblem/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/HtmlTagAbbr/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/OperaExtensionHyperTranslate/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/Troubleshooting/SecurityErrorStylesheets/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/DefinitionLists/Buttons/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/DefinitionLists/Creating/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/DefinitionLists/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/DefinitionLists/Nesting/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/DefinitionLists/Remapping/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/Faq/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/FormatingInlineElements/DropDownBehavior/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/FormatingInlineElements/DropDownLabels/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/FormatingInlineElements/ElementsList/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/FormatingInlineElements/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/Hotkeys/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/MarkingLanguage/DropDownList/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/MarkingLanguage/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/MarkingLanguage/LanguageMarks/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/StylingInlineElements/DropDownBehavior/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/StylingInlineElements/DropDownLabels/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/StylingInlineElements/ElementsList/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/Documentation/UsersManual/StylingInlineElements/Index.rst [new file with mode: 0644]
typo3/sysext/rtehtmlarea/doc/manual.sxw [deleted file]
typo3/sysext/saltedpasswords/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Credits/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/DevelopersGuide/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Images/ExtensionConfigurationCheck.png [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Images/SaltedHashInDatabase.png [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Installation/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Licenses/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Overview/Index.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/saltedpasswords/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/saltedpasswords/doc/manual.sxw [deleted file]
typo3/sysext/scheduler/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/BackendModule/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/DeleteTask/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/EditTask/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/ManualExecution/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/StopTask/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/AppendixA/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/DevelopersGuide/CreatingTasks/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/DevelopersGuide/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/DevelopersGuide/SchedulerApi/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/AddingATask.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/BackendModuleMainView.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/InformationScreen.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/InputValidation.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/LateTask.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/SetupCheck.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/StoppingATask.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/BaseTasks/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/CronJob/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/Installing/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/SchedulerUser/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/SetupCheck/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/KnownProblems/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Overview/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/To-doList/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/doc/manual.sxw [deleted file]
typo3/sysext/sys_action/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Images/CreateBackendUserAction.gif [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Images/CreateSqlQuery.gif [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Images/RecordListAction.gif [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Images/SqlQueryAction.gif [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/CreateBackendUser/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/EditRecords/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/InGeneral/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/NewRecord/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/RecordList/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/Documentation/UsersManual/SqlQuery/Index.rst [new file with mode: 0644]
typo3/sysext/sys_action/doc/manual.sxw [deleted file]
typo3/sysext/taskcenter/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/DevelopersGuide/CreatingANewTask/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/DevelopersGuide/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/DevelopersGuide/TaskcenterApi/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Images/ExampleScreenshot.gif [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/taskcenter/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/taskcenter/doc/manual.sxw [deleted file]
typo3/sysext/workspaces/Documentation/.gitignore [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Configuration/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Versioning/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Workspaces/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/CustomWorkspace/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/ChangeInTheNextStage.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/ChangeRejected.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CreateCustomWorkspace.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspacesPermissions.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/IndividualActions.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/IndividualControlButtons.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/MassActionsMenu.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/ModifiedPageHighlight.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/PageViewIcon.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SaveAndViewButton.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SendToNextStage.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SendToNextStageMessage.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SettingWorkspacesPermissions.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/TuningCustomWorkspace.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/VersionsInListView.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceIndicator.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceLogging.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceMenu.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleOverview.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspacePreviewIcon.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceSplitPreview.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Includes.txt [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Introduction/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Settings.yml [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Targets.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/UsersGuide/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/manual.odt [deleted file]
typo3/sysext/workspaces/Documentation/manual.pdf [deleted file]
typo3/sysext/workspaces/Documentation/manual.sxw [deleted file]

diff --git a/typo3/sysext/css_styled_content/Documentation/.gitignore b/typo3/sysext/css_styled_content/Documentation/.gitignore
new file mode 100644 (file)
index 0000000..6cd159f
--- /dev/null
@@ -0,0 +1,7 @@
+# this is file .gitignore
+
+# ignore everything in this directory
+_make/*
+
+# but do not ignore this file
+!_not_versioned/.gitignore
diff --git a/typo3/sysext/css_styled_content/Documentation/AboutThisDocument/Index.rst b/typo3/sysext/css_styled_content/Documentation/AboutThisDocument/Index.rst
new file mode 100644 (file)
index 0000000..61932e0
--- /dev/null
@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _about-this-document:
+
+About this document
+-------------------
+
+Most parts of this document are copied from somewhere else. Here are
+the credits. Thanks go to:
+
+- Kasper Skårhøj for the original document
+
+- Ernesto Baschny for the documentation (and development of course) of
+  croncssstyledimgtext.
+
+- Steffen Kamper for the media element (documentation and development,
+  again)
+
+- Marc Wöhlken for reading and correcting the alpha version
+
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Constants/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Constants/Index.rst
new file mode 100644 (file)
index 0000000..9ed017a
--- /dev/null
@@ -0,0 +1,1204 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _constants:
+
+Constants
+^^^^^^^^^
+
+.. note::
+
+   Not all constants described here can be edited with the Constant Editors.
+   Just define those in the "Constants" field of your TypoScript templates.
+
+
+.. _constants-page-target:
+
+PAGE\_TARGET
+""""""""""""
+
+.. container:: table-row
+
+   Property
+         PAGE\_TARGET
+
+   Data type
+         string
+
+   Description
+         Target for internal links: Should match the name of the content PAGE-
+         object in TypoScript when used with frames. Most cases: set to ""
+         (empty). If you have frames in the template set to "page".
+
+
+
+.. _constants-content:
+
+content
+"""""""
+
+
+.. _constants-defaultheadertype:
+
+defaultHeaderType
+~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         defaultHeaderType
+
+   Data type
+         int
+
+   Description
+         The number of the header layout to be used by default
+
+   Default
+         1
+
+
+
+.. _constants-pageframeobj:
+
+pageFrameObj
+~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         pageFrameObj
+
+   Data type
+         string
+
+   Description
+         The name of the "contentframe". Normally set to "page" if the site has
+         a frameset. Otherwise it should be an empty value. This is important,
+         as it determines the target of internal links!
+
+
+
+.. _constants-shortcut-tables:
+
+shortcut.tables
+~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         shortcut.tables
+
+   Data type
+         string
+
+   Description
+         List of tables with an old-style name
+
+   Default
+         tt_content,tt_address,tt_links,tt_guest,tt_board,tt_calender,tt_products,tt_news,tt_rating,tt_poll
+
+
+
+.. _constants-spacebefore:
+
+spaceBefore
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         spaceBefore
+
+   Data type
+         int
+
+   Description
+         Space before each content element (pixels)
+
+   Default
+         0
+
+
+
+.. _constants-spaceafter:
+
+spaceAfter
+~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         spaceAfter
+
+   Data type
+         int
+
+   Description
+         Space after each content element (pixels)
+
+   Default
+         0
+
+
+.. _constants-styles-content:
+
+styles.content
+""""""""""""""
+
+
+.. _constants-styles-content-getnews-newspid:
+
+getNews.newsPid
+~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         getNews.newsPid
+
+   Data type
+         int
+
+   Description
+         If your template has a column with "news"-content fetched from another
+         page-id, this is where you enter the id-number of that page!
+
+   Default
+         0
+
+
+.. _constants-styles-content-links:
+
+styles.content.links
+""""""""""""""""""""
+
+
+.. _constants-styles-content-links-exttarget:
+
+extTarget
+~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         extTarget
+
+   Data type
+         string
+
+   Description
+         Target for external links
+
+   Default
+         \_blank
+
+
+
+.. _constants-styles-content-links-target:
+
+target
+~~~~~~
+
+.. container:: table-row
+
+   Property
+         target
+
+   Data type
+         string
+
+   Description
+         Default target for links
+
+   Default
+         {$PAGE\_TARGET}
+
+
+
+.. _constants-styles-content-links-allowtags:
+
+allowTags
+~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         allowTags
+
+   Data type
+         string
+
+   Description
+         Tags allowed in RTE content.
+
+
+   Default
+         b,i,u,a,img,br,div,center,pre,font,hr,sub,sup,p,strong,em,li,ul,ol,blo
+         ckquote,strike,del,ins,span,h1,h2,h3,h4,h5,h6,address
+
+
+.. _constants-styles-content-imgtext:
+
+styles.content.imgtext
+""""""""""""""""""""""
+
+
+.. _constants-styles-content-imgtext-maxw:
+
+maxW
+~~~~
+
+.. container:: table-row
+
+   Property
+         maxW
+
+   Data type
+         int
+
+   Description
+         This indicates that maximum number of pixels (width) a block of images
+         inserted as content is allowed to consume.
+
+   Default
+         600
+
+
+
+.. _constants-styles-content-imgtext-maxwintext:
+
+maxWInText
+~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         maxWInText
+
+   Data type
+         int
+
+   Description
+         Same as above, but this is the maximum width when text is wrapped
+         around an imageblock. Default is 50% of the normal Max Image Width.
+
+
+
+.. _constants-styles-content-imgtext-captionsplit:
+
+captionSplit
+~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         captionSplit
+
+   Data type
+         bool
+
+   Description
+         **Deprecated** Use :code:`imageTextSplit` below instead
+
+
+   Default
+         0
+
+
+
+.. _constants-styles-content-imgtext-imagetextsplit:
+
+imageTextSplit
+~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         imageTextSplit
+
+   Data type
+         bool
+
+   Description
+         If this is set, then the image text (caption, alt, title, longdesc)
+         will be split by each line and they will appear on the corresponding
+         images in the image list.
+
+   Default
+         1
+
+
+
+.. _constants-styles-content-imgtext-emptytitlehandling:
+
+emptyTitleHandling
+~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         emptyTitleHandling
+
+   Data type
+         string
+
+   Description
+         How the 'title' attribute will be handled if no title is given for an
+         image. Possible choices: "keepEmpty", "useAlt" or "removeAttr".
+         Recommended for accessibility is "removeAttr". For correct tooltips on
+         IE, use "keepEmpty". For use of alt="" text as title use "useAlt".
+
+   Default
+         removeAttr
+
+
+
+.. _constants-styles-content-imgtext-titleinlink:
+
+titleInLink
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         titleInLink
+
+   Data type
+         bool
+
+   Description
+         Do you want the 'title' attribute to be added to the surrounding <a>
+         tag, if present? Recommended for accessibility is "true".
+
+   Default
+         1
+
+
+
+.. _constants-styles-content-imgtext-titleinlinkandimg:
+
+titleInLinkAndImg
+~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         titleInLinkAndImg
+
+   Data type
+         bool
+
+   Description
+         If you have the title in the <a>-tag (titleInLink=1), you don't get
+         the 'title' in the <img>-tag. IE6 will not show the tooltip anymore.
+         So to get the 'title' in <img> too (to keep IE happy), set this too.
+         Recommended for accessibility is "false". For correct tooltips on IE6,
+         set this to "true".
+
+   Default
+         0
+
+
+
+.. _constants-styles-content-imgtext-colspace:
+
+colSpace
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         colSpace
+
+   Data type
+         int
+
+   Description
+         Horizontal distance between images in content elements of type "Image"
+         or "Text w/Image". If you change this manually in your CSS, you need
+         to adjust this setting accordingly.
+
+   Default
+         10
+
+
+
+.. _constants-styles-content-imgtext-rowspace:
+
+rowSpace
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         rowSpace
+
+   Data type
+         int
+
+   Description
+         Vertical distance after image rows in content elements of type "Image"
+         or "Text w/Image". If you change this manually in your CSS, you need
+         to adjust this setting accordingly.
+
+   Default
+         5
+
+
+
+.. _constants-styles-content-imgtext-textmargin:
+
+textMargin
+~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         textMargin
+
+   Data type
+         int
+
+   Description
+         Horizontal distance between images and text in content elements of
+         type "Text w/Image".
+
+   Default
+         10
+
+
+
+.. _constants-styles-content-imgtext-bordercolor:
+
+borderColor
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         borderColor
+
+   Data type
+         string
+
+   Description
+         Border color of images in content elements when "Border"-option for
+         element is set. Has to be either a defined color (like black, lime,
+         maroon) or a hexadecimal color code (like :code:`#FF00FF`)
+
+   Default
+         black
+
+
+
+.. _constants-styles-content-imgtext-borderthick:
+
+borderThick
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         borderThick
+
+   Data type
+         int
+
+   Description
+         Thickness (in pixels) of border around images in content elements when
+         "Border"-option for element is set.
+
+   Default
+         2
+
+
+
+.. _constants-styles-content-imgtext-borderspace:
+
+borderSpace
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         borderSpace
+
+   Data type
+         int
+
+   Description
+         Padding (in pixels) left and right to the image, around the border.
+
+   Default
+         0
+
+
+
+.. _constants-styles-content-imgtext-borderselector:
+
+borderSelector
+~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         borderSelector
+
+   Data type
+         string
+
+   Description
+         The selector where the image border is applied to. If you want your
+         border to apply elsewhere, change this setting. E.g. to apply to the
+         whole image+caption, use 'DIV.csc-textpic-border DIV.csc-textpic-
+         imagewrap .csc-textpic-image'.
+
+   Default
+         DIV.{$styles.content.imgtext.borderClass} DIV.csc-textpic-imagewrap
+         .csc-textpic-image IMG, DIV.{$styles.content.imgtext.borderClass} DIV
+         .csc-textpic-single-image IMG
+
+
+
+.. _constants-styles-content-imgtext-borderclass:
+
+borderClass
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         borderClass
+
+   Data type
+         string
+
+   Description
+         The name of the CSS class inserted and used for creating image borders
+
+   Default
+         csc-textpic-border
+
+
+
+.. _constants-styles-content-imgtext-separaterows:
+
+separateRows
+~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         separateRows
+
+   Data type
+         bool
+
+   Description
+         Whether images should be rendered/wrapped in separated rows, e.g.
+         inside a DIV.csc-textpic-imagerow element
+
+   Default
+         1
+
+
+
+.. _constants-styles-content-imgtext-addintextclearer:
+
+addIntextClearer
+~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         addIntextClearer
+
+   Data type
+         bool
+
+   Description
+         Whether a clearer should be added after textpic elements of type
+         intext-left or intext-right
+
+   Default
+         1
+
+
+
+.. _constants-styles-content-imgtext-linkwrap:
+
+styles.content.imgtext.linkWrap
+"""""""""""""""""""""""""""""""
+
+
+.. _constants-styles-content-imgtext-linkwrap-width:
+
+width
+~~~~~
+
+.. container:: table-row
+
+   Property
+         width
+
+   Data type
+         int+
+
+   Description
+         This specifies the width of the enlarged image when click-enlarge is
+         enabled.
+
+   Default
+         800m
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-height:
+
+height
+~~~~~~
+
+.. container:: table-row
+
+   Property
+         height
+
+   Data type
+         int+
+
+   Description
+         This specifies the height of the enlarged image when click-enlarge is
+         enabled.
+
+   Default
+         600m
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-effects:
+
+effects
+~~~~~~~
+
+.. container:: table-row
+
+   Property
+         effects
+
+   Data type
+         string
+
+   Description
+         Effects applied to the enlarged image.
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-newwindow:
+
+newWindow
+~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         newWindow
+
+   Data type
+         bool
+
+   Description
+         If set, every click-enlarged image will open in it's own popup window
+         and not the current popup window (which may have a wrong size for the
+         image to fit in)
+
+   Default
+         0
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-lightboxenabled:
+
+lightboxEnabled
+~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         lightboxEnabled
+
+   Data type
+         string
+
+   Description
+         If set, images will be rendered with a link to their big version and a
+         specified css class and rel attribute to easily allow the use of
+         lightboxes
+
+   Default
+         0
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-lightboxcssclass:
+
+lightboxCssClass
+~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         lightboxCssClass
+
+   Data type
+         string
+
+   Description
+         Which CSS class to use for lightbox links (only applicable if lightbox
+         rendering is enabled)
+
+   Default
+         lightbox
+
+
+
+.. _constants-styles-content-imgtext-linkwrap-lightboxrelattribute:
+
+LightboxRelAttribute
+~~~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         LightboxRelAttribute
+
+   Data type
+         string
+
+   Description
+         Which rel="" attribute to use for lightbox links (only applicable if
+         lightbox rendering is enabled)
+
+   Default
+         lightbox[{field:uid}]
+
+
+.. _constants-styles-content-uploads:
+
+styles.content.uploads
+""""""""""""""""""""""
+
+
+.. _constants-styles-content-uploads-jumpurl-secure:
+
+jumpurl\_secure
+~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         jumpurl\_secure
+
+   Data type
+         bool
+
+   Description
+         Set to 1 to secure "jump URLs".
+
+
+
+.. _constants-styles-content-uploads-jumpurl-secure-mimetypes:
+
+jumpurl\_secure\_mimeTypes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         jumpurl\_secure\_mimeTypes
+
+   Data type
+         string
+
+   Description
+         Comma-separated list of mime types for which "jump URLs" should be secured.
+
+   Default
+         pdf=application/pdf, doc=application/msword
+
+
+
+.. _constants-styles-content-uploads-jumpurl:
+
+jumpurl
+~~~~~~~
+
+.. container:: table-row
+
+   Property
+         jumpurl
+
+   Data type
+         bool
+
+   Description
+         Set to 1 to active "jump URLs".
+
+
+
+.. _constants-styles-content-uploads-filesizebytelabels:
+
+filesizeByteLabels
+~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         filesizeByteLabels
+
+   Data type
+         string
+
+   Description
+         The labels for bytes, kilobytes, megabytes and gigabytes
+
+   Default
+         " \| K\| M\| G"
+
+
+.. _constants-styles-content-mailform:
+
+styles.content.mailform
+"""""""""""""""""""""""
+
+
+.. _constants-styles-content-mailform-target:
+
+target
+~~~~~~
+
+.. container:: table-row
+
+   Property
+         target
+
+   Data type
+         string
+
+   Description
+         The mailform target
+
+   Default
+         {$PAGE\_TARGET}
+
+
+
+.. _constants-styles-content-mailform-goodmess:
+
+goodMess
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         goodMess
+
+   Data type
+         string
+
+   Description
+         This is the message (if any) that is popped-up (JavaScript) when a
+         user clicks "send" in an email-form
+
+
+
+.. _constants-styles-content-mailform-badmess:
+
+badMess
+~~~~~~~
+
+.. container:: table-row
+
+   Property
+         badMess
+
+   Data type
+         string
+
+   Description
+         This is the message that is popped-up (JavaScript) when a user has NOT
+         filled required fields in an email-form
+
+
+.. _constants-styles-content-loginform:
+
+styles.content.loginform
+""""""""""""""""""""""""
+
+
+.. _constants-styles-content-loginform-target:
+
+target
+~~~~~~
+
+.. container:: table-row
+
+   Property
+         target
+
+   Data type
+         string
+
+   Description
+         The login form target
+
+   Default
+         \_top
+
+
+
+.. _constants-styles-content-loginform-goodmess:
+
+goodMess
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         goodMess
+
+   Data type
+         string
+
+   Description
+         This is the message (if any) that is popped-up (JavaScript) when a
+         user logs in as a front-end user
+
+
+.. _constants-styles-content-loginform-pid:
+
+pid
+~~~
+
+.. container:: table-row
+
+   Property
+         pid
+
+   Data type
+         int
+
+   Description
+         Enter the page-uid number (PID) of the sysFolder where you keep your
+         fe\_users that are supposed to login on this site. This setting is
+         necessary, if login is going to work (and you aren't using "felogin")!
+
+
+.. _constants-styles-content-searchform:
+
+styles.content.searchform
+"""""""""""""""""""""""""
+
+
+.. _constants-styles-content-searchform-goodmess:
+
+goodMess
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         goodMess
+
+   Data type
+         string
+
+   Description
+         This is the message (if any) that is popped-up (JavaScript) when a
+         user performs a search
+
+
+.. _constants-styles-content-searchresult:
+
+styles.content.searchresult
+"""""""""""""""""""""""""""
+
+
+.. _constants-styles-content-searchresult-resulttarget:
+
+resultTarget
+~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         resultTarget
+
+   Data type
+         string
+
+   Description
+         Search result links target.
+
+
+   Default
+         {$PAGE\_TARGET}
+
+
+
+.. _constants-styles-content-searchresult-target:
+
+target
+~~~~~~
+
+.. container:: table-row
+
+   Property
+         target
+
+   Data type
+         string
+
+   Description
+         Target for the search results pagination links.
+
+
+   Default
+         {$PAGE\_TARGET}
+
+
+.. _constants-styles-content-media:
+
+styles.content.media
+""""""""""""""""""""
+
+
+.. _constants-styles-content-media-videoplayer:
+
+videoPlayer
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         videoPlayer
+
+   Data type
+         string
+
+   Description
+         configure the path to the video player
+
+   Default
+         typo3/contrib/flashmedia/flvplayer.swf
+
+
+
+.. _constants-styles-content-media-defaultvideowidth:
+
+defaultVideoWidth
+~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         defaultVideoWidth
+
+   Data type
+         int
+
+   Description
+         define the default width for the media video (in pixels)
+
+   Default
+         600
+
+
+
+.. _constants-styles-content-media-defaultvideoheight:
+
+defaultVideoHeight
+~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         defaultVideoHeight
+
+   Data type
+         int
+
+   Description
+         define the default height for the media video (in pixels)
+
+   Default
+         400
+
+
+
+.. _constants-styles-content-media-audioplayer:
+
+audioPlayer
+~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         audioPlayer
+
+   Data type
+         string
+
+   Description
+         configure the path to the audio player
+
+   Default
+         typo3/contrib/flashmedia/player.swf
+
+
+
+.. _constants-styles-content-media-defaultaudiowidth:
+
+defaultAudioWidth
+~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         defaultAudioWidth
+
+   Data type
+         int
+
+   Description
+         define the default width for the media audio (in pixels)
+
+   Default
+         300
+
+
+
+.. _constants-styles-content-media-defaultaudioheight:
+
+defaultAudioHeight
+~~~~~~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         defaultAudioHeight
+
+   Data type
+         int
+
+   Description
+         define the default height for the media audio (in pixels)
+
+   Default
+         30
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..07b94d8
--- /dev/null
@@ -0,0 +1,29 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _configuration:
+
+Configuration
+-------------
+
+This chapter first covers the TypoScript :ref:`constants <constants>` and
+:ref:`setup <setup>` associated with css\_styled\_content
+and then describes the :ref:`specific properties <properties>` for each
+content element type covered by this extension.
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Constants/Index
+   Setup/Index
+   Objects/Index
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/BulletList/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/BulletList/Index.rst
new file mode 100644 (file)
index 0000000..87a4bba
--- /dev/null
@@ -0,0 +1,23 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-bullet-list:
+
+Bullet list
+"""""""""""
+
+The bullet list-type content element is rendered using a simple
+:ref:`t3tsref:cobj-text` object applied to the "bodytext" field.
+The :ref:`split <t3tsref:split>` function is used to split
+the content into individual lines on each line break. Odd and
+even lines are marked with a different class.
+
+.. note::
+
+   The rendering will produce only unordered lists.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Divider/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Divider/Index.rst
new file mode 100644 (file)
index 0000000..cf70993
--- /dev/null
@@ -0,0 +1,17 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-divider:
+
+Divider
+"""""""
+
+By default the divider element renders by default a :code:`<hr>`
+(or a :code:`<hr />` when XHTML compliancy is set), wrapped in a
+:code:`<div>`. The :code:`<div>` is needed for styling in IE6.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Header/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Header/Index.rst
new file mode 100644 (file)
index 0000000..8fa829f
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-header:
+
+Header
+""""""
+
+Being just a header, most of this content element type's rendering
+is done by :ref:`setup-lib-stdheader`. The rest of the rendering takes care of
+the "subheader" field.
+
+.. figure:: ../../../Images/HeaderContentElement.png
+   :alt: Header content element
+
+   Input of a header content element in the TYPO3 backend
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Html/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Html/Index.rst
new file mode 100644 (file)
index 0000000..035d971
--- /dev/null
@@ -0,0 +1,19 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-html:
+
+HTML
+""""
+
+Renders straight HTML content by using a :ref:`t3tsref:cobj-text`
+object and outputting the content of the :code:`bodytext` field without
+further transformation.
+
+All properties of the :ref:`t3tsref:cobj-text` object apply.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Image/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Image/Index.rst
new file mode 100644 (file)
index 0000000..b54d9d0
--- /dev/null
@@ -0,0 +1,1104 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-image:
+
+Image
+"""""
+
+Image-type content elements are not rendered using a standard TypoScript
+content object but instead rely on a :ref:`USER <t3tsref:cobj-user>` object provided by
+CSS Styled Content, as can be seen in the TypoScript setup::
+
+       tt_content.image = COA
+       tt_content.image.10 = < lib.stdheader
+       tt_content.image.20 = USER
+       tt_content.image.20 {
+               userFunc = tx_cssstyledcontent_pi1->render_textpic
+               ...
+       }
+
+
+.. figure:: ../../../Images/ImageContentElement.png
+   :alt: Image content element
+
+   Defining the appearance of an image content element in the TYPO3 backend
+
+
+The :code:`render_textpic` function supports a whole variety of specific
+properties, which are detailed below.
+
+.. note::
+
+   All properties of USER objects also apply, in particular :ref:`stdWrap <t3tsref:stdwrap>`.
+
+
+.. _objects-image-reference:
+
+Reference
+~~~~~~~~~
+
+
+.. _objects-image-reference-text:
+
+text
+''''
+
+.. container:: table-row
+
+   Property
+         text
+
+   Data type
+         :ref:`CARRAY <t3tsref:carray>` / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Use this to import / generate the content, that should flow around the
+         imageblock.
+
+
+
+.. _objects-image-reference-textpos:
+
+textPos
+'''''''
+
+.. container:: table-row
+
+   Property
+         textPos
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Textposition:
+
+         bit[0-2]: 000 = centre, 001 = right, 010 = left
+
+         bit[3-5]: 000 = over, 001 = under, 010 text
+
+         0 - Above: Centre
+
+         1 - Above: Right
+
+         2 - Above: Left
+
+         8 - Below: Centre
+
+         9 - Below: Right
+
+         10 - Below: Left
+
+         17 - In Text: Right
+
+         18 - In Text: Left
+
+         25 - In Text: Right (no wrap)
+
+         26 - In Text: Left (no wrap)
+
+
+
+.. _objects-image-reference-imglist:
+
+imgList
+'''''''
+
+.. container:: table-row
+
+   Property
+         imgList
+
+   Data type
+         list of imagefiles / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         list of images from ".imgPath"
+
+         **Example:**
+
+         This imports the list of images from tt\_content's image-field
+
+         "imgList.field = image"
+
+   Default
+         field = image
+
+
+
+.. _objects-image-reference-imgpath:
+
+imgPath
+'''''''
+
+.. container:: table-row
+
+   Property
+         imgPath
+
+   Data type
+         path / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Path to the images
+
+         **Example:**
+
+         "uploads/pics/"
+
+   Default
+         uploads/pics/
+
+
+
+.. _objects-image-reference-imgmax:
+
+imgMax
+''''''
+
+.. container:: table-row
+
+   Property
+         imgMax
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         max number of images
+
+   Default
+         0 [all]
+
+
+
+.. _objects-image-reference-imgstart:
+
+imgStart
+''''''''
+
+.. container:: table-row
+
+   Property
+         imgStart
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         start with image-number ".imgStart"
+
+   Default
+         0
+
+
+
+.. _objects-image-reference-imgobjnum:
+
+imgObjNum
+'''''''''
+
+.. container:: table-row
+
+   Property
+         imgObjNum
+
+   Data type
+         *imgObjNum* + :ref:`optionSplit <t3tsref:objects-optionsplit>`
+
+   Description
+         Here you define which :ref:`IMAGE <t3tsref:cobj-image>`-cObjects from the array "1,2,3,4..."
+         should render which image.
+
+         "current" is set to the image-filename.
+
+         **Example:**
+
+         "imgObjNum = 1 \|\*\|\|\*\| 2":
+
+         If your ".imgList" contains 3 images, this would render the first two
+         images with "1. ..." and the last image with "2. ...".
+
+   Default
+         1
+
+
+
+.. _objects-image-reference-1-2-3-4:
+
+1,2,3,4,...
+'''''''''''
+
+.. container:: table-row
+
+   Property
+         1,2,3,4,...
+
+   Data type
+         :ref:`IMAGE <t3tsref:cobj-image>`
+
+   Description
+         Rendering of the individual images
+
+         The register "IMAGE\_NUM" is set with the number of image being
+         rendered for each rendering of a image-object. Starting with zero.
+
+         The image-object should not be of type GIFBUILDER!
+
+         **Important:**
+
+         "file.import.current = 1" fetches the name of the images!
+
+
+
+.. _objects-image-reference-caption:
+
+caption
+'''''''
+
+.. container:: table-row
+
+   Property
+         caption
+
+   Data type
+         :ref:`CARRAY <t3tsref:carray>` / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Caption
+
+
+
+.. _objects-image-reference-captionalign:
+
+captionAlign
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         captionAlign
+
+   Data type
+         align / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Caption alignment
+
+   Default
+         field = imagecaption\_position
+
+
+
+.. _objects-image-reference-imagetextsplit:
+
+imageTextSplit
+''''''''''''''
+
+.. container:: table-row
+
+   Property
+         imageTextSplit
+
+   Data type
+         boolean
+
+   Description
+         If this is set, the caption/alttext/title/longdescURL text is split by
+         the character (or string) from ".token" , and every item is rendered
+         to the accordant image in the image block.
+
+
+
+.. _objects-image-reference-border:
+
+border
+''''''
+
+.. container:: table-row
+
+   Property
+         border
+
+   Data type
+         boolean / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         If true, a border is generated around the images.
+
+   Default
+         field = imageborder
+
+
+
+.. _objects-image-reference-bordercol:
+
+borderCol
+'''''''''
+
+.. container:: table-row
+
+   Property
+         borderCol
+
+   Data type
+         HTML-color / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Color of the border, if ".border" is set.
+
+         This is used just to create the CSS class that will be added to an
+         image block that needs a border. The border itself will have to be
+         specified in CSS. See CSS section later.
+
+   Default
+         black
+
+
+
+.. _objects-image-reference-borderthick:
+
+borderThick
+'''''''''''
+
+.. container:: table-row
+
+   Property
+         borderThick
+
+   Data type
+         pixels / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Width of the border around the pictures
+
+         This is used just to create the CSS class that will be added to an
+         image block that needs a border. The border itself will have to be
+         specified in CSS. See CSS section later.
+
+   Default
+         2
+
+
+
+.. _objects-image-reference-cols:
+
+cols
+''''
+
+.. container:: table-row
+
+   Property
+         cols
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Columns
+
+   Default
+         field = imagecols
+
+
+
+.. _objects-image-reference-rows:
+
+rows
+''''
+
+.. container:: table-row
+
+   Property
+         rows
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Rows (higher priority than "cols")
+
+
+
+.. _objects-image-reference-norows:
+
+noRows
+''''''
+
+.. container:: table-row
+
+   Property
+         noRows
+
+   Data type
+         boolean / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         If set, the rows are not divided by table-rows. Thus images are more
+         nicely shown if the height differs a lot (normally the width is the
+         same!)
+
+   Default
+         field = image\_noRows
+
+
+
+.. _objects-image-reference-nocols:
+
+noCols
+''''''
+
+.. container:: table-row
+
+   Property
+         noCols
+
+   Data type
+         boolean / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         If set, the columns are not made in the table. The images are all put
+         in one row separated by a clearer to space them apart.
+
+         If noRows is set, noCols will be unset. They cannot be set
+         simultaneously.
+
+
+
+.. _objects-image-reference-colspace:
+
+colSpace
+''''''''
+
+.. container:: table-row
+
+   Property
+         colSpace
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Space between columns. If you use the default CSS this will be added
+         automatically as margin-right to the images.
+
+
+
+.. _objects-image-reference-maxw:
+
+maxW
+''''
+
+.. container:: table-row
+
+   Property
+         maxW
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Max width of the image-table.
+
+         This will scale images not in the right size! Takes the number of
+         columns into account!
+
+
+
+.. _objects-image-reference-maxwintext:
+
+maxWInText
+''''''''''
+
+.. container:: table-row
+
+   Property
+         maxWInText
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Max width of the image-table, if the text is wrapped around the image-
+         table (on the left or right side).
+
+         This will scale images not in the right size! Takes the number of
+         columns into account!
+
+   Default
+         50% of maxW
+
+
+
+.. _objects-image-reference-equalh:
+
+equalH
+''''''
+
+.. container:: table-row
+
+   Property
+         equalH
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         If this value is greater than zero, it will secure that images in a
+         row have the same height. The width will be calculated.
+
+         If the total width of the images raises above the "maxW"-value of the
+         table the height for each image will be scaled down equally so that
+         the images still have the same height but are within the limits of the
+         totalWidth.
+
+         Please note that this value will override the properties "width",
+         "maxH", "maxW", "minW", "minH" of the IMAGE-objects generating the
+         images. Furthermore it will override the "noRows"-property and
+         generate a table with no columns instead!
+
+
+
+.. _objects-image-reference-colrelations:
+
+colRelations
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         colRelations
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         This value defines the width-relations of the images in the columns of
+         IMGTEXT. The syntax is "[int] : [int] : [int] : ..." for each column.
+         If there are more image columns than figures in this value, it's
+         ignored. If the relation between two of these figures exceeds 10, this
+         function is ignored.
+
+         It works only fully if all images are downscaled by their maxW-
+         definition.
+
+         **Example:**
+
+         If 6 images are placed in three columns and their width's are high
+         enough to be forcibly scaled, this value will scale the images in the
+         to be e.g. 100, 200 and 300 pixels from left to right
+
+         1 : 2 : 3
+
+
+
+.. _objects-image-reference-image-compression:
+
+image\_compression
+''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         image\_compression
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Image Compression:
+
+         0= Default
+
+         1= Don't change! (removes all parameters for the image\_object!!)
+
+         (adds gif-extension and color-reduction command)
+
+         10= GIF/256
+
+         11= GIF/128
+
+         12= GIF/64
+
+         13= GIF/32
+
+         14= GIF/16
+
+         15= GIF/8
+
+         (adds jpg-extension and quality command)
+
+         20= IM: -quality 100
+
+         21= IM: -quality 90 <=> Photoshop 60 (JPG/Very High)
+
+         22= IM: -quality 80 (JPG/High)
+
+         23= IM: -quality 70
+
+         24= IM: -quality 60 <=> Photoshop 30 (JPG/Medium)
+
+         25= IM: -quality 50
+
+         26= IM: -quality 40 (JPG/Low)
+
+         27= IM: -quality 30 <=> Photoshop 10
+
+         28= IM: -quality 20 (JPG/Very Low)
+
+         The default ImageMagick quality seems to be 75. This equals Photoshop
+         quality 45. Images compressed with ImageMagick with the same visual
+         quality as a Photoshop-compressed image seems to be 50% bigger in file
+         size!!
+
+         .. note::
+
+            Works ONLY if IMAGE-obj is NOT GIFBUILDER
+
+
+
+.. _objects-image-reference-image-effects:
+
+image\_effects
+''''''''''''''
+
+.. container:: table-row
+
+   Property
+         image\_effects
+
+   Data type
+         int / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Adds these IM/GM commands to the parameters for scaling. This function
+         has no effect if "image\_compression" above is set to 1!!
+
+         1 => "-rotate 90",
+
+         2 => "-rotate 270",
+
+         3 => "-rotate 180",
+
+         10 => "-colorspace GRAY",
+
+         11 => "-sharpen 70",
+
+         20 => "-normalize",
+
+         23 => "-contrast",
+
+         25 => "-gamma 1.3",
+
+         26 => "-gamma 0.8"
+
+         .. note::
+
+            Works ONLY if IMAGE-obj is NOT GIFBUILDER
+
+
+
+.. _objects-image-reference-image-frames:
+
+image\_frames
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         image\_frames
+
+   Data type
+         Array
+
+         \+ .key / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         **Frames:**
+
+         .key points to the frame used.
+
+         ".image\_frames.x" is imgResource-mask (".m")properties which will
+         override to the [imgResource].m properties of the imageObjects. This
+         is used to mask the images into a frame. See how it's done in the
+         default configuration and IMGTEXT in the static\_template-table.
+
+         **Example:**
+
+         ::
+
+            1 {
+              mask = media/uploads/darkroom1_mask.jpg
+              bgImg = GIFBUILDER
+              bgImg {
+                XY = 100,100
+                backColor = {$bgCol}
+              }
+              bottomImg = GIFBUILDER
+              bottomImg {
+                XY = 100,100
+                backColor = black
+              }
+              bottomImg_mask = media/uploads/darkroom1_bottom.jpg
+            }
+
+                .. note::
+
+            This cancels the jpg-quality settings sent as ordinary
+            ".params" to the imgResource. In addition the output of this operation
+            will always be jpg or gif!
+
+         .. note::
+
+            Works ONLY if IMAGE-obj is NOT GIFBUILDER
+
+
+
+.. _objects-image-reference-editicons:
+
+editIcons
+'''''''''
+
+.. container:: table-row
+
+   Property
+         editIcons
+
+   Data type
+         string
+
+   Description
+         See :ref:`stdWrap.editIcons <t3tsref:stdwrap-editicons>`.
+
+
+
+.. _objects-image-reference-rendermethod:
+
+renderMethod
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         renderMethod
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         The rendering method to use for this content object. The name of the
+         method must be one of the entries in the  **rendering** setting.
+
+   Default
+         singleNoCaption
+
+
+
+.. _objects-image-reference-fallbackrendering:
+
+fallbackRendering
+'''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         fallbackRendering
+
+   Data type
+         cObj
+
+   Description
+         If no rendering is specified, this is the fallback that will be used.
+         Can be used to overwrite the rendering method in specific "edge"
+         situations (e.g. when rendering only one image, or when rendering a
+         list of files without captions). This cObject will be called once the
+         major "rendering" type is defined (dl, ul, div) and when the pre-
+         processor already has gathered some information about how many images
+         to render (register:imageCount) and if the current rendering will
+         output a global caption for the whole image block or split captions
+         are needed (register:renderGlobalCaption). Using this information the
+         fallbackRendering can output some string, which will overwrite the
+         default rendering method (e.g. dl, ul, div and newly introduced
+         "simple", which renders least structure, intended for one image only).
+
+         The default css\_styled\_content setup in TYPO3 v4.3 provides these
+         fallbacks:
+
+         - with rendering=dl,ul,div, a single image fallbacks to rendering=simple
+
+         - with rendering=dl, a list of images with no caption fallbacks to
+           rendering=ul
+
+         - with rendering=dl, a list of images with one "global" caption (no
+           splitCaption configured) fallbacks to rendering=ul
+
+   Default
+         dl
+
+
+
+.. _objects-image-reference-rendering:
+
+rendering
+'''''''''
+
+.. container:: table-row
+
+   Property
+         rendering
+
+   Data type
+         Array of
+
+         :ref:`IMGTEXT <t3tsref:cobj-imgtext>` properties
+
+   Description
+         In this array, a list of renderers can be created from which the user
+         chooses which one will render each "Text with image" content object.
+         The settings in each entry can override settings from this table, and
+         there is also a set of :ref:`stdWrap <t3tsref:stdwrap>`'s that allows you to create the XHTML
+         structure of your choosing for rendering the imageblock.
+
+         In the standard installation the rendering will be loaded from the
+         lib.imgtextrendering TypoScript object, so you might want to
+         change/add stuff here.
+
+         **Example:**
+
+         ::
+
+            tt_content.textpic.20.rendering {
+              dl {
+                  imageRowStdWrap.wrap = <div class="csi-imagerow" style="width:{register:rowwidth}px;"> | </div>
+                  imageRowStdWrap.insertData = 1
+                  noRowsStdWrap.wrap =
+                  oneImageStdWrap.wrap = <dl class="csi-image" style="width:{register:imagewidth}px;"> | </dl>
+                  oneImageStdWrap.insertData = 1
+                  imgTagStdWrap.wrap = <dt> | </dt>
+                  editIconsStdWrap.wrap = <dd> | </dd>
+                  captionStdWrap.wrap = <dd class="csi-caption"> | </dd>
+              }
+              # Now we add another rendering method:
+              dl-nospace < .dl
+              dl-nospace.addClasses = csi-textpic-dl-nospace
+            }
+
+
+
+.. _objects-image-reference-addclasses:
+
+addClasses
+''''''''''
+
+.. container:: table-row
+
+   Property
+         addClasses
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Add the specified classes to the csc-textpic <div> (the outer
+         surrounding block). This is useful to override in a specific
+         "rendering" engine, allowing you for example to have different margin
+         styles (one with margin around images, the other without).
+
+
+
+.. _objects-image-reference-addclassesimage:
+
+addClassesImage
+'''''''''''''''
+
+.. container:: table-row
+
+   Property
+         addClassesImage
+
+   Data type
+         String / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Add the specified classes to the image element
+
+
+
+.. _objects-image-reference-separaterows:
+
+separateRows
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         separateRows
+
+   Data type
+         boolean / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Separate the rows of images in different :code:`<div>` tags, so that they can be
+         styled in some other way. See CSS-section for more details.
+
+   Default
+         0
+
+
+
+.. _objects-image-reference-imgtagstdwrap:
+
+imgTagStdWrap
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         imgTagStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around the :code:`<img>` tag.
+
+
+
+.. _objects-image-reference-editiconsstdwrap:
+
+editIconsStdWrap
+''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         editIconsStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around the frontend editing icons
+
+
+
+.. _objects-image-reference-oneimagestdwrap:
+
+oneImageStdWrap
+'''''''''''''''
+
+.. container:: table-row
+
+   Property
+         oneImageStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around one "image" in the block (with image and caption)
+
+
+
+.. _objects-image-reference-imagerowstdwrap:
+
+imageRowStdWrap
+'''''''''''''''
+
+.. container:: table-row
+
+   Property
+         imageRowStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around one row of images
+
+
+
+.. _objects-image-reference-imagelastrowstdwrap:
+
+imageLastRowStdWrap
+'''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         imageLastRowStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around the last row of images
+
+
+
+.. _objects-image-reference-norowsstdwrap:
+
+noRowsStdWrap
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         noRowsStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around all images if there are no separate rows (either by
+         **separateRows** setting, of if we just have one row).
+
+
+
+.. _objects-image-reference-imagestdwrap:
+
+imageStdWrap
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         imageStdWrap
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around the whole image block if a width is needed. This is
+         the case when
+
+         - position is center
+
+         - there is more than 1 row
+
+         - or we have a global caption
+
+
+
+.. _objects-image-reference-imagestdwrapnowidth:
+
+imageStdWrapNoWidth
+'''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         imageStdWrapNoWidth
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Wrapping around the whole image block if no width is needed.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Index.rst
new file mode 100644 (file)
index 0000000..2254c99
--- /dev/null
@@ -0,0 +1,78 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _objects:
+
+Objects rendering
+^^^^^^^^^^^^^^^^^
+
+This chapter describes how the rendering of each type of content element
+is configured in css\_styled\_content. Some types are very simple and rely
+purely on standard TypoScript objects. Other types use a configuration that
+is specific to css\_styled\_content.
+
+All content types rendering definitions contain at least two levels of nested
+TypoScript object. The first level is **always** a :ref:`COA <t3tsref:cobj-coa-int>`.
+Inside that object there is always the following configuration::
+
+   10 = < lib.stdheader
+
+
+This means that the :ref:`standard rendering of content element headers <setup-lib-stdheader>`
+is referenced inside every content element types, ensuring that headers are rendered
+consistently no matter what the type.
+
+
+.. _objects-default-message:
+
+Default Message
+"""""""""""""""
+
+When no rendering definition can be found for a content element type,
+some default message is displayed. This message is based on a standard
+:ref:`t3tsref:cobj-text` object and prints out some error message
+in a yellow box::
+
+       tt_content.default = TEXT
+       tt_content.default {
+               field = CType
+               wrap = <p style="background-color: yellow;"><b>ERROR:</b> Content Element type "|" has no rendering definition!</p>
+
+               prefixComment = 2 | Unknown element message:
+       }
+
+
+.. _objects-rendering-reference:
+
+Rendering reference
+"""""""""""""""""""
+
+The following sections describe the rendering of each element type, with a reference
+to all properties, when specific ones exist:
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Header/Index
+   Text/Index
+   Image/Index
+   TextImage/Index
+   BulletList/Index
+   Table/Index
+   Uploads/Index
+   Media/Index
+   Mailform/Index
+   Search/Index
+   Menu/Index
+   InsertRecords/Index
+   Plugin/Index
+   Divider/Index
+   Html/Index
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/InsertRecords/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/InsertRecords/Index.rst
new file mode 100644 (file)
index 0000000..b282d72
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-insert-records:
+
+Insert Records (shortcut)
+"""""""""""""""""""""""""
+
+The insert records content element allows elements from any page to be
+referenced in another page, so you can display the same element multiple times
+without copying it.
+
+Rendering is simply achieved by using a :ref:`t3tsref:cobj-records` object.
+Before that a :ref:`t3tsref:cobj-case` object is used basing itself
+on the :code:`layout` field of table "tt_content". This makes it possible
+to vary the rendering depending on the chosen layout.
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Mailform/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Mailform/Index.rst
new file mode 100644 (file)
index 0000000..73043bd
--- /dev/null
@@ -0,0 +1,15 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-mailform:
+
+Mailform
+""""""""
+
+Rendering of a form-type content element is achieved simply
+with a :ref:`t3tsref:cobj-form` object.
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Media/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Media/Index.rst
new file mode 100644 (file)
index 0000000..95bad80
--- /dev/null
@@ -0,0 +1,807 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-media:
+
+Media
+"""""
+
+The Media content element acts as a dispatcher for different media
+output formats.
+
+
+.. figure:: ../../../Images/MediaContentElementStructure.png
+   :alt: Media element and media formats
+
+   The MEDIA element and the various media formats
+
+
+The Media content element is a dispatcher which gets its HTML output
+from one of the available render objects. By default, these render
+objects include SWFOBJECT (Flash driven by Javascript), QTOBJECT
+(Quicktime driven by Javascript) and MULTIMEDIA (the original
+MULTIMEDIA object rendered with EMBED tags).
+
+The renderType defines which object is used for rendering. If set to
+its default value of "auto", the Media content element uses the media
+file's extension to choose the right renderer. This auto-detection may
+not work as well for external URLs so setting the renderType manually
+is preferable in that case.
+
+If one of the existing renderTypes does not meet your needs, new
+renderTypes can be registered and rendered with a custom extension.
+
+The Media content element contains the following third-party
+files in :file:`typo3/contrib/flashmedia`:
+
+- :file:`qtobject/qtobject.js` (Javascript for QTOBJECT)
+
+- :file:`swfobject/swfobject.js` (Javascript for SWFOBJECT)
+
+- :file:`swfobject/expressInstall.swf` (this is displayed if Flash version of
+  client is too low)
+
+- :file:`flvplayer.swf` (TYPO3 video player for flv, swf, mp4, m4u etc)
+
+- :file:`player.swf` (Audio player from 1pixelout)
+
+- :file:`player.txt` (License for audio player)
+
+If you want to use a different player, it can be configured via
+TypoScript.
+
+
+.. _objects-media-reference:
+
+MEDIA Reference
+~~~~~~~~~~~~~~~
+
+
+.. _objects-media-reference-flexparams:
+
+flexParams
+''''''''''
+
+.. container:: table-row
+
+   Property
+         flexParams
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Used for Flexform configuration of the content element
+
+   Default
+         flexParams.field = pi\_flexform
+
+
+
+.. _objects-media-reference-alternativecontent:
+
+alternativeContent
+''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         alternativeContent
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Alternative content
+
+   Default
+         alternativeContent.field = bodytext
+
+
+
+.. _objects-media-reference-type:
+
+type
+''''
+
+.. container:: table-row
+
+   Property
+         type
+
+   Data type
+         string
+
+   Description
+         Defines media type: video/audio
+
+   Default
+         video
+
+
+
+.. _objects-media-reference-rendertype:
+
+renderType
+''''''''''
+
+.. container:: table-row
+
+   Property
+         renderType
+
+   Data type
+         string
+
+   Description
+         Used for select the render object. Possible renderTypes are:
+         auto/swf/qt/object. Extensions may add custom renderTypes as well.
+
+   Default
+         auto
+
+
+
+.. _objects-media-reference-allowemptyurl:
+
+allowEmptyUrl
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         allowEmptyUrl
+
+   Data type
+         boolean
+
+   Description
+         If set to 0 you see a warning if no file/URL is configured. If you do
+         some advanced setup such as a Javascript-driven player with a playlist
+         you may use the object without a URL and need to set the value to 1.
+
+   Default
+         0
+
+
+
+.. _objects-media-reference-mimehandler:
+
+mimeHandler
+'''''''''''
+
+.. container:: table-row
+
+   Property
+         mimeHandler
+
+   Data type
+         array
+
+   Description
+         The mappings between file extensions and render types can be
+         configured here and will be used when renderType=auto. Possible values
+         are MEDIA, SWF, QT
+
+   Default
+         ::
+
+                        mimeHandler {
+                                default = MEDIA
+                                mp3 = SWF
+                                mp4 = SWF
+                                m4v = SWF
+                                mov = QT
+                                avi = MEDIA
+                                asf = MEDIA
+                                class = MEDIA
+                                swa = SWF
+                        }
+
+
+
+.. _objects-media-reference-mimeconf-swfobject:
+
+mimeConf.swfobject
+''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         mimeConf.swfobject
+
+         mimeConf.qtobject
+
+   Data type
+         array
+
+   Description
+         Copy of configuration for SWFOBJECT and QTOBJECT
+
+   Default
+         mimeConf.swfobject < tt\_content.swfobject.20
+
+         mimeConf.qtobject < tt\_content.qtobject.20
+
+
+
+.. _objects-media-reference-video:
+
+Video Player Reference
+~~~~~~~~~~~~~~~~~~~~~~
+
+
+.. _objects-media-reference-video-player:
+
+player
+''''''
+
+.. container:: table-row
+
+   Property
+         player
+
+   Data type
+         string
+
+   Description
+         Location of video player
+
+   Default
+         {$styles.content.media.videoPlayer}
+
+         typo3/contrib/flashmedia/flvplayer.swf
+
+
+
+.. _objects-media-reference-video-defaultwidth:
+
+defaultWidth
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         defaultWidth
+
+   Data type
+         int
+
+   Description
+         Default video media width
+
+   Default
+         {$styles.content.media.defaultVideoWidth}
+
+         600
+
+
+
+.. _objects-media-reference-video-defaultheight:
+
+defaultHeight
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         defaultHeight
+
+   Data type
+         int
+
+   Description
+         Default video media height
+
+   Default
+         {$styles.content.media.defaultVideoHeight}
+
+         400
+
+
+
+.. _objects-media-reference-video-default:
+
+default
+'''''''
+
+.. container:: table-row
+
+   Property
+         default
+
+   Data type
+         array
+
+   Description
+         Default parameters for flashvars / params / attributes
+
+         **Usage:**
+
+         ::
+
+            default {
+               flashvars.allowFullScreen = true
+               params.wmode = transparent
+               attributes.align = center
+            }
+
+         flashvars are used for swf file configuration. There is no standard
+         across players, but for flvplayer see description below.
+
+         For detailed description of possible params/attributes visit this URL:
+
+         http://helpx.adobe.com/flash/kb/flash-object-embed-tag-attributes.html
+
+   Default
+         ::
+
+                        default {
+                                params.quality = high
+                                params.wmode = transparent
+                                params.menu = false
+                                params.allowScriptAccess =
+                                sameDomain
+                                params.allowFullScreen = true
+                        }
+
+
+
+.. _objects-media-reference-video-mapping:
+
+mapping
+'''''''
+
+.. container:: table-row
+
+   Property
+         mapping
+
+   Data type
+         array
+
+   Description
+         If you want to rename predefined vars you can use mapping. See
+         tt\_content.media.20.audio where it's needed
+
+
+
+
+.. _objects-media-reference-audio:
+
+Audio Player Reference
+~~~~~~~~~~~~~~~~~~~~~~
+
+
+.. _objects-media-reference-audio-player:
+
+player
+''''''
+
+.. container:: table-row
+
+   Property
+         player
+
+   Data type
+         string
+
+   Description
+         Location of audio player
+
+   Default
+         {$styles.content.media.audioPlayer}
+
+         typo3/contrib/flashmedia/player.swf
+
+
+
+.. _objects-media-reference-audio-defaultwidth:
+
+defaultWidth
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         defaultWidth
+
+   Data type
+         int
+
+   Description
+         Default audio media width
+
+   Default
+         {$styles.content.media.defaultAudioWidth}
+
+         600
+
+
+
+.. _objects-media-reference-audio-defaultheight:
+
+defaultHeight
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         defaultHeight
+
+   Data type
+         int
+
+   Description
+         Default audio media height
+
+   Default
+         {$styles.content.media.defaultAudioHeight}
+
+         400
+
+
+
+.. _objects-media-reference-audio-default:
+
+default
+'''''''
+
+.. container:: table-row
+
+   Property
+         default
+
+   Data type
+         array
+
+   Description
+         Default parameter for flashvars / params / attributes
+
+         Usage::
+
+                        default {
+                                flashvars.allowFullScreen = true
+                                params.wmode = transparent
+                                attributes.align = center
+                        }
+
+
+         Flashvars are used for swf file configuration. There is no standard
+         across players, but for flvplayer see description below.
+
+         For detailed description of possible params/attributes visit this URL:
+
+         http://helpx.adobe.com/flash/kb/flash-object-embed-tag-attributes.html
+
+   Default
+         ::
+
+                        default {
+                                params.quality = high
+                                params.wmode = transparent
+                                params.allowScriptAccess =
+                                sameDomain
+                                params.menu = false
+                        }
+
+
+
+.. _objects-media-reference-audio-mapping:
+
+mapping
+'''''''
+
+.. container:: table-row
+
+   Property
+         mapping
+
+   Data type
+         array
+
+   Description
+         The audio player doesn't work with file, but instead expects the file
+         with the flashvar soundFile. mapping does the rename of parameter for
+         you by default.
+
+   Default
+         ::
+
+               mapping {
+                       flashvars.file = soundFile
+               }
+
+
+
+.. _objects-media-reference-swfobject:
+
+SWFOBJECT Reference
+~~~~~~~~~~~~~~~~~~~
+
+
+.. _objects-media-reference-swfobject-file:
+
+file
+''''
+
+.. container:: table-row
+
+   Property
+         file
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Media file or URL
+
+
+
+.. _objects-media-reference-swfobject-width:
+
+width
+'''''
+
+.. container:: table-row
+
+   Property
+         width
+
+   Data type
+         int
+
+   Description
+         Width of swfObject
+
+
+
+.. _objects-media-reference-swfobject-height:
+
+height
+''''''
+
+.. container:: table-row
+
+   Property
+         height
+
+   Data type
+         int
+
+   Description
+         Height of swfObject
+
+
+
+.. _objects-media-reference-swfobject-flexparams:
+
+flexParams
+''''''''''
+
+.. container:: table-row
+
+   Property
+         flexParams
+
+   Data type
+         Flexform configuration
+
+
+   Description
+         Used for Flexform configuration of the CE
+
+   Default
+         flexParams.field = pi\_flexform
+
+
+
+.. _objects-media-reference-swfobject-alternativecontent:
+
+alternativeContent
+''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         alternativeContent
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Alternative content
+
+   Default
+         alternativeContent.field = bodytext
+
+
+
+.. _objects-media-reference-swfobject-layout:
+
+layout
+''''''
+
+.. container:: table-row
+
+   Property
+         layout
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         HTML Template for the Object. ###SWFOBJECT### is replaced with the
+         sfwobject, ###ID### is replaced with the unique Id of the div/object
+
+   Default
+         ###SWFOBJECT###
+
+
+
+.. _objects-media-reference-swfobject-video-player:
+
+video.player
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         :ref:`video.player <objects-media-reference-video>`
+
+         :ref:`audio.player <objects-media-reference-audio>`
+
+   Data type
+         Array of properties
+
+   Description
+         Properties of each player.
+
+
+.. _objects-media-reference-qtobject:
+
+QTOBJECT Reference
+~~~~~~~~~~~~~~~~~~
+
+
+.. _objects-media-reference-qtobject-file:
+
+file
+''''
+
+.. container:: table-row
+
+   Property
+         file
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Media file or URL
+
+
+
+.. _objects-media-reference-qtobject-width:
+
+width
+'''''
+
+.. container:: table-row
+
+   Property
+         width
+
+   Data type
+         int
+
+   Description
+         Width of qtObject
+
+
+
+.. _objects-media-reference-qtobject-height:
+
+height
+''''''
+
+.. container:: table-row
+
+   Property
+         height
+
+   Data type
+         int
+
+   Description
+         Height of qtObject
+
+
+
+.. _objects-media-reference-qtobject-flexparams:
+
+flexParams
+''''''''''
+
+.. container:: table-row
+
+   Property
+         flexParams
+
+   Data type
+         Flexform configuration
+
+   Description
+         Used for Flexform configuration of the CE
+
+   Default
+         flexParams.field = pi\_flexform
+
+
+
+.. _objects-media-reference-qtobject-alternativecontent:
+
+alternativeContent
+''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         alternativeContent
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Alternative content
+
+   Default
+         alternativeContent.field = bodytext
+
+
+
+.. _objects-media-reference-qtobject-layout:
+
+layout
+''''''
+
+.. container:: table-row
+
+   Property
+         layout
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         HTML Template for the Object. ###QTOBJECT### is replaced with the
+         qtobject, ###ID### is replaced with the unique Id of the div/object
+
+   Default
+         ###QTOBJECT###
+
+
+
+.. _objects-media-reference-qtobject-video-player:
+
+video.player
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         :ref:`video.player <objects-media-reference-video>`
+
+         :ref:`audio.player <objects-media-reference-audio>`
+
+   Data type
+         Array of properties
+
+   Description
+         Properties of each player.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Menu/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Menu/Index.rst
new file mode 100644 (file)
index 0000000..45ae254
--- /dev/null
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-menu:
+
+Menu / Sitemap
+""""""""""""""
+
+The menu / sitemap content element is a :ref:`t3tsref:cobj-case` object
+that renders different types of menu depending on the selection made in the
+:code:`menu_type` field of table "tt_content". All rendering is driven by
+:ref:`t3tsref:cobj-hmenu` objects.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Plugin/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Plugin/Index.rst
new file mode 100644 (file)
index 0000000..df2cd2c
--- /dev/null
@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-plugin:
+
+Insert Plugin (List)
+""""""""""""""""""""
+
+Plugins correspond to the list-type content element (the "list" meaning
+the list of all plugins). The exact type of plugin used by a given
+list-type content element is stored in the :code:`list_type` field of
+the "tt_content" table.
+
+Thus for rendering the list-type content element is one big
+:ref:`t3tsref:cobj-case` object using the :code:`list_type` field as key.
+When plugins are registered, the appopriate code is automatically added
+to this main :ref:`t3tsref:cobj-case` object so that rendering requests
+can be dispatched to the plugin's class.
+
+Configuration of the plugin itself resides in :code:`plugin.[extension signature]`.
+Some very old plugins however (like "tt\_board") are still registered
+"manually" by including all their configuration in a top-level object.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Search/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Search/Index.rst
new file mode 100644 (file)
index 0000000..11101dc
--- /dev/null
@@ -0,0 +1,17 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-search:
+
+Search
+""""""
+
+The search is a :ref:`COA <t3tsref:cobj-coa-int>` consisting of the header rendering,
+the cObj :ref:`t3tsref:cobj-searchresult` and a copy of the :ref:`objects-mailform`
+with slightly different configuration for rendering the search form.
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Table/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Table/Index.rst
new file mode 100644 (file)
index 0000000..6862216
--- /dev/null
@@ -0,0 +1,158 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-table:
+
+Table
+"""""
+
+Table-type content elements are not rendered using a standard TypoScript
+content object but instead rely on a :ref:`USER <t3tsref:cobj-user>` object provided by
+CSS Styled Content, as can be seen in the TypoScript setup::
+
+       tt_content.table = COA
+       tt_content.table {
+               10 = < lib.stdheader
+
+               20 = USER
+               20.userFunc = tx_cssstyledcontent_pi1->render_table
+               20.field = bodytext
+               ...
+       }
+
+
+.. figure:: ../../../Images/TableContentElement.png
+   :alt: Table content element
+
+   Input of a table content element in the TYPO3 backend
+
+
+The :code:`render_table` function supports a whole variety of specific
+properties, which are detailed below.
+
+.. note::
+
+   All properties of USER objects also apply, in particular :ref:`stdWrap <t3tsref:stdwrap>`.
+
+
+.. _objects-table-reference:
+
+Reference
+~~~~~~~~~
+
+.. _objects-table-reference-field:
+
+field
+'''''
+
+.. container:: table-row
+
+   Property
+         field
+
+   Data type
+         data
+
+   Description
+         The field to fetch the content from.
+
+   Default
+         bodytext
+
+
+
+.. _objects-table-reference-innerstdwrap:
+
+innerStdWrap
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         innerStdWrap
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         StdWrap to the content of the table cells.
+
+         With this you can for example pass the content through lib.parseFunc
+
+   Default
+         innerStdWrap.parseFunc =< lib.parseFunc
+
+
+
+.. _objects-table-reference-color:
+
+color
+'''''
+
+.. container:: table-row
+
+   Property
+         color
+
+   Data type
+         :ref:`t3tsref:data-type-html-color`
+
+   Description
+         Background Color of the table. Some predefined values are already
+         there. (Look into the background color dropdown of the table element)
+
+         Add your own with
+
+         ::
+
+            color.[dropDownId] = #000000
+
+         Fallback is
+
+         ::
+
+            color.default =
+
+   Default
+         1 = #EDEBF1
+
+         2 = #F5FFAA
+
+
+
+.. _objects-table-reference-tableparams-layout:
+
+tableParams\_[layout]
+'''''''''''''''''''''
+
+.. container:: table-row
+
+   Property
+         tableParams\_[layout]
+
+   Data type
+         border,
+
+         cellpadding,
+
+         cellspacing
+
+   Description
+         Table params dependent on the selected layout (dropdown). You should
+         better use CSS to style your tables.
+
+         For example:
+
+         ::
+
+            tableParams_0 {
+                    border =
+                    cellpadding =
+                    cellspacing =
+            }
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Text/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Text/Index.rst
new file mode 100644 (file)
index 0000000..465b20c
--- /dev/null
@@ -0,0 +1,23 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-text:
+
+Text
+""""
+
+Rendering of a text-type content element is achieved simply
+with a :ref:`t3tsref:cobj-text` object and a reference to
+:ref:`setup-lib-parsefunc-rte` for rendering rich-text content
+from the "bodytext" field.
+
+.. figure:: ../../../Images/TextContentElement.png
+   :alt: Text content element
+
+   Input of a text content element in the TYPO3 backend
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/TextImage/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/TextImage/Index.rst
new file mode 100644 (file)
index 0000000..0e149fc
--- /dev/null
@@ -0,0 +1,40 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-textpic:
+
+Text & Image (textpic)
+""""""""""""""""""""""
+
+Text & Image-type content elements are rendered by combining
+the rendering of the :ref:`Text-type <objects-text>` and
+:ref:`Image-type <objects-image>` content elements, as can be
+seen in this excerpt of the TypoScript setup::
+
+       tt_content.textpic = COA
+       tt_content.textpic {
+               10 = COA
+               ...
+               10.10 = < lib.stdheader
+
+               20  = < tt_content.image.20
+               20 {
+                       text.10 = COA
+                       text.10 {
+                               ...
+                       }
+                       text.20 = < tt_content.text.20
+                       ...
+               }
+       }
+
+
+.. warning::
+
+   For this particular element type, :ref:`lib.stdheader <setup-lib-stdheader>`
+   is not found in the usual place (see code above).
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Uploads/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Objects/Uploads/Index.rst
new file mode 100644 (file)
index 0000000..5b06e61
--- /dev/null
@@ -0,0 +1,251 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+.. _objects-uploads:
+
+File links / Uploads
+""""""""""""""""""""
+
+Since TYPO3 CMS 6.0 the file links content element types simply uses the FAL-related
+:ref:`FILES <t3tsref:cobj-files>` for rendering.
+
+.. important::
+
+   Read what follows only if you use the static templates of
+   css\_styled\_content for version 4.7 or below (see
+   :ref:`installation`).
+
+Before that it was rendered using a :ref:`USER <t3tsref:cobj-user>` object provided by
+CSS Styled Content, as can be seen in the TypoScript setup::
+
+       tt_content.uploads = COA
+       tt_content.uploads {
+               10 = < lib.stdheader
+
+               20 = USER
+               20.userFunc = tx_cssstyledcontent_pi1->render_uploads
+               ...
+       }
+
+
+The :code:`render_uploads` function supports a whole variety of specific
+properties, which are detailed below.
+
+.. note::
+
+   All properties of USER objects also apply, in particular :ref:`stdWrap <t3tsref:stdwrap>`.
+
+
+.. _objects-uploads-reference:
+
+Reference
+~~~~~~~~~
+
+
+.. _objects-uploads-reference-filepath:
+
+filePath
+''''''''
+
+.. container:: table-row
+
+   Property
+         filePath
+
+   Data type
+         string / :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         The path to the files to read out.
+
+   Default
+         field = select\_key
+
+
+
+.. _objects-uploads-reference-field:
+
+field
+'''''
+
+.. container:: table-row
+
+   Property
+         field
+
+   Data type
+         string
+
+   Description
+         The field to fetch the content from.
+
+   Default
+         media
+
+
+
+.. _objects-uploads-reference-linkproc:
+
+linkProc
+''''''''
+
+.. container:: table-row
+
+   Property
+         linkProc
+
+   Data type
+         Array of options listed below
+
+
+   Description
+         The link processing options.
+
+         **Example:**
+
+         ::
+
+            target = _blank
+            jumpurl = {$styles.content.uploads.jumpurl}
+            jumpurl.secure = {$styles.content.uploads.jumpurl_secure}
+            jumpurl.secure.mimeTypes= {$styles.content.uploads.jumpurl_secure_mimeTypes}
+            removePrependedNumbers = 1
+            iconCObject = IMAGE
+            iconCObject.file.import.data = register : ICON_REL_PATH
+            iconCObject.file.width = 150
+            ATagParams = class="external-link-new-window"
+
+   Default
+         See example
+
+
+
+.. _objects-uploads-reference-labelstdwrap:
+
+labelStdWrap
+''''''''''''
+
+.. container:: table-row
+
+   Property
+         labelStdWrap
+
+   Data type
+         :ref:`stdWrap <t3tsref:stdwrap>`
+
+   Description
+         Provides a mean to override the default text that is linked in the
+         "linkedLabel" registry for each itemRendering. Registry items
+         filename, path, description, fileSize and fileExtension are available
+         at this point.
+
+         **Example:**
+
+         ::
+
+            tt_content.uploads.20.labelStdWrap.override.data = register:description
+
+
+.. _objects-uploads-reference-filesize:
+
+fileSize
+''''''''
+
+.. container:: table-row
+
+   Property
+         fileSize
+
+   Data type
+
+
+   Description
+         Display options for file size.
+
+   Default
+         bytes = 1
+
+         bytes.labels = {$styles.content.uploads.filesizeBytesLabels}
+
+
+
+.. _objects-uploads-reference-itemrendering:
+
+itemRendering
+'''''''''''''
+
+.. container:: table-row
+
+   Property
+         itemRendering
+
+   Data type
+         :ref:`cObj <t3tsref:cobjects>` / + :ref:`optionSplit <t3tsref:objects-optionsplit>`
+
+   Description
+         Provides the rendering information for every row in the file list.
+         Each file will be rendered with this cObject, optionSplit will be
+         applied to the whole itemRendering array so that different rendering
+         needs can be applied to individual rows. Default rendering in
+         css\_styled\_content is a :ref:`COA <t3tsref:cobj-coa-int>` for table based rendering with even/odd
+         classes in the rows.
+
+         **Available registers at this point are:**
+
+         - linkedIcon: a linked icon representing the file (either extension-
+           dependent or a thumbnail of the image)
+
+         - linkedLabel: the linked text, usually the filename. The text can be
+           overwritten using the labelStdWrap property.
+
+         - filename: the filename being rendered (with extension, but without
+           path)
+
+         - path: the full path of the file
+
+         - description: optional, if available
+
+         - fileSize: the size of the file in bytes
+
+         - fileExtension: the extension of the file (e.g. "pdf", "gif", etc)
+
+         **Example:**
+
+         ::
+
+            itemRendering = COA
+            itemRendering {
+                    wrap = <tr class="tr-odd tr-first">|</tr> |*| <tr class="tr-even">|</tr> || <tr class="tr-odd">|</tr> |*|
+
+                    10 = TEXT
+                    10.data = register:linkedIcon
+                    10.wrap = <td class="csc-uploads-icon">|</td>
+                    10.if.isPositive.field = layout
+
+                    20 = COA
+                    20.wrap = <td class="csc-uploads-fileName">|</td>
+                    20.1 = TEXT
+                    20.1 {
+                            data = register:linkedLabel
+                            wrap = <p>|</p>
+                    }
+                    20.2 = TEXT
+                    20.2 {
+                            data = register:description
+                            wrap = <p class="csc-uploads-description">|</p>
+                            required = 1
+                    }
+
+                    30 = TEXT
+                    30.if.isTrue.field = filelink_size
+                    30.data = register:fileSize
+                    30.wrap = <td class="csc-uploads-fileSize">|</td>
+                    30.bytes = 1
+                    30.bytes.labels = {$styles.content.uploads.filesizeBytesLabels}
+            }
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Configuration/Setup/Index.rst b/typo3/sysext/css_styled_content/Documentation/Configuration/Setup/Index.rst
new file mode 100644 (file)
index 0000000..52d42b6
--- /dev/null
@@ -0,0 +1,263 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _setup:
+
+Setup
+^^^^^
+
+
+.. _setup-styles-content:
+
+styles.content
+""""""""""""""
+
+
+.. _setup-styles-content-get:
+
+get
+~~~
+
+.. container:: table-row
+
+   Property
+         get
+
+   Data type
+         cObj
+
+   Description
+         Predefined CONTENT objects for getting content from columns.
+         Column: Normal
+
+   Default
+         :ref:`t3tsref:cobj-content`
+
+
+
+.. _setup-styles-content-getright:
+
+getRight
+~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         getRight
+
+   Data type
+         cObj
+
+   Description
+         Predefined CONTENT objects for getting content from columns.
+         Column: Right
+
+   Default
+         :ref:`t3tsref:cobj-content`
+
+
+
+.. _setup-styles-content-getleft:
+
+getLeft
+~~~~~~~
+
+.. container:: table-row
+
+   Property
+         getLeft
+
+   Data type
+         cObj
+
+   Description
+         Predefined CONTENT objects for getting content from columns.
+         Column: Left
+
+   Default
+         :ref:`t3tsref:cobj-content`
+
+
+
+.. _setup-styles-content-getborder:
+
+getBorder
+~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         getBorder
+
+   Data type
+         cObj
+
+   Description
+         Predefined CONTENT objects for getting content from columns.
+         Column: Border
+
+   Default
+         :ref:`t3tsref:cobj-content`
+
+
+
+.. _setup-styles-content-getnews:
+
+getNews
+~~~~~~~
+
+.. container:: table-row
+
+   Property
+         getNews
+
+   Data type
+         cObj
+
+   Description
+         Predefined CONTENT object for getting News from a special page
+         (defined in Constants)
+
+   Default
+         :ref:`t3tsref:cobj-content`
+
+
+
+.. _setup-styles-content-editpanelpage:
+
+editPanelPage
+~~~~~~~~~~~~~
+
+.. container:: table-row
+
+   Property
+         editPanelPage
+
+   Data type
+         cObj
+
+   Description
+         Predefined EDITPANEL object for displaying a panel to edit the page
+         (frontend editing).
+
+   Default
+         :ref:`t3tsref:cobj-editpanel`
+
+
+
+.. _setup-styles-content-get-example:
+
+Example 1
+~~~~~~~~~
+
+Here is some example setup code for :code:`styles.content`. Note that all properties of
+:ref:`t3tsref:cobj-content` objects apply.
+
+::
+
+   styles.content.get = CONTENT
+   styles.content.get {
+           table = tt_content
+           select.orderBy = sorting
+           select.where = colPos=0
+           select.languageField = sys_language_uid
+   }
+
+.. _setup-styles-content-editpanel-example:
+
+Example 2
+~~~~~~~~~
+
+And here is an example setup for the edit panel. Note that all propoperties of
+:ref:`t3tsref:cobj-editpanel` objects apply.
+
+::
+
+   styles.content.editPanelPage = EDITPANEL
+   styles.content.editPanelPage {
+           allow = toolbar,move,hide
+           label.data = LLL:EXT:css_styled_content/pi1/locallang.xml:eIcon.page
+           label.wrap = |&nbsp;<b>%s</b>
+   }
+
+
+.. _setup-lib-parsefunc-rte:
+
+lib.parsefunc\_RTE
+""""""""""""""""""
+
+The lib.parsefunc\_RTE is responsible for rendering the RTE content.
+It's mainly a copy of lib.parsefunc with some modifications.
+
+For reference see :ref:`t3tsref:parsefunc`, :ref:`t3tsref:htmlparser`
+and :ref:`t3tsref:htmlparser-tags` in the TypoScript Reference.
+
+
+.. _setup-lib-stdheader:
+
+lib.stdheader
+"""""""""""""
+
+With the lib.stdheader object the headlines are rendered. Here you can
+influence how the different header layouts will appear on your site.
+
+
+.. _setup-tt-content:
+
+tt\_content
+"""""""""""
+
+This is the heart of CSS Styled Content. The :ref:`t3tsref:cobj-case` object for rendering
+the different content element types. The use of CASE (based on the "tt_content" field "CType")
+makes it possible to provide a different rendering for each element type.
+
+
+.. _setup-tt-content-stdwrap-innerwrap:
+
+stdWrap.innerWrap
+~~~~~~~~~~~~~~~~~
+
+The innerWrap part is responsible for the rendering of section frames.
+This is the definition of what happens if you choose a frame in a
+content element.
+
+.. figure:: ../../Images/SectionFrame.png
+   :alt: Section frame field
+
+   Section frame selector in the TYPO3 backend
+
+
+.. _setup-tt-content-stdwrap-innerwrap2:
+
+stdWrap.innerWrap2
+~~~~~~~~~~~~~~~~~~
+
+Generates the link to top if the editor activated it in the content
+element.
+
+.. figure:: ../../Images/LinkToTop.png
+   :alt: Link to top field
+
+   The link to top field in the TYPO3 backend
+
+
+.. _setup-tt-content-stdwrap-prepend:
+
+stdWrap.prepend
+~~~~~~~~~~~~~~~
+
+Used to prepend the localized uid of the content element (in case it
+is translated).
+
+
+.. _setup-tt-content-stdwrap-editpanel:
+
+stdWrap.editPanel
+~~~~~~~~~~~~~~~~~
+
+Defines the edit panels for the content elements.
diff --git a/typo3/sysext/css_styled_content/Documentation/HowTo/Index.rst b/typo3/sysext/css_styled_content/Documentation/HowTo/Index.rst
new file mode 100644 (file)
index 0000000..f4e18ff
--- /dev/null
@@ -0,0 +1,65 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _how-to:
+
+How to...
+---------
+
+
+.. _constant-editor:
+
+... use the Constant Editor for configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Basic configuration for CSS Styled Content is done using the constant
+editor. Go to the Web > Template module on your root page and switch
+to the Constant Editor. Choose the category "CONTENT". You'll now get
+a list of possible constants and their descriptions. The descriptions
+should be pretty self explaining.
+
+
+.. figure:: ../Images/ConstantEditor.png
+   :alt: The constant editor
+
+   Changing the main settings of css\_styled\_content in the Constant Editor
+
+
+.. _object-browser:
+
+... use the Object Browser to change a single value
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to change a certain value – like a wrap around an element
+– you should use the TypoScript Object Browser. Go to the Web >
+Template module and choose "TypoScript Object Browser". Now expand the
+:code:`tt_content` tree to the element you want to change (for example the
+"div" [Divider] element):
+
+
+.. figure:: ../Images/TypoScriptObjectBrowser.png
+   :alt: The TypoScript Object Browser
+
+   Locating a specific property in the TypoScript Object Browser (TSOB)
+
+
+On pressing "Update" the value is written into the setup field
+of your current template. If you edit quite a few values you should
+later manually cleanup the setup field (setting curly braces for
+better readability, deleting double entries...).
+
+
+.. figure:: ../Images/EditTypoScriptProperty.png
+   :alt: Editing a property
+
+   Editing a TypoScript property
+
+
+For more information about working with TypoScript, please refer to the
+:ref:`t3tssyntax:start` manual.
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/ConstantEditor.png b/typo3/sysext/css_styled_content/Documentation/Images/ConstantEditor.png
new file mode 100644 (file)
index 0000000..76b2c47
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/ConstantEditor.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/EditTypoScriptProperty.png b/typo3/sysext/css_styled_content/Documentation/Images/EditTypoScriptProperty.png
new file mode 100644 (file)
index 0000000..69be89b
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/EditTypoScriptProperty.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/ExtensionManager.png b/typo3/sysext/css_styled_content/Documentation/Images/ExtensionManager.png
new file mode 100644 (file)
index 0000000..905861d
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/ExtensionManager.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/HeaderContentElement.png b/typo3/sysext/css_styled_content/Documentation/Images/HeaderContentElement.png
new file mode 100644 (file)
index 0000000..5d892d7
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/HeaderContentElement.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/ImageContentElement.png b/typo3/sysext/css_styled_content/Documentation/Images/ImageContentElement.png
new file mode 100644 (file)
index 0000000..553431c
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/ImageContentElement.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/LinkToTop.png b/typo3/sysext/css_styled_content/Documentation/Images/LinkToTop.png
new file mode 100644 (file)
index 0000000..ee1fd28
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/LinkToTop.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/MediaContentElementStructure.png b/typo3/sysext/css_styled_content/Documentation/Images/MediaContentElementStructure.png
new file mode 100644 (file)
index 0000000..edbb6b9
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/MediaContentElementStructure.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/SectionFrame.png b/typo3/sysext/css_styled_content/Documentation/Images/SectionFrame.png
new file mode 100644 (file)
index 0000000..d79ad56
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/SectionFrame.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/StaticTemplateInclusion.png b/typo3/sysext/css_styled_content/Documentation/Images/StaticTemplateInclusion.png
new file mode 100644 (file)
index 0000000..58c4db3
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/StaticTemplateInclusion.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/TableContentElement.png b/typo3/sysext/css_styled_content/Documentation/Images/TableContentElement.png
new file mode 100644 (file)
index 0000000..b69c49b
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/TableContentElement.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/TextContentElement.png b/typo3/sysext/css_styled_content/Documentation/Images/TextContentElement.png
new file mode 100644 (file)
index 0000000..977a6e6
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/TextContentElement.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/TtContentOverview.png b/typo3/sysext/css_styled_content/Documentation/Images/TtContentOverview.png
new file mode 100644 (file)
index 0000000..730d0e2
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/TtContentOverview.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Images/TypoScriptObjectBrowser.png b/typo3/sysext/css_styled_content/Documentation/Images/TypoScriptObjectBrowser.png
new file mode 100644 (file)
index 0000000..0fa3422
Binary files /dev/null and b/typo3/sysext/css_styled_content/Documentation/Images/TypoScriptObjectBrowser.png differ
diff --git a/typo3/sysext/css_styled_content/Documentation/Includes.txt b/typo3/sysext/css_styled_content/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..38aa398
--- /dev/null
@@ -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
diff --git a/typo3/sysext/css_styled_content/Documentation/Index.rst b/typo3/sysext/css_styled_content/Documentation/Index.rst
new file mode 100644 (file)
index 0000000..bf3c1ea
--- /dev/null
@@ -0,0 +1,65 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+.. _start:
+
+==================
+css_styled_content
+==================
+
+:Extension key:
+      css_styled_content
+
+:Version:
+      6.2
+
+:Language:
+      en
+
+:Description:
+      Manual for CSS Styled Content, the system extension, which provides default rendering instructions for Content Elements.
+
+:Keywords:
+      css_styled_content, content elements, rendering, TypoScript
+
+:Copyright:
+      2000-2013
+
+:Author:
+      TYPO3 CMS Core Development Team
+
+:License:
+      Open Content License available from `www.opencontent.org/opl.shtml
+      <http://www.opencontent.org/opl.shtml>`_
+
+:Rendered:
+      |today|
+
+The content of this document is related to TYPO3,
+
+a GNU/GPL CMS/Framework available from `www.typo3.org
+<http://www.typo3.org/>`_
+
+
+
+
+**Table of Contents**
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Introduction/Index
+   Installation/Index
+   HowTo/Index
+   Configuration/Index
+   OutOfTheBoxCssStyling/Index
+   AboutThisDocument/Index
+   Targets
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Installation/Index.rst b/typo3/sysext/css_styled_content/Documentation/Installation/Index.rst
new file mode 100644 (file)
index 0000000..b19cf95
--- /dev/null
@@ -0,0 +1,112 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _installation:
+
+Installation
+------------
+
+
+.. _extension-manager:
+
+Extension Manager
+^^^^^^^^^^^^^^^^^
+
+The extension is normally installed by default – you can check it in
+the extension manager.
+
+.. figure:: ../Images/ExtensionManager.png
+   :alt: css_styled_content in the EM
+
+   Verifying that css_styled_content is loaded in the Extension Manager
+
+
+.. _web-template:
+
+Web > Template
+^^^^^^^^^^^^^^
+
+To use the default rendering definitions CSS Styled Content provides
+you have to add the static template to your TypoScript template.
+
+
+.. figure:: ../Images/StaticTemplateInclusion.png
+   :alt: Including the static template
+
+   Inclusion of the static template in a system template
+
+
+Normally you should choose the template "CSS Styled Content".
+If you upgraded from a previous TYPO3 version and notice that
+something breaks your layout – try the template corresponding to your
+version (for example "CSS Styled Content TYPO3 v4.7").
+
+.. note::
+
+   The upgrade wizard in the install tool automatically inserts
+   the static template corresponding to your compatibility version.
+
+
+.. _your-template:
+
+Inserting content into your template
+""""""""""""""""""""""""""""""""""""
+
+To get the different columns from the backend displayed in the
+frontend you can use predefined :ref:`CONTENT <t3tsref:cobj-content>` objects. Normally you would do
+something like the following to get the content from the "Normal"
+column into your template:
+
+::
+
+   page = PAGE
+   page.10 = TEMPLATE
+   page.10 {
+           file = your/html/template.html
+           subparts {
+                   MAIN_CONTENT = CONTENT
+                   MAIN_CONTENT {
+                           table = tt_content
+                           select {
+                                   orderBy = sorting
+                                   where = colPos=0
+                                   languageField = sys_language_uid
+                           }
+                   }
+           }
+   }
+
+
+With CSS Styled Content you can shorten that code quite a bit:
+
+::
+
+   page = PAGE
+   page.10 = TEMPLATE
+   page.10 {
+           file = your/html/template.html
+           subparts {
+                   MAIN_CONTENT < styles.content.get
+           }
+   }
+
+
+:code:`styles.content.get` is one of the predefined CONTENT objects, that
+renders the "normal" column. The following predefined CONTENT objects
+exist:
+
+======================== ====================================
+CONTENT object           Column
+======================== ====================================
+styles.content.get       Normal
+styles.content.getLeft   Left
+styles.content.getRight  Right
+styles.content.getBorder Border
+======================== ====================================
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Introduction/Index.rst b/typo3/sysext/css_styled_content/Documentation/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..693ed10
--- /dev/null
@@ -0,0 +1,128 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _introduction:
+
+Introduction
+------------
+
+
+.. _what-does-it-do:
+
+What does it do?
+^^^^^^^^^^^^^^^^
+
+This extension provides a static TypoScript template file and
+additional resources for CSS based, XHTML or HTML5 compliant rendering of
+content elements in TYPO3.
+
+This document covers only elements specific to "css\_styled\_content".
+For a general overview of all the properties of TypoScript objects,
+please refer to the :ref:`TypoScript Reference <t3tsref:start>`.
+
+
+.. _modern-rendering:
+
+Modern content element rendering
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+From the birth of TYPO3 content elements have been rendered by the
+*static template* called "content (default)". This was mainly based on
+font-tags for styling and tables for positioning which was needed to
+achieve the visual constructions of the old versions of web browsers.
+However, with the widespread acceptance of CSS "content (default)"
+became obsolete and deprecated. This extension aims to provide a
+complete substitution of "content (default)"'s content rendering.
+
+The objectives are to:
+
+- use standard XHTML or HTML5 compliant tags for rendering, styled by CSS, tagged
+  by various classes.
+
+- reduce the amount of TypoScript Setup code, in particular cut down
+  redundancy; this makes adjustments easier and cleaner.
+
+- reduce the amount of TypoScript constants to a necessary minimum; this
+  makes configuration more "no-nonsense" since most layout related stuff
+  is in the style sheets now.
+
+- use PHP for special rendering where a TypoScript implementation
+  becomes too complex (this is the case for images, tables and file link
+  elements).
+
+- use TypoScript for what it does absolutely best. This includes menus
+  (HMENU, etc.) and image manipulation (IMAGE, IMGTEXT), simple wrapping
+  operations, parsing of content and rendering of some standard elements
+  like forms, file links etc. And of course the base setup of page
+  objects, frame sets etc. (which is not affected at all by this
+  plugin). And being a generally brilliant way to pass parameters to PHP
+  from TYPO3's backend.
+
+- use non-TYPO3 specific tags with the RTE: only the link-tags are
+  preserved as a concept. Bullet lists, tables and headers are now
+  native HTML stored in the database. Still simple content lines are
+  dissolved into lines with no <P> tags wrapped around.
+
+- achieve full XHTML-transitional and HTML5 compliance.
+
+- preserve backwards compatibility where it wouldn't compromise quality
+  and modernity.
+
+These are the more technical specs:
+
+- A new static template file is provided which works as a substitute for
+  "content (default)". A certain number of "styles.content.xxx" objects
+  are preserved as well as constants from those templates. No
+  dependencies on any static template record at all. The new static
+  template file contains a TLO "tt\_content" which is a CASE cObject
+  just like in "content (default)".
+
+- All rendering of the content elements is done in TypoScript except for
+  the Content Elements "Table", "Images" and "File links" which are
+  rendered by a USER cObject calling methods from
+  "tx\_cssstyledcontent\_pi1" for rendering.
+
+- TYPO3 specific tags: skipping typolist, typohead, typocode tags (using
+  native HTML from RTE instead). Preserving the <LINK> tag.
+
+- The position of the parseFunc object has changed to "lib.parseFunc"
+  and with TYPO3 versions > 3.6.0RC1 parseFunc can be referenced (which
+  avoids redundancy!). Backwards compatibility with "added" custom tags
+  should be available, but might fail depending on implementation.
+
+- The "lib.stdheader" is also largely preserved in structure, which
+  means the "lib.stdheader.10 = CASE " object is still there as a true
+  content object, thus backwards compatible for any added header-types.
+
+- RTE based on <P>, <Hx>-tags, images, tables, bullet lists (<OL>/<UL>).
+  Only <LINK>-tags are converted to/from <A>-tags.
+
+
+.. _content-rendering:
+
+The Content Rendering & CSS Styled Content
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Content in TYPO3 is rendered by a so-called render object. CSS Styled
+Content mainly provides the render object for rendering content from
+the "tt\_content" table. In TypoScript this means it defines the object
+:code:`tt_content.[renderingDefinitions]`. You can always have a look at your
+configuration with the help of the TS Object Browser. With the
+rendering configuration you can decide how your content elements are
+wrapped, for example if a headline should be wrapped in a <h1> or
+in <div><h1> or if all of your content elements should be wrapped by a
+default <div> for styling. CSS Styled Content tries to make it easier
+for you by providing sensible defaults for wraps, link targets, image
+rendering and more.
+
+.. figure:: ../Images/TtContentOverview.png
+   :alt: tt_content overview
+
+   Overview of the tt_content configuration
+
diff --git a/typo3/sysext/css_styled_content/Documentation/OutOfTheBoxCssStyling/Index.rst b/typo3/sysext/css_styled_content/Documentation/OutOfTheBoxCssStyling/Index.rst
new file mode 100644 (file)
index 0000000..8382da8
--- /dev/null
@@ -0,0 +1,60 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _css-styling:
+
+Out of the box CSS styling
+--------------------------
+
+This extension comes with a working CSS, which will be auto-generated
+and added to the rendered pages. This auto-generated CSS will be
+externalized with :code:`config.inlineStyle2TempFile = 1` which is set
+by default (see :ref:`config reference in the TSRef <t3tsref:config>`).
+This provides the most "out-of-the-box" experience, because you can now
+influence the appearance through some settings in the CONSTANT EDITOR
+(e.g. border, spacing, etc).
+
+But you can also avoid this auto-generated CSS and choose to include
+the CSS responsible for this plugin in your own .css files. To do so,
+include this in your TypoScript Template:
+
+::
+
+   plugin.tx_cssstyledcontent._CSS_DEFAULT_STYLE >
+
+
+or since TYPO3 CMS 4.6, you can set::
+
+       config.removeDefaultCss = 1
+
+
+which also affects plugins providing some default CSS.
+
+Be aware that some settings in the external CSS
+influence the rendering that needs to be done in the plugin. Thus some
+settings that are done in CSS have to be specified in TypoScript too,
+so that our plugin knows how to handle them. Basically those are
+settings that influence spacing and borders and they can be set in the
+CONSTANT EDITOR.
+
+So you adapt your CSS to your wishes and then go to the CONSTANT
+EDITOR and reflect these settings in these constants:
+
+- **colSpace**: The space between columns of images (in pixels)
+
+- **rowSpace**: The space after each row of images (in pixels)
+
+- **textMargin**: The space from the imageblock to the text (in case of
+  in-text rendering) (in pixels)
+
+- **borderSpace**: The space that the borders around images take (in
+  pixels)
+
+- **borderThick**: The thickness of borders (in pixels)
+
diff --git a/typo3/sysext/css_styled_content/Documentation/Settings.yml b/typo3/sysext/css_styled_content/Documentation/Settings.yml
new file mode 100644 (file)
index 0000000..40a5434
--- /dev/null
@@ -0,0 +1,11 @@
+# This is the project specific Settings.yml file.
+# Place Sphinx specific build information here.
+# Settings given here will replace the settings of 'conf.py'.
+
+---
+conf.py:
+  copyright: 1997-2013
+  project: css_styled_content
+  version: 6.2
+  release: 6.2
+...
diff --git a/typo3/sysext/css_styled_content/Documentation/Targets.rst b/typo3/sysext/css_styled_content/Documentation/Targets.rst
new file mode 100644 (file)
index 0000000..c7c43c0
--- /dev/null
@@ -0,0 +1,13 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+.. _index-labels-for-crossreferencing:
+
+Index: Labels for Crossreferencing
+==================================
+
+.. ref-targets-list::
diff --git a/typo3/sysext/css_styled_content/doc/manual.sxw b/typo3/sysext/css_styled_content/doc/manual.sxw
deleted file mode 100755 (executable)
index 9d948f2..0000000
Binary files a/typo3/sysext/css_styled_content/doc/manual.sxw and /dev/null differ
diff --git a/typo3/sysext/dbal/Documentation/.gitignore b/typo3/sysext/dbal/Documentation/.gitignore
new file mode 100644 (file)
index 0000000..6cd159f
--- /dev/null
@@ -0,0 +1,7 @@
+# this is file .gitignore
+
+# ignore everything in this directory
+_make/*
+
+# but do not ignore this file
+!_not_versioned/.gitignore
diff --git a/typo3/sysext/dbal/Documentation/Appendices/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/Index.rst
new file mode 100644 (file)
index 0000000..59682b7
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _appendices:
+
+Appendices
+==========
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       UsingOracleWithTypo3/Index
+       UsingPostgresqlWithTypo3/Index
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/ConfiguringDatabaseAccess/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/ConfiguringDatabaseAccess/Index.rst
new file mode 100644 (file)
index 0000000..fee0a92
--- /dev/null
@@ -0,0 +1,61 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+
+.. _oracle-configuring-database-access:
+
+Configuring Database Access
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Edit file ``typo3conf/localconf.php`` again and add these lines::
+
+       $typo_db_username = 'username';
+       $typo_db_password = 'password';
+       $typo_db_host = 'localhost';
+       $typo_db = 'ServiceNameOrSID';
+
+Unlike MySQL you don't connect to a server and select a database.
+Instead, you connect as a user and use the default schema. To do this
+you can either use the SID or the name of the service ("XE" when you
+use 10g XE). You must set the hostname and the service name in
+``$typo_db_host`` and ``$typo_db``. It is not possible to set them in one
+as " *//hostname/servicename* ".
+
+If you need to use another default port than 1521, use following
+syntax for ``$typo_db_host``::
+
+       $typo_db_host = 'localhost:1234';
+
+If you wish to use caching framework introduced with TYPO3 4.3, you
+have to remap very long table names to prevent the identifier to be
+too long for Oracle. Edit the file ``typo3conf/localconf.php`` and
+add these lines::
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['mapping'] = array(
+          'cachingframework_cache_hash' => array(
+              'mapTableName' => 'cf_cache_hash',
+          ),
+          'cachingframework_cache_pages' => array(
+              'mapTableName' => 'cf_cache_pages',
+          ),
+          'cachingframework_cache_hash_tags' => array(
+              'mapTableName' => 'cf_cache_hash_tags',
+          ),
+          'cachingframework_cache_pages_tags' => array(
+              'mapTableName' => 'cf_cache_pages_tags',
+          ),
+          'cachingframework_cache_pagesection' => array(
+              'mapTableName' => 'cf_cache_ps',
+          ),
+          'cachingframework_cache_pagesection_tags' => array(
+              'mapTableName' => 'cf_cache_ps_tags',
+          ),
+       );
+
+Then use the install tool to create tables and configure TYPO3 as
+usual.
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/Index.rst
new file mode 100644 (file)
index 0000000..0c42b95
--- /dev/null
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _using-oracle-with-typo3:
+
+Using Oracle with TYPO3
+-----------------------
+
+This section describes how to configure access to an existing Oracle
+schema.
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       InstallingAndConfiguringAdodbAndDbal/Index
+       ConfiguringDatabaseAccess/Index
+
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingOracleWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst
new file mode 100644 (file)
index 0000000..8b04082
--- /dev/null
@@ -0,0 +1,38 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+
+.. _oracle-installing-and-configuring-adodb-and-dbal:
+
+Installing and Configuring ADOdb and DBAL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Edit the file ``typo3conf/localconf.php`` and append "adodb,dbal" to
+the comma-separated list of extensions found in
+``$TYPO3_CONF_VARS['EXT']``. Another option is to add following code to
+the end of the file::
+
+       $TYPO3_CONF_VARS['EXT']['extList'] .= ',adodb,dbal';
+
+Now add following code to the end of the same file ``typo3conf/localconf.php``::
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['handlerCfg'] = array(
+          '_DEFAULT' => array(
+              'type' => 'adodb',
+              'config' => array(
+                  'driver' => 'oci8',
+                  'driverOptions' => array(
+                      'connectSID' => FALSE,
+                  ),
+              )
+          ),
+       );
+
+This allows you to connect to an Oracle server using a serviceName
+(see below). If you wish to use a SID instead, make sure to set the
+driver option ``connectSID`` to ``TRUE``.
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/CompatibilityTuning/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/CompatibilityTuning/Index.rst
new file mode 100644 (file)
index 0000000..fc112f3
--- /dev/null
@@ -0,0 +1,15 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+
+.. _compatibility-tuning:
+
+Compatibility Tuning
+^^^^^^^^^^^^^^^^^^^^
+
+You are strongly advised to run SQL scripts located in directory ``dbal/res/postgresql/*`` to ensure best compatibility with TYPO3.
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/ConfiguringDatabaseAccess/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/ConfiguringDatabaseAccess/Index.rst
new file mode 100644 (file)
index 0000000..95af163
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+
+.. _postgresql-configuring-database-access:
+
+Configuring Database Access
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Edit file ``typo3conf/localconf.php`` again and add these lines::
+
+       $typo_db_username = 'username';
+       $typo_db_password = 'password';
+       $typo_db_host = 'localhost';
+       $typo_db = 'database';
+
+Then use the install tool to create tables and configure TYPO3 as usual.
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/Index.rst
new file mode 100644 (file)
index 0000000..4647caf
--- /dev/null
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _using-postgresql-with-typo3:
+
+Using PostgreSQL with TYPO3
+---------------------------
+
+This section describes how to configure access to an existing
+PostgreSQL database.
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       InstallingAndConfiguringAdodbAndDbal/Index
+       ConfiguringDatabaseAccess/Index
+       CompatibilityTuning/Index
diff --git a/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst b/typo3/sysext/dbal/Documentation/Appendices/UsingPostgresqlWithTypo3/InstallingAndConfiguringAdodbAndDbal/Index.rst
new file mode 100644 (file)
index 0000000..75c93e8
--- /dev/null
@@ -0,0 +1,31 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../../Includes.txt
+
+
+
+.. _postgresql-installing-and-configuring-adodb-and-dbal:
+
+Installing and Configuring ADOdb and DBAL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Edit the file ``typo3conf/localconf.php`` and append "adodb,dbal" to
+the comma-separated list of extensions found in
+``$TYPO3_CONF_VARS['EXT']``. Another option is to add following code to
+the end of the file::
+
+       $TYPO3_CONF_VARS['EXT']['extList'] .= ',adodb,dbal';
+
+Now add following code to the end of the same file ``typo3conf/localconf.php``::
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['handlerCfg'] = array(
+          '_DEFAULT' => array(
+              'type' => 'adodb',
+              'config' => array(
+                  'driver' => 'postgres',
+              )
+          ),
+       );
diff --git a/typo3/sysext/dbal/Documentation/Bugs/Index.rst b/typo3/sysext/dbal/Documentation/Bugs/Index.rst
new file mode 100644 (file)
index 0000000..b7609f2
--- /dev/null
@@ -0,0 +1,16 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _bugs:
+
+Bugs
+----
+
+Please use the bug tracker at https://forge.typo3.org/projects/typo3v4-core/issues to submit
+any bugs you find in this extension and choose category "dbal".
diff --git a/typo3/sysext/dbal/Documentation/Configuration/ConfigurationHints/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/ConfigurationHints/Index.rst
new file mode 100644 (file)
index 0000000..500fb54
--- /dev/null
@@ -0,0 +1,142 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _configuration-hints:
+
+Database-specific configuration hints
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Depending on the database you use, the meaning of the
+host/username/password settings may slightly differ. This the case for
+Oracle, and maybe other RDBMS as well.
+
+
+.. _hints-mysql:
+
+MySQL
+"""""
+
+.. container:: table-row
+
+       RDBMS
+               **MySQL**
+
+       Host
+               DB server
+
+       Username
+               Username
+
+       Password
+               Password
+
+       DB Name
+               Database name
+
+
+.. _hints-postgresql:
+
+PostgreSQL
+""""""""""
+
+.. container:: table-row
+
+       RDBMS
+               **PostgreSQL**
+
+       Host
+               DB server
+
+       Username
+               Username
+
+       Password
+               Password
+
+       DB Name
+               Database name
+
+
+.. _hints-oracle:
+
+Oracle
+""""""
+
+.. container:: table-row
+
+       RDBMS
+               **Oracle**
+
+       Host
+               DB server
+
+       Username
+               Username
+
+       Password
+               Password
+
+       DB Name
+               SID / Instance name
+
+               Must be entered in ``localconf.php`` manually!
+
+
+.. _hints-firebird:
+
+Firebird
+""""""""
+
+.. container:: table-row
+
+       RDBMS
+               **Firebird**
+
+       Host
+               DB server
+
+       Username
+               Username
+
+       Password
+               Password
+
+       DB Name
+               Full path to the database file, e.g. ``/tmp/testfb.fdb``
+
+               .. note::
+                       *Currently not working!*
+
+
+.. _hints-ms-sql:
+
+MS SQL Server (using ODBC)
+""""""""""""""""""""""""""
+
+.. container:: table-row
+
+       RDBMS
+               **MS SQL Server (using ODBC)**
+
+       Host
+               ODBC DNS
+
+       Username
+               Username
+
+       Password
+               Password
+
+       DB Name
+               Set to some dummy string!
+
+
+If your RDBMS is not shown in the list, try with the usual meaning of
+those parameters first, if that doesn't work, but you figure out how
+to connect, then please let us know, so we can update this document.
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Debug/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Debug/Index.rst
new file mode 100644 (file)
index 0000000..777957f
--- /dev/null
@@ -0,0 +1,173 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _debug:
+
+->debug
+^^^^^^^
+
+Debugging options
+
+
+.. _enabled:
+
+enabled
+"""""""
+
+.. container:: table-row
+
+       Key
+               enabled
+
+       Datatype
+               boolean
+
+       Description
+               If set, TYPO3 will log every SQL execution in the ``tx_dbal_debuglog``
+               table.
+
+               This option must be set for the other options below to work.
+
+               You can view the log from the backend; There is a DBAL module in the
+               Tools main module.
+
+
+.. _printerrors:
+
+printErrors
+"""""""""""
+
+.. container:: table-row
+
+       Key
+               printErrors
+
+       Datatype
+               boolean
+
+       Description
+               If set, SQL errors will be ``debug()``'ed to browser after any SQL
+               execution.
+
+
+.. _explain:
+
+EXPLAIN
+"""""""
+
+.. container:: table-row
+
+       Key
+               EXPLAIN
+
+       Datatype
+               boolean
+
+       Description
+               Will log the result of a ``EXPLAIN SELECT...`` in case of select-queries.
+               Can help you to benchmark the performance of your indexes in the
+               database.
+
+               When using Oracle (the ADOdb oci8 driver) you **must** create the
+               necessary ``PLAN_TABLE`` manually, according to the Oracle version you
+               use. See http://www.adp-gmbh.ch/ora/explainplan.html for some
+               background information.
+
+
+.. _parsequery:
+
+parseQuery
+""""""""""
+
+.. container:: table-row
+
+       Key
+               parseQuery
+
+       Datatype
+               boolean
+
+       Description
+               Will parse all possible parts of the SQL queries, compile them again
+               and match the results. If the parsed and recompiled queries did not
+               match they will enter the log table and can subsequently be addressed.
+               This will help you to spot "TYPO3 incompatible SQL" (as defined by the
+               core parser of ``t3lib_sqlengine``).
+
+
+.. _jointables:
+
+joinTables
+""""""""""
+
+.. container:: table-row
+
+       Key
+               joinTables
+
+       Datatype
+               boolean
+
+       Description
+               Will log every SELECT query performed with a table join - necessary to
+               make sure that all tables that may be joined in TYPO3 is also handled
+               by the same handlerKey (which is required for obvious reasons!)
+
+
+.. _numberrows:
+
+numberRows
+""""""""""
+
+.. container:: table-row
+
+       Key
+               numberRows
+
+       Datatype
+               boolean
+
+       Description
+               Will log number of affected rows in previous INSERT, UPDATE or DELETE
+               operation or number of returned rows in previous SELECT query.
+
+
+.. _backtrace:
+
+backtrace
+"""""""""
+
+.. container:: table-row
+
+       Key
+               backtrace
+
+       Datatype
+               integer
+
+       Description
+               If set, the given number of backtrace steps are logged with the query.
+
+
+
+.. _debug-example:
+
+Example
+"""""""
+
+This enables all debug options::
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['debugOptions'] = array(
+           'enabled' => TRUE,        // Generally, enable debugging.
+           'printErrors' => TRUE,    // Enable output of SQL errors after query executions.
+           'EXPLAIN' => TRUE,        // EXPLAIN SELECT ...(Only on default handler)
+           'parseQuery' => TRUE,     // Parsing queries, testing parsability (All queries)
+           'joinTables' => TRUE,
+           'numberRows' => TRUE,     // Number of affected/returned rows (INSERT, UPDATE, DELETE or SELECT)
+       );
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Handlercfg/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Handlercfg/Index.rst
new file mode 100644 (file)
index 0000000..2fea61a
--- /dev/null
@@ -0,0 +1,470 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _handlercfg:
+
+->handlerCfg
+^^^^^^^^^^^^
+
+Configuration of a data handler
+
+
+.. _type:
+
+type
+""""
+
+.. container:: table-row
+
+       Key
+               type
+
+       Datatype
+               handler type (string)
+
+       Description
+               The type of the handler.
+
+               The type is a fixed keyword between these:
+
+               - native
+               - adodb
+               - userdefined
+
+               (See description of each in the introduction above)
+
+               The "native" handler is used by default (and is MySQL-only!)
+
+               The handler type will determine what options are available for
+               "config"
+
+
+.. _config:
+
+config
+""""""
+
+.. container:: table-row
+
+       Key
+               config
+
+       Datatype
+               array
+
+       Description
+               Array containing configuration for the handler. See below for options.
+
+               Notice that the options are supported depending on handler type. For
+               this, see information in italic and square brackets.
+
+
+.. _config-username:
+
+config[username]
+""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[username]
+
+       Datatype
+               string
+
+       Description
+               Username for connection
+
+               .. warning::
+                       For the "_DEFAULT" handler this is overridden by
+                       ``$typo_db_username`` from ``localconf.php``
+
+               .. note::
+                       Only native / adodb
+
+
+.. _config-password:
+
+config[password]
+""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[password]
+
+       Datatype
+               string
+
+       Description
+               Password for connection
+
+               .. warning::
+                       For the "_DEFAULT" handler this is overridden by
+                       ``$typo_db_password`` from ``localconf.php``
+
+               .. note::
+                       Only native / adodb
+
+
+.. _config-host:
+
+config[host]
+""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[host]
+
+       Datatype
+               string
+
+       Description
+               Host for the database server
+
+               .. warning::
+                       For the "_DEFAULT" handler this is overridden by
+                       ``$typo_db_host`` from ``localconf.php``
+
+               .. note::
+                       Only native / adodb
+
+
+.. _config-port:
+
+config[port]
+""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[port]
+
+       Datatype
+               integer
+
+       Description
+               Port for the database server
+
+               .. note::
+                       Only native / adodb
+
+
+.. _config-database:
+
+config[database]
+""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[database]
+
+       Datatype
+               string
+
+       Description
+               The database name
+
+               .. warning::
+                       For the "_DEFAULT" handler this is overridden by
+                       ``$typo_db`` from ``localconf.php``
+
+               .. note::
+                       Only native / adodb
+
+
+.. _config-driver:
+
+config[driver]
+""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[driver]
+
+       Datatype
+               string
+
+       Description
+               Which driver, (eg. ``mysql``, ``oci8`` etc.). Depending on API (see ADOdb
+               documentation for details)
+
+               .. note::
+                       Only adodb
+
+
+.. _config-driveroptions:
+
+config[driverOptions]
+"""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[driverOptions]
+
+       Datatype
+               array
+
+       Description
+               Key/value pairs of driver-specific options.
+
+               E.g., ``array('connectSID' => TRUE)`` to connect to an Oracle database with
+               a SID instead of a service name
+
+               .. warning::
+                       Available options are found in ADOdb, in the class you use
+                       as driver to connect to your database
+
+               .. note::
+                       Only adodb
+
+
+.. _config-sequencestart:
+
+config[sequenceStart]
+"""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[sequenceStart]
+
+       Datatype
+               integer
+
+       Description
+               The number which is used as initial value for sequences when they are
+               generated.
+
+               .. note::
+                       Only adodb
+
+
+.. _config-classfile:
+
+config[classFile]
+"""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[classFile]
+
+       Datatype
+               string
+
+       Description
+               Class file for user defined DB handler class.
+
+               E.g., ``EXT:dbal/handlers/class.tx_dbal_handler_xmldb.php``
+
+               Must be relative path to ``PATH_site``. The ``EXT:`` prefix can be used for
+               locations inside of extensions.
+
+               .. note::
+                       Only userdefined
+
+
+.. _config-class:
+
+config[class]
+"""""""""""""
+
+.. container:: table-row
+
+       Key
+               config[class]
+
+       Datatype
+               string
+
+       Description
+               Class name for the handler inside of config[classFile].
+
+               E.g., ``tx_dbal_handler_xmldb``
+
+               Please see examples/templates of userdefined handlers inside
+               ``dbal/handlers/`` directory.
+
+               .. note::
+                       Only userdefined
+
+
+
+.. _using-adodb-or-pear-db-for-the-default-handler:
+
+Using ADOdb or PEAR::DB for the \_DEFAULT handler
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block:: php
+       :linenos:
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg'] = array(
+           '_DEFAULT' => array(
+               'type' => 'adodb',
+               'config' => array(
+                   'driver' => 'mysql',
+               )
+           )
+       );
+
+If you need to use other databases, just change the value in line 5 to
+the name of the other database driver. See ADOdb manual for details.
+
+
+.. _using-another-mysql-database-for-the-tt-guest-and-sys-note-tables:
+
+Using another MySQL database for the "tt_guest" and "sys_note" tables
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block:: php
+       :linenos:
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg'] = array(
+           '_DEFAULT' => array (
+               'type' => 'native',
+               'config' => array(
+                   'username' => '',        // Set by default (overridden)
+                   'password' => '',        // Set by default (overridden)
+                   'host' => '',            // Set by default (overridden)
+                   'database' => '',        // Set by default (overridden)
+               )
+           ),
+           'alternativeMySQLdb' => array(
+               'type' => 'native',
+               'config' => array(
+                   'username' => 'your_username',
+                   'password' => 'your_password',
+                   'host' => 'localhost',
+                   'database' => 'alternative_database_name',
+               )
+           ),
+       );
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['table2handlerKeys'] = array(
+           'tt_guest' => 'alternativeMySQLdb',
+           'sys_note' => 'alternativeMySQLdb',
+       );
+
+In line 24 and 25 we configure the two tables to use the *handler
+key* "alternativeMySQLdb" instead of the "\_DEFAULT" handler. In both
+cases the handlers will connect natively to MySQL - but two different
+databases at the "same time".
+
+
+.. _storing-tt-guest-and-sys-note-tables-in-oracle:
+
+Storing "tt_guest" and "sys_note" tables in Oracle
+""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block:: php
+       :linenos:
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg'] = array(
+           '_DEFAULT' => array(
+               'type' => 'native',
+               'config' => array(
+                   'username' => '',        // Set by default (overridden)
+                   'password' => '',        // Set by default (overridden)
+                   'host' => '',            // Set by default (overridden)
+                   'database' => '',        // Set by default (overridden)
+               )
+           ),
+           'oracleDB' => array(
+               'type' => 'adodb',
+               'config' => array(
+                   'username' => 'your_username',
+                   'password' => 'your_password',
+                   'host' => 'localhost',
+                   'database' => 'oracleDB',
+                   'driver' => 'oci8'
+               )
+           ),
+       );
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['table2handlerKeys'] = array(
+           'tt_guest' => 'oracleDB',
+           'sys_note' => 'oracleDB',
+       );
+
+This example is basically similar to the former, just that the key
+name was changed to "oracleDB" for convenience.
+
+The real change is that
+
+- line 12 configures ADOdb to be used and
+
+- line 18 configures ADOdb to use the ``oci8`` driver instead of MySQL.
+
+
+.. _storing-tt-guest-and-sys-note-tables-in-an-xml-file:
+
+Storing "tt_guest" and "sys_note" tables in an XML file
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block:: php
+       :linenos:
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg'] = array(
+           '_DEFAULT' => array(
+               'type' => 'native',
+               'config' => array(
+                   'username' => '',        // Set by default (overridden)
+                   'password' => '',        // Set by default (overridden)
+                   'host' => '',            // Set by default (overridden)
+                   'database' => '',        // Set by default (overridden)
+               )
+           ),
+           'xmlDB' => array(
+               'type' => 'userdefined',
+               'config' => array(
+                   'classFile' => 'EXT:dbal/handlers/class.tx_dbal_handler_xmldb.php',
+                   'class' => 'tx_dbal_handler_xmldb',
+                   'tableFiles' => array(
+                       'tt_guest' => 'fileadmin/tt_guest.xml',
+                       'sys_note' => 'fileadmin/sys_note.xml',
+                   )
+               )
+           ),
+       );
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['table2handlerKeys'] = array(
+           'tt_guest' => 'xmlDB',
+           'sys_note' => 'xmlDB',
+       );
+
+In this example the handler key ``xmlDB` sets up a userdefined handler;
+basically a PHP class with certain functions for INSERT / SELECT /
+UPDATE and DELETE operations and data-to-disc I/O. In this case it is
+just an example using the class ``tx_dbal_handler_xmldb`` which is
+shipped with this extensions. Configuration might be different since
+that class (at time of writing) is not finished.
+
+Anyways, the point is that this userdefined, PHP written handler will
+simulate an SQL server and allow to insert, select, update and delete
+records which is actually stored in some XML files and not real
+database tables!
+
+This goes to show the possibilities, right... :-)
+
+
+.. _notice-on-joins-and-tables-separated-into-different-databases:
+
+Notice on joins and tables separated into different databases
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+If you chose to configure that some tables like ``sys_note`` and
+``tt_guest`` will go into other databases as the example shows above,
+you will have to make sure  *they are never joined with any tables
+from other databases* . If they are, you will face a fatal error from
+the DBAL; logically you cannot join tables across database systems!
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..4300577
--- /dev/null
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _configuration:
+
+Configuration
+-------------
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       Introduction/Index
+       Typo3ConfVars/Index
+       Handlercfg/Index
+       Mapping/Index
+       Debug/Index
+       ConfigurationHints/Index
+       Memcached/Index
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Introduction/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..67f4de0
--- /dev/null
@@ -0,0 +1,47 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _configuration-introduction:
+
+Introduction
+^^^^^^^^^^^^
+
+Before the DBAL will do anything different for you than just
+connecting to the default database you will have to configure it. By
+default it connects using the "native" handler type - which means
+direct interaction with MySQL.
+
+Since the DBAL offers to store information in multiple sources and not
+just a single database you might have to understand handlers first.
+
+First, some definitions:
+
+- **handler type** - which kind of interface is used for a data handler.
+  The options are "native", "adodb" or "userdefined".
+
+  - native - Connects directly to MySQL with hardcoded PHP functions
+
+  - adodb - Is an instance of ADOdb database API offering support for a
+    long list of databases other than MySQL. The DBAL extension has been
+    developed with a focus on ADOdb until now, so it should work.
+
+  - userdefined - Is an instance of a userdefined class which must contain
+    certain functions to supply results from the "database" - offers
+    support for just any kind of data source you can program an interface
+    to yourself!
+
+- **handlerKey** - a string which uniquely identifies a data handler.
+  Each handler represents an instance of a handler type (see above). The
+  handlerKey can be any alphanumeric string. The handler key "\_DEFAULT"
+  is the default handler for all tables unless otherwise configured.
+
+- **tablename** - the database table name seen from the TYPO3 side in
+  the system (might differ from the  *real* database name if mapping is
+  enabled!)
+
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Mapping/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Mapping/Index.rst
new file mode 100644 (file)
index 0000000..12f5feb
--- /dev/null
@@ -0,0 +1,127 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _mapping:
+
+->mapping
+^^^^^^^^^
+
+Contains mapping of tablename and fields in a table. Notice that
+entering any configuration for a table might affect performance since
+translation is needed before results are returned or queries executed.
+
+Mapping is totally transparent for applications inside TYPO3 and
+mapping is independent of handler type - the translation goes on
+between these two spheres.
+
+Mapping can work as a work-around for reserved field- or table names.
+
+
+.. _maptablename:
+
+mapTableName
+""""""""""""
+
+.. container:: table-row
+
+       Key
+               mapTableName
+
+       Datatype
+               string
+
+       Description
+               Real, physical tablename for the table
+
+
+.. _mapfieldnames-fieldname:
+
+mapFieldNames[fieldname]
+""""""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               mapFieldNames[fieldname]
+
+       Datatype
+               string
+
+       Description
+               Real, physical fieldname in the table.
+
+
+
+.. _mapping-example:
+
+Example
+"""""""
+
+.. code-block:: php
+       :linenos:
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['mapping'] = array(
+           'sys_note' => array(
+               'mapTableName' => 'SysNoteTable',
+               'mapFieldNames' =>  array(
+                   'uid' => 'uid999',
+                   'pid' => 'pid999',
+                   'deleted' => 'deleted999',
+                   'tstamp' => 'tstamp999',
+                   'crdate' => 'crdate999',
+                   'cruser' => 'cruser999',
+                   'author' => 'author999',
+                   'email' => 'email999',
+                   'subject' => 'subject999',
+                   'message' => 'message999',
+                   'personal' => 'personal999',
+                   'category' => 'category999'
+               )
+           ),
+           '_tt_content' => array(
+               'mapTableName' => 'tt_content999',
+               'mapFieldNames' => array(
+                   'bodytext' => 'bodytext999',
+                   'header' => 'header999',
+                   'image' => 'image999',
+                   'pid' => 'pid999',
+                   'sorting' => 'sorting999',
+               )
+           )
+       );
+
+In this example two classic TYPO3 tables have been mapped; the
+``sys_note`` table (from the ``sys_note`` extension) and the
+``tt_content`` table (Content Elements).
+
+According to this mapping example the ``sys_note`` table in the database
+(or whatever data source) is actually named ``SysNoteTable`` and all
+fields are actually named differently; with "...999" after (this is
+just an example).
+
+When you try to make a look up in the ``sys_note`` like
+
+.. code-block:: sql
+
+       SELECT uid FROM sys_note WHERE uid=123
+
+then this is transformed into
+
+.. code-block:: sql
+
+       SELECT uid999 FROM SysNoteTable WHERE uid999=123
+
+before executed. And the result row which will be ``array('uid999' => 123)`` will be transformed back to
+``array('uid' => 123)`` before you receive it inside of TYPO3.
+
+.. warning::
+       Mapping tables to two different databases on localhost
+       will most likely only work if ``[SYS][no_pconnect]`` is set in
+       ``$TYPO3_CONF_VARS``. Otherwise PHP will, regardless of DBAL maintaining
+       different links for the databases, use the wrong one.
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Memcached/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Memcached/Index.rst
new file mode 100644 (file)
index 0000000..f711d15
--- /dev/null
@@ -0,0 +1,35 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _memcached:
+
+Memcached
+^^^^^^^^^
+
+Since TYPO3 4.5.0, prepared queries started to be used in Core for
+frequent queries. Since the effort to successfully parse SQL queries
+is high, DBAL caches the result of this lengthy process when prepared
+queries are issued. Out of the box, DBAL will use the transient memory
+cache backend of TYPO3 to store this information. This allows queries
+to be cached for the scope of a single request. If Memcached is
+configured, it can then cache queries for much longer, thus allowing
+DBAL to be much more efficient. Caching may be configured within
+``localconf.php``::
+
+       $GLOBALS['TYPO3_CONF_VARS']['SYS']['useCachingFramework'] = 1;
+       $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['dbal'] = array(
+           'backend' => 't3lib_cache_backend_MemcachedBackend',
+           'options' => array(
+               // port is mandatory!
+               'servers' => array('localhost:11211', 'otherhost:11211', 'thirdhost:11211'),
+           )
+       );
+
+You need to have memcached installed as a daemon and also as a PHP
+extension.
diff --git a/typo3/sysext/dbal/Documentation/Configuration/Typo3ConfVars/Index.rst b/typo3/sysext/dbal/Documentation/Configuration/Typo3ConfVars/Index.rst
new file mode 100644 (file)
index 0000000..7219c88
--- /dev/null
@@ -0,0 +1,123 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _typo3-conf-vars:
+
+$TYPO3\_CONF\_VARS['EXTCONF']['dbal']
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The DBAL is configurable through ``$TYPO3_CONF_VARS['EXTCONF']['dbal']``
+entered in ``ext_localconf.php`` / ``localconf.php``. This table is an
+overview of the main keys in this array:
+
+
+.. _handlercfg-handlerkey:
+
+handlerCfg[ *handlerKey* ]
+""""""""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               handlerCfg[ *handlerKey* ]
+
+       Datatype
+               :ref:`->handlerCfg <handlercfg>`
+
+       Description
+               Configuration of each data handler you want to use in the system.
+
+               Each handler is identified with a string (``handlerKey``) which is used in
+               the ``table2handlerKeys`` configuration (see below) to pair table names
+               with handlers.
+
+               There is *always* a default handler needed which has the handlerKey
+               "\_DEFAULT". By default this handler is configured with the classic
+               username/password/host and database settings from ``localconf.php`` in
+               TYPO3.
+
+               If you want to use ADOdb or just need to store a table in another
+               database you can configure a handler here and map the tables you need
+               to that handler (with ``table2handlerKeys``, see below).
+
+
+.. _table2handlerkeys-tablename:
+
+table2handlerKeys[ *tablename* ]
+""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               table2handlerKeys[ *tablename* ]
+
+       Datatype
+               handlerKey
+
+       Description
+               Using other handlers than the "\_DEFAULT" handler key is possible on a
+               per-table basis and simply done by entering the table name as key in
+               this array and letting the value be the handlerKey you want to use for
+               this table!
+
+               **Beware:** The table names here are the values of ``mapTableName`` and
+               not the names that TYPO3 will use; thus the real table names.
+
+               **Notice:** If tables are joined *both tables* must use the same
+               handlerKey. If they do not TYPO3 will exit with a fatal error!
+
+               You can use the debug options to track all table joins and assess
+               which tables can safely be handled together.
+
+
+.. _mapping-tablename:
+
+mapping[ *tablename* ]
+""""""""""""""""""""""
+
+.. container:: table-row
+
+       Key
+               mapping[ *tablename* ]
+
+       Datatype
+               :ref:`->mapping <mapping>`
+
+       Description
+               Configuration of mapping of table and fieldnames. For instance you can
+               configure that TYPO3 should use a physical table in the database named
+               ``typo3_pages`` instead of ``pages``. Or you can map fieldname in a
+               similar fashion.
+
+               The point is that TYPO3 always sees a table or field names as TYPO3
+               requires internally but in reality the table- or field name could be
+               something different in the physical database source.
+
+               There is a performance loss by configuring such mapping of course:
+               Result rows are preprocessed before being returned and all SQL queries
+               are parsed, transformed and re-compiled again before execution.
+
+
+.. _debugoptions:
+
+debugOptions
+""""""""""""
+
+.. container:: table-row
+
+       Key
+               debugOptions
+
+       Datatype
+               :ref:`->debug <debug>`
+
+       Description
+               Options for various debugging in the DBAL.
+
+
diff --git a/typo3/sysext/dbal/Documentation/DebugBackendModule/Configuration/Index.rst b/typo3/sysext/dbal/Documentation/DebugBackendModule/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..1f07f91
--- /dev/null
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _viewing-configuration:
+
+Viewing the configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The configuration as it has been defined in ``localconf.php`` can be
+checked in the backend by using the Configuration module in the Tools
+section. Select ``$TYPO3_CONF_VARS`` and open the EXTCONF/dbal part of
+the tree display.
diff --git a/typo3/sysext/dbal/Documentation/DebugBackendModule/DatabaseInformation/Index.rst b/typo3/sysext/dbal/Documentation/DebugBackendModule/DatabaseInformation/Index.rst
new file mode 100644 (file)
index 0000000..f491e4a
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _cached-database-information:
+
+Viewing cached database information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The DBAL extension makes heavy use of caching for field information.
+This includes primary keys, auto\_increment fields and native/meta
+types of fields.
+
+To see the cached data select  *View cached data* in the DBAL Debug
+backend module. From there you can clear the cache file, if that seems
+necessary (it is automatically cleaned whenever the database structure
+is changed from within TYPO3).
diff --git a/typo3/sysext/dbal/Documentation/DebugBackendModule/DebugLog/Index.rst b/typo3/sysext/dbal/Documentation/DebugBackendModule/DebugLog/Index.rst
new file mode 100644 (file)
index 0000000..5d2fc1d
--- /dev/null
@@ -0,0 +1,50 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _the-debug-log:
+
+The debug log
+^^^^^^^^^^^^^
+
+When the debug options are enabled queries are logged to a table
+including various details. You can use the "DBAL debug" backend module
+to view the log:
+
+.. figure:: ../../Images/DebugLog.png
+   :alt: DBAL debug log
+
+   The DBAL debug log
+
+
+Above the table you see a few items to click on:
+
+- **FLUSH LOG** clears the logging table.
+
+- **JOINS** shows you the logged table joins, if that feature has been
+  enabled.
+
+- **ERRORS** shows just the entries that caused an error.
+
+- **PARSING** shows the results of the SQL parsing check, if that
+  feature has been enabled.
+
+- **LOG** is what you see when you enter the module.
+
+- **WHERE** shows a log of all WHERE-clauses. This may be used to
+  optimize the database structure or spot performance bottlenecks.
+
+The main log table shows you when how many queries where executed from
+what script in how much time. If an error occurred, this is noted as
+well. If you click on the script name, you'll get a list of all
+queries to help you with debugging.
+
+To aid in debugging problems with null value comparisons '', IS NULL
+and IS NOT NULL are highlighted in the log and where views in red and
+green respectively. This indicates no error in itself, so don't worry
+too much about it.
+
diff --git a/typo3/sysext/dbal/Documentation/DebugBackendModule/Index.rst b/typo3/sysext/dbal/Documentation/DebugBackendModule/Index.rst
new file mode 100644 (file)
index 0000000..d1606dc
--- /dev/null
@@ -0,0 +1,24 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _debug-backend-module:
+
+The DBAL Debug backend module
+-----------------------------
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       DebugLog/Index
+       DatabaseInformation/Index
+       Configuration/Index
+       SqlCheck/Index
diff --git a/typo3/sysext/dbal/Documentation/DebugBackendModule/SqlCheck/Index.rst b/typo3/sysext/dbal/Documentation/DebugBackendModule/SqlCheck/Index.rst
new file mode 100644 (file)
index 0000000..412ce1b
--- /dev/null
@@ -0,0 +1,27 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _sql-check:
+
+SQL check
+^^^^^^^^^
+
+Here you can check SQL queries for compliance with the TYPO3 SQL
+parser. If you enter values in the form fields those are handed to the
+query building methods and the result is shown. Check of it matches
+your input to see if the DB subsystem (core and DBAL) can do what you
+want. For testing inserts, a very simple syntax is used to specify the
+values to be inserted in the first text area: Each line is seen as a
+key/value pair that is exploded at =.
+
+The raw SQL check allows you to enter any query you like and have it
+parsed and reassembled by TYPO3. If this is successful the input will
+be shown below. In case of an error (input and output not matching)
+the query generated by TYPO3 is shown in a red box below the input
+query.
diff --git a/typo3/sysext/dbal/Documentation/Extensions/CodingGuidelines/Index.rst b/typo3/sysext/dbal/Documentation/Extensions/CodingGuidelines/Index.rst
new file mode 100644 (file)
index 0000000..13b9f72
--- /dev/null
@@ -0,0 +1,16 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _coding-guidelines:
+
+Coding Guidelines
+^^^^^^^^^^^^^^^^^
+
+For details on this, please look into the Project Coding Guidelines
+document - there is a section about this.
diff --git a/typo3/sysext/dbal/Documentation/Extensions/Index.rst b/typo3/sysext/dbal/Documentation/Extensions/Index.rst
new file mode 100644 (file)
index 0000000..c84dfbe
--- /dev/null
@@ -0,0 +1,24 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _dbal-compliant-extensions:
+
+Writing DBAL compliant TYPO3 extensions
+---------------------------------------
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       Introduction/Index
+       SqlStandard/Index
+       SmallCookbook/Index
+       CodingGuidelines/Index
diff --git a/typo3/sysext/dbal/Documentation/Extensions/Introduction/Index.rst b/typo3/sysext/dbal/Documentation/Extensions/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..5200c4f
--- /dev/null
@@ -0,0 +1,23 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _writing-extensions-introduction:
+
+Introduction
+^^^^^^^^^^^^
+
+If you want your TYPO3 extensions to be DBAL compliant you might have
+to rewrite parts of them. The most basic DBAL support is to substitute
+all direct ``mysql\*()`` function calls with the wrapper functions found
+in ``t3lib_db`` accessed through the global object ``$GLOBALS['TYPO3_DB']``.
+The most radical support is to consistently use the methods in the
+``t3lib_db`` class prefixed ``exec_`` - they will automatically create the
+proper SQL behind the scenes and execute the queries right away,
+returning a result pointer/object. This allows the DBAL to handle an
+ultimate amount of the interaction with the database for you.
diff --git a/typo3/sysext/dbal/Documentation/Extensions/SmallCookbook/Index.rst b/typo3/sysext/dbal/Documentation/Extensions/SmallCookbook/Index.rst
new file mode 100644 (file)
index 0000000..e6d794d
--- /dev/null
@@ -0,0 +1,67 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _small-cookbook:
+
+Small Cookbook
+^^^^^^^^^^^^^^
+
+
+.. _database-structure:
+
+Database Structure
+""""""""""""""""""
+
+MySQL supports ``text`` columns as part of a ``WHERE`` clause using equality
+while Oracle for instance does not. This means that if you need to do
+something like that:
+
+.. code-block:: sql
+
+       SELECT * FROM tx_ext WHERE column = 'something'
+
+Make sure **not to use** ``text`` as column type but instead use
+``varchar(4000)`` which is the limit for Oracle. The other solution is
+to use a ``LIKE`` operator:
+
+.. code-block:: sql
+
+       SELECT * FROM tx_ext WHERE column LIKE 'something'
+
+
+.. _where-clauses:
+
+WHERE Clauses
+"""""""""""""
+
+The SQL parser is not as powerful as it could be. Typical problems
+occur with calculated conditions such as
+
+.. code-block:: sql
+
+       ... WHERE column1 + number1 >= number2
+
+
+.. _rules-of-thumb:
+
+Rules of thumb
+~~~~~~~~~~~~~~
+
+#. The calculated part (``column1 + number1``) **must** start with a column
+   name
+
+#. The calculated part may have a column name or a number as second
+   operand
+
+#. The part after the operator (``number2``) **must** be a number
+
+#. The calculated part **can only** occur on the left hand of the
+   comparison operator
+
+#. More than two operands on the left hand **are not** supported
diff --git a/typo3/sysext/dbal/Documentation/Extensions/SqlStandard/Index.rst b/typo3/sysext/dbal/Documentation/Extensions/SqlStandard/Index.rst
new file mode 100644 (file)
index 0000000..3352daa
--- /dev/null
@@ -0,0 +1,72 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _sql-standard:
+
+SQL standard
+^^^^^^^^^^^^
+
+When the core of TYPO3 including a number of global extensions were
+converted to the database wrapper class, ``t3lib_db``, it was found that
+the usage of SQL in TYPO3 was luckily quite simple and consistently
+using the same features. This made it fairly easy to convert the whole
+application into using the wrapper functions. But it also meant that
+there was a basis for defining a subset of the MySQL features that are
+those officially supported by TYPO3.
+
+Yet, this subset is not defined in a document but there exist a class,
+``t3lib_sqlengine``, which contains parser functions for SQL and
+compliance with "TYPO3 sql" is basically defined by whether this class
+can parse your SQL without errors. (The debug-options /DBAL debug
+backend module from this extension can be helpful to spot non-
+compliant SQL.)
+
+This means that TYPO3 now has an official "SQL abstraction language"
+based on SQL itself and being a subset of the features that MySQL has.
+Contrary to creating SQL code from a homemade abstraction language
+there are several advantages in using (a subset of) SQL itself  *as*
+the abstraction language:
+
+- We do not re-invent the wheel by imposing a new "SQL abstraction
+  language" for programmers - they just use simple SQL.
+
+- MySQL (and compatibles) has "native" support and does not need
+  translation (= high speed for our primary database).
+
+- Other databases might need transformation but the overhead can be
+  reduced drastically by simply using the right functions in the DBAL -
+  optionally. And basically such transformation is what would otherwise
+  occur with *any* abstraction language anyways.
+
+- We are able to parse the SQL and validate conformity with the "TYPO3
+  SQL standard" defined at any time by ``t3lib_sqlengine`` - and we can
+  always extend it as need arises.
+
+
+.. _sql-calls:
+
+SQL calls
+"""""""""
+
+The PHP API for MySQL contains a long list of functions. By the
+inspection of the TYPO3 core it was found that only quite few of these
+were used and subsequently only those has made it into the ``t3lib_db``
+class (For instance ``mysql()`` was typically used to execute a query and
+subsequently the result was traversed by ``mysql_fetch_assoc()`` in 95%
+of the cases).
+
+The wrapper functions in the class ``t3lib_db`` are now the only
+functions that are "allowed" to be used for database connectivity and
+it is believed that these functions is sufficient for all TYPO3
+extension programmers. By defining such a limited set of functions we
+might force some users to change their "habits" of using MySQL/SQL
+databases but we believe that this is good in another way since we get
+more consistent code across extensions. If it turns out that some new
+functions are needed in the wrapper class it must be based on the
+strength of arguments.
diff --git a/typo3/sysext/dbal/Documentation/Faq/Index.rst b/typo3/sysext/dbal/Documentation/Faq/Index.rst
new file mode 100644 (file)
index 0000000..1f48140
--- /dev/null
@@ -0,0 +1,124 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _faq:
+
+FAQ
+---
+
+
+.. _how-to-import-db-dumps-with-the-install-tool:
+
+How to import DB dumps with the install tool
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to move a site from a MySQL setup to a DBAL setup with
+another database, you can either use the Import/Export extension
+(impexp) or create a dump to be imported by the install tool. For this
+to work a few hints should be followed:
+
+#. Create the MySQL using mysqldump with thses
+   options:--compatible=mysql40 --complete-insert --skip-opt --skip-
+   quote-names --skip-comments
+
+   Empty tables as well as cache\_\*, session\_\* and maybe the sys\_log
+   and sys\_history (according to your preference) can be left out of the
+   dump.
+
+#. Make sure the dump has no backticks around table or field names
+   (during testing there still were some, despite the options above being
+   used). Don't do an unconditional replace over the whole dump, though,
+   as there may be backticks inside the actual data. Be careful!
+
+#. Put the dump in ``typo3conf/`` and import it using the install tool.
+
+#. Now use the "Update required tables COMPARE" in the install tool to
+   create the remaining missing or changed tables and fields.
+
+
+.. _can-i-put-the-cache-tables-in-a-different-database:
+
+Can I put the cache tables in a different database?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Yes, you can map the cache tables somewhere else. There is one caveat,
+though – if you put the ``cache_pages`` table into a different database
+than the pages table the FE will throw an error. The ``tslib_fe`` class
+uses a join over those two tables, which cannot work. Never.
+
+You can do two things to work around this: Use the file-based caching
+that is available since TYPO3 4.0.0 or apply the patch
+``class.tslib_fe.php.diff`` found in the ``doc/`` directory of the DBAL
+extension ( **beware:** this patch is not maintained anymore and may
+not apply cleanly to new versions of TYPO3).
+
+
+.. _what-happens-to-the-table-definitions-in-mysql-format:
+
+What happens to the table definitions in MySQL format?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Right, all table definitions in TYPO3 and it's extensions come in a
+format compatible to what mysqldump produces. Still, the DBAL can
+handle this, and here are the rules that apply when the ADOdb handler
+is used:
+
+- MySQL field types are mapped onto meta types, taken from ADOdb, but
+  adapted to better fit the needs of TYPO3. From those field types the
+  actual types for the target database are generated with the ADOdb
+  library.
+
+- If we need to map the actual field type in the database back onto a
+  MySQL type, we use the same system backwards. This explains why most
+  field type comparisons don't match exactly. An example: a TINYINT is
+  mapped to the meta type I2, this is mapped to some DB-specific type.
+  Later the actual type is mapped back to I2 and then to SMALLINT. Bang,
+  the types do not match.
+
+- If a field has no default value assigned in the dump, it is assigned
+  either 0 or an empty string as default (depending on it's type). This
+  is done to fake the implicit default values MySQL assigns to fields
+  that have no explicit default.
+
+- The UNSIGNED attribute for integer fields is dropped for all databases
+  except MySQL when using the ADOdb handler, as it is MySQL specific.
+
+- The AUTO\_INCREMENT attribute is never used for the ADOdb handler,
+  (emulated) sequences are used instead.
+
+- If a field is declared NOT NULL in the MySQL dump, this will be
+  changed to allow NULL if running on Oracle..
+
+Notice: For the native handler no conversion is done.
+
+
+.. _why-drop-not-null-constraints-and-add-default-values:
+
+Why drop NOT NULL constraints and add default values?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+All the NOT NULL fields in the database dumps only work on MySQL,
+because *all* fields *always* have a default value in MySQL, even if
+none is given explicitly, if they are NOT NULL. Yes, MySQL always
+assigns a default value – there are no fields without a default value.
+
+In other databases this is not the case, so that any NOT NULL field
+not being assigned a value during an INSERT triggers an error. This in
+itself is perfectly fine, were TYPO3 not to omit a lot of fields in a
+lot INSERT queries. This is why a default value is always added – it
+avoids errors during INSERT queries.
+
+Now, we still drop the NOT NULL when running on Oracle, why is that
+the case? Oracle treats an empty string as being null, so you cannot
+insert an empty string into a field being NOT NULL. Furthermore,
+having an empty string as default value is the same as having null as
+default value. The bottom line is: it does not work having a NOT NULL
+field with NULL as default, as you would get errors during INSERT. Now
+go and complain to the folks over at Oracle...
+
diff --git a/typo3/sysext/dbal/Documentation/Images/DebugLog.png b/typo3/sysext/dbal/Documentation/Images/DebugLog.png
new file mode 100644 (file)
index 0000000..cab8e36
Binary files /dev/null and b/typo3/sysext/dbal/Documentation/Images/DebugLog.png differ
diff --git a/typo3/sysext/dbal/Documentation/Includes.txt b/typo3/sysext/dbal/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..38aa398
--- /dev/null
@@ -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
diff --git a/typo3/sysext/dbal/Documentation/Index.rst b/typo3/sysext/dbal/Documentation/Index.rst
new file mode 100644 (file)
index 0000000..505739e
--- /dev/null
@@ -0,0 +1,70 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+.. _start:
+
+==========================
+Database Abstraction Layer
+==========================
+
+:Extension key:
+      dbal
+
+:Version:
+      6.2
+
+:Language:
+      en
+
+:Description:
+      Manual of the system extension DBAL, which provides an abstraction
+      layer in order to allow easy usage of TYPO3 with a broad variety of
+      database management systems.
+
+:Keywords:
+      database, abstraction, oracle, postgresql, mssql
+
+:Copyright:
+      2000-2013
+
+:Author:
+      TYPO3 CMS Core Development Team
+
+:License:
+      Open Content License available from `www.opencontent.org/opl.shtml
+      <http://www.opencontent.org/opl.shtml>`_
+
+:Rendered:
+      |today|
+
+The content of this document is related to TYPO3,
+
+a GNU/GPL CMS/Framework available from `www.typo3.org
+<http://www.typo3.org/>`_
+
+
+
+
+**Table of Contents**
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       Introduction/Index
+       Configuration/Index
+       DebugBackendModule/Index
+       InstallingWithDbal/Index
+       Extensions/Index
+       KnownProblems/Index
+       Faq/Index
+       Bugs/Index
+       To-doList/Index
+       Appendices/Index
+       Targets
diff --git a/typo3/sysext/dbal/Documentation/InstallingWithDbal/DoingTheActualSetup/Index.rst b/typo3/sysext/dbal/Documentation/InstallingWithDbal/DoingTheActualSetup/Index.rst
new file mode 100644 (file)
index 0000000..4fe9b91
--- /dev/null
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _doing-the-actual-setup:
+
+Doing the actual setup
+^^^^^^^^^^^^^^^^^^^^^^
+
+Now fire up a browser and visit your new TYPO3 install – you should
+get redirected to the install tool in 1-2-3 mode. Fill in the database
+connection parameters and you should get a list of present databases
+to choose from (if any exist and are accessible to the user entered).
+If everything went well up to this point, just continue as usual.
+
+If the 1-2-3 more doesn't work, just go to the regular mode and work
+your way through the setup.
+
+**Try not to create a database from within the install tool,** this
+doesn't work anyway (and it probably never will).
+
diff --git a/typo3/sysext/dbal/Documentation/InstallingWithDbal/Index.rst b/typo3/sysext/dbal/Documentation/InstallingWithDbal/Index.rst
new file mode 100644 (file)
index 0000000..b5f1ac4
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _installing-with-dbal:
+
+Installing from scratch with DBAL
+---------------------------------
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       Introduction/Index
+       PreparingSetup/Index
+       DoingTheActualSetup/Index
diff --git a/typo3/sysext/dbal/Documentation/InstallingWithDbal/Introduction/Index.rst b/typo3/sysext/dbal/Documentation/InstallingWithDbal/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..5deca87
--- /dev/null
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _installation-introduction:
+
+Introduction
+^^^^^^^^^^^^
+
+Installing with DBAL enabled right from the start isn't as easy as it
+may seem. You need to have two extensions (the DBAL itself and the
+ADOdb library) installed before even setting up the core system. How
+this can be done is explained in this section.
diff --git a/typo3/sysext/dbal/Documentation/InstallingWithDbal/PreparingSetup/Index.rst b/typo3/sysext/dbal/Documentation/InstallingWithDbal/PreparingSetup/Index.rst
new file mode 100644 (file)
index 0000000..bcdf101
--- /dev/null
@@ -0,0 +1,44 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _preparing-setup:
+
+Preparing setup
+^^^^^^^^^^^^^^^
+
+Unpack the TYPO3 source as usual, and unpack a dummy package. Set
+everything up as explained in the setup documentation, until you come
+to the point where you are asked to start the install tool – DON'T DO
+THIS YET!
+
+Extensions DBAL and ADOdb are part of the system extensions shipped
+with TYPO3. As such, you only have to load them.
+
+Edit the file ``typo3conf/localconf.php`` and append "adodb,dbal" to
+the comma-separated list of extensions found in
+``$TYPO3_CONF_VARS['EXT']``. Another option is to add following code to
+the end of the file::
+
+       $TYPO3_CONF_VARS['EXT']['extList'] .= ',adodb,dbal';
+
+Now add following code to the end of the same file ``typo3conf/localconf.php``::
+
+       $TYPO3_CONF_VARS['EXTCONF']['dbal']['handlerCfg'] = array(
+           '_DEFAULT' => array(
+               'type' => 'adodb',
+              'config' => array(
+                  'driver' => 'mysql',
+              )
+          ),
+       );
+
+Of course you need to adjust the DBAL configuration as you need to,
+the example above does nothing but route everything through ADOdb
+inside the DBAL extension. See appendices for specific DBMS setup
+tutorials.
diff --git a/typo3/sysext/dbal/Documentation/Introduction/Index.rst b/typo3/sysext/dbal/Documentation/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..83a9bbe
--- /dev/null
@@ -0,0 +1,66 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _introduction:
+
+Introduction
+------------
+
+
+.. _what-does-it-do:
+
+What does it do?
+^^^^^^^^^^^^^^^^
+
+It provides a layer for support of other core databases (DBMS) in
+TYPO3 than the default database support based on MySQL. Further, each
+layer can be selected on a per-table basis, thus offering storage of
+content from TYPO3 in multiple databases and multiple formats.
+
+The support is possible through the well known PHP database API ADOdb.
+The extension also supports any user-defined layer you can make
+yourself thus offering unlimited possibilities for connectivity.
+
+
+.. _technical-details:
+
+Technical details
+^^^^^^^^^^^^^^^^^
+
+This extension works by overriding class :code:`\TYPO3\CMS\Core\Database\DatabaseConnection`
+in order to parse query and rebuild them in a way compatible with
+multiple RDBMS.
+
+Without the DBAL extension installed TYPO3 CMS works as usual
+and with virtually no overhead in database
+connectivity. DBAL offers support for other databases than
+MySQL at the cost of parsing and rewriting queries.
+
+
+.. _working-databases:
+
+Working databases
+^^^^^^^^^^^^^^^^^
+
+The following databases have been tested and are known to work in
+general. This means, not every aspect has been thoroughly checked, but
+TYPO3 has been installed from scratch successfully, BE logins are
+possible, and basic websites can be created (template, pages, content
+elements):
+
+- MySQL 5.x
+
+- Microsoft SQL Server 2000
+
+- PostgreSQL 7.x and 8.x
+
+- Oracle 8, 9, 10 and 11
+
+- Firebird 1.5.2
+
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/ChangingOfTableOrFieldDefinitionsThroughDbal/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/ChangingOfTableOrFieldDefinitionsThroughDbal/Index.rst
new file mode 100644 (file)
index 0000000..36e3141
--- /dev/null
@@ -0,0 +1,29 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _changing-of-table-or-field-definitions-through-dbal:
+
+Changing of table or field definitions through DBAL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+MySQL allows the user to change nearly everything at runtime, you can
+change field types, constraints, defaults and more on a field and
+MySQL handles data conversion and similar tasks transparently. This
+does work very differently with many other DB systems, some things do
+not work at all. Since we rely on existing abstraction libraries, we
+are bound to what they offer. There may be cases in which it simply is
+impossible to do a needed change to the database automatically.
+
+It is even problematic to add fields to existing tables, although this
+seems like a rather simple thing to do. But, alas, it is not.
+
+It must be noted that e.g. the recent version 8.0 of PostgreSQL was a
+huge step forward in that direction, as it allows a lot more of those
+operations in an easy way, than earlier versions. So if you want to
+run TYPO3 on PostgreSQL, use version 8.0 or later, if possible.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/CreatingADatabaseFromWithinTheInstallTool/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/CreatingADatabaseFromWithinTheInstallTool/Index.rst
new file mode 100644 (file)
index 0000000..edb0e22
--- /dev/null
@@ -0,0 +1,16 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _creating-a-database-from-within-the-install-tool:
+
+Creating a database from within the install tool
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Because of the differences between the way RDBMS create databases,
+this isn't possible and probably never will be.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/DatabaseCheckInBackend/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/DatabaseCheckInBackend/Index.rst
new file mode 100644 (file)
index 0000000..f51117f
--- /dev/null
@@ -0,0 +1,17 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _database-check-in-backend:
+
+Database Check in Backend
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The *Advanced Query* tool in the *Full Search* of the *DB Check* in
+the backend does not "speak DBAL" yet, so it will not work with anything
+but MySQL until this has been worked on.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/DatabaseSpecificIssues/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/DatabaseSpecificIssues/Index.rst
new file mode 100644 (file)
index 0000000..3a4b60a
--- /dev/null
@@ -0,0 +1,64 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _database-specific-issues:
+
+Database-specific issues
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+.. _native-handler:
+
+Native handler
+""""""""""""""
+
+The native handler currently does not support importing static data
+through the install tool or EM, the import will be incomplete in most
+cases.
+
+
+.. _postgresql:
+
+PostgreSQL
+""""""""""
+
+Currently altering an existing column is not supported, as the
+underlying ADOdb library needs a full table description to do that, as
+on PostgreSQL you need to drop and recreate a table to change it's
+type (this has changed in PostgreSQL 8, but ADOdb doesn't support this
+yet).
+
+
+.. _mssql:
+
+MSSQL
+"""""
+
+Tests have shown you need to
+
+- enable ANSI quotes (``SET QUOTED_IDENTIFIER ON``). This can also be done
+  through the management console:MS SQL Server Management Studio
+  (Express) -> Choose DB (context menu) -> Properties -> Options ->
+  Miscellaneous / Quoted Identifiers Enabled : true
+
+- set the max text length in ``php.ini`` to a value higher than the default
+  of 4kB; Valid range 0 - 2147483647. Default = 4096.mssql.textlimit =
+  5000000; Valid range 0 - 2147483647. Default = 4096.mssql.textsize =
+  5000000
+
+- Problems with persistent connections were reported, so if you run into
+  trouble, disable them in ``php.ini``
+
+- On SQL Server there are many options regarding the handling of ``NULL`` in
+  comparisons. You can make ``"a"=NULL`` to return undefined, ``FALSE``, or ``TRUE``
+  depending on a server config. Maybe this helps with certain
+  problems...
+
+More problems will arise, depending on the setup details. Further
+fixes and documentation is being worked on.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/Index.rst
new file mode 100644 (file)
index 0000000..cdb8a53
--- /dev/null
@@ -0,0 +1,27 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _known-problems:
+
+Known problems
+--------------
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       DatabaseSpecificIssues/Index
+       ResultsOfDatabaseComparisonOperations/Index
+       ChangingOfTableOrFieldDefinitionsThroughDbal/Index
+       DatabaseCheckInBackend/Index
+       SequencesCollideWithImportedData/Index
+       SomeFieldNamesAreTooLong/Index
+       CreatingADatabaseFromWithinTheInstallTool/Index
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/ResultsOfDatabaseComparisonOperations/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/ResultsOfDatabaseComparisonOperations/Index.rst
new file mode 100644 (file)
index 0000000..08b84d2
--- /dev/null
@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _results-of-database-comparison-operations:
+
+Results of database comparison operations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Whenever a database structure comparison is done, it is likely that
+differences are detected, that have no real background. The
+*unsigned* attribute used with integer fields in MySQL for instance
+has no equivalent in PostgreSQL. Thus if a change is suggested that
+would solely try to add this attribute, just ignore it. To make this
+easier the changes that are usually preselected in the install tool
+are not, when the DBAL extension is detected.
+
+Similar "errors" will be detected for certain field types and probably
+keys/indexes. You have to use common sense and your DB background
+knowledge to move around those issues.
+
+On some databases you might even see keys that should be dropped or
+created, most of the time this is bogus, too.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/SequencesCollideWithImportedData/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/SequencesCollideWithImportedData/Index.rst
new file mode 100644 (file)
index 0000000..f5ce1f6
--- /dev/null
@@ -0,0 +1,20 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _sequences-collide-with-imported-data:
+
+Sequences collide with imported data
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have imported data into a table that is not running on MySQL,
+you may see error messages when inserting a new record (see e.g., bug
+#15314 on `http://forge.typo3.org/ <http://forge.typo3.org/issues/15314>`_ ).
+This can be avoided by setting the sequence start to a number higher then
+the highest ID already in use in all the tables for that handler. See
+above for the configuration syntax.
diff --git a/typo3/sysext/dbal/Documentation/KnownProblems/SomeFieldNamesAreTooLong/Index.rst b/typo3/sysext/dbal/Documentation/KnownProblems/SomeFieldNamesAreTooLong/Index.rst
new file mode 100644 (file)
index 0000000..60e2e67
--- /dev/null
@@ -0,0 +1,20 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _some-field-names-are-too-long:
+
+Some field names are too long
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Oracle for example has a restriction on table and field names, they
+can only be 30 bytes long. Some fields, especially of extensions
+adding fields to existing tables may violate that restriction. A way
+to work around this is to configure a field name mapping for those
+long names onto a shorter one before creating them (through the
+Extension Manager or Install Tool).
diff --git a/typo3/sysext/dbal/Documentation/Settings.yml b/typo3/sysext/dbal/Documentation/Settings.yml
new file mode 100644 (file)
index 0000000..69d0e81
--- /dev/null
@@ -0,0 +1,11 @@
+# This is the project specific Settings.yml file.
+# Place Sphinx specific build information here.
+# Settings given here will replace the settings of 'conf.py'.
+
+---
+conf.py:
+  copyright: 1997-2013
+  project: dbal
+  version: 6.2.0
+  release: 6.2.0
+...
diff --git a/typo3/sysext/dbal/Documentation/Targets.rst b/typo3/sysext/dbal/Documentation/Targets.rst
new file mode 100644 (file)
index 0000000..c7c43c0
--- /dev/null
@@ -0,0 +1,13 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+.. _index-labels-for-crossreferencing:
+
+Index: Labels for Crossreferencing
+==================================
+
+.. ref-targets-list::
diff --git a/typo3/sysext/dbal/Documentation/To-doList/GeneralTodo/Index.rst b/typo3/sysext/dbal/Documentation/To-doList/GeneralTodo/Index.rst
new file mode 100644 (file)
index 0000000..0d7e114
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _general-todo:
+
+General TODO:
+^^^^^^^^^^^^^
+
+- Implement and test other databases with ADOdb and PEAR
+
+- Create any amount of management needed
+
+- Support for people implementing DBAL (I imagine there is a contact
+  person per DBMS implemented)
+
diff --git a/typo3/sysext/dbal/Documentation/To-doList/Index.rst b/typo3/sysext/dbal/Documentation/To-doList/Index.rst
new file mode 100644 (file)
index 0000000..8a7cb27
--- /dev/null
@@ -0,0 +1,31 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _to-do-list:
+
+To-Do list
+----------
+
+This list has been radically edited for version 0.9.9 after being the
+unchanged TODO.txt in the doc directory for a rather long time. It is
+now much shorter but still needs some points to be checked and added.
+
+However, since the stable release of DBAL 1.0.0 with TYPO3 4.3.0, the
+goal is really to support as many extensions as possible rather than
+add fancy features...
+
+
+.. toctree::
+       :maxdepth: 5
+       :titlesonly:
+       :glob:
+
+       NewFeatures/Index
+       GeneralTodo/Index
+       Oracle/Index
diff --git a/typo3/sysext/dbal/Documentation/To-doList/NewFeatures/Index.rst b/typo3/sysext/dbal/Documentation/To-doList/NewFeatures/Index.rst
new file mode 100644 (file)
index 0000000..92f03cb
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _new-features:
+
+New Features?
+^^^^^^^^^^^^^
+
+- Support for Extbase, the new MVC framework that is part of TYPO3 4.3
+
+- User processing hooks implemented on tables/fields etc.
+
+- ReadOnly control on tables/handlers
+
+- Persistent connections configured as an option per handler?
+
diff --git a/typo3/sysext/dbal/Documentation/To-doList/Oracle/Index.rst b/typo3/sysext/dbal/Documentation/To-doList/Oracle/Index.rst
new file mode 100644 (file)
index 0000000..3d263ec
--- /dev/null
@@ -0,0 +1,23 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _oracle-to-do:
+
+Oracle
+^^^^^^
+
+- Insert a string longer than the size of the field in the database
+  (MySQL just silently accepts this...) - so will we have to evaluate
+  all values in update/insert queries first?
+
+- Does not allow us to CHANGE existing fields into something else - only
+  create new fields, otherwise we must export/import database.
+
+- A quoted value cannot be inserted into an integer field!!!
+
diff --git a/typo3/sysext/dbal/doc/class.tslib_fe.php.diff b/typo3/sysext/dbal/doc/class.tslib_fe.php.diff
deleted file mode 100644 (file)
index 5a1739e..0000000
+++ /dev/null
@@ -1,39 +0,0 @@
-Index: typo3/sysext/cms/tslib/class.tslib_fe.php
-===================================================================
-RCS file: /cvsroot/typo3/TYPO3core/typo3/sysext/cms/tslib/class.tslib_fe.php,v
-retrieving revision 1.104.2.25
-diff -u -w -r1.104.2.25 class.tslib_fe.php
---- typo3/sysext/cms/tslib/class.tslib_fe.php  7 Jun 2006 10:02:10 -0000       1.104.2.25
-+++ typo3/sysext/cms/tslib/class.tslib_fe.php  27 Jun 2006 19:36:14 -0000
-@@ -1579,16 +1579,22 @@
-               $GLOBALS['TT']->push('Cache Query','');
-                       $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
--                              'S.*',
--                              'cache_pages S,pages P',
--                              'S.hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->newHash, 'cache_pages').'
--                                      AND S.page_id=P.uid
--                                      AND S.expires > '.intval($GLOBALS['EXEC_TIME']).'
--                                      AND P.deleted=0
--                                      AND P.hidden=0
--                                      AND P.starttime<='.intval($GLOBALS['EXEC_TIME']).'
--                                      AND (P.endtime=0 OR P.endtime>'.intval($GLOBALS['EXEC_TIME']).')'
-+                                              '*',
-+                                              'cache_pages',
-+                                              'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->newHash, 'cache_pages').'
-+                                                      AND expires > '.intval($GLOBALS['EXEC_TIME'])
-                       );
-+              if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
-+                      $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
-+                                              'uid',
-+                                              'pages',
-+                                              'uid='.$row['page_id'].'
-+                                                      AND deleted=0
-+                                                      AND hidden=0
-+                                                      AND starttime<='.intval($GLOBALS['EXEC_TIME']).'
-+                                                      AND (endtime=0 OR endtime>'.intval($GLOBALS['EXEC_TIME']).')'
-+                                      );
-+              }
-               $GLOBALS['TT']->pull();
-               if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
diff --git a/typo3/sysext/dbal/doc/manual.sxw b/typo3/sysext/dbal/doc/manual.sxw
deleted file mode 100644 (file)
index a28b545..0000000
Binary files a/typo3/sysext/dbal/doc/manual.sxw and /dev/null differ
diff --git a/typo3/sysext/felogin/Documentation/.gitignore b/typo3/sysext/felogin/Documentation/.gitignore
new file mode 100644 (file)
index 0000000..6cd159f
--- /dev/null
@@ -0,0 +1,7 @@
+# this is file .gitignore
+
+# ignore everything in this directory
+_make/*
+
+# but do not ignore this file
+!_not_versioned/.gitignore
diff --git a/typo3/sysext/felogin/Documentation/Configuration/Index.rst b/typo3/sysext/felogin/Documentation/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..f8dd5af
--- /dev/null
@@ -0,0 +1,1034 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _configuration:
+
+Configuration
+-------------
+
+All configuration options are available in the FlexForm or TypoScript,
+with the FlexForm settings taking precedence.
+
+
+.. _plugin-tx-felogin-pi1:
+
+plugin.tx\_felogin\_pi1
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. _storagepid:
+
+storagePid
+""""""""""
+
+.. container:: table-row
+
+   Property
+         storagePid
+
+   Data type
+         string
+
+   Description
+         Define the Storage Folder with the Website User Records, using a comma
+         seperated list or single value
+
+   Default
+         {$styles.content.loginform.pid}
+
+
+
+.. _recursive:
+
+recursive
+"""""""""
+
+.. container:: table-row
+
+   Property
+         recursive
+
+   Data type
+         bool
+
+   Description
+         If set, also any subfolders of the storagePid will be used
+
+
+
+.. _templatefile:
+
+templateFile
+""""""""""""
+
+.. container:: table-row
+
+   Property
+         templateFile
+
+   Data type
+         string
+
+   Description
+         The Template File
+
+   Default
+         EXT:felogin/template.html
+
+
+
+.. _feloginbaseurl:
+
+feloginBaseURL
+""""""""""""""
+
+.. container:: table-row
+
+   Property
+         feloginBaseURL
+
+   Data type
+         string
+
+   Description
+         Base url if something other than the system base URL is needed
+
+
+
+.. _wrapcontentinbaseclass:
+
+wrapContentInBaseClass
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         wrapContentInBaseClass
+
+   Data type
+         bool
+
+   Description
+         If set, plugin is wrapped by Standard Base Class-Wrap
+
+   Default
+         true
+
+
+
+.. _linkconfig:
+
+linkConfig
+""""""""""
+
+.. container:: table-row
+
+   Property
+         linkConfig
+
+   Data type
+         array
+
+   Description
+         Typolink Configuration for the generated Links
+
+
+
+.. _preservegetvars:
+
+preserveGETvars
+"""""""""""""""
+
+.. container:: table-row
+
+   Property
+         preserveGETvars
+
+   Data type
+         String
+
+   Description
+         When using login plugin on a page with other plugins you might want to
+         have your GET-params preserved. You can define them here. Possible
+         settings:
+
+         all - takes all GET-vars found
+
+         comma-separated list - takes defined vars
+
+         Example::
+
+            preserveGETvars = tx_ttnews[tt_news],tx_myext[id],...
+
+
+
+.. _showforgotpasswordlink:
+
+showForgotPasswordLink
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         showForgotPasswordLink
+
+   Data type
+         bool
+
+   Description
+         If set, the section in the template to display the link to the forget
+         password dialogue is visible.
+
+
+
+.. _showpermalogin:
+
+showPermaLogin
+""""""""""""""
+
+.. container:: table-row
+
+   Property
+         showPermaLogin
+
+   Data type
+         bool
+
+   Description
+         If set, the section in the template to display the option to remember
+         the login (with a cookie) is visible.
+
+
+
+.. _forgetlinkhashvalidtime:
+
+forgetLinkHashValidTime
+"""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         forgetLinkHashValidTime
+
+   Data type
+         integer
+
+   Description
+         How many hours the link for forget password is valid
+
+   Default
+         12
+
+
+
+.. _newpasswordminlength:
+
+newPasswordMinLength
+""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         newPasswordMinLength
+
+   Data type
+         integer
+
+   Description
+         Minimum length of the new password a user sets
+
+   Default
+         6
+
+
+
+.. _showlogoutformafterlogin:
+
+showLogoutFormAfterLogin
+""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         showLogoutFormAfterLogin
+
+   Data type
+         bool
+
+   Description
+         If set, the logout form will be displayed immediately after successful
+         login.
+
+         .. note::
+
+            Setting this option will disable the redirect options!
+            Instead of redirecting the plugin will show the logout form.
+
+
+
+.. _welcomeheader-stdwrap:
+
+welcomeHeader\_stdWrap
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         welcomeHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Welcome Header
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _welcomemessage-stdwrap:
+
+welcomeMessage\_stdWrap
+"""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         welcomeMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Welcome Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _successheader-stdwrap:
+
+successHeader\_stdWrap
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         successHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Login SuccessHeader
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _successmessage-stdwrap:
+
+successMessage\_stdWrap
+"""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         successMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Login Success Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _logoutheader-stdwrap:
+
+logoutHeader\_stdWrap
+"""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         logoutHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Logout Header
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _logoutmessage-stdwrap:
+
+logoutMessage\_stdWrap
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         logoutMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Logout Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _errorheader-stdwrap:
+
+errorHeader\_stdWrap
+""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         errorHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Error Header
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _errormessage-stdwrap:
+
+errorMessage\_stdWrap
+"""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         errorMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Error Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _forgotheader-stdwrap:
+
+forgotHeader\_stdWrap
+"""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         forgotHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Forgot Header
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _forgotmessage-stdwrap:
+
+forgotMessage\_stdWrap
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         forgotMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Forgot Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _forgoterrormessage-stdwrap:
+
+forgotErrorMessage\_stdWrap
+"""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         forgotErrorMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for error message in forgot password form
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _forgotresetmessageemailsentmessage-stdwrap:
+
+forgotResetMessageEmailSentMessage\_stdWrap
+"""""""""""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         forgotResetMessageEmailSentMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for message that password reset mail was sent
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _changepasswordnotvalidmessage-stdwrap:
+
+changePasswordNotValidMessage\_stdWrap
+""""""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordNotValidMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for message that changed password was not valid
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _changepasswordtooshortmessage-stdwrap:
+
+changePasswordTooShortMessage\_stdWrap
+""""""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordTooShortMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for message that new password was too short
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _changepasswordnotequalmessage-stdwrap:
+
+changePasswordNotEqualMessage\_stdWrap
+""""""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordNotEqualMessage\_stdWrap
+
+   Data type
+
+
+   Description
+         stdWrap for message that new passwords were not equal
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _changepasswordheader-stdwrap:
+
+changePasswordHeader\_stdWrap
+"""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordHeader\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Change Password Header
+
+   Default
+         wrap = <h3>\|</h3>
+
+
+
+.. _changepasswordmessage-stdwrap:
+
+changePasswordMessage\_stdWrap
+""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for Change Password Message
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _changepassworddonemessage-stdwrap:
+
+changePasswordDoneMessage\_stdWrap
+""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         changePasswordDoneMessage\_stdWrap
+
+   Data type
+         array
+
+   Description
+         stdWrap for message that password was changed
+
+   Default
+         wrap = <div>\|</div>
+
+
+
+.. _userfields:
+
+userfields
+""""""""""
+
+.. container:: table-row
+
+   Property
+         userfields
+
+   Data type
+         array
+
+   Description
+         Array of fields from the fe\_users table. Each field can have its own
+         stdWrap configuration. These fields can be used as markers in the
+         template (e.g. ###USERNAME###)
+
+   Default
+         ::
+
+            username {
+                htmlSpecialChars = 1
+                wrap = <strong>\|</strong>
+            }
+
+
+
+.. _redirectmode:
+
+redirectMode
+""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectMode
+
+   Data type
+         string
+
+   Description
+         Comma separated list of redirect modes. Possible values:
+
+         groupLogin, userLogin, login, getpost, referer, refererDomains,
+         loginError, logout
+
+         See section on redirect modes for details.
+
+
+
+.. _redirectfirstmethod:
+
+redirectFirstMethod
+"""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectFirstMethod
+
+   Data type
+         bool
+
+   Description
+         If set the first method from redirectMode which is possible will be
+         used
+
+
+
+.. _redirectpagelogin:
+
+redirectPageLogin
+"""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectPageLogin
+
+   Data type
+         integer
+
+   Description
+         Page id to redirect to after Login
+
+
+
+.. _redirectpageloginerror:
+
+redirectPageLoginError
+""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectPageLoginError
+
+   Data type
+         integer
+
+   Description
+         Page id to redirect to after Login Error
+
+
+
+.. _redirectpagelogout:
+
+redirectPageLogout
+""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectPageLogout
+
+   Data type
+         integer
+
+   Description
+         Page id to redirect to after Logout
+
+
+
+.. _redirectdisable:
+
+redirectDisable
+"""""""""""""""
+
+.. container:: table-row
+
+   Property
+         redirectDisable
+
+   Data type
+         bool
+
+   Description
+         If set redirecting is disabled
+
+
+
+.. _email-from:
+
+email\_from
+"""""""""""
+
+.. container:: table-row
+
+   Property
+         email\_from
+
+   Data type
+         string
+
+   Description
+         Email address used as sender of the change password emails
+
+
+
+.. _email-fromname:
+
+email\_fromName
+"""""""""""""""
+
+.. container:: table-row
+
+   Property
+         email\_fromName
+
+   Data type
+         string
+
+   Description
+         Name used as sender of the change password emails
+
+
+
+.. _replyto:
+
+replyTo
+"""""""
+
+.. container:: table-row
+
+   Property
+         replyTo
+
+   Data type
+         string
+
+   Description
+         Reply-to address used in the change password emails
+
+
+
+.. _domains:
+
+domains
+"""""""
+
+.. container:: table-row
+
+   Property
+         domains
+
+   Data type
+         string
+
+   Description
+         Comma separated list of domains which are allowed for the referrer
+         redirect mode
+
+
+
+.. _dateformat:
+
+dateFormat
+""""""""""
+
+.. container:: table-row
+
+   Property
+         dateFormat
+
+   Data type
+         date-conf
+
+   Description
+         Format for the link is valid until message (forget password email)
+
+   Default
+         Y-m-d H:i
+
+
+
+.. _linkprefix:
+
+linkPrefix
+""""""""""
+
+.. container:: table-row
+
+   Property
+         linkPrefix
+
+   Data type
+         string
+
+   Description
+         Prefix for the link sent in the forgot password email
+
+
+
+.. _exposenonexistentuserinforgotpassworddialog:
+
+exposeNonexistentUserInForgotPasswordDialog
+"""""""""""""""""""""""""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         exposeNonexistentUserInForgotPasswordDialog
+
+   Data type
+         bool
+
+   Description
+         If set and the user account cannot be found in the forgot password
+         dialogue, an error message will be shown that the account could not be
+         found.
+
+         .. warning::
+
+            Enabling this will disclose information about whether an
+            email address is actually used for a frontend user account! Visitors
+            can find out if a user is known as frontend user.
+
+   Default
+         0
+
+
+
+.. _css-default-style:
+
+\_CSS\_DEFAULT\_STYLE
+"""""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         \_CSS\_DEFAULT\_STYLE
+
+   Data type
+         string
+
+   Description
+         CSS included in the page containing the login form
+
+   Default
+         ::
+
+            .tx-felogin-pi1 label {
+                display: block;
+            }
+
+
+.. _default-pi-vars:
+
+\_DEFAULT\_PI\_VARS
+"""""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         \_DEFAULT\_PI\_VARS
+
+   Data type
+         array
+
+   Description
+         Default values for variables sent from the forms.
+
+
+.. _local-lang:
+
+\_LOCAL\_LANG
+"""""""""""""
+
+.. container:: table-row
+
+   Property
+         \_LOCAL\_LANG (+ "." + "default" or language code)
+
+   Data type
+         array
+
+   Description
+         Localized labels that can be overridden per TypoScript.
+
+         =========================================== =================================
+         Label                                       Usage
+         =========================================== =================================
+         ll\_welcome\_header                         Status header
+         ll\_welcome\_message                        Status message
+         ll\_logout\_header                          Status header
+         ll\_logout\_message                         Status message
+         ll\_error\_header                           Status header
+         ll\_error\_message                          Status message
+         ll\_success\_header                         Status header
+         ll\_success\_message                        Status message
+         ll\_status\_header                          Status header
+         ll\_status\_message                         Status message
+         cookie\_warning                             Warning when no cookie can be set
+         username                                    Form field label
+         password                                    Form field label
+         login                                       Legend, form field label
+         permalogin                                  Form field label
+         logout                                      Legend, submit button
+         send\_password                              Submit button
+         reset\_password                             Legend, submit button
+         ll\_change\_password\_header                Status header
+         ll\_change\_password\_message               Status message
+         ll\_change\_password\_nolinkprefix\_message Error message
+         ll\_change\_password\_notvalid\_message     Status message
+         ll\_change\_password\_notequal\_message     Status message
+         ll\_change\_password\_tooshort\_message     Status message
+         ll\_change\_password\_done\_message         Status message
+         change\_password                            Legend
+         newpassword\_label1                         Form field label
+         newpassword\_label2                         Form field label
+         your\_email                                 Form field label
+         ll\_forgot\_header                          Status header, link text
+         ll\_forgot\_validate\_reset\_password       Email body
+         ll\_forgot\_message\_emailSent              Status message
+         ll\_forgot\_reset\_message                  Status message
+         ll\_forgot\_reset\_message\_emailSent       Status message
+         ll\_forgot\_reset\_message\_error           Status message
+         ll\_forgot\_header\_backToLogin             Text of back link to loginform
+         ll\_enter\_your\_data                       Form field label
+         oLabel\_header\_welcome                     Legend
+         =========================================== =================================
+
diff --git a/typo3/sysext/felogin/Documentation/Examples/Index.rst b/typo3/sysext/felogin/Documentation/Examples/Index.rst
new file mode 100644 (file)
index 0000000..7fc4ce5
--- /dev/null
@@ -0,0 +1,100 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _examples:
+
+Examples
+--------
+
+In this section some common situations are described.
+
+
+.. _login-and-back-to-original-page:
+
+Send visitors to login page and redirect to original page
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A common situation is that visitors who go to a page with access
+restrictions should go to a login page first and after logging in
+should be send back to the page they originally requested.
+
+Assume we have a login page with id 2.
+
+Using TypoScript we can still display links to access restricted pages
+and send visitors to the login page:
+
+::
+
+   config {
+           typolinkAccessRestrictedPages = 2
+           typolinkAccessRestrictedPages_addParams = &return_url=###RETURN_URL###
+   }
+
+On the login page the login form must be configured to redirect to the
+original page:
+
+::
+
+   plugin.tx_felogin_pi1.redirectMode = referer
+
+(This option can also be set in the flexform configuration of the
+felogin content element)
+
+If visitors will directly enter the URL of an access restricted page
+they will be sent to the first page in the rootline to which they have
+access. Sending those direct visits to a login page is not a job of
+the felogin plugin, but requires a custom page-not-found handler.
+
+
+.. _login-link-visibility:
+
+Login link visible when not logged in and logout link visible when logged in
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Again TypoScript will help you out. The page with the login form has
+id=2:
+
+::
+
+   10 = TEXT
+   10 {
+           value = Login
+           typolink.parameter = 2
+   }
+   [loginUser = *]
+   10.value = Logout
+   10.typolink.additionalParams = &logintype=logout
+   [end]
+
+Of course there can be solutions with HMENU items, etc.
+
+
+.. _access-restrictions:
+
+Access restrictions on the felogin plugin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A very common issue is that the felogin plugin is set to Access: Hide
+at login. After the core has processed the login request the page will
+be rendered without the felogin plugin. If there are redirect options
+active they will NOT be executed, simply because the felogin plugin is
+hidden.
+
+One solution is to insert felogin with TypoScript in the page. The
+redirect options must be set in the TypoScript configuration. Any
+output of this plugin can be hidden with CSS. Redirect options will be
+executed by this invisible felogin. If there are two instances of
+felogin present on a page (one as a content element, the other via
+TypoScript) this can easily lead to problems, just as with any
+pi\_base plugin.
+
+Of course setting the felogin plugin to Hide at login and having
+redirect options together doesn't really makes sense if a redirect
+will happen in all cases.
+
diff --git a/typo3/sysext/felogin/Documentation/Hooks/Index.rst b/typo3/sysext/felogin/Documentation/Hooks/Index.rst
new file mode 100644 (file)
index 0000000..dd26800
--- /dev/null
@@ -0,0 +1,36 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+
+.. _hooks:
+
+Hooks
+-----
+
+The following hooks are available:
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['beforeRedirect']
+  Receives loginType and redirectUrl as parameters, allows to change
+  the redirectUrl
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['postProcContent']
+  Postprocessing of the output just before it is returned
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['login\_confirmed']
+  Hook for general actions after login has been confirmed
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['loginFormOnSubmitFuncs']
+  This Hook is used by kb\_md5fepw extension to set hidden
+  fields and onsubmit-scripts
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['logout\_confirmed']
+  Hook for general actions after logout has been confirmed
+
+$GLOBALS['TYPO3\_CONF\_VARS']['EXTCONF']['felogin']['forgotPasswordMail ']
+  Hook to change the contents of the forgot password mail
+
diff --git a/typo3/sysext/felogin/Documentation/Images/ContentElementWizard.png b/typo3/sysext/felogin/Documentation/Images/ContentElementWizard.png
new file mode 100644 (file)
index 0000000..6cacd54
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/ContentElementWizard.png differ
diff --git a/typo3/sysext/felogin/Documentation/Images/GeneralSettings.png b/typo3/sysext/felogin/Documentation/Images/GeneralSettings.png
new file mode 100644 (file)
index 0000000..7e47bf0
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/GeneralSettings.png differ
diff --git a/typo3/sysext/felogin/Documentation/Images/MessagesConfiguration.png b/typo3/sysext/felogin/Documentation/Images/MessagesConfiguration.png
new file mode 100644 (file)
index 0000000..604ae01
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/MessagesConfiguration.png differ
diff --git a/typo3/sysext/felogin/Documentation/Images/RedirectConfiguration.png b/typo3/sysext/felogin/Documentation/Images/RedirectConfiguration.png
new file mode 100644 (file)
index 0000000..c8f11e5
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/RedirectConfiguration.png differ
diff --git a/typo3/sysext/felogin/Documentation/Images/UserGroupRedirection.png b/typo3/sysext/felogin/Documentation/Images/UserGroupRedirection.png
new file mode 100644 (file)
index 0000000..97ffb95
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/UserGroupRedirection.png differ
diff --git a/typo3/sysext/felogin/Documentation/Images/UserRedirection.png b/typo3/sysext/felogin/Documentation/Images/UserRedirection.png
new file mode 100644 (file)
index 0000000..a59efb4
Binary files /dev/null and b/typo3/sysext/felogin/Documentation/Images/UserRedirection.png differ
diff --git a/typo3/sysext/felogin/Documentation/Includes.txt b/typo3/sysext/felogin/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..38aa398
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+..