--- doc/docbase/writing_docs/01_writing_docs.html 2015/04/29 10:41:20 2747 +++ doc/docbase/writing_docs/01_writing_docs.html 2015/04/29 10:55:48 2748 @@ -505,7 +505,7 @@ with ??language??. Obviously it is exhausting to supply such a lang attribute with every single code sample, especially if you are just referring - a single code token within your paragraphs. So you don't have to do that. + to a single code token within your paragraphs. So you don't have to do that. If you omit the lang attribute, then our site's software will automatically use the language defined by you with one of the previous code blocks. You may also disable automatic syntax highlighting @@ -868,7 +868,46 @@ The only thing that changed compared to the regular note, is the "class" attribute of the note tag.

- + +

Directory Listings

+

+ Software components often have a certain kind of directory structure. + For readers of your articles is it way easier to perceive directory + structures if they are displayed in a visual appropriate way. There are + two specials tags you can use for this purpose: +

+ + <dir>/ + <dir>home + <dir>bob + <file>README.txt</file> + <file>foo.sh</file> + </dir> + </dir> + <dir>tmp + <file>bla.tmp</file> + </dir> + </dir> + + + / + home + bob + README.txt + foo.sh + + + tmp + bla.tmp + + + +

+ Currently for each file the same icon will be displayed. This might change + in future, i.e. a an automatic different icon could be picked by the + site's software according to the respective file name extension. +

+

Extensions

This is almost the end of this article. You are still seeking for features