Documentation changes for 2.6.1.

git-svn-id: https://circuit.svn.sourceforge.net/svnroot/circuit/trunk@89 70edf91d-0b9e-4248-82e7-2488d7716404
This commit is contained in:
Carl Burch 2010-09-30 01:25:19 +00:00
parent cd4ec49730
commit 425ecc8879
17 changed files with 207 additions and 9 deletions

View File

@ -131,6 +131,7 @@
<tocitem target="arith_comparator" text="Comparator" />
<tocitem target="arith_shifter" text="Shifter" />
<tocitem target="arith_bitadder" text="Bit Adder" />
<tocitem target="arith_bitfinder" text="Bit Finder" />
</tocitem>
<tocitem target="mem" text="Memory library">
<tocitem target="mem_flipflops" text="D/T/J-K/S-R Flip-Flop" />

View File

@ -40,8 +40,8 @@ ff
<p>The first line identifies the file format used (currently, there is only
one file format recognized). Subsequent values list the values in
hexadecimal, starting from address 0; you can place several such
values on the same line. Logisim will assume that any
values unlisted in the file are zero.</p>
values on the same line. If there are more memory locations that are identified
in the file, Logisim will load 0 into the other memory locations.</p>
<p>The image file can use run-length encoding; for example, rather than
list the value <tt>00</tt> sixteen times in a row, the file can include
@ -50,6 +50,9 @@ than the number of repetitions is written in base 10.
Files produced by Logisim will use run-length encoding for runs of
at least four values.</p>
<p>You can place comments into the file by using the '#' symbol: All characters
in the line starting from the '#' symbol will be ignored by Logisim.</p>
<p><strong>Next:</strong> <a href="hex.html">Hex editor</a>.</p>
</body>

BIN
doc/en/icons/bitfindr.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 B

View File

@ -0,0 +1,106 @@
<html>
<head>
<title>Bit Finder</title>
</head>
<body bgcolor="FFFFFF">
<h1><img align="center" height="32" width="32" src="../../icons/bitfindr.gif">
<em>Bit Finder</em></h1>
<p><table>
<tr><td><strong>Library:</strong></td>
<td><a href="index.html">Arithmetic</a></td></tr>
<tr><td><strong>Introduced:</strong></td>
<td>2.6.1</td></tr>
<tr><td valign="top"><strong>Appearance:</strong></td>
<td valign="top"><img src="../images/bitfindr.png"></td></tr>
</table></p>
<h2>Behavior</h2>
<p>The component takes a multi-bit input and determines the the index of a bit,
where the index is computed by counting from 0 as the lowest-order bit.
Exactly which index it computes depends on the Type attribute, as illustrated
by the examples in the below table for the 8-bit sample input 11010100.</p>
<blockquote><table><thead>
<tr><th>Type</th><th>Output for 11010100</th></td></tr>
</thead><tbody>
<tr><td>Lowest-order 1</td><td align="center">2</td></tr>
<tr><td>Highest-order 1</td><td align="center">7</td></tr>
<tr><td>Lowest-order 0</td><td align="center">0</td></tr>
<tr><td>Highest-order 0</td><td align="center">5</td></tr>
</body></table></blockquote>
<p>For the lowest-order 1, the output is 2 because if you index the bits
starting from 0 for the lowest-order bit, the first 1 you will find is
at index 2. (The bits at indices 0 and 1 are both 0.)
For the highest-order 1, the output is 7 because the topmost 1 bit is at index 7
(again counting from the lowest-order bit as 0).</p>
<p>The component's output on the south edge indicates whether the desired bit
was found at all. In the above examples involving the input 11010100,
the south output is 1 in all cases.
But if the input were 00000000 and the component is to find the
lowest-order 1, then the south output would be 0 &mdash; and the output on the
west edge would be 0 as well.</p>
<p>If while searching for the desired value, a value that is neither 0 or 1 is
found (the bit could be floating or an error value),
then both outputs will consist entirely of error bits.
Note that this occurs only if the problematic bit is encountered before finding
the desired bit: For the input x1010100, the output would still be 2 if
the lowest-order 1 is desired; but we would get error values if the component's
type indicates to search for the highest-order 1 or the highest-order 0, since
there is an erroneous bit in a higher-order bit than either the highest-order 0
or the highest-order 1.</p>
<h2>Pins</h2>
<dl>
<dt>West edge (input, bit width matches Data Bits attribute)</dt>
<dd>The multibit input that is to be searched for the desired bit.</dd>
<dt>East edge (output, bit width computed as described below)</dt>
<dd>The index of the desired bit, counting from 0 for the lowest-order bit.
The bit width is the
minimum number of bits to store the maximum possible index, which is one
less than the value of the Data Bits attribute.</dd>
<dt>South edge (output, bit width 1)</dt>
<dd>1 if the desired bit is found, 0 if all input bits are the inverse of the
desired bit, and the error value if a non-0, non-1 value is found before the
desired bit.</dd>
</dl>
<h2>Attributes</h2>
<p>When the component is selected or being added,
Alt-0 through Alt-9 alter its <q>Data Bits</q> attribute.</p>
<dl>
<dt>Data Bits</dt>
<dd>The bit width of the input.</dd>
<dt>Type</dt>
<dd>Indicates which bit to search for &mdash; the lowest-order 0,
the highest-order 0, the lowest-order 1, or the highest-order 1.</dd>
</dl>
<h2>Poke Tool Behavior</h2>
<p>None.</p>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>
</body>
</html>

