datamints_documentation

datamints_documentation

Extensions zum einfachen anlegen von Dokumentation für Extensions und das Projekt selbst. Steht im BE den Redakteuren und Integratoren zur Verfügung.

• Stellt BE-Module zur Anzeige von Dokumenattionen zum Auftritt und für Extensions für Redakteure und Integratoren bereit
• Sucht in datamints* Extensions nach README[EDITOR|INTEGRATOR].md und zeigt diese an
• Für andere extensions kann im TS angegeben werden, wo die .md Datei liegt
• Es können datamints_* Extensions im TS ausgeschlossen werden
• Es können Verzeichnisse angegeben werden, in denen nach .md Dateien gesucht wird.
• Bei Installation aktiviert sich das Modul mit der o.g. Config selbst
• Für ein Beispiel siehe EXT:datamints_documentation/Configuration/TypoScript/setup.txt bzw. folgendes Beispiel

# Module configuration
module.tx_datamintsdocumentation {

 view {
   templateRootPath = EXT:datamints_documentation/Resources/Private/Backend/Templates/
   partialRootPath = EXT:datamints_documentation/Resources/Private/Backend/Partials/
   layoutRootPath = EXT:datamints_documentation/Resources/Private/Backend/Layouts/
 }

   settings{
       editor{
           #Von diesen Verzeichnissen werden alle md dateien geladen
           customDirectories{
               0 = fileadmin/Resources/Private/Documentation/FCE
               1 = fileadmin/Resources/Private/Documentation/Other
           }
           #in diesen Extensions liegen die Dateien an anderen Orten
           #customExtensions{
           #    ext_key = lokaler/pfad/zur.md
           #}
           defaultExtensionPrefix = datamints_
           excludeExtensions{
               #ist read only im BE => Editors brauchen das nicht
               0 = datamints_documentation
           }
       }
       integrator{
           #leer anlegen. Für Integratoren gibt es zuerstmal keine Infos zu FCEs
           customDirectories{
               0 = fileadmin/Resources/Private/Documentation/Integrator
           }

       }
   }
}