more work on docs

Author: bjornregnell

index.html

@@ -6,6 +6,9 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
   <title>reqT - Requirements Engineering Tool</title>
   <style>
+    /* Default styles provided by pandoc.
+    ** See https://pandoc.org/MANUAL.html#variables-for-html for config info.
+    */
     code{white-space: pre-wrap;}
     span.smallcaps{font-variant: small-caps;}
     div.columns{display: flex; gap: min(4vw, 1.5em);}
@@ -99,44 +102,21 @@ <h1 class="title">reqT - Requirements Engineering Tool</h1>
 </header>
 <nav id="TOC" role="doc-toc">
 <ul>
-<li><a href="#what-is-reqt" id="toc-what-is-reqt">What is reqT?</a></li>
 <li><a href="#download" id="toc-download">Download</a></li>
+<li><a href="#what-is-reqt" id="toc-what-is-reqt">What is reqT?</a></li>
+<li><a href="#why-reqt" id="toc-why-reqt">Why reqT?</a></li>
 <li><a href="#getting-started" id="toc-getting-started">Getting
 started</a></li>
-<li><a href="#why-reqt" id="toc-why-reqt">Why reqT?</a></li>
 <li><a href="#using-the-reqt-desktop-app"
 id="toc-using-the-reqt-desktop-app">Using the reqT desktop app</a></li>
 <li><a href="#using-reqt-with-scala"
 id="toc-using-reqt-with-scala">Using reqT with Scala</a></li>
+<li><a href="#reqt-command-line-arguments"
+id="toc-reqt-command-line-arguments">reqT command line
+arguments</a></li>
 <li><a href="#publications" id="toc-publications">Publications</a></li>
 </ul>
 </nav>
-<h2 id="what-is-reqt">What is reqT?</h2>
-<p><strong>reqT</strong> is a <em>flexible</em> and <em>scalable</em>
-open source <strong>requirements engineering tool</strong> for software
-developers and learners, available as a desktop application and a Scala
-library.</p>
-<p>With reqT you can specify requirements using a simple requirements
-modelling language called <strong>reqT-lang</strong> with essential
-requirements engineering concepts, giving structure to natural language
-requirements, while enabling analysis, visualization and automation.</p>
-<p>The reqT-lang syntax is a small subset of <a
-href="https://en.wikipedia.org/wiki/Markdown">Markdown</a> using bullet
-lists with indentation and special keywords, to express textual
-requirements models by connecting <span
-class="EntType"><em>entities</em></span> via <span
-class="RelType"><em>relations</em></span> to <span
-class="StrAttrType"><em>attributes</em></span>, as in this example:</p>
-<pre><code>* <span class="EntType">Feature</span>: helloWorld <span class="RelType">has</span> 
-  * <span class="StrAttrType">Spec</span>: Print a nice greeting.
-  * <span class="StrAttrType">Why</span>: First step to get started.
-</code></pre>
-<p>Visit the
-<a href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"><strong>Quickref</strong></a>
-to explore requirements engineering concepts in reqT-lang.</p>
-<p>Maintainer of reqT: <a
-href="https://cs.lth.se/bjorn-regnell">Prof. Björn Regnell</a>. Used at
-Lund University in <a href="https://cs.lth.se/krav">this course</a>.</p>
 <h2 id="download">Download</h2>
 <p>Latest version: <b> 4.6.3 </b>   All versions:   <a
 href="https://github.com/reqT/reqT/releases">reqT</a>   <a
@@ -147,7 +127,7 @@ <h2 id="download">Download</h2>
   <a href="https://github.com/reqT/reqT/releases/latest/download/reqT.jar"> Desktop App </a>
 </button>
 
-<button type="button" class="button" onclick='window.location.href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"'>
+<button type="button" class="buttMaintainer of reqT: Prof. Björn Regnell. Used at Lund University in this course.on" onclick='window.location.href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"'>
   <a href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"> Quickref </a>
 </button>
 
@@ -166,39 +146,133 @@ <h2 id="download">Download</h2>
 tinyurl.com/get-reqT</a>
 </p>
 <pre>curl -L https://tinyurl.com/get-reqT -o reqT.jar</pre>