View File

@ -28,6 +28,8 @@ two's-complement values.</p>
<td><a href="shifter.html">Shifter</a></td></tr>
<tr><td align="right"><a href="bitadder.html"><img border="0" src="../../icons/bitadder.gif"></a></td>
<td><a href="bitadder.html">Bit Adder</a></td></tr>
<tr><td align="right"><a href="bitfinder.html"><img border="0" src="../../icons/bitfindr.gif"></a></td>
<td><a href="bitfinder.html">Bit Finder</a></td></tr>
</table>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

View File

@ -148,6 +148,12 @@ beyond what the shape naturally accommodates.</dd>
<dd>Determines how many pins to have for the component on its west
side.</dd>
<dt>Label</dt>
<dd>The text within the label associated with the gate.</dd>
<dt>Label Font</dt>
<dd>The font with which to render the label.</dd>
<dt>Negate <var>x</var></dt>
<dd>If <q>yes</q>, the input is negated before it is fed into the gate.
The inputs are counted top-down if the facing is east or west,
@ -161,7 +167,7 @@ and they are counted left-to-right if the facing is north or south.</dd>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p>Allows the label associated with the gate to be edited.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

View File

@ -64,6 +64,12 @@ and the arrow keys alter its <q>Facing</q> attribute.</p>
<dt>Data Bits</dt>
<dd>The bit width of the component's inputs and outputs.</dd>
<dt>Label</dt>
<dd>The text within the label associated with the gate.</dd>
<dt>Label Font</dt>
<dd>The font with which to render the label.</dd>
</dl>
<h2>Poke Tool Behavior</h2>
@ -72,7 +78,7 @@ and the arrow keys alter its <q>Facing</q> attribute.</p>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p>Allows the label associated with the gate to be edited.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

View File

@ -89,6 +89,12 @@ from the input: If the component faces east and is <q>right-handed,</q>
the control line is to the south; but if it is <q>left-handed,</q>
the control line is to the north.</dd>
<dt>Label</dt>
<dd>The text within the label associated with the gate.</dd>
<dt>Label Font</dt>
<dd>The font with which to render the label.</dd>
</dl>
<h2>Poke Tool Behavior</h2>
@ -97,7 +103,7 @@ the control line is to the north.</dd>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p>Allows the label associated with the gate to be edited.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

View File

@ -64,6 +64,12 @@ and the arrow keys alter its <q>Facing</q> attribute.</p>
<dd>Determines whether to draw a larger or a smaller version of the
component.</dd>
<dt>Label</dt>
<dd>The text within the label associated with the gate.</dd>
<dt>Label Font</dt>
<dd>The font with which to render the label.</dd>
</dl>
<h2>Poke Tool Behavior</h2>
@ -72,7 +78,7 @@ component.</dd>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p>Allows the label associated with the gate to be edited.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

View File

@ -141,6 +141,12 @@ requested.</dd>
<dd>Determines how many pins to have for the component on its west
side.</dd>
<dt>Label</dt>
<dd>The text within the label associated with the gate.</dd>
<dt>Label Font</dt>
<dd>The font with which to render the label.</dd>
<dt>Multiple-Input Behavior (XOR and XNOR only)</dt>
<dd>When three or more inputs are provided, the XOR/XNOR gate's output will
either be based on whether exactly one input is 1 (the default) or an odd number
@ -154,7 +160,7 @@ of inputs are 1.</dd>
<h2>Text Tool Behavior</h2>
<p>None.</p>
<p>Allows the label associated with the gate to be edited.</p>
<p><a href="../index.html">Back to <em>Library Reference</em></a></p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 408 B

View File

