Edit in DokuwikiEdit in AsciidocEdit in Markdown

Files tree diagram

You can use PlantUML to visualize directories and files tree.

To activate this feature, the diagram must:

• begin with @startfiles keyword
• end with @endfiles keyword.

🎉 Copied!

@startfiles /.github /src/example.py /tests/example_test.py /src/example1.py /README.md /LICENSE @endfiles

[Ref. GH-1448]

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Order

The files are not sort and are on the same order as the source.

🎉 Copied!

@startfiles /c.txt /b.txt /a.txt /c /b /a @endfiles

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Merge

The files are merged depending of there directory.

🎉 Copied!

@startfiles /a/a1.txt /b/b0.txt /a/a2.txt @endfiles

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Creole on Files tree

You can use Creole or HTML Creole on Files tree:

🎉 Copied!

@startfiles /**creole_test**/~~wave~~ /**creole_test**/**bold** /**creole_test**/""monospaced"" /**creole_test**/--stricken-out-- /**creole_test**/__not underlined__ /**creole_test**/~__not underlined__ /**creole_test**/~~wave-underlined~~ /**creole_test**///not italics :-)// /**creole_html_test**/<b>bold /**creole_html_test**/<i>italics /**creole_html_test**/<font:monospaced>monospaced /**creole_html_test**/<s>stroked /**creole_html_test**/<u>underlined /**creole_html_test**/<w>waved /**creole_html_test**/<s:green>stroked /**creole_html_test**/<u:red>underlined /**creole_html_test**/<w:#0000FF>waved /**creole_html_test**/<color:blue>Blue /**creole_html_test**/<back:orange>Orange background /**creole_html_test**/<size:20>big @endfiles

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Using notes

You can use the <note> and </note> keywords to define notes related to a single file.

🎉 Copied!

@startfiles <note> this is a note on top on two lines </note> /a/a1.py /a/a2.py <note> this is a note on a2 on two lines </note> /a/a3.py /b/z/b1.txt <note> this is a note on b1 </note> @endfiles

[Ref. QA-18534]