+<h2 id="what-is-reqt">What is reqT?</h2>
+<p><strong>reqT</strong> is a <em>flexible</em> and <em>scalable</em>
+open source <strong>requirements engineering tool</strong> for software
+developers and learners, available as a desktop application and a Scala
+library.</p>
+<p>With reqT you can specify requirements using a simple requirements
+modelling language called <strong>reqT-lang</strong> with essential
+requirements engineering concepts, giving structure to natural language
+requirements, while enabling analysis, visualization and automation.</p>
+<p>Visit the
+<a href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"><strong>Quickref</strong></a>
+to explore requirements engineering concepts in reqT-lang.</p>
+<p>The reqT-lang syntax is a small subset of <a
+href="https://en.wikipedia.org/wiki/Markdown">Markdown</a> using bullet
+lists with indentation and special keywords, to express textual
+requirements models by connecting <span
+class="EntType"><em>entities</em></span> via <span
+class="RelType"><em>relations</em></span> to <span
+class="StrAttrType"><em>attributes</em></span>, as in this example:</p>
+<pre><code>* <span class="EntType">Feature</span>: helloWorld <span class="RelType">has</span> 
+  * <span class="StrAttrType">Spec</span>: Print a nice greeting.
+  * <span class="StrAttrType">Why</span>: First step to get started.
+</code></pre>
+<p><em>Maintainer of reqT:</em> <a
+href="https://cs.lth.se/bjorn-regnell">Prof. Björn Regnell</a>. reqT is
+used at Lund University in <a
+href="https://lunduniversity.github.io/krav/">this course</a>.</p>
+<h2 id="why-reqt">Why reqT?</h2>
+<p>With reqT you can…</p>
+<ol type="1">
+<li>Model, analyse, visualize and prioritize requirements.</li>
+<li>Manage requirements in issues and git using simple markdown
+syntax.</li>
+<li>Combine natural language with formal structure.</li>
+<li>Flexibly mix abstraction levels and modelling approaches.</li>
+<li>Integrate requirements and test specification.</li>
+<li>Export, import and visualize requirements via open formats.</li>
+<li>Manipulate models with expressive, safe and convenient Scala
+programs.</li>
+<li>Allocate requirements to releases with constraint solving.</li>
+<li>Express prompts for spec-driven development with generative AI
+.</li>
+</ol>
+<p>… using a simple markdown-based language in an open source tool and
+library.</p>
 <h2 id="getting-started">Getting started</h2>
 <ul>
 <li><p>Make sure you have <a
 href="https://adoptium.net/temurin/releases/?package=jdk&amp;version=21">Java
 21 - LTS</a> and <a href="https://www.scala-lang.org/download/">Scala
-3</a> installed for your system. Check this in terminal using:
+3</a> installed for your specific system. Check this in terminal using:
 </br><code>java -version</code></br><code>scala -version</code></br> (If
-you use later versions than Java 21 - LTS and Scala 3.6.4 you may get
-some warnings, but things should work fine anyway.)</p></li>
-<li><p>Download the <a
-href="https://github.com/reqT/reqT/releases/latest/download/reqT.jar">reqT
-desktop app</a> and run in terminal using:
+you use other versions you may get warnings, but things could work
+anyway.)</p></li>
+<li><p>Download <a
+href="https://github.com/reqT/reqT/releases/latest/download/reqT.jar"><strong>reqT.jar</strong></a>
+and double-click the downloaded file or run in terminal using:
 <code>java -jar reqT.jar</code></p></li>
+<li><p>Learn more about <a href="#using-the-reqt-desktop-app">using the
+reqT desktop app</a> and <a href="#using-reqt-with-scala">using reqT
+with Scala</a>.</p></li>
 <li><p>Visit the reqT <a
-href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf">Quickref</a>
-to learn about available concepts in reqT-lang.</p></li>
-<li><p>Learn more about <a href="#using-the-reqt-app">using the reqT
-app</a></p></li>
-<li><p>Do the reqT labs to learn about using reqT in Requirements
-Engineering:</p>
+href="https://github.com/reqT/reqT-lang/releases/latest/download/reqT-quickref-GENERATED.pdf"><strong>Quickref</strong></a>
+to learn about the concepts in reqT-lang.</p></li>
+<li><p>Do the <strong>reqT labs</strong> to learn about using reqT in
+Requirements Engineering:</p>
 <ul>