@ -113,6 +113,8 @@ documented in this reference material.</p>
<td><a href="arith/shifter.html">Shifter</a></td></tr>
<tr><td align="right"><a href="arith/bitadder.html"><img border="0" src="../icons/bitadder.gif"></a></td>
<td><a href="arith/bitadder.html">Bit Adder</a></td></tr>
<tr><td align="right"><a href="arith/bitfinder.html"><img border="0" src="../icons/bitfindr.gif"></a></td>
<td><a href="arith/bitfinder.html">Bit Finder</a></td></tr>
<tr><td colspan="2"><br><font size="+1"><b><a href="mem/index.html">Memory library</a></b></font></td></tr>
<tr><td align="right"><a href="mem/flipflops.html" style="text-decoration: none">

View File

@ -61,10 +61,17 @@ TIL321.)</p>
<dl>
<dt>Color</dt>
<dt>On Color</dt>
<dd>The color with which to draw the display segments and decimal point when
they are on.</dd>
<dt>Off Color</dt>
<dd>The color with which to draw the display segments and decimal point when
they are off.</dd>
<dt>Background</dt>
<dd>The color with which to draw the display's background (transparent by default).</dd>
<dt>Active On High?</dt>
<dd>If <q>yes</q>, then the segments light when the corresponding input is 1.
If <q>no</q>, they light when the corresponding input is 0.</dd>

View File

@ -43,10 +43,17 @@ remains off.</dd>
<dl>
<dt>Color</dt>
<dt>On Color</dt>
<dd>The color with which to draw the display segments and decimal point when
they are on.</dd>
<dt>Off Color</dt>
<dd>The color with which to draw the display segments and decimal point when
they are off.</dd>
<dt>Background</dt>
<dd>The color with which to draw the display's background (transparent by default).</dd>
</dl>
<h2>Poke Tool Behavior</h2>

View File

@ -68,6 +68,12 @@ and clear inputs).
If it is <q>Falling Edge,</q>, then this happens when the
clock input changes from 1 to 0.</dd>
<dt>Color</dt>
<dd>The color with which to draw the text appearing in the terminal.</dd>
<dt>Background</dt>
<dd>The color with which to draw the terminal's background.</dd>
</dl>
<h2>Poke Tool Behavior</h2>

View File

@ -115,6 +115,7 @@
<mapID target="arith_comparator" url="libs/arith/comparator.html" />
<mapID target="arith_shifter" url="libs/arith/shifter.html" />
<mapID target="arith_bitadder" url="libs/arith/bitadder.html" />
<mapID target="arith_bitfinder" url="libs/arith/bitfinder.html" />
<mapID target="mem" url="libs/mem/index.html" />
<mapID target="mem_flipflops" url="libs/mem/flipflops.html" />
<mapID target="mem_register" url="libs/mem/register.html" />

View File

@ -0,0 +1,33 @@
LOGISIM 2.6.1 ADDS GERMAN, ENHANCES LIBRARIES
Logisim, a graphical design and simulation tool for logic circuits, is now at version 2.6.1. The biggest feature in this release is a new German translation composed by Uwe Zimmerman of Uppsala University. The release also repairs some minor bugs in the recently released 2.6.0.
Besides the German translation, the release includes several minor enhancements to the library components. In the Gates library, you can now associate a label with any gate added into the circuit. In the Arithmetic library, a new Bit Finder component has been added, and all existing components have been enhanced so that a tool tip will be displayed when the mouse hovers over an input or output. In the I/O library, several components provide more color configuration options.
Educational institutions around the world use Logisim as an aid to teaching about digital logic and computer architecture. As a Java application, Logisim can run on most major operating systems. Read more about Logisim at http://www.cburch.com/logisim/, and download it from SourceForge.net at http://sourceforge.net/projects/circuit/.
CHANGE LOG
Feature: A German translation of the GUI elements is now included.
Feature: Added a Label and Label Font attribute for all components in the Gates library except Constant.
Feature: Added the Bit Finder component into the Arithmetic library.
Feature: Added tool tips for each input and output of all Arithmetic components.
Feature: Memory image files generated by a text editor or other file can include comments: Logisim ignores the '#' character and the following characters on that line.
Feature: Added Off Color and Background attributes for the I/O library's Seven-Segment Display and Hex Digit Display.
Feature: Added Color and Background attributes for the I/O library's TTY component.
Feature: Enhanced the splash screen and "About" dialog to give credit to other team members.
Bug fix: Circuit statistics were not computed recursively as intended (it was done correctly in 2.5.1).
Bug fix: The Bit Adder's output bit width was one bit too small when the maximum possible count was a power of 2.
Bug fix: With a multiplexer/demultiplexer/decoder selected, pressing 1 through 4 alters the number of select bits, but 5 does not work properly.
Bug fix: If you select a wire and drag one endpoint in the same direction the wire is facing, then it shows just a fragment of the resulting longer wire being selected.