[latexila] Doc: section about TODOs and FIXMEs in the structure



commit 65ca6ee59cf8785380017ec0c5b5579b2083f429
Author: SÃbastien Wilmet <swilmet gnome org>
Date:   Sat Feb 16 14:16:32 2013 +0100

    Doc: section about TODOs and FIXMEs in the structure
    
    The web page contains a screenshot with that, but it's better to add
    this in the documentation too.

 help/C/structure.page |   14 ++++++++++++++
 help/Makefile.am      |    2 +-
 2 files changed, 15 insertions(+), 1 deletions(-)
---
diff --git a/help/C/structure.page b/help/C/structure.page
index 52eab19..9c4abcc 100644
--- a/help/C/structure.page
+++ b/help/C/structure.page
@@ -42,4 +42,18 @@
     <gui style="menu">Structure</gui> menu.
   </p>
 </section>
+
+<section its:locNote="Do not translate the words TODO and FIXME. They are special comments
+that can be inserted in LaTeX documents.">
+  <title>TODOs and FIXMEs</title>
+
+  <p>
+    It can be useful to add TODOs and FIXMEs comments in the document. They will be
+    displayed in the structure. Example:
+  </p>
+
+  <code mime="text/x-tex">
+%TODO a remaining task
+%FIXME something is broken</code>
+</section>
 </page>
diff --git a/help/Makefile.am b/help/Makefile.am
index efca827..1d7d996 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -5,7 +5,7 @@ HELP_ID = latexila
 HELP_FILES = \
        build_tools.page        \
        completion.page         \
-       index.page                  \
+       index.page              \
        projects.page           \
        spell_checking.page     \
        structure.page          \


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]