[ktechlab] doc/en: Various minor fixes

Yuri Chornoivan null at kde.org
Mon Jan 2 16:50:54 UTC 2017


Git commit d36f37021b177a4f9d1d984d69b10a7bf044dc18 by Yuri Chornoivan.
Committed on 02/01/2017 at 16:50.
Pushed by yurchor into branch 'master'.

Various minor fixes

M  +5    -5    doc/en/circuits.docbook
M  +2    -2    doc/en/debugging.docbook
M  +1    -1    doc/en/microbe.docbook
M  +1    -1    doc/en/quick.docbook

https://commits.kde.org/ktechlab/d36f37021b177a4f9d1d984d69b10a7bf044dc18

diff --git a/doc/en/circuits.docbook b/doc/en/circuits.docbook
index 9d8356ab..a86bd6d7 100644
--- a/doc/en/circuits.docbook
+++ b/doc/en/circuits.docbook
@@ -21,7 +21,7 @@
 		
 		<para>The best way to get a feel for manual connection routing is by experimenting with it. Click on the starting pin or connection, and then extend the proto-connector by moving the mouse away from where you clicked. To place a corner, left-click. To cancel drawing the connection, either press &Esc;, or right-click the mouse.</para>
 		
-		<para>&ktechlab; tries its best to maintain the routes your connections take. However, if dragging a component results in the end points of a connection moving relative to each other, &ktechlab; will be forced to redraw the connection using auto-routing. Before moving a component, you can see which connectors will have to be rerouted - as they will turn grey on clicking.</para>
+		<para>&ktechlab; tries its best to maintain the routes your connections take. However, if dragging a component results in the end points of a connection moving relative to each other, &ktechlab; will be forced to redraw the connection using auto-routing. Before moving a component, you can see which connectors will have to be rerouted - as they will turn gray on clicking.</para>
 		
 		<para>To remove an existing connection, select it by drawing a small select-rectangle over part of the connector, and hit <keycap>Del</keycap>.</para>
 	</sect1>
@@ -30,9 +30,9 @@
 		<title>Component Attributes</title>
 		<para>Most components will have editable attributes, such as the resistance for resistors. By default, you can edit simple attributes in the toolbar, when a group of the same type of components are selected. If your selection contains a mixture of different types of components (such as resistors and capacitors), then no attributes will be displayed for editing.</para>
 		
-		<para>Some components have more advanced attributes which are not accessible via the toolbar. These are found in the Item sidebar on the right. The diode, for example, has a variety of behavioural characteristics that you can edit here.</para>
+		<para>Some components have more advanced attributes which are not accessible via the toolbar. These are found in the <guilabel>Item</guilabel> sidebar on the right. The diode, for example, has a variety of behavioral characteristics that you can edit here.</para>
 <!-- Not in 0.3.6 version
-		<para>If your selection of components have different values for their attributes (for example, different resistances for a selection of resistors), the <guilabel>Item</guilabel> sidebar will have the disagreeing attributes greyed-out. You can enable these by clicking the <guibutton>Merge properties</guibutton> button.</para>
+		<para>If your selection of components have different values for their attributes (for example, different resistances for a selection of resistors), the <guilabel>Item</guilabel> sidebar will have the disagreeing attributes grayed-out. You can enable these by clicking the <guibutton>Merge properties</guibutton> button.</para>
 
 		<para>The "Defaults" button will reset the component attributes to the ones it had on creation.</para>
 		-->
@@ -47,7 +47,7 @@
 		
 		<para>The results of the simulation are provided through several graphical means.</para>
 		
-		<para>The pins on the components will display voltage sidebars. These are coloured orange for positive voltage, and blue for negative voltage. Their length depends on the voltage level, and their width on the amount of current flowing through the pin. These can be turned off in the <guilabel>General</guilabel> page of the <guilabel>Configuration</guilabel> dialog.</para>
+		<para>The pins on the components will display voltage sidebars. These are colored orange for positive voltage, and blue for negative voltage. Their length depends on the voltage level, and their width on the amount of current flowing through the pin. These can be turned off in the <guilabel>General</guilabel> page of the <guilabel>Configuration</guilabel> dialog.</para>
 		
 		<para>Hovering the mouse over a pin or connection will display a small tooltip showing the voltage and current at that point in the circuit. Several components also provide graphical feedback - for example, LEDs and voltmeters or ammeters.</para>
 		
@@ -58,7 +58,7 @@
 		<title>Oscilloscope</title>
 		<para>The oscilloscope can record logic, voltage and current data. The logic probe is optimized for storing boolean samples, and so should be used instead of the voltage probe when measuring logic.</para>
 		
