Skip to content
This repository has been archived by the owner on Feb 25, 2023. It is now read-only.

Commit

Permalink
Initial version
Browse files Browse the repository at this point in the history
  • Loading branch information
sypets committed Sep 26, 2019
0 parents commit b740ce5
Show file tree
Hide file tree
Showing 17 changed files with 410 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .editorconfig
@@ -0,0 +1,23 @@
# EditorConfig is awesome: http://EditorConfig.org
#
# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig

# top-most EditorConfig file
root = false

[{*.rst,*.rst.txt}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 3

# MD-Files
[*.md]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
1 change: 1 addition & 0 deletions .gitignore
@@ -0,0 +1 @@
*GENERATED*
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,25 @@
# Contribute to TYPO3 Documentation

## Create Issues

* If you find something missing or something is wrong in this manual, you are welcome to write an issue describing the problem.
* If you can, please try to fix the problem yourself.
* For minor changes, it is not necessary to create an issue first.

## Make changes (create pull requests)

* In order to make changes on a [rendered page](https://docs.typo3.org/), just click on "Edit me on GitHub".
* For a step-by-step walkthrough for making a change, see [Contribute to docs.typo3.org](https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html)
* For a step-by-step walkthrough of alternative workflow, see [Local Editing and Rendering with Docker](https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html)

## Get help

* If you need help with contributing to the docs, see [How to get Help](https://docs.typo3.org/typo3cms/HowToDocument/HowToGetHelp.html)

# Contribute to TYPO3 Core

* See [TYPO3 Contribution Guide - Core Development](https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/)

# General TYPO3 Support

If you have some general TYPO3 support questions or need help with TYPO3, please see https://typo3.org/help.
25 changes: 25 additions & 0 deletions Documentation/AboutContributing.rst
@@ -0,0 +1,25 @@
.. include:: Includes.txt

.. _contribute:

==================
About Contributing
==================


**Do you have a cheat sheet yourself?**

Do you want **your** cheat sheets to be featured on docs.typo3.org as well?

Then don't hesitate to add your cheat sheet :ref:`with a pull request <h2document:contribute>`.

Or `contact the Documentation Team <https://typo3.org/community/teams/documentation/#c9886>`__.

Every contribution is welcome!

**Have you found an error on one of the cheat sheets or want to make
a suggestion?**

Again, make the change yourself :ref:`with a pull request <h2document:contribute>`,
report an issue or `contact the Documentation Team <https://typo3.org/community/teams/documentation/#c9886>`__.

143 changes: 143 additions & 0 deletions Documentation/CheatSheets.rst
@@ -0,0 +1,143 @@
.. include:: Includes.txt

.. _cheat-sheets:

======================
TYPO3 CMS Cheat Sheets
======================

.. important::

The cheat sheets on this page refer to version |release| of TYPO3
CMS. Use the version selector on this page to select the
version of TYPO3 you are currently using.
See `Usage tips: version selector <https://docs.typo3.org/Home/About/UsingThisSite/Index.html#version-selector>`__.


TypoScript
==========

stdWrap overview for cObjects
-----------------------------

*by Xavier Perseguers*


This overview presents the different stdWrap properties of a cObject.
It uses the cObject "TEXT" as example to demonstrate where they are applied.


* `Download <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/stdwrap.png>`__
* `Edit <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/stdwrap.png>`__

stdWrap overview for menu objects
---------------------------------

*by Xavier Perseguers*

This overview presents the different stdWrap properties of a menu. It uses the menu type
"HMENU" as an example to demonstrate where they are applied.

* `Download <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/stdwrap-menu.png>`__
* `Edit <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/stdwrap-menu.png>`__


New Website Cheat Sheet
-----------------------

*by Leon D.*

Overview of common TypoScript settings for a new TYPO3 website.

* `Download <http://www.cheatography.com/achjaderleon/cheat-sheets/typo3-new-website/pdf/>`__


TYPO3 Page Includes
-------------------

*by Steffen Kamper*

An illustration of the different includes, which are supported by the Page renderer since TYPO3 4.3.

* `Download <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/T3_pageinclude_sheet%20v1.pdf>`__
* `Edit <https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/tree/master/Resources/Public/CheatSheets/T3_pageinclude_sheet%20v1.odp>`__


Extbase / Fluid
===============

2 Extbase Cheat Sheets and 2 Fluid Cheat Sheets
-----------------------------------------------

*by Patrick Lobacher*

Everything around Extbase and Fluid: Extension directory structure, TypoScript settings, API for ActionController,
View and Request. And for Fluid: Fluidtemplate and usage of ViewHelpers.

* `Download <http://www.lobacher.de/files/cs/ExtbaseFluidCheatSheet_3.02_pluswerk.pdf>`__



TCA
===

Compact overview of TCA settings and values
-------------------------------------------

*by Stefan Frömken*



* `Download <http://www.typo3lexikon.de/fileadmin/templates/downloads/TCA-Cheat-Sheet-Schoko-Vanille-Mint.pdf>`__


Testing
=======

Creating and using mocks with Prophecy in PHPUnit
-------------------------------------------------

*by Oliver Klee*


* `Download <https://github.com/oliverklee/tdd-reader/blob/master/AdditionalDocuments/prophecy-cheatsheet.pdf>`__
* `Repository <https://github.com/oliverklee/tdd-reader/>`__

Creating and using mocks in PHPUnit
-----------------------------------

*by Oliver Klee*

* `Download <https://github.com/oliverklee/tdd-reader/blob/master/AdditionalDocuments/mocking-cheatsheet.pdf>`__
* `Repository <https://github.com/oliverklee/tdd-reader/>`__


Test Driven Development with TYPO3 CMS
--------------------------------------

*by Oliver Klee*

* `Download <https://github.com/oliverklee/tdd-reader/blob/master/tdd-cheatsheet.pdf>`__
* `Repository <https://github.com/oliverklee/tdd-reader/>`__



Core Development
================

Git
---

Basic commands for using Git to create and modify core patches

* :ref:`t3contribute:cheat-sheet-git`


Writing TYPO3 Documentation
===========================


reST & Sphinx Cheat Sheet
-------------------------

* :ref:`h2document:rest-cheat-sheet`
27 changes: 27 additions & 0 deletions Documentation/Includes.txt
@@ -0,0 +1,27 @@
.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in THIS documentation project (= manual).

.. role:: aspect (emphasis)

.. role:: html(code)
:language: html

.. role:: js(code)
:language: javascript

.. role:: jts(code)
:class: typescript
:language: typescript

.. role:: php(code)
:language: php

.. role:: typoscript(code)
:language: typoscript

.. role:: ts(typoscript)
:class: typoscript
:language: typoscript

.. default-role:: code
.. highlight:: php
69 changes: 69 additions & 0 deletions Documentation/Index.rst
@@ -0,0 +1,69 @@
.. include:: Includes.txt

.. _start:

============
Cheat Sheets
============

:Version:
|release|

:Language:
en

:Description:
Cheat Sheets provided by the community

:Audience:
Developers, Integrators

:License:
Licenses and copyright as specified in the cheat sheet

:Shortcut:
`t3cheatsheets` is the usual alias for
:ref:`cross-referencing <linktargets-explanation>`.


.. rst-class:: horizbuttons-primary-xxl

* `Jump to the cheat sheets <cheat-sheets>`__


The content of this document is related to TYPO3 CMS, a GNU/GPL CMS/Framework
available from https://typo3.org/.

**About this manual**

This section holds files, which are related to the TYPO3 CMS Core
documentation, but which do not really fit into any specific manual.

They contain concise information about one topic, usually on one or
only a few pages.

**Community Documentation**

The cheat sheets are provided by the TYPO3 community.

**Contribute**

.. note::

**Do you have a cheat sheet yourself or have you found an error
or want to make a suggestion?**

Then don't hesitate to :ref:`contribute`

**Credits**

The Documentation Team kindly thanks all authors for their work!

TYPO3 - inspiring people to share.

**Table of Contents**

.. toctree::
CheatSheets
AboutContributing
Sitemap
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions Documentation/Settings.cfg
@@ -0,0 +1,58 @@
# coding: utf-8

[general]

project = Cheat Sheets
release = master (10-dev)
t3author = TYPO3 Documentation Team
copyright = since ever by the TYPO3 Documentation Team

description = Cheat Sheets for TYPO3 CMS


[html_theme_options]

# "Edit me on GitHub" button
github_branch = master
github_repository = TYPO3-Documentation/TYPO3CMS-Cheat-Sheets

# Releated Links
project_contact = https://typo3.org/community/teams/documentation/#c9886
project_discussions =
project_home = https://typo3.org/community/teams/documentation/
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Cheat-Sheets/issues
project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Cheat-Sheets


[intersphinx_mapping]

h2document = https://docs.typo3.org/typo3cms/HowToDocument/
#t3api = https://typo3.org/api/typo3cms/
#t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/
t3contribute = https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/
#t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/
#t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/
#t3extbase = https://docs.typo3.org/typo3cms/ExtbaseGuide/
#t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/
#t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/
#t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/
#t3install = https://docs.typo3.org/typo3cms/InstallationGuide/
#t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/
#t3security = https://docs.typo3.org/typo3cms/SecurityGuide/
#t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/
#t3sitepackage = https://docs.typo3.org/typo3cms/SitePackageTutorial/
#t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/
#t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/
#t3tca = https://docs.typo3.org/typo3cms/TCAReference/
#t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/
#t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/
#t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/
#t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/
#t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/
#t3viewhelper = https://docs.typo3.org/typo3cms/ViewHelperReference/


[extensions]

any_name_youtube = sphinxcontrib.youtube

11 changes: 11 additions & 0 deletions Documentation/Sitemap.rst
@@ -0,0 +1,11 @@
:template: sitemap.html

.. _Sitemap:

=======
Sitemap
=======

.. template 'sitemap.html' will insert the toctree as a sitemap here below
normal contents

0 comments on commit b740ce5

Please sign in to comment.