Skip to content

Commit 9c52037

Browse files
authored
fix: images, quiz, tables according to guidelines. (#563)
Signed-off-by: Manjot Sidhu <[email protected]>
1 parent 90e0a2f commit 9c52037

21 files changed

+124
-174
lines changed

about.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ Interactive-Book is &copy; 2020 by [CircuitVerse](https://circuitverse.org/).
1515

1616
## Contributors
1717
Thanks to everyone who has contributed to the Interactive Book.
18-
<a href="https://github.com/CircuitVerse/Interactive-Book/graphs/contributors"><img src="https://contributors-img.firebaseapp.com/image?repo=CircuitVerse/Interactive-Book" alt="Image of contributors"></a>
18+
[![Image of contributors](https://contributors-img.firebaseapp.com/image?repo=CircuitVerse/Interactive-Book)](https://github.com/CircuitVerse/Interactive-Book/graphs/contributors)

contributing_guidelines.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ CircuitVerse's Interactive Book may also include quotations, images, or other me
7878

7979
More information about "Fair use"
8080

81-
- <https://www.baylor.edu/copyright/index.php?id=56543>
82-
- <https://www.baylor.edu/copyright/doc.php/240714.pdf>
83-
- <https://librarycopyright.net/resources/fairuse/index.php>
84-
- <https://www.baylor.edu/content/services/document.php/68621.pdf>
85-
- <https://www.copylaw.com/new_articles/copy_myths.html>
86-
- <https://blogs.library.duke.edu/scholcomm/2007/11/30/citation-infringement/>
81+
- <https://www.baylor.edu/copyright/index.php?id=56543>
82+
- <https://www.baylor.edu/copyright/doc.php/240714.pdf>
83+
- <https://librarycopyright.net/resources/fairuse/index.php>
84+
- <https://www.baylor.edu/content/services/document.php/68621.pdf>
85+
- <https://www.copylaw.com/new_articles/copy_myths.html>
86+
- <https://blogs.library.duke.edu/scholcomm/2007/11/30/citation-infringement/>
8787

8888

8989
### Linking to copyrighted works

docs/binary-algebra/boolean-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A mathematical expression consisting of Boolean variables combined using the Boo
2626

2727
## Mathematical definition
2828

29-
If $k$ is the number of Boolean variables of the function, then the function $f(x_1,\ldots,x_k)$ and its domain and codomain are defined as $f:\\{0,1\\}^k\rightarrow\\{0,1\\}$
29+
If $k$ is the number of Boolean variables of the function, then the function $f(x_1,\ldots,x_k)$ and its domain and codomain are defined as $f:\{0,1\}^k\rightarrow\{0,1\}$
3030

3131

3232
## Important concepts

docs/binary-algebra/shannon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The *Shannon expansion* or *decomposition* theorem, also known as *Boole's expan
2525

2626
The expansion can take any of these three variations:
2727

28-
$\begin{align} f(x_1,x_2,\ldots,x_n)&= x_1 \cdot f(1,x_2,\ldots,x_n) + \overline{x_1}\cdot f(0,x_2,\ldots,x_n) \\\\\\ &= \bigl(x_1+f(0,x_2,\ldots,x_n)\bigr)\cdot \bigl(\overline{x_1}+f(1,x_2,\ldots,x_n)\bigr) \\\\\\ &= x_1 \cdot f(1,x_2,\ldots,x_n) \oplus \overline{x_1}\cdot f(0,x_2,\ldots,x_n) \end{align}$
28+
$\begin{aligned} f(x_1,x_2,\ldots,x_n)&= x_1 \cdot f(1,x_2,\ldots,x_n) + \overline{x_1}\cdot f(0,x_2,\ldots,x_n) \\\\\\ &= \bigl(x_1+f(0,x_2,\ldots,x_n)\bigr)\cdot \bigl(\overline{x_1}+f(1,x_2,\ldots,x_n)\bigr) \\\\\\ &= x_1 \cdot f(1,x_2,\ldots,x_n) \oplus \overline{x_1}\cdot f(0,x_2,\ldots,x_n) \end{aligned}$
2929

3030
More details can be found in Section 1.9 "Shannon's Expansion Theorem" in {% cite donzellini2018introduction --file books %} and in Section 3.2 "Switching functions" in {% cite kohavi2010switching --file books %}.
3131

docs/binary-representation/negative-quantities.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ has_children: false
2121

2222
## Signed and unsigned numbers
2323

24-
Currently, we have just looked at **unsigned** numbers - they can only be positive, as there is no sign. However, sometimes we need to work with **negative numbers** too. To do this, we add a **sign bit** on the far left of the binary number, which indicates whether the number is positive (\`0\`) or negative(\`1\`).
24+
Currently, we have just looked at **unsigned** numbers - they can only be positive, as there is no sign. However, sometimes we need to work with **negative numbers** too. To do this, we add a **sign bit** on the far left of the binary number, which indicates whether the number is positive (`0`) or negative(`1`).
2525

26-
For example, the number \`10000011\` would be \`131\` if the number is **unsigned**, but if the number is **signed**, the actual representation would be \`-3\`
26+
For example, the number `10000011` would be `131` if the number is **unsigned**, but if the number is **signed**, the actual representation would be `-3`
2727

28-
- The first bit \`1\` represents that the number is negative
29-
- The remaining bits \`0000011\` represent the actual number, \`3\`
28+
- The first bit `1` represents that the number is negative
29+
- The remaining bits `0000011` represent the actual number, `3`
3030

3131
The downside to using a signed number is that it removes one bit from the actual number representation, halving the maximum value.
3232

33-
- The minimum and maximum values for an \`unsigned 8-bit\` number would be \`0\` to \`2<sup>8</sup>-1\` (\`0\` to \`255\`)
34-
- The minimum and maximum values for a \`signed 8-bit\` number would be \`-2<sup>7</sup>-1\` to \`2<sup>7</sup>-1\` (\`-127\` to \`127\`)
33+
- The minimum and maximum values for an `unsigned 8-bit` number would be `0` to `2<sup>8</sup>-1` (`0` to `255`)
34+
- The minimum and maximum values for a `signed 8-bit` number would be `-2<sup>7</sup>-1` to `2<sup>7</sup>-1` (`-127` to `127`)
3535

3636

3737
## Complements in binary system
@@ -68,13 +68,13 @@ add 1 + 1
6868

6969
{:.quiz}
7070

71-
1. Using signed two's complement notation,what is the decimal value of 00010001 ?
71+
1. Using signed two's complement notation, what is the decimal value of 00010001 ?
7272
* -47
7373
* +37
7474
* -149
7575
1. +17
7676

77-
2. Using signed two's complement notation,what is the decimal value of 00010001 ?
77+
2. Using signed two's complement notation, what is the decimal value of 00010001 ?
7878
* positive
7979
* incorrect
8080
1. negative

docs/comb-lsi/alu.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Output = Operation**
4141

4242
Now you can take up the 1 bit ALU as block and construct a 4 bit ALU, which performs all the functions of the 1 bit ALU on the 4 bit inputs. Thus a single building block can be constructed and used recursively. The inputs A and B are four bits and the output is 4 bit as well. Figure below illustrates it:
4343

44-
<div style="text-align:center" ><img src="/assets/images/360px-4BITALU.jpg" /></div>
44+
{% include image.html url='/assets/images/360px-4BITALU.jpg' description='4 bit ALU' %}
4545

4646
There are a few important takeaways here:
4747
- The selection lines MO and M1 select the function ALU performs. These selection lines combined with the input arguments and desired functions, an Instruction Set can be formed.

docs/comb-msi/adders.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ This circuit has two outputs **carry** and **sum**.
3030

3131
## Block diagram
3232

33-
<div style="text-align:center"><img src="/assets/images/halfadder_blockdiagram.jpg" /></div>
33+
{% include image.html url="/assets/images/halfadder_blockdiagram.jpg" description="" %}
3434

3535

3636
## Truth table
3737

38-
<div style="text-align:center"><img src="/assets/images/halfadder_truthtable.jpg" /></div>
38+
{% include image.html url="/assets/images/halfadder_truthtable.jpg" description="" %}
3939

4040
## Circuit diagram
4141

@@ -56,16 +56,16 @@ The full adder is a three-input and two output combinational circuit.
5656

5757
## Block diagram
5858

59-
<div style="text-align:center"><img src="/assets/images/fulladder_blockdiagram.jpg" /></div>
59+
{% include image.html url="/assets/images/fulladder_blockdiagram.jpg" description="" %}
6060

6161

6262
## Truth table
6363

64-
<div style="text-align:center"><img src="/assets/images/fulladder_truthtable.jpg" /></div>
64+
{% include image.html url="/assets/images/fulladder_truthtable.jpg" description="" %}
6565

6666
## Circuit diagram
6767

68-
<div style="text-align:center"><img src="/assets/images/fulladder_circuitdiagram.jpg" /></div>
68+
{% include image.html url="/assets/images/fulladder_circuitdiagram.jpg" description="" %}
6969

7070
## Full adder from 2 half adder
7171

@@ -90,11 +90,11 @@ In the subtraction (A-B), A is called a Minuend bit and B is called a Subtrahend
9090

9191
## Truth table
9292

93-
<div style="text-align:center"><img src="/assets/images/halfsubstrator_truthtable.jpg" /></div>
93+
{% include image.html url="/assets/images/halfsubstrator_truthtable.jpg" description="" %}
9494

9595
## Circuit diagram
9696

97-
<div style="text-align:center"><img src="/assets/images/halfsubstrator_circuitdiagram.jpg" /></div>
97+
{% include image.html url="/assets/images/halfsubstrator_circuitdiagram.jpg" description="" %}
9898

9999
<iframe width="100%" height="400px" src="https://circuitverse.org/simulator/embed/12120" id="half_sub_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
100100

@@ -113,11 +113,11 @@ A is the 'minuend', B is 'subtrahend', C is the 'borrow' produced by the previou
113113

114114
## Truth table
115115

116-
<div style="text-align:center"><img src="/assets/images/fullsubstrator_truthtable.jpg" /></div>
116+
{% include image.html url="/assets/images/fullsubstrator_truthtable.jpg" description="" %}
117117

118118
## Circuit diagram
119119

120-
<div style="text-align:center"><img src="/assets/images/fullsubstrator_circuitdiagram.jpg" /></div>
120+
{% include image.html url="/assets/images/fullsubstrator_circuitdiagram.jpg" description="" %}
121121

122122
<iframe width="100%" height="400px" src="https://circuitverse.org/simulator/embed/12119" id="full_sub_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
123123

@@ -144,7 +144,7 @@ The rest of the connections are the same as those of n-bit parallel adder is sho
144144

145145
## Block diagram
146146

147-
<div style="text-align:center"><img src="/assets/images/fourbitadder_blockdiagram.jpg" /></div>
147+
{% include image.html url="/assets/images/fourbitadder_blockdiagram.jpg" description="" %}
148148

149149
# N-bit parallel subtractor
150150

@@ -163,7 +163,7 @@ If A > B Cout = 0 and the result of binary form (A-B) then Cout = 1 and the resu
163163

164164
## Block diagram
165165

166-
<div style="text-align:center"><img src="/assets/images/fourbitsubstractor_blockdiagram.jpg" /></div>
166+
{% include image.html url="/assets/images/fourbitsubstractor_blockdiagram.jpg" description="" %}
167167

168168

169169
## 8-bit full adder and subtractor

docs/comb-msi/encoders-decoders.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The encoder accepts an n input digital word and converts it into an m bit anothe
2929

3030
## Block diagram
3131

32-
<div style="text-align:center"><img src="/assets/images/encoder_blockdiagram.jpg" /></div>
32+
{% include image.html url="/assets/images/encoder_blockdiagram.jpg" description="" %}
3333

3434
### Examples of encoders ::
3535

@@ -49,15 +49,15 @@ That means if D3 = 1 then Y1 Y1 = 11 irrespective of the other inputs. Similarly
4949

5050
## Block diagram
5151

52-
<div style="text-align:center"><img src="/assets/images/priorityencoder_blockdiagram.jpg" /></div>
52+
{% include image.html url="/assets/images/priorityencoder_blockdiagram.jpg" description="" %}
5353

5454
### Truth table
5555

56-
<div style="text-align:center"><img src="/assets/images/priorityencoder_truthtable.jpg" /></div>
56+
{% include image.html url="/assets/images/priorityencoder_truthtable.jpg" description="" %}
5757

5858
### Logic circuit
5959

60-
<div style="text-align:center"><img src="/assets/images/priorityencoder_logiccircuit.jpg" /></div>
60+
{% include image.html url="/assets/images/priorityencoder_logiccircuit.jpg" description="" %}
6161

6262
<iframe width="100%" height="400px" src="https://circuitverse.org/simulator/embed/762" id="encoder_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
6363

@@ -86,7 +86,7 @@ It performs operations which are exactly opposite to those of an encoder.
8686

8787
## Block diagram
8888

89-
<div style="text-align:center"><img src="/assets/images/decoder_blockdiagram.jpg" /></div>
89+
{% include image.html url="/assets/images/decoder_blockdiagram.jpg" description="" %}
9090

9191
### Examples of decoders ::
9292

@@ -104,15 +104,15 @@ It shows that each output is 1 for only a specific combination of inputs.
104104

105105
## Block diagram
106106

107-
<div style="text-align:center"><img src="/assets/images/two_fourdecoder_blockdiagram.jpg" /></div>
107+
{% include image.html url="/assets/images/two_fourdecoder_blockdiagram.jpg" description="" %}
108108

109109
## Truth table
110110

111-
<div style="text-align:center"><img src="/assets/images/two_fourdecoder_truthtable.jpg" /></div>
111+
{% include image.html url="/assets/images/two_fourdecoder_truthtable.jpg" description="" %}
112112

113113
## Logic circuit
114114

115-
<div style="text-align:center"><img src="/assets/images/two_fourdecoder_logiccircuit.jpg" /></div>
115+
{% include image.html url="/assets/images/two_fourdecoder_logiccircuit.jpg" description="" %}
116116

117117

118118
<iframe width="100%" height="400px" src="https://circuitverse.org/simulator/embed/763" id="decoder_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>

docs/comb-msi/mux-demux.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ E is called the strobe or enable input which is useful for the cascading. It is
3232

3333
## Block diagram
3434

35-
<div style="text-align:center"><img src="/assets/images/n_onemultiplexer_blockdiagram.jpg" /></div>
35+
{% include image.html url='/assets/images/n_onemultiplexer_blockdiagram.jpg' description='n : 1 Multiplexer' %}
3636

3737
## Multiplexers come in multiple variations
3838

@@ -139,12 +139,12 @@ A de-multiplexer is equivalent to a single pole multiple way switch as shown in
139139
### 1 : 2 demultiplexer
140140
#### Block diagram
141141

142-
<div style="text-align:center"><img src="../../assets/images/one_twodemultiplexer_blockdiagram.jpg" /></div>
142+
{% include image.html url='/assets/images/one_twodemultiplexer_blockdiagram.jpg' description='1:2 Demultiplexer' %}
143143

144144

145145
#### Truth table
146146

147-
<div style="text-align:center"><img src="../../assets/images/one_twodemultiplexer_truthtable.jpg" /></div>
147+
{% include image.html url='/assets/images/one_twodemultiplexer_truthtable.jpg' description='1:2 Demultiplexer Truth Table' %}
148148

149149
<iframe width="100%" height="400px" src="https://circuitverse.org/simulator/embed/756" id="demux_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
150150

docs/comb-msi/mux-functions.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,13 @@ The set $\\{M(1),0,1\\}$ is functionally complete (See section **Functionally Co
6565

6666
{:.quiz}
6767

68-
1. Can one MUX block be said an universal logic block ?
69-
1. Yes
70-
* No
71-
2. Can one DEMUX block be said an universal logic block ?
72-
1. Yes
73-
* No
74-
3. Select the MUX-based gates which is/are possible ?
75-
* MUX-based XOR gate
76-
* MUX-based XNOR gate
77-
1. XOR and XNOR both gates
68+
1. Can one MUX block be said an universal logic block ?
69+
1. Yes
70+
* No
71+
2. Can one DEMUX block be said an universal logic block ?
72+
1. Yes
73+
* No
74+
3. Select the MUX-based gates which is/are possible ?
75+
* MUX-based XOR gate
76+
* MUX-based XNOR gate
77+
1. XOR and XNOR both gates

docs/comb-ssi/logic-gates.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Logic gates can be categorized into 3 groups:
2929
2. Universal Gates: NAND, NOR
3030
3. Arithmetic Gates: X-OR, X-NOR
3131

32-
<h2>Truth Table</h2>
32+
## Truth Table
3333

3434
The Table which contains all logical possibilities is known as truth table.
3535

@@ -42,7 +42,7 @@ The NOT gate is also known as an inverter because it produces the exact opposite
4242
| 0 | 1 |
4343
| 1 | 0 |
4444

45-
<img src="/assets/images/NotGate.svg" />
45+
{% include image.html url='/assets/images/NotGate.svg' description='Not Gate' %}
4646

4747
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46600" id="gates_01" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
4848

@@ -68,7 +68,7 @@ The Truth table for AND gate which consists of two inputs is given below
6868
| 1 | 0 | 0 |
6969
| 1 | 1 | 1 |
7070

71-
<img src="/assets/images/AndGate.svg" />
71+
{% include image.html url='/assets/images/AndGate.svg' description='AND Gate' %}
7272

7373
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46601" id="gates_02" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
7474

@@ -95,7 +95,7 @@ The Truth table of OR gate which consists of two inputs is given below
9595
| 1 | 0 | 1 |
9696
| 1 | 1 | 1 |
9797

98-
<img src="/assets/images/OrGate.svg" />
98+
{% include image.html url='/assets/images/OrGate.svg' description='AND Gate' %}
9999

100100
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46603" id="gates_03" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
101101

@@ -123,7 +123,7 @@ The Truth table of NAND gate which consists of two inputs is given below
123123
| 1 | 0 | 1 |
124124
| 1 | 1 | 0 |
125125

126-
<img src="/assets/images/NandGate.svg" />
126+
{% include image.html url='/assets/images/NandGate.svg' description='NAND Gate' %}
127127

128128
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46604" id="gates_04" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
129129

@@ -152,7 +152,7 @@ The Truth table of NOR gate which consists of two inputs is given below
152152
| 1 | 0 | 0 |
153153
| 1 | 1 | 0 |
154154

155-
<img src="/assets/images/NorGate.svg" />
155+
{% include image.html url='/assets/images/NorGate.svg' description='NOR Gate' %}
156156

157157
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46606" id="gates_05" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
158158

@@ -179,7 +179,7 @@ The Truth table of XOR gate which consists of two inputs is given below
179179
| 1 | 0 | 1 |
180180
| 1 | 1 | 0 |
181181

182-
<img src="/assets/images/XorGate.svg" />
182+
{% include image.html url='/assets/images/XorGate.svg' description='XOR Gate' %}
183183

184184
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46609" id="gates_06" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
185185

@@ -206,7 +206,7 @@ The Truth table of XNOR gate which consists of two inputs is given below
206206
| 1 | 0 | 0 |
207207
| 1 | 1 | 1 |
208208

209-
<img src="/assets/images/XnorGate.svg" />
209+
{% include image.html url='/assets/images/XnorGate.svg' description='XNOR Gate' %}
210210

211211
<iframe width="100%" height="220px" src="https://circuitverse.org/simulator/embed/46613" id="gates_07" scrolling="no" webkitAllowFullScreen mozAllowFullScreen allowFullScreen> </iframe>
212212

docs/logic-design/canonical.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,12 @@ F(A,B) = A + B
4545
```
4646
Truth Table::
4747

48-
|A|B|F(A,B)|
49-
|0|0|0|
50-
|0|1|1|
51-
|1|0|1|
52-
|1|1|1|
48+
| A | B | F(A,B) |
49+
| - | - | - |
50+
| 0 | 0 | 0 |a
51+
| 0 | 1 | 1 |
52+
| 1 | 0 | 1 |
53+
| 1 | 1 | 1 |
5354

5455
```yaml
5556
Here you have 4 combinations for 2 variables, try to grasp the next example where variables are 3 which

docs/logic-design/functional-description.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ has_children: false
2222

2323
Combinational circuits consist of Logic gates. These circuits operate with binary values. The output(s) of combinational circuit depends on the combination of present inputs. The following figure shows the **block diagram** of combinational circuit.
2424

25-
<div style="text-align:center"><img src="/assets/images/combinational1.jpg" /></div>
25+
{% include image.html url='/assets/images/combinational1.jpg' description='Combinational Circuit' %}
2626

2727
This combinational circuit has ‘n’ input variables and ‘m’ outputs. Each combination of input variables will affect the output(s).
2828

0 commit comments

Comments
 (0)