diff options
| author | ng0 <ng0@infotropique.org> | 2017-11-03 07:57:29 +0000 |
|---|---|---|
| committer | ng0 <ng0@infotropique.org> | 2017-11-03 07:57:29 +0000 |
| commit | 6bf7f40bfa6a9c3f2d1a046954de7ec09aeb1f97 (patch) | |
| tree | b4e8b62b2703d30ae1a09a9eed56a73393570ec9 | |
| parent | 68705e67c4883dcbec31d45b0086d65f981327d2 (diff) | |
doc README
| -rw-r--r-- | doc/documentation/README.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt index 6a34509a7d..c3dda87c52 100644 --- a/doc/documentation/README.txt +++ b/doc/documentation/README.txt @@ -22,6 +22,13 @@ To be moved to an appropriate section of "how to write documentation" or We do this and the other thing. This is done by foo. +6. Use @footnote{} instead of putting an @*ref{} to the footnote on a + collected footnote-page. + In a 200+ pages handbook it's better to have footnotes accessible + without having to skip over to the end. + +6.1 Avoid unnecessary footnotes, keep the text self-explanatory and + in a simple language where possible/necessary. * Completion Levels: |