Code Monkey home page Code Monkey logo

docs's Introduction

Contao Documentation

The documentation for the Contao project will be maintained in this repository.

The details below are only necessary if you want to install the docs locally. If you just want to contribute content, read the CONTRIBUTING or these detailed instructions.

Cloning

The project installs the Hugo Learn theme as a git submodule. Thus when cloning the repository, you need to use the --recurse-submodules parameter:

git clone --recurse-submodules [email protected]:contao/docs.git

or:

git clone --recurse-submodules https://github.com/contao/docs.git

Updating the Theme

To update the theme after cloning, simply run the following command:

git submodule foreach git pull origin master

Build

The documentation is built using the Hugo site generator, thus you need to install Hugo first on your system.

Building is done using the make command. There are different commands available depending on what part of the documentation you want to build.

make build-dev
make build-manual

Builds the entire documentation into the build directory.

make live-dev
make live-manual

Spins up the development server which automatically tracks changes in the docs directory and rebuilds the front end. You can access the front end on http://localhost:1313.

make clean

Cleans the build directory.

Note

Your are not dependent on the Makefile. If make is not available in your operating system, you can still invoke the hugo commands. For example:

cd page
hugo server --cleanDestinationDir --environment manual --destination ../build/manual 

Or for the Developer Documentation:

cd page
hugo server --cleanDestinationDir --environment dev --destination ../build/dev 

License

The Contao documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License license (CC BY-NC-SA 4.0). If you want to redistribute a modified or unmodified version of the documentation, you can do so under the license terms.

If you contribute to the documentation, e.g. by creating pull requests, you grant us full usage rights of any content you create or upload. You also ensure that your content does not violate any third-party rights.

We are not claiming exclusive usage rights, therefore you are free to use your contributed content (e.g. texts or images) in any other project as well.

docs's People

Contributors

akroii avatar ameotoko avatar aschempp avatar ausi avatar berecont avatar bezin avatar bytehead avatar contaoacademy avatar dmolineus avatar ernestopheles avatar fiedsch avatar fkaminski avatar fritzmg avatar joehi avatar koertho avatar leofeyer avatar m-vo avatar mynyx avatar netzarbeiter avatar rabauss avatar rburch avatar richardhj avatar sheeep avatar srhinow avatar stefansl avatar tastaturberuf avatar toflar avatar xchs avatar zoglo avatar zonky2 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Contao Image Processing

Damit meine ich jetzt nicht die Erklärung der Responsive Image Funktion etc. (die gehört natürlich auch in das Handbuch) sondern ich finde man sollte im Handbuch ein wenig auf die unterstützten Image Libraries und deren Unterschiede eingehen. Also GD, Imagick & Gmagick. Unterschiede & Vorteile. Und wie man im Zweifelfall per Konsole überprüfen kann, was nun von Contao tatsächlich automatisch verwendet wird (via debug:container).

Link callbacks in Caching section

The caching.md contains something along the lines of

Moreover, you don't have to register to all the different callbacks such as onsubmit_callback or ondelete_callback.
You can simply register to the oninvalidate_cache_tags_callback and add your own tags.

I think it would be great if that was directly cross linked to the respective callbacks once they are documented.

Reference: inputType url

Apparently there is an inputType called url? Need to confirm this first and then add to the documenation.

Reference: Back end modules

Die Möglichkeiten des $GOBALS['BE_MOD'] arrays, also was

$GLOBALS['BE_MOD']['...']['...'] = [
    'tables' => ...,
    'table' => ...,
    'list' => ...,
    'option' => ...,
    'callback' => ...,
    ...
];

genau jeweils macht - bzw. alle möglichen Optionen die es gibt (Liste ist vermutlich nicht vollständig).

Manual: step-by-step guide

@netzarbeiter darüber haben wir ja schon mal geredet - also dass es Sinn machen würde eine Art Step-by-Step guide in das Handbuch zu integrieren, wo man durch das Grundsetup von Contao geführt wird, da das bisher eigentlich noch nirgends so erklärt war. Neuankömmlinge in Contao wissen oft nicht, dass zumindest folgende Schritte notwendig sind, um erste Inhalte auf seiner Contao Webseite sehen zu können:

  1. Theme anlegen
  2. Seitenlayout im Theme anlegen
  3. Webseiten Startpunkt anlegen
  4. Seitenlayout im Webseiten Startpunkt auswählen
  5. Startseite mit Alias index anlegen
  6. Startseite mit Inhalt befüllen

Siehe dazu auch contao/contao#601

Startseite über Hugo erzeugen

Zusätzliches Environment für die Startseite. Wir könnten da auch einfach das bestehende index.html Template statisch einbinden, denke ich, mit zwei verschiedenen Sprachversionen.

Cookbook: Extending Contao

May be use an example where the following tasks are shown:

  • adding a field to an existing DCA (includes the PaletteManipulator)
  • using a DCA callback
  • using a Hook
  • using the new field in a template

Though may be that is too much at once.

Documentation: RTE

The DCA reference explains how to define an rte for a textarea, typically ace or tinyMCE. We should also document how to customize the editor's configuration (be_tinyMCE.html5 template) and how to create and assign custom configurations (be_tinyCustom.html5 - if this still actually works, I am not sure).

The editor options do not need to be documented, we can link to the documentation of tinyMCE and ACE. Only Contao-specific options should be mentioned.

{{% expand %}} Formatierung in Callbacks

params

Ist die Formatierung bei den Parametern so gewollt oder fehlt mir eine Erweiterung damit das Markdown im Expand greift?

Falls nicht, würde ich das gerne anders formatieren, z.B. als Tabelle.

Explain the security components

As we have additional helper services such as the TokenChecker, I think we should have a chapter about when to use which service to fetch the front end member or back end user, to check if the FE preview is enabled etc.

Insert Tags aktualisieren

Today I noticed, that for example not all Insert Tag flags that are documented in the old documentation do not exist anymore (see contao/contao#585).

I'll look over it and update everything accordingly (just as I did with hooks and callbacks) :)

Link zur Doku im Manager

Im Manager gibt es aktuell einen Link zur GitHub bzw. der Doku wie man das Passwort zurücksetzen kann. Gibt es da in der neuen Doku was neues, das wir im Manager einbauen könnten?

Absender: Name + E-Mail Adresse Notation

Bei der E-Mail Adresse des System Administrators in den System Einstellungen und den Einstellungen des Website Roots kann man auch folgende Notation schreiben:

Max Mustermann <[email protected]>

oder

Max Mustermann [[email protected]]

Contao macht daraus automatisch Name + E-Mail Adresse für den Admin:

https://github.com/contao/contao/blob/f93d72df61bf57316bb9f3555092f9c204007e89/core-bundle/src/Resources/contao/controllers/FrontendIndex.php#L228-L236

Und das wird dann auch so im Formulargenerator für den Absender benutzt:

https://github.com/contao/contao/blob/f93d72df61bf57316bb9f3555092f9c204007e89/core-bundle/src/Resources/contao/forms/Form.php#L373-L375

Ich glaube das war bisher noch nirgends dokumentiert.

Print style

Das Learn theme hat keinen eigenen print style. Ich würde einen einfachen print style machen wo sidebar, topbar & nav buttons gehidden sind. Plus etwaige Anpassungen (Schriftgröße & Bilder evt.).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.