Menu ▾ ▴

#732 Create a syllabus XML element for NHLP files

v1.1.x
closed
Erik Hänel
documentation (9) internal (109)
v1.1.4
New Functionality
2022-09-18
2022-09-05
Erik Hänel
No

Create a syllabus XML element for documentation files, which shall be converted to <h>Syllabus</h><codeblock>CONTENTS OF SYLLABUS BLOCK</codeblock><hr><h>Description</h> or something similar. This will provide at-a-glance overview of the commands in NumeRe. Those syllabus blocks shall contain all relevant command signatures, e.g.

<syllabus>
    surf EXPRESSIONS -set OPTIONS
    surf phi(x,y), ...
    surf phi(x,y) "LEGEND", ...
    surf datagrid(), ...
    surf datagrid() "LEGEND", ...
</syllabus>

Analysis:

We'll use syntax as block name, but the implementation is done as described by the description. Furthermore, we'll evaluate whether it is possible to introduce syntax highlighting for this block and <codeblock> as well.

Implementation:

  • Implementation: Implemented as proposed by the analysis. Automatic syntax highlighting was also included
  • Revision: [r1208]
  • Implementation test: All documentation articles were modified and opened with the new features available

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [x] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [ ] not needed
  • Language files:
    • [ ] corresponding language files updated
    • [x] not needed

Tests:

No possibility for an automatic test. We'll accept productive tests.

Related

Commit: [r1208]

Discussion

  • Erik Hänel

    Erik Hänel - 2022-09-05
    • labels: --> documentation, internal
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2022-09-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -7,3 +7,25 @@
         surf datagrid(), ...
         surf datagrid() &#34;LEGEND&#34;, ...
     &lt;/syllabus&gt;
+
+###Analysis:
+(*Describe, what&#39;s the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you&#39;ve changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2022-09-09
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -9,7 +9,7 @@
     &lt;/syllabus&gt;

 ###Analysis:
-(*Describe, what&#39;s the issue and which changes have to be made*)
+We&#39;ll use `syntax` as block name, but the implementation is done as described by the description. Furthermore, we&#39;ll evaluate whether it is possible to introduce syntax highlighting for this block and `&lt;codeblock&gt;` as well.

 ###Implementation:

 * Implementation: (*Describe, what you&#39;ve changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2022-09-11
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -12,20 +12,20 @@
 We&#39;ll use `syntax` as block name, but the implementation is done as described by the description. Furthermore, we&#39;ll evaluate whether it is possible to introduce syntax highlighting for this block and `&lt;codeblock&gt;` as well.

 ###Implementation:
-* Implementation: (*Describe, what you&#39;ve changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Implemented as proposed by the analysis. Automatic syntax highlighting was also included
+* Revision: [r1208]
+* Implementation test: All documentation articles were modified and opened with the new features available

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
-    * [ ] corresponding documentation articles updated
+    * [x] corresponding documentation articles updated
     * [ ] new documentation articles created
     * [ ] not needed
 * **Language files:**
     * [ ] corresponding language files updated
-    * [ ] not needed
+    * [x] not needed

 ###Tests:
 (*Describe, which tests you performed and their outcome*)
    • status: implementing --> testing
     

    Related

    Commit: [r1208]

  • Erik Hänel

    Erik Hänel - 2022-09-18
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -28,4 +28,4 @@

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+No possibility for an automatic test. We&#39;ll accept productive tests.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB