[ktechlab] doc/en: Fix formatting + several updates, comment out outdated parts
Yuri Chornoivan
null at kde.org
Mon Jan 2 09:52:12 UTC 2017
Git commit 7aca329d628d3b36a589eff8f3a277912b55a7e4 by Yuri Chornoivan.
Committed on 02/01/2017 at 09:52.
Pushed by yurchor into branch 'master'.
Fix formatting + several updates, comment out outdated parts
M +13 -13 doc/en/circuits.docbook
M +7 -7 doc/en/debugging.docbook
M +5 -5 doc/en/flowcode.docbook
M +10 -11 doc/en/microbe.docbook
M +7 -7 doc/en/picprograms.docbook
https://commits.kde.org/ktechlab/7aca329d628d3b36a589eff8f3a277912b55a7e4
diff --git a/doc/en/circuits.docbook b/doc/en/circuits.docbook
index 2fcf4097..9d8356ab 100644
--- a/doc/en/circuits.docbook
+++ b/doc/en/circuits.docbook
@@ -6,11 +6,11 @@
<title>Placing components</title>
<para>On the left, you'll find the <guilabel>Components</guilabel> tab.</para>
- <para>Dragging a component from the sidebar into the circuit will place it under the mouse cursor. Alternatively, you can double click on an item in the Components sidebar to repeatedly add it to the circuit. In this mode, a copy of the selected component will be placed repeatedly on mouse left-clicking until either Escape is pressed, or the mouse is right-clicked.</para>
+ <para>Dragging a component from the sidebar into the circuit will place it under the mouse cursor. Alternatively, you can double click on an item in the <guilabel>Components</guilabel> sidebar to repeatedly add it to the circuit. In this mode, a copy of the selected component will be placed repeatedly on mouse left-clicking until either &Esc; is pressed, or the mouse is right-clicked.</para>
<para>To reposition a component, left-click and drag. You'll find it snapping to the underlying grid. If you drag the component out of the right or bottom edges of the workarea, the workarea will resize itself to accommodate.</para>
- <para>All components have a notion of orientation; 0, 90, 180 and 270 degrees. Those that aren't symmetrical about an axis can also be flipped. To rotate a selection of components, either right click and select from the Orientation menu, or click on the rotate buttons in the toolbar. The latter can also be accessed by pressing the "[" and "]" keys (familiar to Inkscape users). The Item sidebar (on the right) provides a powerful method of setting the orientation by providing previews of the components. Flipping components is also only possibly via the Item sidebar.</para>
+ <para>All components have a notion of orientation; 0, 90, 180 and 270 degrees. Those that aren't symmetrical about an axis can also be flipped. To rotate a selection of components, either right click and select from the <guimenu>Orientation</guimenu> menu, or click on the rotate buttons in the toolbar. The latter can also be accessed by pressing the <keycap>[</keycap> and <keycap>]</keycap> keys (familiar to <application>Inkscape</application> users). The <guilabel>Item</guilabel> sidebar (on the right) provides a powerful method of setting the orientation by providing previews of the components. Flipping components is also only possibly via the <guilabel>Item</guilabel> sidebar.</para>
</sect1>
<sect1 id="connecting_components">
@@ -19,11 +19,11 @@
<para>In automatic mode, create a connection by dragging from either a component pin or an existing connection, and releasing the mouse over the desired pin or connection. You'll see the straight-line being drawn turn orange when a valid connection will be created on mouse release. If the line you're drawing is black, it's either because there's nothing beneath the mouse cursor, or you're attempting to connect together two items which are already connected. When flowcharting, the criteria for a valid connection are more complex - but we'll get to that later.</para>
- <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 escape, or right-click the mouse.</para>
+ <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>To remove an existing connection, select it by drawing a small select-rectangle over part of the connector, and hit delete.</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>
<sect1 id="component_attributes">
@@ -31,23 +31,23 @@
<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>If your selection of components have different values for their attributes (for example, different resistances for a selection of resistors), the Item sidebar will have the disagreeing attributes greyed-out. You can enable these by clicking the "Merge properties" button.</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>The "Defaults" button will reset the component attributes to the ones it had on creation.</para>
-
+ -->
<para>There is one type of attribute that cannot be editable by either the toolbar or Item sidebar - multiline text. Double clicking on the item will bring up a dialog box where the text can be entered.</para>
</sect1>
<sect1 id="circuit_simulation">
<title>Simulation</title>
- <para>By default, the simulation will be running when you create a new circuit. The status of the simulation is displayed in the lower right of a circuit view, and can be changed via the Tools menu. Firstly - a little explanation on how the Simulator works. This should allow you to make the most out of it.</para>
+ <para>By default, the simulation will be running when you create a new circuit. The status of the simulation is displayed in the lower right of a circuit view, and can be changed via the <guimenu>Tools</guimenu> menu. Firstly - a little explanation on how the Simulator works. This should allow you to make the most out of it.</para>
<para>When a circuit is created or modified, the affected areas are partitioned up into groups of pins and connections that can be considered independent. Each group is then simulated as a separate entity (although still interacting via the components), with the simulation provided dependent on the group's complexity. Complex groups, such as those involving nonlinear components like LEDs, are slow to simulate. Groups that contain only logic pins, of which only one controls the value on those pins, are the fastest to simulate.</para>
<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 Work Area tab of the Configuration dialog.</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>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>
@@ -60,7 +60,7 @@
<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>For voltage and current probes, the range of input values can be adjusted in the "Item Editor" sidebar on the right.</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>
<para>Zooming is controlled by a slider. The scaling is logarithmic; for every few pixels that the slider moves along, the zoom factor will be multiplied by a constant. &ktechlab; simulates logic to a maximum precision of 1 microsecond, and at maximum zoom level, one microsecond is represented by 8 pixels.</para>
@@ -73,9 +73,9 @@
<title>Subcircuits</title>
<para>Subcircuits offer a reusable and tidy way of using a circuit, when you're only interested in interacting with external connections to the circuit. The subcircuit is creating as an IC, with the pins acting as the interaction with the internal circuit.</para>
- <para>First, the circuit to be used in as a template for creating a subcircuit from must be constructed. The points of interaction are defined via "External Connection" components. These must be connected up, and positioned where you want the pin to be positioned on the subcircuit IC.</para>
+ <para>First, the circuit to be used in as a template for creating a subcircuit from must be constructed. The points of interaction are defined via <guilabel>External Connection</guilabel> components. These must be connected up, and positioned where you want the pin to be positioned on the subcircuit IC.</para>
- <para>Next, select the group of components and external connections to be turned into a subcircuit, and select "Create Subcircuit" from the right-click menu. You'll be offered to enter a name for the subcircuit. Once created, the name will popup in the Component selector under the Subcircuits selection. This can be treated as any normal component - with the additional option of removing it by right-clicking on the item and selecting Remove.</para>
+ <para>Next, select the group of components and external connections to be turned into a subcircuit, and select <guimenuitem>Create Subcircuit</guimenuitem> from the right-click menu. You'll be offered to enter a name for the subcircuit. Once created, the name will popup in the <guilabel>Components</guilabel> selector under the <guilabel>Subcircuits</guilabel> selection. This can be treated as any normal component - with the additional option of removing it by right-clicking on the item and selecting <guimenuitem>Remove</guimenuitem>.</para>
</sect1>
</chapter>
diff --git a/doc/en/debugging.docbook b/doc/en/debugging.docbook
index af1a8641..10292419 100644
--- a/doc/en/debugging.docbook
+++ b/doc/en/debugging.docbook
@@ -5,11 +5,11 @@
<sect1 id="starting_debugger">
<title>Starting the Debugger</title>
- <para>Debugging support is provided for Assembly, SDCC and Microbe, when they are open as a text document. From here, stepping is controlled via the Debug menu. There are two methods of starting the debugger.</para>
+ <para>Debugging support is provided for Assembly, SDCC and Microbe, when they are open as a text document. From here, stepping is controlled via the <guimenu>Debug</guimenu> menu. There are two methods of starting the debugger.</para>
<para>If the PIC program is already running in a circuit, then double-clicking on the PIC component will open up the program. For assembly PIC programs, the debugger for that text document will be linked into the PIC component. In this case, the debug menu cannot stop the PIC program - as this is owned by the PIC component.</para>
- <para>If the assembly file is already opened, then the debugger can be run via the Debug menu. After compiling the program, the debugger will be ready, with the PIC program paused at the first instruction. Note that when debugging high level languages, the current execution point will not be shown if there is no line that corresponds to the first assembly instruction to be executed. In this case, clicking next will bring the execution point to the first line in the program.</para>
+ <para>If the assembly file is already opened, then the debugger can be run via the <guimenu>Debug</guimenu> menu. After compiling the program, the debugger will be ready, with the PIC program paused at the first instruction. Note that when debugging high level languages, the current execution point will not be shown if there is no line that corresponds to the first assembly instruction to be executed. In this case, clicking <guibutton>Next</guibutton> will bring the execution point to the first line in the program.</para>
</sect1>
<sect1 id="controlling_debugger">
@@ -17,19 +17,19 @@
<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>In stepping mode, a green arrow in the margin of the text document indicates the next line to be executed (familiar to KDevelop users). It may be useful to turn on the icon border via the View menu (it can be permanently turned on via the Editor Settings dialog).</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>
<para>There are three types of stepping:</para>
<itemizedlist>
- <listitem><para>Step into - This executes the current instruction. The green arrow is moved onto the next line to be executed.</para></listitem>
- <listitem><para>Step over - If the next instruction to be executed is a call, or similar, then this will "step over" the call, returning to stepping mode once the call has returned. Otherwise, stepping over an instruction behaves identically to step. To put it technically - the initial stack level is recorded, and the program execution is paused once the stack level returns to its initial level.</para></listitem>
- <listitem><para>Step out - 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>
+ <listitem><para><guimenuitem>Step</guimenuitem> - This executes the current instruction. The green arrow is moved onto the next line to be executed.</para></listitem>
+ <listitem><para><guimenuitem>Step Over</guimenuitem> - If the next instruction to be executed is a call, or similar, then this will "step over" the call, returning to stepping mode once the call has returned. Otherwise, stepping over an instruction behaves identically to step. To put it technically - the initial stack level is recorded, and the program execution is paused once the stack level returns to its initial level.</para></listitem>
+ <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>The "Symbol Viewer" 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 Symbol Viewer also controls how the value is displayed when hovering over a variable.</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>
</chapter>
diff --git a/doc/en/flowcode.docbook b/doc/en/flowcode.docbook
index dbef18e0..dbb87a89 100644
--- a/doc/en/flowcode.docbook
+++ b/doc/en/flowcode.docbook
@@ -20,11 +20,11 @@
<sect1 id="flowcode_creation">
<title>Creating a Program</title>
- <para>Every &flowcode; program needs a unique starting point - this is the place where your program will be run from on PIC startup. To define this point, open up the FlowParts sidebar on the left, and drag across the Start part. &ktechlab; will only allow you to use one of these.</para>
+ <para>Every &flowcode; program needs a unique starting point - this is the place where your program will be run from on PIC startup. To define this point, open up the FlowParts sidebar on the left, and drag across the <guilabel>Start</guilabel> part. &ktechlab; will only allow you to use one of these.</para>
- <para>You can then construct your program by using the predefined parts on the left - or insert code of your own (in assembly or µbe; format) via the Embed part. The flow of the program is controlled via the connections between the FlowParts - <xref linkend="connecting_components"/> offers more detail on creating connections.</para>
+ <para>You can then construct your program by using the predefined parts on the left - or insert code of your own (in assembly or µbe; format) via the <guilabel>Embed</guilabel> part. The flow of the program is controlled via the connections between the FlowParts - <xref linkend="connecting_components"/> offers more detail on creating connections.</para>
- <para>&flowcode; imposes limitations in addition to those of Circuits on what can be connected. For example, each FlowPart can only have one output connection. Additional limitations are described in <xref linkend="nestling_flowcode"/>.</para>
+ <para>&flowcode; imposes limitations in addition to those of circuits on what can be connected. For example, each FlowPart can only have one output connection. Additional limitations are described in <xref linkend="nestling_flowcode"/>.</para>
</sect1>
<sect1 id="pic_settings">
@@ -34,9 +34,9 @@
<para>Each pin shown on the picture of the PIC shows the initial type of pin (input or output), and its initial state (high or low). You can change these by dragging the pin to set the type, and clicking on it to toggle its state.</para>
- <para>The Settings dialog, invoked by clicking on the Settings button, also allows you to edit the initial pin types and states - in this case, by editing the binary values written to the PORT and TRIS registers. As well as pin settings though, the dialog allows editing of the initial values of variables in the PIC program.</para>
+ <para>The <guilabel>Settings</guilabel> dialog, invoked by clicking on the <guibutton>Settings</guibutton> button, also allows you to edit the initial pin types and states - in this case, by editing the binary values written to the PORT and TRIS registers. As well as pin settings though, the dialog allows editing of the initial values of variables in the PIC program.</para>
- <para>At the bottom, there is a list of currently defined pin maps, as well as buttons to manipulate them. Pin maps are used to specify how a seven segment or a keypad is connected to a PIC. To use the Seven Segment or the Keypad &flowcode; parts, you will need to define a pin map here first.</para>
+ <para>At the bottom, there is a list of currently defined pin maps, as well as buttons to manipulate them. Pin maps are used to specify how a seven segment or a keypad is connected to a PIC. To use the <guilabel>Seven Segment</guilabel> or the <guilabel>Keypad</guilabel> &flowcode; parts, you will need to define a pin map here first.</para>
</sect1>
diff --git a/doc/en/microbe.docbook b/doc/en/microbe.docbook
index 853d2b82..d494a3a8 100644
--- a/doc/en/microbe.docbook
+++ b/doc/en/microbe.docbook
@@ -18,7 +18,7 @@
</itemizedlist>
<para>
- The .microbe input file must identify the target PIC by inserting the PIC name at the top of the .microbe file; e.g. the name of a PIC16F84 is "P16F84".
+ The .microbe input file must identify the target PIC by inserting the PIC name at the top of the .microbe file; ⪚ the name of a PIC16F84 is "P16F84".
<example><title>Simple complete µbe; program</title>
<programlisting role="correct">
@@ -44,7 +44,7 @@ end</programlisting>
<listitem><para>They can only contain alphanumerical characters [a..z][A..Z][0..9] and the underscore "_".</para></listitem>
<listitem><para>They are case-sensitive.</para></listitem>
<listitem><para>They cannot start with a number.</para></listitem>
- <listitem><para>They should not start with "__" (double underscore), as this is reserved for use by the compiler.</para></listitem>
+ <listitem><para>They should not start with <quote>__</quote> (double underscore), as this is reserved for use by the compiler.</para></listitem>
</itemizedlist>
</para>
</sect2>
@@ -92,7 +92,7 @@ multiline comment */</programlisting>
<sect2 id="structure">
<title>Program Structure</title>
<para>
- The PIC id must be inserted at the top of the program. The end of the main program is denoted with "end". Subroutines must placed after "end".
+ The PIC id must be inserted at the top of the program. The end of the main program is denoted with <quote>end</quote>. Subroutines must placed after <quote>end</quote>.
</para>
</sect2>
@@ -106,7 +106,7 @@ sub SubName
{
// Code...
}</programlisting>
- <para>The subroutine is called with "call SubName".</para>
+<para>The subroutine is called with <quote>call <replaceable>SubName</replaceable></quote>.</para>
</sect2>
</sect1>
@@ -216,7 +216,7 @@ goto MyLabel
Syntax:
<programlisting role="correct"><function>call</function> [SubName]</programlisting>
- where SubName is the name of the subroutine to be called.
+ where <replaceable>SubName</replaceable> is the name of the subroutine to be called.
</para>
</sect2>
@@ -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 - i.e. 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>
@@ -317,7 +317,7 @@ x = keypad1</programlisting>
<sect2 id="pins">
<title>Pin I/O</title>
<para>
- Each pin on a port is obtained by prefixing the pin number by the port name; e.g. Pin 2 (starting from Pin 0) on PORTA is known as
+ Each pin on a port is obtained by prefixing the pin number by the port name; ⪚ Pin 2 (starting from Pin 0) on PORTA is known as
<emphasis>PORTA.0</emphasis>.
The syntax to set a pin state is:
@@ -414,11 +414,10 @@ TRISB = 255
There are several types of events, and some of these take an optional parameter making
the condition under which the routine is called more specific.
<itemizedlist>
- <listitem><para><emphasis>changed <pin name></emphasis>
- - Occurs when the state of the specified pin changes. Pin name is in the usual syntax of PORTX.n, e.g. <programlisting>interrupt changed PORTB.4</programlisting></para></listitem>
- <listitem><para><emphasis>triggered</emphasis> - Rotates the variable x right through carry.</para></listitem>
+ <listitem><para><emphasis>change <pin name></emphasis>
+ - Occurs when the state of the specified pin changes. Pin name is in the usual syntax of PORTX.n, ⪚ <programlisting>interrupt change PORTB.4</programlisting></para></listitem>
<listitem><para><emphasis>timer</emphasis> - ///TODO</para></listitem>
- <listitem><para><emphasis>write_complete</emphasis> - ///TODO</para></listitem>
+ <listitem><para><emphasis>external</emphasis> - ///TODO</para></listitem>
</itemizedlist>
</para>
</sect1>
diff --git a/doc/en/picprograms.docbook b/doc/en/picprograms.docbook
index 03ab43a6..12e8aa18 100644
--- a/doc/en/picprograms.docbook
+++ b/doc/en/picprograms.docbook
@@ -8,24 +8,24 @@
<para>When you create a FlowCode or a Text document, you'll notice a drop down menu in the toolbar with a rocket icon. From here, you can manipulate your PIC program; changing it to different forms.</para>
<itemizedlist>
- <listitem><para>Convert to µbe; - This is used only in &flowcode; documents. This is explained further in <xref linkend="flowcode"/>.</para></listitem>
+ <listitem><para><guimenuitem>Convert to µbe;</guimenuitem> - This is used only in &flowcode; documents. This is explained further in <xref linkend="flowcode"/>.</para></listitem>
- <listitem><para>Convert to Assembly - This can be used in four contexts. When a &flowcode; document is open, it will output the &flowcode; as assembly instructions. When a µbe; document is open, it will invoke the <command>microbe</command> program distributed with &ktechlab; to compile the program. Similarly, if a C program is open, it will attempt to compile it via SDCC. When a text document containing PIC hex is open, it will invoke <command>gpdasm</command> to disassemble the hex.</para></listitem>
+ <listitem><para><guimenuitem>Convert to Assembly</guimenuitem> - This can be used in four contexts. When a &flowcode; document is open, it will output the &flowcode; as assembly instructions. When a µbe; document is open, it will invoke the <command>microbe</command> program distributed with &ktechlab; to compile the program. Similarly, if a C program is open, it will attempt to compile it via SDCC. When a text document containing PIC hex is open, it will invoke <command>gpdasm</command> to disassemble the hex.</para></listitem>
- <listitem><para>Convert to Hex - This can also be used in four contexts. As with Convert to Assembly, this can be used with &flowcode;, µbe; and C documents. It will also be enabled when an assembly document is open to assemble it via <command>gpasm</command>.</para></listitem>
+ <listitem><para><guimenuitem>Convert to Hex</guimenuitem> - This can also be used in four contexts. As with <guimenuitem>Convert to Assembly</guimenuitem>, this can be used with &flowcode;, µbe; and C documents. It will also be enabled when an assembly document is open to assemble it via <command>gpasm</command>.</para></listitem>
- <listitem><para>Upload to PIC - This assembles the PIC program currently being edited, and uploads it using the programmer that the user has selected.</para></listitem>
+ <listitem><para><guimenuitem>Upload to PIC</guimenuitem> - This assembles the PIC program currently being edited, and uploads it using the programmer that the user has selected.</para></listitem>
</itemizedlist>
- <para>None of these actions require the current document to be saved - very useful for when a quick program is required. For non-PIC targets, the Output Dialog invoked on clicking on one of these actions can either output the result (always text in the above three cases) to a fresh document, or to a file. If the output is saved to file, it also provides options to load the file after creation, and adding the newly created file to the open project (if one is open).</para>
+ <para>None of these actions require the current document to be saved - very useful for when a quick program is required. For non-PIC targets, the <guilabel>Output</guilabel> dialog invoked on clicking on one of these actions can either output the result (always text in the above three cases) to a fresh document, or to a file. If the output is saved to file, it also provides options to load the file after creation, and adding the newly created file to the open project (if one is open).</para>
- <para>Note that you can make &ktechlab; always use the same view for displaying the outputted content by selecting the option under General Settings.</para>
+ <para>Note that you can make &ktechlab; always use the same view for displaying the outputted content by selecting the option under <guilabel>General</guilabel> settings.</para>
</sect1>
<sect1 id="uploading">
<title>Uploading</title>
- <para>&ktechlab; uses third-party programmers to upload programs to PICs. A variety of common programmers come predefined. Others can be added via the Settings dialog. See the <ulink url="http://ktechlab.org/pic_programmers.php">&ktechlab; website</ulink> for more information.</para>
+ <para>&ktechlab; uses third-party programmers to upload programs to PICs. A variety of common programmers come predefined. Others can be added via the <guilabel>Settings</guilabel> dialog.<!-- See the <ulink url="http://ktechlab.org/pic_programmers.php">&ktechlab; website</ulink> for more information.--></para>
<para>The list of ports is obtained from scanning for serial and parallel ports that are readable and writable. Serial ports are looked for in:</para>
<itemizedlist>
More information about the kde-doc-english
mailing list