4:36 p.m.
commit 5cef7607a911b18f9d03aedac9716f170bf50327
Author: John J. McDonough <wb8rcr(a)arrl.net>
Date: Sat Nov 6 17:36:36 2010 -0400
Add documentation for rcrpanel
en-US/images/others-rcrpanel/Controls.png | Bin 0 -> 2584 bytes
en-US/images/others-rcrpanel/Dial1.png | Bin 0 -> 23498 bytes
en-US/images/others-rcrpanel/Dial2.png | Bin 0 -> 5983 bytes
en-US/images/others-rcrpanel/Dial3.png | Bin 0 -> 16228 bytes
en-US/images/others-rcrpanel/ExamplePanel.png | Bin 0 -> 38263 bytes
en-US/images/others-rcrpanel/WhiteFill.png | Bin 0 -> 1751 bytes
en-US/others-rcrpanel.xml | 502 +++++++++++++++++++++++++
en-US/others.xml | 4 +-
8 files changed, 505 insertions(+), 1 deletions(-)
---
diff --git a/en-US/images/others-rcrpanel/Controls.png
b/en-US/images/others-rcrpanel/Controls.png
new file mode 100644
index 0000000..4dd07bb
Binary files /dev/null and b/en-US/images/others-rcrpanel/Controls.png differ
diff --git a/en-US/images/others-rcrpanel/Dial1.png
b/en-US/images/others-rcrpanel/Dial1.png
new file mode 100644
index 0000000..daec043
Binary files /dev/null and b/en-US/images/others-rcrpanel/Dial1.png differ
diff --git a/en-US/images/others-rcrpanel/Dial2.png
b/en-US/images/others-rcrpanel/Dial2.png
new file mode 100644
index 0000000..951b0f2
Binary files /dev/null and b/en-US/images/others-rcrpanel/Dial2.png differ
diff --git a/en-US/images/others-rcrpanel/Dial3.png
b/en-US/images/others-rcrpanel/Dial3.png
new file mode 100644
index 0000000..b670cdf
Binary files /dev/null and b/en-US/images/others-rcrpanel/Dial3.png differ
diff --git a/en-US/images/others-rcrpanel/ExamplePanel.png
b/en-US/images/others-rcrpanel/ExamplePanel.png
new file mode 100644
index 0000000..b376a6a
Binary files /dev/null and b/en-US/images/others-rcrpanel/ExamplePanel.png differ
diff --git a/en-US/images/others-rcrpanel/WhiteFill.png
b/en-US/images/others-rcrpanel/WhiteFill.png
new file mode 100644
index 0000000..176a665
Binary files /dev/null and b/en-US/images/others-rcrpanel/WhiteFill.png differ
diff --git a/en-US/others-rcrpanel.xml b/en-US/others-rcrpanel.xml
new file mode 100644
index 0000000..e7c7e23
--- /dev/null
+++ b/en-US/others-rcrpanel.xml
@@ -0,0 +1,502 @@
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docarticle/xml/4.5/docarticlex.dtd" [
+]>
+
+ <section id="others-rcrpanel">
+ <title>rcrpanel</title>
+ <para>
+ <package>rcrpanel</package> is a command line application wich allows
+ layout of panels for electronic equipment.
<package>rcrpanel</package>
+ accepts as input a text file describing the panel. It produces as output a
+ Postscript stream of an image of the panel. The Postscript stream may be
+ redirected to a file, a Postscript printer, or piped to another
+ application such as Ghostscript.
+ </para>
+ <para>
+ By taking a text description of the panel, <package>rcrpanel</package>
+ allows precise placement of controls and annotation, which can be
+ difficult to achieve with a GUI interface. <package>rcrpanel</package>
+ provides scripting elements for text, controls of various sizes, and even
+ calibrated dials.
+ </para>
+ <para>
+ <figure float="0">
+ <title>Example Panel</title>
+ <mediaobject>
+ <imageobject><imagedata scale="99" scalefit="1"
fileref="images/others-rcrpanel/ExamplePanel.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ Example Panel
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <section>
+ <title>Running rcrpanel</title>
+ <para>
+ <package>rcrpanel</package> accepts a single command line parameter, the
+ input file containing the description of the panel. It produces its
+ output on <filename>stdout</filename>, which means that in most cases,
+ the user will redirect the output to a file. For example:
+ <screen>
+ rcrpanel mypanel.txt >mypanel.ps
+ </screen>
+ </para>
+ <para>
+ There are no command line switches available.
+ </para>
+ </section>
+ <section>
+ <title>The Input File</title>
+ <para>
+ The input file contains lines describing the various controls. Most
+ lines are of the form
+ <screen>
+ Command = something
+ </screen>
+
+ where the spaces around the equal sign are significant, and the command
+ itself is case-sensitive.
+ </para>
+ <para>
+ Measurements are in units of millimeters. Angles are in degrees.
+ Colors are given as 24 bit C style integers where each byte repesents
+ the amount of red, green, or blue.
+ </para>
+ <para>
+ In general, the order of commands makes no difference. However, the
+ <command>Text</command> command must be immediately followed by a line
+ containing the text to be displayed, and those commands affecting the
+ appearance of a <command>Dial</command> affect the preceding
+ <command>Dial</command> command.
+ </para>
+
+ <section>
+ <title>Background</title>
+ <para>
+ This command takes a single color following the equal sign. The
+ entire panel will be filled with this color.
+<screen>
+Background = 0xfff5e8
+</screen>
+ Note, however, that the interior of controls will not be filled with
+ this color, allowing the alignment marks to be viewed for drilling,
+ even if the panel were filled with a dark color.
+ </para>
+ <para>
+ <figure float="0">
+ <title>ControlPhone on a dark background</title>
+ <mediaobject>
+ <imageobject><imagedata scale="50" scalefit="0"
fileref="images/others-rcrpanel/WhiteFill.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ ControlPhone on a dark background
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
+
+ <section>
+ <title>ControlLarge</title>
+ <para>
+ This is used for large diameter controls such as large pots and
+ the like. It takes 2 values after the equal sign representing the
+ position of the control on the panel.
+<screen>
+ControlLarge = 23.0 30.0
+</screen>
+ </para>
+ </section>
+
+ <section>
+ <title>ControlLED</title>
+ <para>
+ This command generates an outline for a 5 mm LED. Like the other
+ control commands, it takes 2 values, the X and Y positions on the
+ panel of the center of the LED.
+ </para>
+ </section>
+
+ <section>
+ <title>ControlPhone</title>
+ <para>
+ This is used for 1/4" phone jacks and similar controls. The 2
+ values after the equal sign represent the position on the panel.
+ </para>
+ </section>
+
+ <section>
+ <title>ControlSmall</title>
+ <para>
+ This command generates an outline for a 3.5 mm phone jack. The two
+ values are the X and Y positions of the jack on the panel.
+ </para>
+
+
+ </section>
+ <section>
+ <title>ControlTiny</title>
+ <para>
+ This command generates an outline for a 2.5 mm phone jack. The two
+ values are the X and Y positions of the jack on the panel.
+<screen>
+ControlTiny = 75.0 30.0
+</screen>
+ </para>
+ <para>
+ <figure float="0">
+ <title>Large, Phone, LED, Small and Tiny controls</title>
+ <mediaobject>
+ <imageobject><imagedata scale="50" scalefit="0"
fileref="images/others-rcrpanel/Controls.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ Large, Phone, LED, Small and Tiny controls
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+
+
+ </section>
+ <section>
+ <title>Panel</title>
+ <para>
+ This command defines the size of the panel. The 2 dimensions are the
+ width and height of the panel.
+<screen>
+Panel = 193.675 53.975
+</screen>
+ </para>
+
+
+ </section>
+ <section>
+ <title>Reverse</title> <para> This command takes no arguments. If
this
+ command appears anywhere in the input file, the resulting PostScript
+ will be flipped left to right (for printing on the reverse side of
+ transparency material).
+ </para>
+
+
+ </section>
+ <section>
+ <title>Text</title>
+ <para>
+ This command is somewhat different from the others. After the equal
+ sign, it takes 3 floating point numbers, a color, and a text string.
+ The first 2 floating point numbers are the X, Y position of the text
+ on the panel. The third number is the height of the text. The color
+ represents the color of the text, and the text string represents the
+ font to be used. No checking is done before preparing the PostScript;
+ you are responsible for ensuring that the font is availble on your
+ printer.
+ </para>
+
+ <para>
+ This command is then followed by another line containing the text to
+ be displayed.
+<screen>
+Text = 100.0 10.0 5.0 0x7f4f00 Times-Roman-Bold
+Filter
+</screen>
+ </para>
+
+
+ </section>
+ <section>
+ <title>Dial</title>
+ <para>
+ This command introduces a new dial. The <command>Dial</command>
+ command describes the X,Y center of the dial. The following commands
+ then further refine the details of this particular dial. This
+ relationship between the <command>Dial</command> command and it's
+ successors is the only place where the order of the commands within
+ the file matters.
+<screen>
+Dial = 170.0 30.0
+</screen>
+ </para>
+
+
+ </section>
+ <section>
+ <title>Radius</title>
+ <para>
+ This command takes a single value which is the radius of the circle
+ which forms the inside of the tick marks. This command refers to the
+ current <command>Dial</command> command.
+<screen>
+Radius = 7.0
+</screen>
+ </para>
+
+
+ </section>
+ <section>
+ <title>Span</title>
+ <para>
+ This command describes the angle over which the control may operate.
+ Typically, this would be 270 for a potentiometer and 180 for a
+ variable capacitor. This command refers to the current
+ <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>NumTicks</title>
+ <para>
+ This command describes the total number of tick marks, large and
+ small, to be drawn. This is usually an odd number since the starting
+ and ending values are counted. Typically this will be 11, 101, or a
+ similar number. This command refers to the current
+ <command>Dial</command> command.
+<screen>
+NumTicks = 101
+</screen>
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>BigPer</title>
+ <para>
+ This command tells the program how many small tick marks there are per
+ large tick mark. This command refers to the current
+ <command>Dial</command> command.
+<screen>
+BigPer = 10
+</screen>
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>SizeTicks</title>
+ <para>
+ This command describes the length of the small tick marks. This
+ command refers to the current <command>Dial</command> command.
+<screen>
+SizeTicks = 6.5
+</screen>
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>SizeBig</title>
+ <para>
+ This command describes the length of the large tick marks. This
+ command refers to the current <command>Dial</command> command.
+<screen>
+SizeBig = 7.5
+</screen>
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>StartingIndicator</title>
+ <para>
+ This command describes the value to be placed on the furthest
+ counterclockwise large tick mark. This command refers to the current
+ <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>IncrementPerBigTick</title>
+ <para>
+ This command tells rcrpanel how much to increment the value in
+ <command>StartingIndicator</command>
+ for each succeding large tick mark.
+ This command refers to the current
+ <command>Dial</command>
+ command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>SizeFont</title>
+ <para>
+ This command describes how large to make the annotation on the ticks.
+ This command refers to the current
+ <command>Dial</command>
+ command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>ColorCircle</title>
+ <para>
+ This command takes a single color as an argument, which is used to
+ draw the inner circle. This command refers to the current
+ <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>ColorTickMarks</title>
+ <para>
+ This command permits setting the color to draw the small tick marks.
+ This command refers to the current <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>ColorBigTickMarks</title>
+ <para>
+ This command permits setting the color to draw the large tick marks.
+ This command refers to the current <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>ColorText</title>
+ <para>
+ This command accepts a single color which will be used for the
+ annotation. This command refers to the current
+ <command>Dial</command> command.
+ </para>
+
+
+
+ </section>
+ <section>
+ <title>StartAngle</title>
+ <para>
+ By default, <package>rcrpanel</package> arranges dials so the dead
+ spot on the control is straight down. This is the desired behavior in
+ almost all cases. However, sometimes you may want to rotate a control
+ to some other orientation. The single argument to
+ <command>StartAngle</command> is the number of degrees clockwise to
+ rotate the control. This command refers to the current
+ <command>Dial</command> command.
+ </para>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Example Dials</title>
+
+ <section>
+ <title>Frequency Markings for a VCO</title>
+ <para>
+<screen>
+Dial = 25.0 25.0
+Radius = 7.0
+SizeTicks = 4.5
+ColorTickMarks = 0xff7777
+SizeBig = 7.5
+ColorBigTickMarks = 0x000000
+StartingIndicator = 7.0
+IncrementPerBigTick = 0.01
+NumTicks = 51
+BigPer = 5
+ColorCircle = 0xff7777
+SizeFont = 3.0
+</screen>
+ </para>
+ <para>
+ <figure float="0">
+ <title>40 meter dial, 270 degrees</title>
+ <mediaobject>
+ <imageobject><imagedata scale="50" scalefit="0"
fileref="images/others-rcrpanel/Dial1.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ 40 meter dial, 270 degrees
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
+
+ <section>
+ <title>Markings for a volume control</title>
+ <para>
+<screen>
+ControlLarge = 25.0 25.0
+Dial = 25.0 25.0
+Radius = 7.0
+SizeTicks = 1.0
+ColorTickMarks = 0xaaddaa
+SizeBig = 2.0
+ColorBigTickMarks = 0x007f00
+StartingIndicator = 0
+IncrementPerBigTick = 2
+NumTicks = 11
+BigPer = 2
+ColorCircle = 0xccffcc
+SizeFont = 3.0
+</screen>
+ </para>
+ <para>
+ <figure float="0">
+ <title>Volume Control</title>
+ <mediaobject>
+ <imageobject><imagedata scale="50" scalefit="0"
fileref="images/others-rcrpanel/Dial2.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ Volume Control
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
+
+ <section>
+ <title>Markings for a VFO (capacitor based)</title>
+ <para>
+<screen>
+ControlLarge = 25.0 25.0
+Dial = 25.0 25.0
+Radius = 7.0
+SizeTicks = 3.5
+ColorTickMarks = 0x777777
+SizeBig = 5.5
+ColorBigTickMarks = 0xffffff
+StartingIndicator = 3.5
+IncrementPerBigTick = 0.01
+NumTicks = 41
+BigPer = 4
+ColorCircle = 0x777777
+SizeFont = 2.0
+ColorText = 0xffffff
+Span = 180.0
+Text = 25.0 15.0 2.0 0xff0000 Century-Schoolbook
+Frequency
+</screen>
+ </para>
+ <para>
+ <figure float="0">
+ <title>80 meter VFO</title>
+ <mediaobject>
+ <imageobject><imagedata scale="50" scalefit="0"
fileref="images/others-rcrpanel/Dial3.png"
format="PNG"/></imageobject>
+ <textobject><para>
+ 80 meter VFO
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
+ </section>
+ </section>
diff --git a/en-US/others.xml b/en-US/others.xml
index 3c477ba..48e63e0 100644
--- a/en-US/others.xml
+++ b/en-US/others.xml
@@ -19,7 +19,9 @@
<xi:include href="others-gridloc.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="others-gtkwave.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="others-ibp.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="others-morse2txt.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="others-morse2txt.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+<xi:include href="others-rcrpanel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="others-ssbd.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="others-svxlink.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="others-thebridge.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />