Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve guide docs #1559

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

improve guide docs #1559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/resources/doc/de/html/guide/verify/test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h1>
The file format is simple. The first line contains column headers that correspond to the names of the signals. If the bit width is greater than 1 then it is necessary to specify it in square brackets. Example <tt>C[8]</tt>. The data for each test situation is in the following lines. Blank lines are ignored. Anything following a "#" character is a comment.
</p>
<p>
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>&lt; tt=""&gt;</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. inary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>"0x"</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. Binary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
</p>
<p>
Here is an example of a test vector file:
Expand Down
44 changes: 22 additions & 22 deletions src/main/resources/doc/en/html/guide/verify/test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="fr">
<title>
Fenêtre Vecteur de test
Test Vector Window
</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>
<body>
<div class="maindiv">
<h1>
Fenêtre Vecteur de test
Test Vector Window
</h1>
<p>
Depuis la fenêtre Vecteur de test vous pouvez charger un vecteur de test à partir d'un fichier et Logisim lancera des tests sur le circuit actuel. Il n'y a qu'une seule fenêtre de vecteur de test pour le projet et la table changera pour refléter le circuit simulé dans la fenêtre du projet. Notez cependant que le module vecteur de test exécute une copie séparée du simulateur de circuit et n'interfère donc pas avec la simulation dans la fenêtre du projet et n'est pas influencé par cette simulation.
From the Test vector window you can load a test vector from a file and Logisim will run tests on the current circuit. There is only one test vector window for the project and the table will change to reflect the simulated circuit in the project window. Note however that the test vector module runs a separate copy of the circuit simulator and therefore does not interfere with the simulation in the project window and is not influenced by this simulation.
</p>
<p>
Pour l'exemple, nous allons tester le circuit ci-dessous. Ce circuit donne les résultats de cinq fonctions logiques à partir de deux entrées. Il comporte une erreur la porte NAND du bas devrait être une porte AND.
For the example, we will test the circuit below. This circuit gives the results of five logic functions from two inputs. It has an error the bottom NAND gate should be an AND gate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last part is not a sentence. I suggest adding "because" to get: "It has an error because the bottom..."

That change should also be made in the other files that contain English.

In fact, all the files that contain English (including en) should be identical as far as I know (except for the line that specifies the Content-Language). Currently, de, ru, and pt are actually in English and are the same. I didn't check if any others exist. Does this PR make en match? No. At least line 20 is different here than in the other files.

In an ideal implementation, we wouldn't have multiple files that have essentially the same content. I recommend we make all the files match for this PR and raise the issue of redundancy in the implementation elsewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll see what I can do.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dtowell: It would be nice if you could incorporate @davidhutchens's suggestion so that this PR can be merged.