-<li><a href="https://github.com/reqT/reqT/blob/4.x/docs/lab1.md">Lab 1:
-Context, Features and Priorities</a></li>
-<li><a href="https://github.com/reqT/reqT/blob/4.x/docs/lab2.md">Lab 2:
-Quality Requirements and Release Planning</a></li>
-<li>Labs are part of this course at Lund University: <a
-href="https://lunduniversity.github.io/krav/">ETSN15 Requirements
-Eng.</a></li>
+<li><a
+href="https://github.com/reqT/reqT/blob/4.x/docs/lab1.md"><strong>Lab
+1</strong>: Context, Features and Priorities</a></li>
+<li><a
+href="https://github.com/reqT/reqT/blob/4.x/docs/lab2.md"><strong>Lab
+2</strong>: Quality Requirements and Release Planning</a></li>
+<li>These labs are part of the <a
+href="https://lunduniversity.github.io/krav/"><em>ETSN15 Requirements
+Eng.</em></a> course at Lund Univ.</li>
 </ul></li>
-<li><p>Start reqT in the <a
+</ul>
+<h2 id="using-the-reqt-desktop-app">Using the reqT desktop app</h2>
+<ul>
+<li><p>Download <a
+href="https://github.com/reqT/reqT/releases/latest/download/reqT.jar">reqT.jar</a>
+and start by double-click or open a terminal and navigate to the folder
+with the downloaded file and type:
+<code>java -jar reqT.jar</code></p></li>
+<li><p>The main window of the reqT desktop app has menus and three panes
+as shown in the image below:
+<img src="img/screen1.png" alt="reqT Main Window" width="100%"/></p>
+<ol type="1">
+<li><p>The left pane is called the <strong>Tree</strong> where your reqT
+model is shown as a hierarchy of (un)foldable and selectable nodes. The
+model is updated by the <em>Tree</em> menu. If you want to edit a
+selected Tree node then select <em>Tree -&gt; Edit Selected Node in
+Editor (Ctrl+E)</em>. The Tree is not updated until you explicitly issue
+an update, for example using <em>Tree -&gt; Replace Selected Node from
+Editor (Ctrl+R)</em></p></li>
+<li><p>The middle pane is a text <strong>Editor</strong> with reqT-lang
+syntax highlighting and completion using <em>Ctrl+Space</em>. It can be
+manipulated using the <em>Editor</em> menu. Editing of model fragments
+is <em>independent</em> of the Tree pane. You can copy your edits into
+the Tree <em>explicitly</em> by using the <em>Tree</em> menu or the
+shortcuts shown in that menu.</p></li>
+<li><p>The right pane contains the <strong>Log</strong> where help
+messages are printed. You can use the <em>Log</em> menu to change line
+wrapping, increase/decrease font size, and clear the log.</p></li>
+</ol></li>
+<li><p>You can use the <em>View</em> menu to toggle pane orientation,
+fullscreen, window title, and increase/decrease the menu and tree font
+size.</p></li>
+<li><p>You can use the <em>Tools</em> menu to apply different
+pre-defined tools to your model.</p></li>
+<li><p>You can use the <em>Export</em> menu to save your model in
+different formats, such as html and LaTex. If you have <a
+href="https://graphviz.org/">GraphViz</a> installed on your path, you
+can visualize your model as a nested or flat graph.</p></li>
+<li><p>You can use the <em>Template</em> menu to enter example models
+into the editor.</p></li>
+<li><p>You can use the <em>Help</em> menu to print help messages in the
+Log and see the current version of reqT using the <em>About</em> menu
+item.</p></li>
+</ul>
+<h2 id="using-reqt-with-scala">Using reqT with Scala</h2>
+<ul>
+<li>Start reqT in the <a
 href="https://docs.scala-lang.org/scala3/book/taste-repl.html">Scala
 REPL</a> using: <code>java -jar reqT.jar repl</code> </br> You can
-create a requirements Model in the scala repl like so:</p></li>
+create a requirements Model in the scala repl like so:</li>
 </ul>
 <div class="sourceCode" id="cb1"><pre
 class="sourceCode scala"><code class="sourceCode scala"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>scala<span class="op">&gt;</span> <span class="kw">val</span> m <span class="op">=</span> <span class="st">&quot;* Feature: helloWorld has Spec: print greeting&quot;</span><span class="op">.</span>toModel</span>
