strictdoc-project · stanislaw · Mar 25, 2022 · Mar 21, 2022
diff --git a/docs/sphinx/source/strictdoc.rst b/docs/sphinx/source/strictdoc.rst
@@ -519,6 +519,79 @@ Special feature of ``[COMPOSITE_REQUIREMENT]``: like ``[SECTION]`` element, the
 often, a more basic combination of nested ``[SECTION]`` and ``[REQUIREMENT]``
 elements should do the job.
 
+Include files
+~~~~~~~~~~~~~
+
+StrictDoc ``.sdoc`` files can be built-up from including other fragment documents.
+
+The ``[FRAGMENT_FROM_FILE]`` element can be used anywhere body elements can be
+used ( e.g.``[SECTION]``, ``[REQUIREMENT``, ``[COMPOSITE_REQUIREMENT]`` etc.) and will
+evaluate by inserting its contents from the file referenced by its ``FILE:`` property
+where it was used in the parent document. The files included must start with a ``[FRAGMENT]``
+directive and cannot contain ``[FREETEXT]`` elements but are otherwise identical to
+``*.sdoc`` files. They can have any filename except a``.sdoc`` extension.
+
+Here is an example pair of files similar to examples above. First the
+``.sdoc`` file has a ``[FRAGMENT_FROM_FILE]`` that references the latter file.
+
+.. code-block:: text
+
+    [DOCUMENT]
+    TITLE: StrictDoc
+
+    [FREETEXT]
+    ...
+    [/FREETEXT]
+
+    [FRAGMENT_FROM_FILE]
+    FILE: include.ssec
+
+    [REQUIREMENT]
+
+Then the referenced file, ``include.ssec``:
+
+.. code-block:: text
+
+    [FRAGMENT]
+
+    [REQUIREMENT]
+
+    [SECTION]
+    TITLE: Sub section
+    [/SECTION]
+
+    [COMPOSITE_REQUIREMENT]
+
+    [REQUIREMENT]
+
+    [/COMPOSITE_REQUIREMENT]
+
+Which will resolve to the following document after inclusion:
+
+.. code-block:: text
+
+    [DOCUMENT]
+    TITLE: StrictDoc
+
+    [FREETEXT]
+    ...
+    [/FREETEXT]
+
+    [REQUIREMENT]
+
+    [SECTION]
+    TITLE: Sub section
+    [/SECTION]
+
+    [COMPOSITE_REQUIREMENT]
+
+    [REQUIREMENT]
+
+    [/COMPOSITE_REQUIREMENT]
+
+    [REQUIREMENT]
+
+
 Custom grammars
 ---------------
 
@@ -879,10 +952,6 @@ Planned formats:
   `ReqIF Implementation Guide <https://www.prostep.org/fileadmin/downloads/PSI_ImplementationGuide_ReqIF_V1-7.pdf>`_
   that attempts to harmonize the developments of ReqIF by requirements
   management tools.
-- `ProR <http://pror.org>`_
-- Doors
-- Enterprise Architect
-- and others
 
 Import flow (ReqIF -> SDoc):
 ----------------------------

diff --git a/docs/strictdoc-html/strictdoc-html/docs/strictdoc-DEEP-TRACE.html b/docs/strictdoc-html/strictdoc-html/docs/strictdoc-DEEP-TRACE.html
@@ -180,6 +180,11 @@
                 4.2.4
               </span>
               Composite requirement
+            </span></li><li><span class="toc-title-no-link" title="Section has no requirements">
+              <span class="section-number">
+                4.2.5
+              </span>
+              Include files
             </span></li></ul>
             </li><li><span class="toc-title-no-link" title="Section has no requirements">
               <span class="section-number">

diff --git a/docs/strictdoc-html/strictdoc-html/docs/strictdoc-TABLE.html b/docs/strictdoc-html/strictdoc-html/docs/strictdoc-TABLE.html
@@ -124,6 +124,9 @@
             </li><li><a href="#4.2.4-Composite-requirement">
               <span class="section-number">4.2.4</span>
               Composite requirement
+            </a></li><li><a href="#4.2.5-Include-files">
+              <span class="section-number">4.2.5</span>
+              Include files
             </a></li></ul>
             </li><li><a href="#4.3-Custom-grammars">
               <span class="section-number">4.3</span>
@@ -1519,6 +1522,90 @@
 
     </div></section>
 
+</article>
+          <article class="docsection">
+
+  <section data-section="meta" class="docsection_section">
+
+    <div data-role='anchor' id="4.2.5-Include-files"></div>
+
+
+        <h3
+class="section-title"
+data-level="4.2.5"
+>Include files
+</h3>
+
+
+  </section>
+
+  <section data-section="description" class="docsection_section"><div class="free-text">
+      <div class="document">
+<p>StrictDoc <tt class="docutils literal">.sdoc</tt> files can be built-up from including other fragment documents.</p>
+<p>The <tt class="docutils literal">[FRAGMENT_FROM_FILE]</tt> element can be used anywhere body elements can be
+used ( e.g.``[SECTION]``, <tt class="docutils literal">[REQUIREMENT</tt>, <tt class="docutils literal">[COMPOSITE_REQUIREMENT]</tt> etc.) and will
+evaluate by inserting its contents from the file referenced by its <tt class="docutils literal">FILE:</tt> property
+where it was used in the parent document. The files included must start with a <tt class="docutils literal">[FRAGMENT]</tt>
+directive and cannot contain <tt class="docutils literal">[FREETEXT]</tt> elements but are otherwise identical to
+<tt class="docutils literal">*.sdoc</tt> files. They can have any filename except a``.sdoc`` extension.</p>
+<p>Here is an example pair of files similar to examples above. First the
+<tt class="docutils literal">.sdoc</tt> file has a <tt class="docutils literal">[FRAGMENT_FROM_FILE]</tt> that references the latter file.</p>
+<pre class="code text literal-block">
+[DOCUMENT]
+TITLE: StrictDoc
+
+[FREETEXT]
+...
+[/FREETEXT]
+
+[FRAGMENT_FROM_FILE]
+FILE: include.ssec
+
+[REQUIREMENT]
+</pre>
+<p>Then the referenced file, <tt class="docutils literal">include.ssec</tt>:</p>
+<pre class="code text literal-block">
+[FRAGMENT]
+
+[REQUIREMENT]
+
+[SECTION]
+TITLE: Sub section
+[/SECTION]
+
+[COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+
+[/COMPOSITE_REQUIREMENT]
+</pre>
+<p>Which will resolve to the following document after inclusion:</p>
+<pre class="code text literal-block">
+[DOCUMENT]
+TITLE: StrictDoc
+
+[FREETEXT]
+...
+[/FREETEXT]
+
+[REQUIREMENT]
+
+[SECTION]
+TITLE: Sub section
+[/SECTION]
+
+[COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+
+[/COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+</pre>
+</div>
+
+    </div></section>
+
 </article>
           <article class="docsection">
 
@@ -2081,10 +2168,6 @@
 <a class="reference external" href="https://www.prostep.org/fileadmin/downloads/PSI_ImplementationGuide_ReqIF_V1-7.pdf">ReqIF Implementation Guide</a>
 that attempts to harmonize the developments of ReqIF by requirements
 management tools.</li>
-<li><a class="reference external" href="http://pror.org">ProR</a></li>
-<li>Doors</li>
-<li>Enterprise Architect</li>
-<li>and others</li>
 </ul>
 </div>
 

diff --git a/docs/strictdoc-html/strictdoc-html/docs/strictdoc-TRACE.html b/docs/strictdoc-html/strictdoc-html/docs/strictdoc-TRACE.html
@@ -127,6 +127,9 @@
             </li><li><a href="#4.2.4-Composite-requirement">
               <span class="section-number">4.2.4</span>
               Composite requirement
+            </a></li><li><a href="#4.2.5-Include-files">
+              <span class="section-number">4.2.5</span>
+              Include files
             </a></li></ul>
             </li><li><a href="#4.3-Custom-grammars">
               <span class="section-number">4.3</span>
@@ -1645,6 +1648,95 @@
 
     </div></section>
 
+</article></div>
+          <div class="content_item" data-role="children"></div>
+        </section>
+        <section class="content_section">
+
+          <div class="content_item" data-role="parents"></div>
+          <div class="content_item" data-role="current"><article class="docsection">
+
+  <section data-section="meta" class="docsection_section">
+
+    <div data-role='anchor' id="4.2.5-Include-files"></div>
+
+
+        <h3
+class="section-title"
+data-level="4.2.5"
+>Include files
+</h3>
+
+
+  </section>
+
+  <section data-section="description" class="docsection_section"><div class="free-text">
+      <div class="document">
+<p>StrictDoc <tt class="docutils literal">.sdoc</tt> files can be built-up from including other fragment documents.</p>
+<p>The <tt class="docutils literal">[FRAGMENT_FROM_FILE]</tt> element can be used anywhere body elements can be
+used ( e.g.``[SECTION]``, <tt class="docutils literal">[REQUIREMENT</tt>, <tt class="docutils literal">[COMPOSITE_REQUIREMENT]</tt> etc.) and will
+evaluate by inserting its contents from the file referenced by its <tt class="docutils literal">FILE:</tt> property
+where it was used in the parent document. The files included must start with a <tt class="docutils literal">[FRAGMENT]</tt>
+directive and cannot contain <tt class="docutils literal">[FREETEXT]</tt> elements but are otherwise identical to
+<tt class="docutils literal">*.sdoc</tt> files. They can have any filename except a``.sdoc`` extension.</p>
+<p>Here is an example pair of files similar to examples above. First the
+<tt class="docutils literal">.sdoc</tt> file has a <tt class="docutils literal">[FRAGMENT_FROM_FILE]</tt> that references the latter file.</p>
+<pre class="code text literal-block">
+[DOCUMENT]
+TITLE: StrictDoc
+
+[FREETEXT]
+...
+[/FREETEXT]
+
+[FRAGMENT_FROM_FILE]
+FILE: include.ssec
+
+[REQUIREMENT]
+</pre>
+<p>Then the referenced file, <tt class="docutils literal">include.ssec</tt>:</p>
+<pre class="code text literal-block">
+[FRAGMENT]
+
+[REQUIREMENT]
+
+[SECTION]
+TITLE: Sub section
+[/SECTION]
+
+[COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+
+[/COMPOSITE_REQUIREMENT]
+</pre>
+<p>Which will resolve to the following document after inclusion:</p>
+<pre class="code text literal-block">
+[DOCUMENT]
+TITLE: StrictDoc
+
+[FREETEXT]
+...
+[/FREETEXT]
+
+[REQUIREMENT]
+
+[SECTION]
+TITLE: Sub section
+[/SECTION]
+
+[COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+
+[/COMPOSITE_REQUIREMENT]
+
+[REQUIREMENT]
+</pre>
+</div>
+
+    </div></section>
+
 </article></div>
           <div class="content_item" data-role="children"></div>
         </section>
@@ -2272,10 +2364,6 @@
 <a class="reference external" href="https://www.prostep.org/fileadmin/downloads/PSI_ImplementationGuide_ReqIF_V1-7.pdf">ReqIF Implementation Guide</a>
 that attempts to harmonize the developments of ReqIF by requirements
 management tools.</li>
-<li><a class="reference external" href="http://pror.org">ProR</a></li>
-<li>Doors</li>
-<li>Enterprise Architect</li>
-<li>and others</li>
 </ul>
 </div>