</p>
<p align="center">
<img class="notscal" src="../../../../img-guide/vector-test.png" alt="#########">
</p>
<p>
Le fichier de test ressemble à ceci.
<p>
The test file looks like this.
</p>
<blockquote>
<pre>A B O_Nor O_Nand O_Xor O_Or O_And O_AB[2]
Expand All @@ -37,22 +37,22 @@ <h1>
</pre>
</blockquote>
<p>
Pour lancer le test, sélectionnez le menu <b class="menu">|&nbsp; Simulation &nbsp;|</b>→<b class="menu">|&nbsp; Vecteur de test &nbsp;|</b> puis utilisez le bouton <b class="button">"Chargez vecteur"</b>. Sélectionnez le fichier des vecteurs que vous avez construits. La simulation est exécutée immédiatement et un tableau s'affiche avec le résultat.
To run the test, select the menu <b class="menu">|&nbsp; Simulation &nbsp;|</b>→<b class="menu">|&nbsp;Test vector &nbsp;|</b> then use the <b class="button">"Load vector"</b> button. Select the vector file you built. The simulation is executed immediately and a table is displayed with the result.
</p>
<p align="center">
<img src="../../../img-guide/vector-result.png" alt="#########">
</p>
<p>
Toute sortie incorrecte sera signalée en rouge. Les lignes avec des sorties incorrectes sont triées en haut de la fenêtre.
Any incorrect output will be flagged in red. Rows with incorrect outputs are sorted at the top of the window.
</p>
<p>
Le format de fichier des vecteurs est simple. La première ligne contient les entêtes de colonnes qui correspondent au nom des signaux. Si la largeur de bit est plus grande que 1 alors il est nécessaire de le spécifier entre des crochets. Exemple <tt>C[8]</tt>. Les données de chaque situation de test sont dans les lignes suivantes. Les lignes vides sont ignorées. Tout ce qui suit un caractère "#" est un commentaire.
The vector file format is simple. The first line contains the column headings which correspond to the names of the signals. If the bit width is greater than 1 then it is necessary to specify it in square brackets. Example <tt>C[8]</tt>>. The data for each test situation is in the following rows. Blank lines are ignored. Anything after a "#" character is a comment.
</p>
<p>
Les lignes restantes répertorient chaque valeur séparée par un espace ou une tabulation. Les valeurs peuvent être en hexadécimales, octal, binaire ou décimal signé. Les valeurs hexadécimal doivent avoir le préfixe <b><tt>"0x"</tt></b>. Les valeurs octales doivent avoir le préfixe <b><tt>"0o"</tt></b>. Les nombres binaires et décimaux se distinguent par le nombre de chiffres: les valeurs binaires doivent toujours avoir exactement autant de chiffres que la largeur de la colonne; les valeurs décimales ne doivent pas avoir de zéro en tête et peuvent avoir un signe négatif.
The remaining lines list each value separated by a space or a tab. Values ​​can be hexadecimal, octal, binary, or signed decimal. Hexadecimal values ​​must have the prefix <b><tt>"0x"</tt></b>. Octal values ​​must have the prefix <b><tt>"0o"</tt></b>. Binary and decimal numbers are distinguished by the number of digits: binary values ​​must always have exactly as many digits as the width of the column; decimal values ​​must not have a leading zero and may have a negative sign.
</p>
<p>
Voici un exemple de fichier vectoriel de test:
Here is an example of a test vector file:
</p>
<blockquote>
<pre>#test vector for adder 4bit
Expand All @@ -63,33 +63,33 @@ <h1>
</pre>
</blockquote>
<p>
Selon la représentation des valeurs hexadécimales, octales ou binaires, la lettre minuscule <tt>"x"</tt> permet de spécifier quatre, trois ou un bits «sans importance». Par exemple a valeur 101xx est une valeur binaire de cinq bits, avec les deux derniers bits non spécifiés, et 0x1ax5 est une valeur hexadécimale avec deux fois quatre bits non spécifiés. De tels jokers ne peuvent pas être utilisés en notation décimale.
Depending on the representation of hexadecimal, octal, or binary values, the lowercase letter <tt>"x"</tt> is used to specify four, three, or one "unimportant" bits. For example, a value of <tt>101xx</tt> is a five-bit binary value, with the last two bits unspecified, and <tt>0x1ax5</tt> is a hexadecimal value with two unspecified four-bit bits. Such wildcards cannot be used in decimal notation.
</p>
<p>
<strong>Ligne de commande:</strong> Pour faciliter les tests automatisés, la fonctionnalité de vecteur de test peut être exécutée à partir de la ligne de commande, comme suit:
<strong>Command line:</strong> To facilitate automated testing, the test vector functionality can be run from the command line as follows:
</p>
<blockquote>
<div class="forcode">
<tt>java -jar logisim-evolution.jar -testvector &lt;circuitname&gt; &lt;vector.txt&gt; &lt;project.circ&gt;</tt>
</div>
</blockquote>
<p>
Le résultat d'un test réussi sera dans la sortie standard (stdout) celui-ci par exemple
The result of a successful test will be sent to standard output (stdout), for example
</p>
<blockquote>
<pre>Loading test vector "testv1b.txt" ...
Execution 4 vecteurs ...
Running 4 vectors ...
1
2
3
4

Réussit: 4, Erreur: 0
Passed : 4, Failed : 0
</pre>
</blockquote>et en cas d'échec
</blockquote>and in case of failure
<blockquote>
<pre>Loading test vector "testv1a.txt" ...
Exécution 4 vecteurs ...
Running 4 vectors ...
1
2
3
Expand All @@ -99,16 +99,16 @@ <h1>

ob = 1 (expected 0)

Réussit: 2, Erreur: 2
</pre>
</blockquote>Note: Dans la sortie erreur (stderr) on lira ceci :
Passed : 2, Failed : 2
</pre>
</blockquote>Note: The error output (stderr) will read:
<blockquote>
<pre>Error on test vector 3:
Error on test vector 4:
</pre>
</blockquote>
<p>
<b>Suite:</b> <a href="../index.html">User's Guide</a>.
<b>Next:</b> <a href="../index.html">User's Guide</a>.
</p>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/doc/pt/html/guide/verify/test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h1>
The file format is simple. The first line contains column headers that correspond to the names of the signals. If the bit width is greater than 1 then it is necessary to specify it in square brackets. Example <tt>C[8]</tt>. The data for each test situation is in the following lines. Blank lines are ignored. Anything following a "#" character is a comment.
</p>
<p>
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>&lt; tt=""&gt;</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. inary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>"0x"</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. Binary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
</p>
<p>
Here is an example of a test vector file:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/doc/ru/html/guide/verify/test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h1>
The file format is simple. The first line contains column headers that correspond to the names of the signals. If the bit width is greater than 1 then it is necessary to specify it in square brackets. Example <tt>C[8]</tt>. The data for each test situation is in the following lines. Blank lines are ignored. Anything following a "#" character is a comment.
</p>
<p>
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>&lt; tt=""&gt;</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. inary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
The remaining rows list each value separated by a space or tab. Values can be in hexadecimal, octal, binary, or signed decimal. The hexadecimal values must have the prefix <b><tt>"0x"</tt></b>. Octal values must have the prefix <b><tt>"0o"</tt></b>. Binary and decimal are be distinguished by the number of digits: binary values must always have exactly as many digits as the width of the column; decimal values must always have fewer, should not have leading zeros, and may have a negative sign.
</p>
<p>
Here is an example of a test vector file:
Expand Down