@@ -235,40 +309,39 @@ <h2 id="getting-started">Getting started</h2>
 <span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a>@main <span class="kw">def</span> hello <span class="op">=</span> </span>
 <span id="cb2-14"><a href="#cb2-14" aria-hidden="true" tabindex="-1"></a>  <span class="fu">println</span><span class="op">(</span>m<span class="op">.</span>toMarkdown<span class="op">)</span></span></code></pre></div>
-<h2 id="why-reqt">Why reqT?</h2>
-<p>With reqT you can…</p>
-<ol type="1">
-<li>Model, analyse, visualize and prioritize requirements.</li>
-<li>Manage requirements in issues and git using simple markdown
-syntax.</li>
-<li>Combine natural language with formal structure.</li>
-<li>Flexibly mix abstraction levels and modelling approaches.</li>
-<li>Integrate requirements and test specification.</li>
-<li>Export, import and visualize requirements via open formats.</li>
-<li>Manipulate models with expressive, safe and convenient Scala
-programs.</li>
-<li>Allocate requirements to releases with constraint solving.</li>
-<li>Express prompts for spec-driven development with generative AI
-.</li>
-</ol>
-<p>… using a simple markdown-based language in an open source tool and
-library.</p>
-<h2 id="using-the-reqt-desktop-app">Using the reqT desktop app</h2>
-<p>Download <a
-href="https://github.com/reqT/reqT/releases/latest/download/reqT.jar">reqT.jar</a>
-and start by double-click or open a terminal and navigate to the folder
-with the downloaded file and type: <code>java -jar reqT.jar</code></p>
-<figure>
-<img src="img/screen1.png" alt="reqT Main Window" />
-<figcaption aria-hidden="true">reqT Main Window</figcaption>
-</figure>
-<h2 id="using-reqt-with-scala">Using reqT with Scala</h2>
 <ul>
-<li><p>TODO: example usage of the <a
-href="https://github.com/reqT/reqT-lang">reqT-lang api</a></p></li>
-<li><p>TODO: example usage of the <a
-href="https://github.com/reqT/reqT/blob/4.x/src/main/scala/Main.scala">reqT
-command-line args</a></p></li>
+<li><p>Visit the <a
+href="https://fileadmin.cs.lth.se/reqt-lang/api"><strong>reqT-lang
+api</strong></a> and <a
+href="https://github.com/reqT/reqT-lang/"><strong>source
+code</strong></a></p></li>
+<li><p>Visit the <a
+href="https://fileadmin.cs.lth.se/reqt/api"><strong>reqT app
+api</strong></a> and <a
+href="https://github.com/reqT/reqT/"><strong>source
+code</strong></a></p></li>
+</ul>
+<h2 id="reqt-command-line-arguments">reqT command line arguments</h2>
+<ul>
+<li>See the command line arguments available using the <code>help</code>
+argument:</li>
+</ul>
+<pre><code>$ java -jar reqT.jar help
+
+Welcome to reqT 4.6.3 https://reqT.github.io
+
+  Main program args:
+
+    &lt;none&gt;       open a reqT window with empty model
+    edit f1 f2   for each file open a window with model from file
+    repl         start the scala repl and do &#39;import reqt.*&#39;
+    quiz         start a quiz game in terminal
+    version      print version, also -v --version 
+    help         print this message, also -h, --help
+</code></pre>
+<ul>
+<li>Visit the reqT main program code: <a
+href="https://github.com/reqT/reqT/blob/4.x/src/main/scala/Main.scala">Main.scala</a></li>
 </ul>
 <h2 id="publications">Publications</h2>
 <ul>

quiz/index.html

@@ -6,6 +6,9 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
   <title>reqT Quiz</title>
   <style>
+    /* Default styles provided by pandoc.
+    ** See https://pandoc.org/MANUAL.html#variables-for-html for config info.
+    */
     code{white-space: pre-wrap;}
     span.smallcaps{font-variant: small-caps;}
     div.columns{display: flex; gap: min(4vw, 1.5em);}