Skip to content

Commit

Permalink
Documentation: last piace of Michael Clement's review
Browse files Browse the repository at this point in the history
  • Loading branch information
mcallegari committed Nov 18, 2013
1 parent 181c786 commit 7fe340b
Show file tree
Hide file tree
Showing 38 changed files with 378 additions and 377 deletions.
16 changes: 8 additions & 8 deletions docs/addeditfixtures.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <H1>Add/Edit Fixtures</H1>
each other exactly, any <A HREF="file:concept.html#Scene">Scene</A> functions you
may have created, will very probably do things that you don't want. Also, if
the channel counts don't match, you might end up having fixtures with overlapping
channels, which also results in unwanted behaviour.
channels, which results also to unwanted behaviour.
<A HREF="file:concept.html#RGBMatrix">RGB Matrix</A>, <A HREF="file:concept.html#EFX">EFX</A>,
<A HREF="file:concept.html#Chaser">Chaser</A> and <A HREF="file:concept.html#Collection">Collection</A>
functions remain unaffected since they don't directly address specific channels, but are more
Expand Down Expand Up @@ -47,14 +47,14 @@ <H3>Controls</H3>
<TD>
<UL>
<LI>Name: The friendly name you wish to assign to the fixture</LI>
<LI>Mode: The <A HREF="file:concept.html#FixtureMode">mode</A> you have configured for the fixture</LI>
<LI>Universe: The DMX universe that the newly-added fixture(s) are connected to</LI>
<LI>Mode: The <A HREF="file:concept.html#FixtureMode">mode</A> you have configured to the fixture</LI>
<LI>Universe: The DMX universe where the newly-added fixture(s) are connected to</LI>
<LI>Address: The address of the (first) fixture you are adding. If you are
adding multiple fixtures, each consecutive fixture will be assigned an
address immediately after the previous fixture's channels, unless the address gap
address immediately after the previous fixture's channels, unless address gap
(see below) is non-zero.</LI>
<LI>Channels: If you have selected the <B>Generic</B> dimmer device, you
can define its channel count in this field. Otherwise this field is read-only
can define its channel count to this field. Otherwise this field is read-only
and it just tells you how many channels the currently selected fixture needs
in its currently selected mode.</LI>
<LI>Channel list: This field displays a more detailed list of individual
Expand All @@ -70,11 +70,11 @@ <H3>Controls</H3>
</TD>
<TD>
You can also add more than one fixture at the same time if your setup
consists of multiple fixtures that are of the same make and model.
consists of multiple fixtures that are of the same make &amp; model.
These features are disabled when you are editing an existing fixture.
<UL>
<LI>Amount: The number of new fixtures to create. Each newly-added fixture
also includes a number after its assigned name when you add more than one
<LI>Amount: Number of new fixtures to create. Each newly-added fixture
includes also a number after its assigned name when adding more than one
fixture at a time.</LI>
<LI>Address gap: Leave this many empty channels between each new fixture</LI>
</UL>
Expand Down
4 changes: 2 additions & 2 deletions docs/addvcbuttonmatrix.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

<H1>Add Button Matrix</H1>
<P>
When you wish to create many buttons at a time to the
<A HREF="file:virtualconsole.html">Virtual Console</A>, you may do that by creating a
When you want to create many buttons at the same time on the
<A HREF="file:virtualconsole.html">Virtual Console</A>, you may do this by creating a
<A HREF="file:vcbuttonmatrix.html">Button Matrix</A>, using the Add Button Matrix
dialog.
</P>
Expand Down
8 changes: 4 additions & 4 deletions docs/functionmanager.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<H1><img src="qrc:/function.png" width=32 align="absmiddle"> Function Manager</H1>
<P>
With the function manager you can manage all of your functions that do the actual
work to automate your lights. You can create new functions, remove and edit existing
work of automating your lights. You can create new functions, remove and edit existing
ones as well as create copies of them. Controls are on the upper part of the window;
the lower part displays all of your functions as well as the function editor for the
currently selected function (if any).
Expand All @@ -19,9 +19,9 @@ <H1><img src="qrc:/function.png" width=32 align="absmiddle"> Function Manager</H
<P>
Each function type can be found under its own category: Scene for scenes, EFX for EFX's etc.
When a new function is created or an existing one selected, the appropriate editor is
chosen and displayed on the right side of the Function Manager window. Changes made in the
editor pane are stored immediately to the functions themselves and no additional OK clicks
are no longer required.
chosen and displayed on the right hand side of the Function Manager window. Changes made in the
editor pane are stored immediately in the functions themselves and no additional OK clicks
are required.
</P>

