"Fossies" - the Fresh Open Source Software Archive

Member "ILIAS-5.4.9/docs/documentation/docs-guidelines.md" (24 Jan 2020, 2896 Bytes) of package /linux/www/ILIAS-5.4.9.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

Docs Guidelines

This guidelines direct authors in creating, naming and writing files providing information such as guidelines, how-tos, tutorials, examples or abouts. If you want to propose changes to any of the doc files, please make a PR agains trunk and label it with ‘JourFixe’. Further, please consult the contributing guideline for more information about collaborating in this project.

Location

When such new information is to be added, the following points need to be considered concerning the location of this information:

Naming

Content

Table of Contents (Markdown)

To maintain a TOC the Sublime Edit plugin MarkdownTOC MAY be used, other Tools are welcome as well. If MarkdownTOC is used, the TOC SHOULD be initiated with the following attributes:

<!-- MarkdownTOC depth=0 autolink="true" bracket="round" autoanchor="true" style="ordered" indent="   " -->