diff options
Diffstat (limited to 'app/doc')
34 files changed, 419 insertions, 16 deletions
diff --git a/app/doc/CMakeLists.txt b/app/doc/CMakeLists.txt index dcee056..03ac14b 100644 --- a/app/doc/CMakeLists.txt +++ b/app/doc/CMakeLists.txt @@ -38,7 +38,11 @@ ADD_CUSTOM_TARGET(clean-html # If we're using the GTK back-end, just generate "vanilla" HTML help files for use with gtkhtml IF(XTRKCAD_USE_GTK) - SET(HALIBUT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/linconf.but ${HALIBUT_SOURCES}) + IF (APPLE) + SET(HALIBUT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/osxconf.but ${HALIBUT_SOURCES}) + ELSE(APPLE) + SET(HALIBUT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/linconf.but ${HALIBUT_SOURCES}) + ENDIF(APPLE) ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html @@ -63,7 +67,31 @@ IF(XTRKCAD_USE_GTK) INSTALL( FILES xtrkcad_lin.css DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/html - ) + ) +# Copy the help files to the Help bundle if Apple + IF (APPLE) + ADD_CUSTOM_COMMAND( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/XTrackCAD.helpindex + DEPENDS help-html ${HALIBUT_SOURCES} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html + COMMAND hiutil -Cf XTrackCAD.helpindex -gva -e "IndexPage.html" -e "toc.html" ${CMAKE_CURRENT_BINARY_DIR}/html + ) + + ADD_CUSTOM_TARGET(help-index ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/XTrackCAD.helpindex) + + INSTALL( + DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ + DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj + ) + INSTALL( + DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/png.d + DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj + ) + INSTALL( + FILES xtrkcad_osx.css + DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj + ) + ENDIF(APPLE) # Otherwise, we're using the Win32 back-end, so generate a compiled HTML help file ELSE(XTRKCAD_USE_GTK) @@ -86,7 +114,7 @@ ELSE(XTRKCAD_USE_GTK) INSTALL( FILES ${CMAKE_CURRENT_BINARY_DIR}/html/xtrkcad.chm - DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR} + DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR} ) ENDIF(XTRKCAD_USE_GTK) diff --git a/app/doc/addm.but b/app/doc/addm.but index 111b188..cee8896 100644 --- a/app/doc/addm.but +++ b/app/doc/addm.but @@ -6,8 +6,9 @@ \C{commandMenus} Command Menus -\rule +\cfg{html-local-head}{<meta name="AppleTitle" content="Command Menus" />} +\rule \H{addM}\i{Add Menu} @@ -49,8 +50,25 @@ The \f{Add Menu} has all the actions related to adding track pieces to the layou \dd \f{Turntable} - Place a turntable. -\rule +\u000 + +\dd \f{Block} - Create, edit or delete a block. + +\u000 + +\dd \f{Switchmotor} - Create, edit or delete a switchmotor. + +\u000 + +\dd \f{Signal} - Create, edit or delete a signal. + +\u000 +\dd \f{Control} - Create a signal. + +\u000 + +\dd \f{Sensor} - Create a sensor. \S{cmdCircle} Circle Track @@ -258,4 +276,111 @@ The \f{Modify command} (\K{cmdModify}) can be used to create turntable stall tra The \f{Turntable Angle} control on the Preferences (\K{cmdPref}) dialog controls how closely you can place tracks connected to a turntable. If you want to create stall tracks every 7.5\u00B0, set the \f{Turntable Angle} control to 7.5 and place the track as close to each other as allowed. \e{XTrackCAD} makes sure they will be separated by the correct angle. -\rule
\ No newline at end of file +\rule + +\S{cmdBlock} Block + +\G{png.d/bblock.png} + +A block is created by first selecting the track segments in the block and then +selecting \f{Create Block} from either the Add menu \K{cmdAdd} or from the block menu on the +hotbar. A block gets a name and a script. The name is only used for +identification and the script is used by the layout control software. The +script should provide whatever information is needed by the layout control +software to determine block occupancy. This could be a code snippet to +retrieve the state of the block occupancy or it could be the address of the +sensor, etc. + +\G{png.d/block.png} + +The create block dialog has spaces for two text strings. One is the name and +the other is a block occupancy script. The name identifies the block and the +script is information used by the layout control software to detect block +occupancy. The script could be a code snippet or I/O device address +information, etc. + +\rule + +\S{cmdSwitchmotor} Switchmotor + +\G{png.d/bswitchmotor.png} + +A switchmotor is created by selecting \f{Create SwitchMotor} from either the Add +menu \K{cmdAdd} or from the switchmotor menu on the hotbar and then clicking on a turnout. +A switchmotor gets a name and three scripts. The name is only used for +identification and the three scripts are used by the layout control software. +The three scripts are for throwing the turnout to its "normal" position, +throwing the turnout to its "reverse" position, and a script to read a point +position sensor. These scripts could be code snippets or they could be +addresses of I/O devices, etc. + +\G{png.d/switchmotor.png} + +The create switchmotor dialog has spaces for four text strings. One is the +name and the other three are scripts for Normal, Reverse, and Point Sense. The +name identifies the switchmotor and the scripts are information used by the +layout control software to throw the turnout to the normal position, throw the +turnout to the reverse position, and sense the point position. The scripts +could be code snippets or I/O device address information, etc. + +\rule + +\S{cmdSignal} Signal + +\G{png.d/bsignal.png} + +A signal is created by selecting \f{Create Signal} from either the Add menu \K{cmdAdd} or +from the hotbar. Use the mouse to select a location (left button) and then +draging (left button down) the signal to set its orientation. Once the left +button is released, a Create/Edit Signal dialog box is displayed, and you can +fill in the signal's properties: name, fine tune the location and orientation, +number of heads, and the aspects. + +\G{png.d/signal.png} + +The create/edit signal dialog has spaces for the name of the signal, its +location and orientation, the number of heads (1, 2, or 3), and a list of +aspects. Each aspect has a name and a script. The name could be a rule book +name (Clear, Aproach, Stop, etc.) or the actual color(s) displayed (green, +yellow, red, etc.). The script is just some information for the layout +control software to actually effect the display of the aspect -- this could be +the LCC event id to trigger the aspect or it could be a code snippet that +causes the aspect to be displayed. + +\rule + +\S{cmdControl} Control + +\G{png.d/bControl.png} + +A control is created by selecting \f{Create Control} from either the Add menu \K{cmdAdd} or +from the hotbar. Use the mouse to select a location (left button) and then +dragging (left button down) the control to where you want it. Once the left +button is released, a Create/Edit Control dialog box is displayed, and you can +fill in the control's properties: name, fine tune the location, and the on and +off scripts. + +\G{png.d/control.png} + +The create/edit control dialog has entry fields for the name of the control, its +location, and a pair of scripts, one to turn the control on and one to turn +the control off. The scripts are just some information for the layout control +software to actually effect the state on the control (on or off). + +\rule + +\S{cmdSensor} Sensor + +\G{png.d/bSensor.png} + +A sensor is created by selecting \f{Create Sensor} from either the Add menu \K{cmdAdd} or +from the hotbar. Use the mouse to select a location (left button) and then +dragging (left button down) the sensor to where you want it. Once the left +button is released, a Create/Edit Sensor dialog box is displayed, and you can +fill in the sensor's properties: name, fine tune the location, and the script. + +\G{png.d/sensor.png} + +The create/edit sensor dialog has spaces for the name of the sensor, its +location, and a script. The script is just some information for the layout +control software to actually return the state of the sensor (on or off).
\ No newline at end of file diff --git a/app/doc/appendix.but b/app/doc/appendix.but index 3155e38..2c16319 100644 --- a/app/doc/appendix.but +++ b/app/doc/appendix.but @@ -2,7 +2,7 @@ \# \# The "\u000" command is used to format the output. These commands causes a blank line to appear between "bulleted" or "described" items. \# - +\cfg{html-local-head}{<meta name="AppleTitle" content="Frequently Asked Questions" />} \A{faqs} Frequently Asked Questions @@ -209,6 +209,44 @@ Menu and sub-menu items are indicated by \e{File>Open}, which means select the \ \rule +\H{controlElementScripts} Control Element Scripts and the Model RR System's Dispatcher + +Notes about control element scripts and the Model RR System's Dispatcher +program in OpenLCB mode: + +When using the Model RR System's Dispatcher program in OpenLCB mode to create +CTC panels, the panel elements can have their LCC event IDs automatically +populated from the information in the XTrackCAD file, if the proper syntax is +observed. + +A LCC event id is a 64-bit number, represented as eight pairs of hexadevimal +digits (0-9, a-f/A-F) separated by periods (.). Each pair represents one 8-bit +byte of the event id. This event id is either produced by a sensor or logic +element or is consumed by a control/device or a logic element. + +For blocks the occupency script contains a pair of LCC event ids, separated by +a colon (:). The first LCC event id is produced by the occupency detector +when the train enters the block and the second LCC event id is produced by the +occupency detector when the train leaves the block. + +For switchmotors the point sense script contains a pair of LCC event ids, +separated by a colon (:). The first LCC event id is produced by the point +sensor when the points are aligned in the "normal" position (typically aligned +to the main) and the second LCC event id is produced by the point sensor when +the points are aligned in the "reverse" position (typically aligned to the +spur). The normal and reverse script each contain a signal LCC event id. +These events are produced by the CTC Panel when the control point Code button +is pressed (clicked) and are consumed by the switch motor. + +For signals, the aspect name is a space separated list of the color(s) of the +signal heads from top to bottom and the aspect script is a LCC event id that +is consumed to produce that aspect. Presumably, the LCC event id is produced +by a logic element (presumably a mast group in a Tower-LCC or similar device) +or virtual track circuit in a Tower-LCC or similar device. + +\rule + + \A{} Messages and Explanations \H{messageType} \i{Message Types} @@ -236,3 +274,4 @@ Menu and sub-menu items are indicated by \e{File>Open}, which means select the \ \K{messageList} provides detail explanation of each information or error message. \rule + diff --git a/app/doc/changem.but b/app/doc/changem.but index 8327edf..2bcd90b 100644 --- a/app/doc/changem.but +++ b/app/doc/changem.but @@ -4,6 +4,8 @@ \# \# The "\u00B0" command gives proper format to the degree sign. +\cfg{html-local-head}{<meta name="AppleTitle" content="Change Menu" />} + \H{changeM}\i{Change Menu} \G{png.d/mchange.png} diff --git a/app/doc/drawm.but b/app/doc/drawm.but index dd53418..21785ce 100644 --- a/app/doc/drawm.but +++ b/app/doc/drawm.but @@ -2,7 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# - +\cfg{html-local-head}{<meta name="AppleTitle" content="Draw Menu" />} \H{cmdDraw} \i{Draw Menu} diff --git a/app/doc/editm.but b/app/doc/editm.but index 9572172..f31b6d6 100644 --- a/app/doc/editm.but +++ b/app/doc/editm.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Edit Menu" />} \H{editM}\i{Edit Menu} diff --git a/app/doc/filem.but b/app/doc/filem.but index a47452e..8b74434 100644 --- a/app/doc/filem.but +++ b/app/doc/filem.but @@ -2,9 +2,11 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="File Menu" />} \H{fileM} \i{File Menu} + \G{png.d/mfile.png} The \f{File Menu} shows file oriented commands for loading and saving layout files. diff --git a/app/doc/helpm.but b/app/doc/helpm.but index 290adf5..08ccd49 100644 --- a/app/doc/helpm.but +++ b/app/doc/helpm.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Help Menu" />} \H{helpM} Help Menu diff --git a/app/doc/hotbar.but b/app/doc/hotbar.but index 3ce82f4..9683c5e 100644 --- a/app/doc/hotbar.but +++ b/app/doc/hotbar.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Hot Bar" />} \H{cmdHotBar} Hot Bar diff --git a/app/doc/intro.but.in b/app/doc/intro.but.in index 3fe5b7e..cb0d0d2 100644 --- a/app/doc/intro.but.in +++ b/app/doc/intro.but.in @@ -44,7 +44,6 @@ Copyright 2007, Bob Blackwell and Martin Fischer \IM{Created by Turnout Command}{Easements and Sectional Track} Sectional Track - \# >>>>>>>>>> Manual Begin's Here <<<<<<<<<< \title \e{XTrackCAD} User's Manual @@ -57,9 +56,10 @@ Copyright 2007, Bob Blackwell and Martin Fischer \rule - \C{index} Introduction To \e{XTrackCAD} +\cfg{html-local-head}{<meta name="AppleTitle" content="org.xtrkcad.help" />} + \e{XTrackCAD} is a CAD (computer-aided design) program for designing Model Railroad layouts. \e{XTrackCAD} supports any scale, has libraries of popular brands of turnouts and sectional track (plus you add your own easily), can automatically use spiral transition curves when joining track and has extensive on-line help and demonstrations. \e{XTrackCAD} lets you manipulate track much like you would with actual flex-track to modify, extend and join tracks and turnouts. Additional features include tunnels, 'post-it' notes, on-screen ruler, parts list, 99 drawing layers, undo/redo commands, bench-work, 'Print to Bitmap', elevations, train simulation and car inventory. Using it, you can @@ -780,7 +780,7 @@ This section of the manual describes how and where to report a bug or seek an en \S{bugs} Reporting \i{Bugs} -If you encounter an unreported bug please submit detail regarding such to the \f{Bug Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&atid=781978}{\e{XTrackCAD} Fork Project Site}. +If you encounter an unreported bug please submit detail regarding such to the \f{Bug Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&atid=781978}{\e{XTrackCAD} Fork Project Site}. \f{Be sure to provide the three basic elements of a bug report:} What you were doing at the time the bug occurred, what you expected to happen and what actually happened. This detail will help developers replicate the error, find and correct the offending code. @@ -808,7 +808,7 @@ If you encounter an unreported bug please submit detail regarding such to the \f \f{Always search the bug database first.} Advice so good, we'll repeat it twice. Always search the bug database first. The odds are good that if you've found a problem, someone else found it too. If you spend a few minutes of your time making sure that you're not filing a duplicate bug, that's a few more minutes someone can spend helping to fix that bug rather than sorting out duplicate bug reports. -\f{If you don't understand an error message, ask for help.} Don't report an error message you don't understand as a bug. There are a lot of places you can ask for help in understanding what is going on before you can claim that an error message you do not understand is a bug. (Once you've understood the error message and have a good suggestion for a way to make the error message clearer, you might consider reporting it as a \W{http://sourceforge.net/tracker/?group_id=151737&atid=781981}{\e{XTrackCAD} Feature Request}). +\f{If you don't understand an error message, ask for help.} Don't report an error message you don't understand as a bug. There are a lot of places you can ask for help in understanding what is going on before you can claim that an error message you do not understand is a bug. (Once you've understood the error message and have a good suggestion for a way to make the error message clearer, you might consider reporting it as a \W{http://sourceforge.net/tracker/?group_id=151737&atid=781981}{\e{XTrackCAD} Feature Request}). \f{Be brief, but don't leave any important details out.} This is a fine line to walk. But there are some general guidelines: @@ -825,6 +825,6 @@ If you can recreate the problem the \f{Macro>Record} command can be used to reco \S{enhancements} \i{Enhancement Requests} -Suggestions for improvements are encouraged and welcome. Submit your suggestion to the \e{XTrackCAD} \f{Feature Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&atid=781981}{\e{XTrackCAD} Fork Project Site} or the \e{XTrackCAD} \f{Wikka Wish List} located at the \W{http://www.xtrkcad.org/Wikka/WishList}{\e{XTrackCAD} Wiki: WishList}. +Suggestions for improvements are encouraged and welcome. Submit your suggestion to the \e{XTrackCAD} \f{Feature Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&.atid=781981}{\e{XTrackCAD} Fork Project Site} or the \e{XTrackCAD} \f{Wikka Wish List} located at the \W{http://www.xtrkcad.org/Wikka/WishList}{\e{XTrackCAD} Wiki: WishList}. \rule diff --git a/app/doc/linconf.but b/app/doc/linconf.but index c8de305..ffb2685 100644 --- a/app/doc/linconf.but +++ b/app/doc/linconf.but @@ -1,7 +1,7 @@ \cfg{html-leaf-level}{infinite}
\cfg{html-leaf-contains-contents}{false}
-\cfg{html-suppress-navlinks}{true}
-\cfg{html-suppress-address}{true}
+\cfg{html-suppress-navlinks}{false}
+\cfg{html-suppress-address}{false}
\cfg{html-contents-filename}{contents.html}
\cfg{html-template-filename}{%k.html}
diff --git a/app/doc/macrom.but b/app/doc/macrom.but index 85fed13..7bf816c 100644 --- a/app/doc/macrom.but +++ b/app/doc/macrom.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Macro Menu" />} \H{macroM} Macro Menu diff --git a/app/doc/managem.but b/app/doc/managem.but index 65a20c0..4a769db 100644 --- a/app/doc/managem.but +++ b/app/doc/managem.but @@ -3,6 +3,7 @@ \# The "\u000" command is used to format the output. These commands causes a blank line to appear between "bulleted" or "described" items. \# \# The "\u00B0" command gives proper format to the degree sign. +\cfg{html-local-head}{<meta name="AppleTitle" content="Manage Menu" />} \H{manageM}\i{Manage Menu} @@ -18,6 +19,10 @@ The \f{Manage Menu} shows commands affecting the \f{Main Canvas} (\K{mainW}). \u000 +\dd \f{Layout Control Elements} - display the \f{Layout Control Elements} (\K{cmdContmgm}) dialog to manipulate blocks, turnout motors and signals. + +\u000 + \dd \f{Group} - creates a \f{Structure} or \f{Turnout} definition from the selected (\K{cmdSelect}) objects. See the \f{Group} command (\K{cmdGroup}) for details. \u000 @@ -290,6 +295,36 @@ The \f{New} buttons invokes the Car (\K{cmdCarpart}) dialog to create a new \f{C \rule +\S{cmdContmgm} Layout Control Elements Dialog + +This dialog is used to manage layout control elements (blocks, switchmotors, and signals). + +Control Elements are elements related to layout control: blocks (occupancy +detection), switchmotors (actuators to "throw" turnouts), signals, controls +(other actuator or output devices), and sensors (other sensor or input +devices). These elements don't relate to directly "physical" items on the +layout, but instead refer to the elements used by the layout control software. +These elements contain "scripts", which are really just textual items that +provide information for the layout control software and provide a bridge +between physical layout elements (like tracks or turnouts) and the layout +control software. These textual items could be actual software code or could +be LCC Events (for I/O device elements on a LCC network) or DCC addresses for +stationary decoders, etc. XTrackCAD does not impose any sort of syntax or format +-- that is left up to other software that might load and parse the XTrkCAD +layout file. All that XTrackCAD does is provide a unified place for this +information to be stored and to provide a mapping (association) between this +control information and the layout itself. + +\G{png.d/lcemanager.png} + +The main part of this dialog contains a list of the currently defined layout +control elements (blocks, switchmotors, signals, controls, and sensors), +along with the tracks they relate to. These elements are added to the layout +either from their Hotbar menus or from the Add menu. + +The \f{Edit} button allows for editing a control element. And the \f{Delete} button +deletes the selected element(s). + \S{cmdGroup} Group Dialog The \f{Group} command combines the selected (\K{cmdSelect}) Lines and Shapes (\K{cmdDraw}) to create structures (\K{cmdHotBar}). You can give the structure (\K{cmdHotBar}) a title consisting of Manufacturer, Description and Part Number on the \f{Group} dialog. diff --git a/app/doc/navigation.but b/app/doc/navigation.but index a11e4fa..66b0cc9 100644 --- a/app/doc/navigation.but +++ b/app/doc/navigation.but @@ -3,6 +3,7 @@ \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# \# The "\u00B0" command gives proper format to the degree sign. +\cfg{html-local-head}{<meta name="AppleTitle" content="Navigation" />} \C{navigation} Navigation diff --git a/app/doc/optionm.but b/app/doc/optionm.but index e6d49e0..c7f00d9 100644 --- a/app/doc/optionm.but +++ b/app/doc/optionm.but @@ -3,6 +3,7 @@ \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# \# The "\u00B0" command gives proper format to the degree sign. +\cfg{html-local-head}{<meta name="AppleTitle" content="Options Menu" />} \H{optionM}\i{Options Menu} diff --git a/app/doc/osxconf.but b/app/doc/osxconf.but new file mode 100644 index 0000000..8656f0e --- /dev/null +++ b/app/doc/osxconf.but @@ -0,0 +1,16 @@ +\cfg{html-version}{xhtml1.0strict}
+\cfg{html-leaf-level}{infinite}
+\cfg{html-leaf-contains-contents}{false}
+\cfg{html-suppress-navlinks}{true}
+\cfg{html-suppress-address}{true}
+
+\cfg{html-contents-filename}{contents.html}
+\cfg{html-template-filename}{%k.html}
+\cfg{html-template-fragment}{%k}
+\cfg{html-applehelp-toc}{toc.html}
+
+\cfg{html-contents-depth}{0}{2}
+
+\cfg{html-head-end}{<link rel="stylesheet" type="text/css" href="xtrkcad_osx.css" /><script type="text/javascript" src="toc.js" ></script>}
+\cfg{html-body-start}{<div id="container"><div id="toc" data-include="toc.html"></div><div id="contents">}
+\cfg{html-body-end}{</div></div>}
\ No newline at end of file diff --git a/app/doc/png.d/bblock.png b/app/doc/png.d/bblock.png Binary files differnew file mode 100644 index 0000000..ccd90d9 --- /dev/null +++ b/app/doc/png.d/bblock.png diff --git a/app/doc/png.d/bcontrol.png b/app/doc/png.d/bcontrol.png Binary files differnew file mode 100644 index 0000000..131bb94 --- /dev/null +++ b/app/doc/png.d/bcontrol.png diff --git a/app/doc/png.d/block.png b/app/doc/png.d/block.png Binary files differnew file mode 100644 index 0000000..598fdad --- /dev/null +++ b/app/doc/png.d/block.png diff --git a/app/doc/png.d/bsensor.png b/app/doc/png.d/bsensor.png Binary files differnew file mode 100644 index 0000000..7d9834b --- /dev/null +++ b/app/doc/png.d/bsensor.png diff --git a/app/doc/png.d/bsignal.png b/app/doc/png.d/bsignal.png Binary files differnew file mode 100644 index 0000000..f6b52f8 --- /dev/null +++ b/app/doc/png.d/bsignal.png diff --git a/app/doc/png.d/bswitchmotor.png b/app/doc/png.d/bswitchmotor.png Binary files differnew file mode 100644 index 0000000..68d9a4a --- /dev/null +++ b/app/doc/png.d/bswitchmotor.png diff --git a/app/doc/png.d/control.png b/app/doc/png.d/control.png Binary files differnew file mode 100644 index 0000000..2097021 --- /dev/null +++ b/app/doc/png.d/control.png diff --git a/app/doc/png.d/lcemanager.png b/app/doc/png.d/lcemanager.png Binary files differnew file mode 100644 index 0000000..281c0c2 --- /dev/null +++ b/app/doc/png.d/lcemanager.png diff --git a/app/doc/png.d/madd.png b/app/doc/png.d/madd.png Binary files differindex 15a1426..f689ebe 100644 --- a/app/doc/png.d/madd.png +++ b/app/doc/png.d/madd.png diff --git a/app/doc/png.d/mmanage.png b/app/doc/png.d/mmanage.png Binary files differindex 931d065..8ea36f7 100644 --- a/app/doc/png.d/mmanage.png +++ b/app/doc/png.d/mmanage.png diff --git a/app/doc/png.d/sensor.png b/app/doc/png.d/sensor.png Binary files differnew file mode 100644 index 0000000..1217b3a --- /dev/null +++ b/app/doc/png.d/sensor.png diff --git a/app/doc/png.d/signal.png b/app/doc/png.d/signal.png Binary files differnew file mode 100644 index 0000000..e4332a5 --- /dev/null +++ b/app/doc/png.d/signal.png diff --git a/app/doc/png.d/switchmotor.png b/app/doc/png.d/switchmotor.png Binary files differnew file mode 100644 index 0000000..7b4e73d --- /dev/null +++ b/app/doc/png.d/switchmotor.png diff --git a/app/doc/statusbar.but b/app/doc/statusbar.but index 61af8fc..6390722 100644 --- a/app/doc/statusbar.but +++ b/app/doc/statusbar.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Status Bar" />} \H{cmdStatusbar} Status Bar diff --git a/app/doc/upgrade.but b/app/doc/upgrade.but index a88f8ce..efd0908 100644 --- a/app/doc/upgrade.but +++ b/app/doc/upgrade.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="Upgrades" />} \A{upgrades} Upgrade From Earlier \e{XTrackCAD} Version @@ -70,7 +71,7 @@ The wheel on a wheel mouse can now be used to zoom in and out on a layout design \f{Internationalization} -Internationalization or the ability to localize \e{XTrackCAD} for use with various languages was adopted during this version upgrade. \e{XTrackCAD} is now available with balloon help and daily tips written in US English, Finnish and German. The \e{XTrackCAD} development team welcomes anyone who wishes to volunteer with translation of various support files. Let them know by submitting an offer to assist to the \e{XTrackCAD} \f{Feature Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&atid=781981}{\e{XTrackCAD} Fork Project Site} or the \e{XTrackCAD} \f{Wikka Wish List} located at the \W{http://www.xtrkcad.org/Wikka/WishList}{\e{XTrackCAD} Wiki: WishList}. +Internationalization or the ability to localize \e{XTrackCAD} for use with various languages was adopted during this version upgrade. \e{XTrackCAD} is now available with balloon help and daily tips written in US English, Finnish and German. The \e{XTrackCAD} development team welcomes anyone who wishes to volunteer with translation of various support files. Let them know by submitting an offer to assist to the \e{XTrackCAD} \f{Feature Tracker} located at the \W{http://sourceforge.net/tracker/?group_id=151737&atid=781981}{\e{XTrackCAD} Fork Project Site} or the \e{XTrackCAD} \f{Wikka Wish List} located at the \W{http://www.xtrkcad.org/Wikka/WishList}{\e{XTrackCAD} Wiki: WishList}. \f{Minor Fixes and Enhancements} diff --git a/app/doc/view_winm.but b/app/doc/view_winm.but index eecb843..47ec17b 100644 --- a/app/doc/view_winm.but +++ b/app/doc/view_winm.but @@ -2,6 +2,7 @@ \# \# The "\u000" command is used to format the output. The command causes a blank line to appear between "bulleted" or "described" items. \# +\cfg{html-local-head}{<meta name="AppleTitle" content="View Menu" />} \H{viewM} \i{View Menu} diff --git a/app/doc/warranty.but b/app/doc/warranty.but index 9c4e909..357a0cb 100644 --- a/app/doc/warranty.but +++ b/app/doc/warranty.but @@ -1,3 +1,5 @@ +\cfg{html-local-head}{<meta name="AppleTitle" content="Warranty" />} + \A{warrantyLicenseCopy} Warranty, License and Copying \e{XTrackCAD} is \XTCCopyRight. @@ -10,6 +12,7 @@ covered by the Creative Commons Attribution-ShareAlike 2.5 License Agreement. \H{warranty} Warranty + \e{XTrackCAD} is provided "as is" without warranty of any kind, either express or implied, including, but not limited to warranties of merchantability or fitness for a particular purpose. In no event will Sillub Technology be liable for any damages, including incidental or consequential damages, arising out of the use of the program, even if advised of the possibility of such damages. \rule diff --git a/app/doc/xtrkcad_osx.css b/app/doc/xtrkcad_osx.css new file mode 100644 index 0000000..9069eb8 --- /dev/null +++ b/app/doc/xtrkcad_osx.css @@ -0,0 +1,144 @@ +/************************************************************************************
+LINUX Help File colour and fonts are done here. Halibut controls margins, line spacing and indents.
+*************************************************************************************/
+
+BODY {
+ background: white;
+ font-family: "Trebuchet MS", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Tahoma, sans-serif;
+}
+
+A:link {
+ text-decoration: none;
+ color: #7DA1BF;
+ font-weight: bold;
+} /* unvisited link */
+
+A:visited {
+ text-decoration: none;
+ color: #1d4e89;
+ font-weight: bold;
+} /* visited links */
+
+A:active {
+ text-decoration: none;
+ font-weight: bold;
+ color: red;
+ } /* active links */
+
+a:hover {
+ text-decoration: underline;
+ color: #F69256;
+ }
+
+H1 {
+ text-align: left;
+ font-size: large;
+ font-style: italic;
+ font-weight: bold;
+ padding: 3px 6px;
+}
+
+H2 {
+ text-align: left;
+ font-size: medium;
+ font-style: italic;
+ font-weight: bold;
+ padding: 3px 6px;
+}
+
+H3 {
+ text-align: left;
+ font-size: small;
+ font-style: italic;
+ font-weight: bold;
+ padding: 3px 6px;
+}
+
+#container {
+ height: 100%;
+ width: 100%;
+ overflow: hidden;
+}
+
+#toc {
+ position: fixed;
+ top: 0px;
+ left: 0px;
+ bottom: 0px;
+ font-size: 25% small;
+ overflow-y: scroll;
+ width: 20%;
+}
+
+#contents {
+ top: 0px;
+ right: 0px;
+ bottom: 0px;
+ margin-left: 20%;
+ float: left;
+ font-size: 90%;
+ color: #333;
+ font-weight: normal;
+ overflow: auto;
+}
+
+UL.top_link {
+ list-style: none;
+ padding-left:0;
+}
+
+#toc UL {
+ list-style: none;
+ padding-left:1em;
+}
+
+#toc A:link {
+ font-size: 62%;
+ text-decoration: none;
+ color: #7DA1BF;
+}
+#toc A:active {
+ font_size: 62%;
+ text-decoration: none;
+ color: red;
+ } /* active links */
+/* Style the buttons that are used to open and close the accordion panel */
+button.accordion {
+ background-color: #eee;
+ color: #444;
+ cursor: pointer;
+ padding: 0px;
+ width: 20px%;
+ text-align: left;
+ border: none;
+ outline: none;
+ transition: 0.4s;
+}
+
+button.accordion:before {
+ content: '\02795'; /* Unicode character for "plus" sign (+) */
+ font-size: 62%;
+ color: #777;
+ float: left;
+ margin-left: 5px;
+}
+
+button.accordion.active:before {
+ content: "\2796"; /* Unicode character for "minus" sign (-) */
+}
+
+
+/* Add a background color to the button if it is clicked on (add the .active class with JS), and when you move the mouse over it (hover) */
+button.accordion.active, button.accordion:hover {
+ background-color: #ddd;
+}
+
+div.panel {
+ padding: 0 18px;
+ background-color: white;
+ max-height: 0;
+ overflow: hidden;
+ transition: max-height 0.2s ease-out;
+}
+
+
|