<H2>Controls</H2>
Expand Down
10 changes: 5 additions & 5 deletions docs/functionwizard.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ <H3>Controls</H3>
<TD>
List of fixtures that will be included in the functions created with the
wizard. You can see each fixture's capabilities for Colour-, Gobo- and Shutter-
type scenes on the <B>Supported capabilities</B> column.
type scenes in the <B>Supported capabilities</B> column.
</TD>
</TR>
<TR>
Expand All @@ -49,14 +49,14 @@ <H3>Controls</H3>
</TD>
<TD>
<UL>
<LI>Colours: Create scenes for changing the colour simultaneously to all
<LI>Colours: Create scenes for changing the colour simultaneously on all
currently included fixtures. For this to work, the fixtures must have at least
one colour channel that controls a fixed-color wheel.</LI>
<LI>Gobos: Create scenes for changing the gobo simultaneously to all currently
<LI>Gobos: Create scenes for changing the gobo simultaneously on all currently
included fixtures. For this to work, the fixtures must have at least one gobo
channel.</LI>
<LI>Shutter: Create scenes for changing the shutter position simultaneously
to all currently included fixtures. For this to work, the fixtures must have
on all currently included fixtures. For this to work, the fixtures must have
at least one shutter channel.</LI>
</UL>
</TD>
Expand All @@ -74,7 +74,7 @@ <H3>Controls</H3>
<LI>Even - Odd: Fade all even intensity channels on, while odd channels fade to off and vice versa.</LI>
<LI>Sequence forwards: Fade each intensity channel on in a consecutive sequence.</LI>
<LI>Sequence backwards: The same as above, but in reverse.</LI>
<LI>Random Multi: Fade multiple channels on & off in a random sequence.</LI>
<LI>Random Multi: Fade multiple channels on and off in a random sequence.</LI>
<LI>Random Single: Fade one channel on at a time in a random sequence.</LI>
</UL>
</LI>
Expand Down
6 changes: 3 additions & 3 deletions docs/guicustomstyles.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ <H2>The GUI style file</H2>
The style file must have a CSS syntax. If you're comfortable with web designing, you should
find the creation of this file very easy !<BR>
Since the style file is strictly related to the inner Qt objects, you might want
to read the following articles to find out the elements names and the additional
to read the following articles to find out the elements' names and the additional
CSS properties the Qt team added to the default CSS syntax.<br>
<A HREF="http://qt-project.org/doc/qt-4.8/stylesheet.html">Qt Style Sheets</A><BR>
<A HREF="http://qt-project.org/doc/qt-4.8/stylesheet-examples.html">Qt Style Sheets Examples</A><BR>
It is up to your fantasy how you prefer to customize the QLC+ GUI appearance ! If you find
a style worth to be shared, don't forget to give your contribution by posting it online in the
It is up to your imagination how you prefer to customize the QLC+ GUI appearance! If you find
a style worth sharing, don't forget to send in your contribution by posting it online in the
<A HREF="http://sourceforge.net/p/qlcplus/discussion/">QLC+ forum</A>
</P>