-		<para>To collect data, create a new probe component, and attach it to an appropriate point in the circuit. You'll see the output immediately drawn in the oscilloscope. Adding more probes will squash the outputs next to each other - you can reposition these by dragging the arrows on the left of the oscilloscope view, and change their colours via the probe's attributes.</para>
+		<para>To collect data, create a new probe component, and attach it to an appropriate point in the circuit. You'll see the output immediately drawn in the oscilloscope. Adding more probes will squash the outputs next to each other - you can reposition these by dragging the arrows on the left of the oscilloscope view, and change their colors via the probe's attributes.</para>
 		
 		<para>For voltage and current probes, the range of input values can be adjusted in the <guilabel>Item Editor</guilabel> sidebar on the right.</para>
 		
diff --git a/doc/en/debugging.docbook b/doc/en/debugging.docbook
index 10292419..e5c6d48d 100644
--- a/doc/en/debugging.docbook
+++ b/doc/en/debugging.docbook
@@ -15,7 +15,7 @@
 	<sect1 id="controlling_debugger">
 		<title>Controlling the Debugger</title>
 		
-		<para>The debugger can be in one of two modes: running, and stepping. While running, the PIC program will be simulated in realtime. To allow stepping, the PIC program must be paused - either by clicking on Interrupt in the Debug menu, or clicking on the pause button on the PIC component.</para>
+		<para>The debugger can be in one of two modes: running, and stepping. While running, the PIC program will be simulated in realtime. To allow stepping, the PIC program must be paused - either by clicking on <guimenuitem>Interrupt</guimenuitem> in the <guimenu>Debug</guimenu> menu, or clicking on the pause button on the PIC component.</para>
 		
 		<para>In stepping mode, a green arrow in the margin of the text document indicates the next line to be executed (familiar to <application>KDevelop</application> users). It may be useful to turn on the icon border via the <guimenu>View</guimenu> menu (it can be permanently turned on via the <guilabel>Editor Settings</guilabel> dialog).</para>
 		
@@ -27,7 +27,7 @@
 				<listitem><para><guimenuitem>Step Out</guimenuitem> - If the current execution is inside a call, or similar, then this will wait until the call returns. Similarly to stepping over, this is equivalent to waiting until the stack level returns to one less than the initial level, if the initial level is greater than zero.</para></listitem>
 		</itemizedlist>
 		
-		<para>Breakpoints allow the execution to be paused when the PIC program reaches a given instruction. To toggle a breakpoint on the line containing the cursor, either use the Debug menu, or click on the icon border of the text document.</para>
+		<para>Breakpoints allow the execution to be paused when the PIC program reaches a given instruction. To toggle a breakpoint on the line containing the cursor, either use the <guimenu>Debug</guimenu> menu, or click on the icon border of the text document.</para>
 		
 		<para>The <guilabel>Symbol Viewer</guilabel> sidebar on the right shows the values of the Special Function Registers. To find out the value of a variable in the General Purpose Registers, you can hover your mouse over the variable name in an instruction that operates on that register. Note that the radix selection in the <guilabel>Symbol Viewer</guilabel> also controls how the value is displayed when hovering over a variable.</para>
 	</sect1>
diff --git a/doc/en/microbe.docbook b/doc/en/microbe.docbook
index d494a3a8..437d94fd 100644
--- a/doc/en/microbe.docbook
+++ b/doc/en/microbe.docbook
@@ -228,7 +228,7 @@ goto MyLabel
 		Syntax:
 		<programlisting role="correct"><function>delay</function> [interval]</programlisting>
 		
-		<note><para>At present, µbe; assumes that the PIC is operating at a frequency of 4Mhz - &ie; each instruction takes 1 microsecond to execute. If this is not the case, the interval must be adjusted proportionately.</para></note>
+		<note><para>At present, µbe; assumes that the PIC is operating at a frequency of 4MHz - &ie; each instruction takes 1 microsecond to execute. If this is not the case, the interval must be adjusted proportionately.</para></note>
 		</para>
 	</sect2>
 	
diff --git a/doc/en/quick.docbook b/doc/en/quick.docbook
index 481bb191..af5a7078 100644
--- a/doc/en/quick.docbook
+++ b/doc/en/quick.docbook
@@ -35,7 +35,7 @@
 		
 		<para>In Circuit and &flowcode; documents, there are several drawing tools available, including text. These are available by clicking on the paintbrush icon in the toolbar. To draw, drag the mouse to form either a shape or a line appropriate to the drawing tool in use.</para>
 		
-		<para>When a drawing is selected, it can be resized by dragging its handles. Holding down &Shift; while dragging will snap the handle to the underlying grid. Each tool has basic options accessible from the toolbar, such as colours. There are also more advanced options found in the <guilabel>Item Editor</guilabel> sidebar, such as line and cap styles.</para>
+		<para>When a drawing is selected, it can be resized by dragging its handles. Holding down &Shift; while dragging will snap the handle to the underlying grid. Each tool has basic options accessible from the toolbar, such as colors. There are also more advanced options found in the <guilabel>Item Editor</guilabel> sidebar, such as line and cap styles.</para>
 		
 	</sect1>
 	


More information about the kde-doc-english mailing list