improved indentation and whitespace for markdown code blocks
All code blocks in markdown have been intended by at least 4 spaces. We add `--tab-stop=8` to all `pandoc(1)` executions in order to set a better tab stop indentation, especially for tab intended code blocks. Changed `bin/pandoc-wrapper.sh` VERSION from "1.5.3 2024-03-26" to "1.6 2024-03-31". Fixed `1991/brnstnd/sorta.README.md` so that the sorta code is code blocks. Removed unneeded paragraph group in copyright in `inc/footer.default.html`. Fixed excess whitespace after list Author on entry `index.html` page. Changed `bin/output-index-author.sh` VERSION from "1.5.2 2024-03-26" to "1.6 2024-03-31". Performed `make www` to perform the above and test under macOS. TODO: Fix the problem of the initial line of code being extra intended. TODO: Fix excess whitespace around code that is inline.
This commit is contained in:
1 parent
b84c27ce02
commit
a996f8d2b8
734 files changed
+16723
-16963
No files matched your search
+44
-45
@@ -135,8 +135,7 @@
|
||||
Location: <a href="../../location.html#SE">SE</a> - <em>Kingdom of Sweden</em> (<em>Sweden</em>)
|
||||
<br><br></li>
|
||||
<li>Name: <a href="../../authors.html#Jyrki_Holopainen">Jyrki Holopainen</a><br>
|
||||
Location: <a href="../../location.html#FI">FI</a> - <em>Republic of Finland </em> (<em>Finland</em>)
|
||||
<br><br></li>
|
||||
Location: <a href="../../location.html#FI">FI</a> - <em>Republic of Finland </em> (<em>Finland</em>)</li>
|
||||
</ul>
|
||||
|
||||
<!-- END: next line ends content generated by: bin/output-index-author.sh -->
|
||||
@@ -145,20 +144,20 @@ Location: <a href="../../location.html#FI">FI</a> - <em>Republic of Finland </em
|
||||
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
|
||||
|
||||
<h2 id="to-build">To build:</h2>
|
||||
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span></span></code></pre></div>
|
||||
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a> <span class="fu">make</span></span></code></pre></div>
|
||||
<p>You will need X11 header files and libraries installed to build this program.</p>
|
||||
<h2 id="to-use">To use:</h2>
|
||||
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> infile.info <span class="op">></span> outfile.info</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> infile.info <span class="op">></span> outfile.info</span></code></pre></div>
|
||||
<p>You will need a system capable of displaying the results of X Window programs.</p>
|
||||
<h2 id="try">Try:</h2>
|
||||
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<p>Then click on cell <code>C3</code> and type in the following:</p>
|
||||
<pre><code>C5 C6 C7 @</code></pre>
|
||||
<pre><code> C5 C6 C7 @</code></pre>
|
||||
<p>Click on cell <code>D4</code> and type in the following:</p>
|
||||
<pre><code>C5 C6 C7 !</code></pre>
|
||||
<pre><code> C5 C6 C7 !</code></pre>
|
||||
<p>Hit <code>ESC</code>.</p>
|
||||
<p>Now try running:</p>
|
||||
<pre><code>./jarijyrki < myedits.info</code></pre>
|
||||
<pre><code> ./jarijyrki < myedits.info</code></pre>
|
||||
<p>And observe that it matches what you had in the previous run!</p>
|
||||
<p>NOTE: changing the dimension parameters (see the authors’ remarks) renders
|
||||
existing spreadsheet files unusable.</p>
|
||||
@@ -191,7 +190,7 @@ supports are:</p>
|
||||
<h3 id="usage-instructions">2. USAGE INSTRUCTIONS</h3>
|
||||
<h4 id="quick-guide">2.1. Quick Guide</h4>
|
||||
<h5 id="starting">Starting</h5>
|
||||
<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<h5 id="stopping">Stopping</h5>
|
||||
<p>Use the ESC key.</p>
|
||||
<h5 id="movement">Movement</h5>
|
||||
@@ -200,29 +199,29 @@ supports are:</p>
|
||||
<p>The currently selected cell is always in the edit state. Press any key to add a
|
||||
character at the end of the formula; press backspace to delete the last one.</p>
|
||||
<h5 id="formulas">Formulas</h5>
|
||||
<pre><code>123.45
|
||||
A1 A2 +
|
||||
B1 B2 -
|
||||
C1 C2 *
|
||||
D1 D2 /</code></pre>
|
||||
<pre><code> 123.45
|
||||
A1 A2 +
|
||||
B1 B2 -
|
||||
C1 C2 *
|
||||
D1 D2 /</code></pre>
|
||||
<h5 id="pie-charts">Pie charts</h5>
|
||||
<pre><code>A1 A2 A3 ...</code></pre>
|
||||
<pre><code> A1 A2 A3 ...</code></pre>
|
||||
<p>Finish the formula with <code>@</code> to create the pie chart.</p>
|
||||
<h5 id="histograms">Histograms</h5>
|
||||
<pre><code>A1 A2 A3 ...</code></pre>
|
||||
<pre><code> A1 A2 A3 ...</code></pre>
|
||||
<p>Finish the formula with <code>!</code> to create the histogram.</p>
|
||||
<h4 id="starting-and-loading-spreadsheets">2.2. Starting and Loading Spreadsheets</h4>
|
||||
<p>To start the spreadsheet program with an existing
|
||||
spreadsheet, for instance <a href="finance.sheet">finance.sheet</a>, use the following
|
||||
command line:</p>
|
||||
<div class="sourceCode" id="cb11"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb11"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet</span></code></pre></div>
|
||||
<p>The file <a href="finance.sheet">finance.sheet</a> has been provided as an example. This
|
||||
file contains a set of financial numbers and two graphical entities - a pie
|
||||
chart and a histogram - based on them. We recommend starting the use of the
|
||||
program from this file, as a way to study and learn the formula language
|
||||
supported by the program.</p>
|
||||
<p>To start the program with an empty sheet, use</p>
|
||||
<div class="sourceCode" id="cb12"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> /dev/null</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb12"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> /dev/null</span></code></pre></div>
|
||||
<p>Alternatively, <code>/dev/zero</code> could be used but that may not exist on all systems.</p>
|
||||
<h4 id="exiting-and-saving-spreadsheets">2.3. Exiting and Saving Spreadsheets</h4>
|
||||
<p>Normally the user obviously wants to edit the spreadsheet. After the
|
||||
@@ -230,7 +229,7 @@ spreadsheet program finishes, it outputs the edited spreadsheet to the standard
|
||||
output. Hence, when the spreadsheet window has come up, you’ve made your
|
||||
changes, and you press the ESC key the program finishes. To save the results in
|
||||
a file, the following typical command line would be used:</p>
|
||||
<div class="sourceCode" id="cb13"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb13"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">./jarijyrki</span> <span class="op"><</span> finance.sheet <span class="op">></span> myedits.info</span></code></pre></div>
|
||||
<h4 id="visual-overview">2.4. Visual Overview</h4>
|
||||
<p>On top of the window the Formula Area shows the formula (or text) of the
|
||||
currently selected cell. The program starts with <code>A1</code> as being the current cell.
|
||||
@@ -259,17 +258,17 @@ plus) are first pushed to the stack and then the operation is performed. If a
|
||||
formula on a cell produces <em>exactly</em> one result then that is shown in the cell.
|
||||
Otherwise, the formula is interpreted as a string and shown as it is.</p>
|
||||
<p>An example of a simple formula, simply specifying a number is</p>
|
||||
<pre><code>123.50</code></pre>
|
||||
<pre><code> 123.50</code></pre>
|
||||
<p>Another simple formula refers to a cell:</p>
|
||||
<pre><code>A1</code></pre>
|
||||
<pre><code> A1</code></pre>
|
||||
<p>This particular example formula referred to the first cell of the first row in
|
||||
the spreadsheet. Arithmetic operations require both arguments:</p>
|
||||
<pre><code>A1 A2 +
|
||||
B1 B2 *
|
||||
C1 C2 -
|
||||
D1 D2 /</code></pre>
|
||||
<pre><code> A1 A2 +
|
||||
B1 B2 *
|
||||
C1 C2 -
|
||||
D1 D2 /</code></pre>
|
||||
<p>More complex formulae can be constructed by combining these simple ones:</p>
|
||||
<pre><code>A1 A2 + 2 *</code></pre>
|
||||
<pre><code> A1 A2 + 2 *</code></pre>
|
||||
<p>This example calculates the sum of the cells <code>A1</code> and <code>A2</code>, and then multiplies
|
||||
the result by two.</p>
|
||||
<p>The currently selected cell is always in a state where it can be edited. Press
|
||||
@@ -282,11 +281,11 @@ of certain commercial spreadsheet programs.)</p>
|
||||
cells: pie charts and histograms. The pie chart can consist of any number of
|
||||
slices, and is constructed by putting the pie amounts in stack and using the <code>@</code>
|
||||
operator. The program automatically computes the relative size of the slices.</p>
|
||||
<pre><code>A1 A2 A3 A4 @</code></pre>
|
||||
<pre><code> A1 A2 A3 A4 @</code></pre>
|
||||
<p>This example would draw a pie chart of four cells, <code>A1</code> to <code>A4</code>.
|
||||
The pie formula is shown above the pie for reference.</p>
|
||||
<p>The histograms are drawn in a similar manner, by using the <code>!</code> operator:</p>
|
||||
<pre><code>A1 A2 A3 A3 !</code></pre>
|
||||
<pre><code> A1 A2 A3 A3 !</code></pre>
|
||||
<h4 id="errors-in-formulas">2.8. Errors in Formulas</h4>
|
||||
<p>The program detects recursive reference attempts, references cells not
|
||||
containing a numerical value, attempts to define formulas with zero, two, or
|
||||
@@ -301,12 +300,12 @@ value supposedly returned by it.</p>
|
||||
<p>This section explains the meaning and rationale for the
|
||||
compile time parameters:</p>
|
||||
<hr />
|
||||
<pre><code>-DC=XK_Up
|
||||
-DL=XK_Down
|
||||
-DO=XK_Left
|
||||
-DV=XK_Right
|
||||
-DR=XK_Escape
|
||||
-D_=XK_BackSpace</code></pre>
|
||||
<pre><code> -DC=XK_Up
|
||||
-DL=XK_Down
|
||||
-DO=XK_Left
|
||||
-DV=XK_Right
|
||||
-DR=XK_Escape
|
||||
-D_=XK_BackSpace</code></pre>
|
||||
<p>These definitions can be used to change the user interface of the program with
|
||||
respect to special keys. The first four define the movement operations and
|
||||
the latter two define the program termination and character deletion keys.
|
||||
@@ -314,36 +313,36 @@ Typical modifications to these parameters include changing character deletion to
|
||||
the key the user is most familiar with, which could also be <code>XK_Delete</code>.
|
||||
<code>XK_Escape</code> might be better in some cases as one of the function keys. Likewise
|
||||
for the arrow keys.</p>
|
||||
<pre><code>-DU=40</code></pre>
|
||||
<pre><code> -DU=40</code></pre>
|
||||
<p>This parameter defines the maximum dimensions of the stored and handled
|
||||
spreadsheet (but see section 4.4 for a warning about changing this without
|
||||
thinking about the consequences!).</p>
|
||||
<pre><code>-DT=98</code></pre>
|
||||
<pre><code> -DT=98</code></pre>
|
||||
<p>This parameter defines the maximum length of a formula in one cell. Note the
|
||||
warning in section 4.4.</p>
|
||||
<pre><code>-Dz="(T+1)*U*U"</code></pre>
|
||||
<pre><code> -Dz="(T+1)*U*U"</code></pre>
|
||||
<p>Defines the number of bytes in a spreadsheet file. The number is automatically
|
||||
adjusted when the spreadsheet size parameters are changed. Note the warning in
|
||||
section 4.4.</p>
|
||||
<pre><code>-DQ=80
|
||||
-DS=20</code></pre>
|
||||
<pre><code> -DQ=80
|
||||
-DS=20</code></pre>
|
||||
<p>These two parameters define the visual dimensions of a cell. Changing these may
|
||||
be necessary on your system if the default font sizes differ from those in the
|
||||
systems we’ve tested the program with. <code>S</code> also defines the size of the left
|
||||
(<code>x1</code>) and top margins (<code>x2</code>).</p>
|
||||
<pre><code>-DN=10</code></pre>
|
||||
<pre><code> -DN=10</code></pre>
|
||||
<p>This is the x-indentation of text inside a cell. Changing this may be necessary
|
||||
to suit other font sizes and different X environments.</p>
|
||||
<pre><code>-DB=5</code></pre>
|
||||
<pre><code> -DB=5</code></pre>
|
||||
<p>This is the y-indentation of text inside a cell. Changing this may be necessary
|
||||
to suit other font sizes and different X environments.</p>
|
||||
<pre><code>-DG=23</code></pre>
|
||||
<pre><code> -DG=23</code></pre>
|
||||
<p>This parameter is the number of cell rows visible at one time.</p>
|
||||
<pre><code>-Dp=7</code></pre>
|
||||
<pre><code> -Dp=7</code></pre>
|
||||
<p>This parameter is one smaller than the number of cells columns visible at one
|
||||
time.</p>
|
||||
<pre><code>-DM="((p+1)*Q)+S"
|
||||
-DH="(G*S)+S+S"</code></pre>
|
||||
<pre><code> -DM="((p+1)*Q)+S"
|
||||
-DH="(G*S)+S+S"</code></pre>
|
||||
<p>These parameters are the window x and y sizes of the spreadsheet program window.
|
||||
With these definitions, they are automatically reflecting the
|
||||
at-one-time-visible cell row/column amounts. Hence, we recommend changing the
|
||||
|
||||
Reference in new issue
Block a user