Expand Down
2 changes: 1 addition & 1 deletion docs/headeditor.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <H3>Controls</H3>
<TD>
Displays the list of all fixture channels available in the current mode. Channels that
have been assigned to another head are disabled and cannot be selected because each
channel can belong to one head at a time.
channel can only belong to one head at a time.
</TD>
</TR>
</TABLE>
Expand Down
20 changes: 10 additions & 10 deletions docs/howto-add-fixtures.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ <H2>Fixture Manager</H2>
The fixture manager is the heart of QLC+ fixture-oriented architecture. As its
name already says, you can manage (add, remove and edit) your lighting fixtures
from the fixture manager. On the left side of the manager there is a list that
contains all of the fixtures in the current workspace (it will be empty until you have added some fixtures).
contains all of the fixtures in the current workspace (currently it's empty).
On the right side you can see some common information related to the currently
selected fixture. At the top of the fixture manager there is again another toolbar,
selected fixture. On top of the fixture manager there is again another toolbar,
containing the following buttons (from left to right):
</P>

Expand Down Expand Up @@ -52,7 +52,7 @@ <H2>Adding a fixture</H2>
of fixture models produced by the manufacturer. You can find for example a
"DJScan250" under the "Futurelight" folder. As you click a fixture from the
list, you can see the <u>Channels</u> field on the right side change to
display the number of DMX channels required by the selected fixture. There is
display the number of DMX channels required by the selected fixture. There's
also a list of the fixture's channels just under the <u>Channels</u> box.
</P>

Expand All @@ -69,28 +69,28 @@ <H2>Adding a fixture</H2>

<P>
If you wish to add multiple fixtures of the same type, you can increase the
value in the <u>Amount</u> box. If you wish to leave a gap between each
value in the <u>Amount</u> box. If you wish to leave some gap between each
fixture's address space, you can change the value in the <u>Address gap</u>
box.
</P>

<P>
If you don't understand the DMX addressing principles, please consult your
lighting equipment manuals for more information. In short, a DMX address is
the first DMX channel of a fixture. In the case of a DJScan250 (which uses
the first DMX channel of one fixture. In the case of a DJScan250 (which uses
6 channels), assigning for example 1 as its DMX address, reserves channels
1, 2, 3, 4, 5, and 6 for the fixture. The next fixture must then be assigned
1, 2, 3, 4, 5, and 6 to the fixture. The next fixture must then be assigned
to DMX address 7 to prevent channel overlapping.
</P>

<H3>Adding a generic dimmer</H3>

<P>
Dimmers are somewhat special devices, since all they can usually do is to adjust
the intensities of their channels (which usually drive PAR cans and the like).
Dimmers are a bit special devices, since all they can usually do is just adjust
the intensities of their channels (that usually drive PAR cans and the like).
If you wish to add such a device, select the <u>Generic dimmer</u> fixture
from the list and specify the number of channels you wish the device to employ
in the <u>Channels</u> box. Note that you cannot adjust the mode for dimmers
into the <u>Channels</u> box. Note that you cannot adjust the mode for dimmers
and the channel list stays empty all the time.
</P>

Expand All @@ -105,7 +105,7 @@ <H2>Back to the fixture manager</H2>
On the left side of the fixture manager you can now see the fixture(s) that you
just added. On the right side, you can see information on the currently selected
fixture. You can edit the fixture's name, address and universe by clicking the
Configure button. You can also change the fixture definition by using the
Configure button. You can also change the fixture definition thru the
configuration dialog.
</P>

Expand Down
14 changes: 7 additions & 7 deletions docs/howto-input-output-mapping.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ <H2>Input/Output Manager</H2>
placed on the bottom of the QLC+ main screen.<br>
The screen is composed in this way:<br>
<ul>
<li>On the left side there is the list of internal universes that QLC+ can manage</li>
<li>On the right side there is the list of devices and their mapped inputs, outputs and feedback lines that QLC+ has detected</li>
<li>On the bottom right side there is a panel displaying brief information of the currently selected device</li>
<li>On the left hand side there is the list of internal universes that QLC+ can manage</li>
<li>On the right hand side there is the list of devices and their mapped inputs, outputs and feedback lines that QLC+ has detected</li>
<li>On the bottom right hand side there is a panel displaying brief information on the currently selected device</li>
</ul>

Every device has a checkbox whenever an input, output or feedback line is available.<br>
Each QLC+ universe can map a single input, a single output and a single feedback line<br>
</P>

<P>
Some plugins might require configuration before they can be used so you might
Some plugins might require configuration before they can be used' so you might
not be able to see all inputs/outputs at first. The configuration button
is place next to the information panel and it is enabled if the plugin
allows any manual setting.<br>
Expand All @@ -45,15 +45,15 @@ <H2>Patching</H2>
To patch a plugin's input/output line to the selected universe, you need to place
a checkmark on that particular plugin's input/output line. You can have only one
line assigned to a universe at a time, so when you check another line, the
checkmark will <u>move</u> from its previous position to the one you checked.<br>
checkmark will <u>move</u> from its previous position to the one you just checked.<br>
If you don't see any line on a plugin, it means you don't have any device that QLC+
understands and you're left with the one and only (non-selectable) choice: <u>None</u>.
</P>

<P>
When an input/output line is checked, the corresponding universe information on the left side of the screen
When an input/output line is checked, the corresponding universe information on the left hand side of the screen
will change and will display the new configuration set.<br>
The plugin information on the bottom right side of the screen will change as well and will give
The plugin information on the bottom right hand side of the screen will change as well and will give
you the new status of the plugin line.
</P>

Expand Down
8 changes: 4 additions & 4 deletions docs/howto-input-profiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <H2>Profile assignment</H2>
assigned yet. To assign a profile to the universe, simply place a check mark
on one of the available profiles by clicking on the empty check box. Only one
profile can be assigned to one universe at a time, so the check mark will
actually <u>move</u> from its previous position to the item that you have
actually <u>move</u> from its previous position to the item that you have just
selected.
</P>

Expand Down Expand Up @@ -93,11 +93,11 @@ <H3>Channel properties</H3>
will be displayed, asking you to fill or change some parameters:
<ul>
<li><b>Number</b>: The channel number. Since QLC+ supports a wide variety of
input plugins, the channel number might not be intuitive, so edit this if
input plugins, the channel number might not be intuitive, so only edit this if
you know what you're doing.
</li>
<li><b>Name</b>: The channel name. This is an arbitrary string to recognize
the meaning of a channel.
<li><b>Name</b>: The channel name. This is an arbitrary string to indicate
the purpose of a channel.
</li>
<li><b>Type</b>: The channel type. This can be:
<IMG SRC="qrc:/slider.png" ALIGN="absmiddle">Slider,
Expand Down
6 changes: 3 additions & 3 deletions docs/kioskmode.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

<H1>Kiosk Mode</H1>

<P>QLC+ has a special mode when you need to run the light by inexperienced people, or you just want to prevent unwanted changes. It's called the Kiosk mode.
In this mode, only Virtual Console is displayed, so no editing is possible.
<P>QLC+ has a special mode when your lighting needs to be operated by inexperienced people, or you just want to prevent unwanted changes. It's called the Kiosk mode.
In this mode only the Virtual Console is displayed, so no editing is possible.
<P>

<P>When you want to start QLC+ in kiosk mode, run:
Expand All @@ -31,7 +31,7 @@ <H1>Kiosk Mode</H1>
</P>

<P>
You can omit any of the paramteres if you need so - for example, omit <B>-c 500,10,32,32</B> if you don't want close button,
You can omit any of the paramteres if you need to - for example, omit <B>-c 500,10,32,32</B> if you don't want close button,
and omit <B>-f</B> if you don't want fullscreen.
</P>

Expand Down
Loading

0 comments on commit 7fe340b

Please sign in to comment.