diff options
Diffstat (limited to 'app/doc')
| -rw-r--r-- | app/doc/CMakeLists.txt | 161 | ||||
| -rw-r--r-- | app/doc/addm.but | 107 | ||||
| -rw-r--r-- | app/doc/appendix.but | 31 | ||||
| -rw-r--r-- | app/doc/changem.but | 107 | ||||
| -rw-r--r-- | app/doc/clean-html.cmake | 6 | ||||
| -rw-r--r-- | app/doc/clean-html.cmake.in | 6 | ||||
| -rw-r--r-- | app/doc/drawm.but | 66 | ||||
| -rw-r--r-- | app/doc/editm.but | 90 | ||||
| -rw-r--r-- | app/doc/filem.but | 132 | ||||
| -rw-r--r-- | app/doc/helpm.but | 13 | ||||
| -rw-r--r-- | app/doc/hhc.cmake.in | 12 | ||||
| -rw-r--r-- | app/doc/hotbar.but | 22 | ||||
| -rw-r--r-- | app/doc/intro.but.in | 61 | ||||
| -rw-r--r-- | app/doc/managem.but | 119 | ||||
| -rwxr-xr-x | app/doc/mk-xtrkcad-manual | 136 | ||||
| -rw-r--r-- | app/doc/navigation.but | 17 | ||||
| -rw-r--r-- | app/doc/optionm.but | 32 | ||||
| -rw-r--r-- | app/doc/png.d/bangle.png | bin | 4818 -> 761 bytes | |||
| -rw-r--r-- | app/doc/png.d/bblock.png | bin | 389 -> 1093 bytes | |||
| -rw-r--r-- | app/doc/png.d/bbridge.png | bin | 0 -> 1043 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcircl1.png | bin | 433 -> 1729 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcircl2.png | bin | 531 -> 1628 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcircl3.png | bin | 520 -> 1584 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcircle.png | bin | 475 -> 1718 bytes | |||
| -rw-r--r-- | app/doc/png.d/bconnect.png | bin | 415 -> 746 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcontrol.png | bin | 303 -> 945 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcornu.png | bin | 4358 -> 1417 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurve.png | bin | 355 -> 1342 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurve1.png | bin | 304 -> 1246 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurve2.png | bin | 302 -> 1234 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurve3.png | bin | 298 -> 1331 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurve4.png | bin | 303 -> 1414 bytes | |||
| -rw-r--r-- | app/doc/png.d/bcurvelin.png | bin | 0 -> 744 bytes | |||
| -rw-r--r-- | app/doc/png.d/bdelete.png | bin | 285 -> 863 bytes | |||
| -rw-r--r-- | app/doc/png.d/bdescrib.png | bin | 273 -> 811 bytes | |||
| -rw-r--r-- | app/doc/png.d/bdraw.png | bin | 936 -> 1988 bytes | |||
| -rw-r--r-- | app/doc/png.d/bdrawsplit.png | bin | 0 -> 605 bytes | |||
| -rw-r--r-- | app/doc/png.d/belev.png | bin | 268 -> 898 bytes | |||
| -rw-r--r-- | app/doc/png.d/bexport.png | bin | 0 -> 439 bytes | |||
| -rw-r--r-- | app/doc/png.d/bexportbmap.png | bin | 0 -> 1298 bytes | |||
| -rw-r--r-- | app/doc/png.d/bexportdxf.png | bin | 0 -> 654 bytes | |||
| -rw-r--r-- | app/doc/png.d/bexportsvg.png | bin | 0 -> 1274 bytes | |||
| -rw-r--r-- | app/doc/png.d/bezier.png | bin | 3866 -> 1359 bytes | |||
| -rw-r--r-- | app/doc/png.d/bfile.png | bin | 757 -> 801 bytes | |||
| -rw-r--r-- | app/doc/png.d/bflip.png | bin | 296 -> 767 bytes | |||
| -rw-r--r-- | app/doc/png.d/bgsnap.png | bin | 378 -> 2304 bytes | |||
| -rw-r--r-- | app/doc/png.d/bgundo.png | bin | 310 -> 1352 bytes | |||
| -rw-r--r-- | app/doc/png.d/bgzoom.png | bin | 521 -> 2140 bytes | |||
| -rw-r--r-- | app/doc/png.d/bhelix.png | bin | 262 -> 1436 bytes | |||
| -rw-r--r-- | app/doc/png.d/bhndldto.png | bin | 275 -> 932 bytes | |||
| -rw-r--r-- | app/doc/png.d/bimport.png | bin | 0 -> 457 bytes | |||
| -rw-r--r-- | app/doc/png.d/bimportmod.png | bin | 0 -> 463 bytes | |||
| -rw-r--r-- | app/doc/png.d/bitmap.png.orig | bin | 0 -> 1298 bytes | |||
| -rw-r--r-- | app/doc/png.d/bjoin.png | bin | 4433 -> 1060 bytes | |||
| -rw-r--r-- | app/doc/png.d/bjoinline.png | bin | 4329 -> 733 bytes | |||
| -rw-r--r-- | app/doc/png.d/blayer.png | bin | 70247 -> 2835 bytes | |||
| -rw-r--r-- | app/doc/png.d/blink.png | bin | 626 -> 776 bytes | |||
| -rw-r--r-- | app/doc/png.d/bmenu.png | bin | 221 -> 339 bytes | |||
| -rw-r--r-- | app/doc/png.d/bmodify.png | bin | 296 -> 1169 bytes | |||
| -rw-r--r-- | app/doc/png.d/bmove.png | bin | 296 -> 784 bytes | |||
| -rw-r--r-- | app/doc/png.d/bmovedes.png | bin | 311 -> 845 bytes | |||
| -rw-r--r-- | app/doc/png.d/bnew.png | bin | 793 -> 427 bytes | |||
| -rw-r--r-- | app/doc/png.d/bnewcar.png | bin | 305 -> 561 bytes | |||
| -rw-r--r-- | app/doc/png.d/bnote.png | bin | 684 -> 507 bytes | |||
| -rw-r--r-- | app/doc/png.d/bopen.png | bin | 889 -> 743 bytes | |||
| -rw-r--r-- | app/doc/png.d/bparallel.png | bin | 4402 -> 802 bytes | |||
| -rw-r--r-- | app/doc/png.d/bparalleline.png | bin | 4357 -> 721 bytes | |||
| -rw-r--r-- | app/doc/png.d/bparam.png | bin | 0 -> 772 bytes | |||
| -rw-r--r-- | app/doc/png.d/bprint.png | bin | 0 -> 450 bytes | |||
| -rw-r--r-- | app/doc/png.d/brevert.png | bin | 0 -> 694 bytes | |||
| -rw-r--r-- | app/doc/png.d/broadbed.png | bin | 0 -> 841 bytes | |||
| -rw-r--r-- | app/doc/png.d/brotate.png | bin | 291 -> 1117 bytes | |||
| -rw-r--r-- | app/doc/png.d/bruler.png | bin | 250 -> 674 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsave.png | bin | 938 -> 636 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsaveas.png | bin | 0 -> 839 bytes | |||
| -rw-r--r-- | app/doc/png.d/bselect.png | bin | 273 -> 687 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsensor.png | bin | 281 -> 1224 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsetup.png | bin | 0 -> 420 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsignal.png | bin | 256 -> 581 bytes | |||
| -rw-r--r-- | app/doc/png.d/bsplit.png | bin | 326 -> 919 bytes | |||
| -rw-r--r-- | app/doc/png.d/bstraigh.png | bin | 329 -> 1100 bytes | |||
| -rw-r--r-- | app/doc/png.d/bstruct.png | bin | 338 -> 777 bytes | |||
| -rw-r--r-- | app/doc/png.d/bswitchmotor.png | bin | 316 -> 805 bytes | |||
| -rw-r--r-- | app/doc/png.d/btext.png | bin | 374 -> 670 bytes | |||
| -rw-r--r-- | app/doc/png.d/bties.png | bin | 0 -> 727 bytes | |||
| -rw-r--r-- | app/doc/png.d/btop_bottom.png | bin | 375 -> 837 bytes | |||
| -rw-r--r-- | app/doc/png.d/btrain.png | bin | 261 -> 883 bytes | |||
| -rw-r--r-- | app/doc/png.d/btunnel.png | bin | 428 -> 652 bytes | |||
| -rw-r--r-- | app/doc/png.d/bturnout.png | bin | 456 -> 897 bytes | |||
| -rw-r--r-- | app/doc/png.d/bturntbl.png | bin | 357 -> 1151 bytes | |||
| -rw-r--r-- | app/doc/png.d/caritem.png | bin | 16233 -> 48958 bytes | |||
| -rw-r--r-- | app/doc/png.d/carpart.png | bin | 16263 -> 47392 bytes | |||
| -rw-r--r-- | app/doc/png.d/carproto.png | bin | 13229 -> 29806 bytes | |||
| -rw-r--r-- | app/doc/png.d/celev.png | bin | 7125 -> 14895 bytes | |||
| -rw-r--r-- | app/doc/png.d/cgroup.png | bin | 7967 -> 32372 bytes | |||
| -rw-r--r-- | app/doc/png.d/colorw.png | bin | 4684 -> 5299 bytes | |||
| -rw-r--r-- | app/doc/png.d/convertfrom.png | bin | 4169 -> 874 bytes | |||
| -rw-r--r-- | app/doc/png.d/convertto.png | bin | 3940 -> 814 bytes | |||
| -rw-r--r-- | app/doc/png.d/custmgm.png | bin | 18986 -> 32580 bytes | |||
| -rw-r--r-- | app/doc/png.d/dbench.png | bin | 289 -> 691 bytes | |||
| -rw-r--r-- | app/doc/png.d/dbezier.png | bin | 3776 -> 837 bytes | |||
| -rw-r--r-- | app/doc/png.d/dbox.png | bin | 271 -> 570 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcircle1.png | bin | 0 -> 1078 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcircle2.png | bin | 296 -> 908 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcircle3.png | bin | 496 -> 886 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcurve1.png | bin | 280 -> 728 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcurve2.png | bin | 295 -> 793 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcurve3.png | bin | 288 -> 780 bytes | |||
| -rw-r--r-- | app/doc/png.d/dcurve4.png | bin | 302 -> 801 bytes | |||
| -rw-r--r-- | app/doc/png.d/ddimlin.png | bin | 284 -> 802 bytes | |||
| -rw-r--r-- | app/doc/png.d/dentermove.png | bin | 0 -> 2592 bytes | |||
| -rw-r--r-- | app/doc/png.d/dfilbox.png | bin | 262 -> 573 bytes | |||
| -rw-r--r-- | app/doc/png.d/dfilpoly.png | bin | 316 -> 852 bytes | |||
| -rw-r--r-- | app/doc/png.d/dflcrcl2.png | bin | 303 -> 1022 bytes | |||
| -rw-r--r-- | app/doc/png.d/dflcrcl3.png | bin | 297 -> 983 bytes | |||
| -rw-r--r-- | app/doc/png.d/dlayer.png | bin | 9268 -> 0 bytes | |||
| -rw-r--r-- | app/doc/png.d/dlayers.png | bin | 89877 -> 51754 bytes | |||
| -rw-r--r-- | app/doc/png.d/dline.png | bin | 260 -> 444 bytes | |||
| -rw-r--r-- | app/doc/png.d/dpoly.png | bin | 313 -> 722 bytes | |||
| -rw-r--r-- | app/doc/png.d/dpolylin.png | bin | 0 -> 716 bytes | |||
| -rw-r--r-- | app/doc/png.d/dprmfile.png | bin | 11394 -> 47325 bytes | |||
| -rw-r--r-- | app/doc/png.d/dproperties.png | bin | 43970 -> 50787 bytes | |||
| -rw-r--r-- | app/doc/png.d/dtbledge.png | bin | 270 -> 631 bytes | |||
| -rw-r--r-- | app/doc/png.d/easew.png | bin | 12509 -> 12875 bytes | |||
| -rw-r--r-- | app/doc/png.d/exportfile.png | bin | 22136 -> 28238 bytes | |||
| -rw-r--r-- | app/doc/png.d/exportfiledxf.png | bin | 19413 -> 24605 bytes | |||
| -rw-r--r-- | app/doc/png.d/exportfilesvg.png | bin | 0 -> 29333 bytes | |||
| -rw-r--r-- | app/doc/png.d/grid.png | bin | 6099 -> 15729 bytes | |||
| -rw-r--r-- | app/doc/png.d/iconlink.png (renamed from app/doc/png.d/iconlink.PNG) | bin | 230 -> 230 bytes | |||
| -rw-r--r-- | app/doc/png.d/import.png | bin | 22302 -> 22986 bytes | |||
| -rw-r--r-- | app/doc/png.d/importmod.png | bin | 0 -> 22835 bytes | |||
| -rw-r--r-- | app/doc/png.d/madd.png | bin | 3174 -> 13154 bytes | |||
| -rw-r--r-- | app/doc/png.d/map.png | bin | 3868 -> 1430 bytes | |||
| -rw-r--r-- | app/doc/png.d/mchange.png | bin | 5142 -> 30930 bytes | |||
| -rw-r--r-- | app/doc/png.d/medit.png | bin | 5981 -> 6233 bytes | |||
| -rw-r--r-- | app/doc/png.d/mentermove.png | bin | 0 -> 6641 bytes | |||
| -rw-r--r-- | app/doc/png.d/mhelp.png | bin | 2240 -> 4789 bytes | |||
| -rw-r--r-- | app/doc/png.d/mrotatevariable.png | bin | 0 -> 21603 bytes | |||
| -rw-r--r-- | app/doc/png.d/mselectcmd.png | bin | 78701 -> 33446 bytes | |||
| -rw-r--r-- | app/doc/png.d/mselectcontext.png | bin | 47076 -> 31696 bytes | |||
| -rw-r--r-- | app/doc/png.d/mtoolbar.png | bin | 4568 -> 0 bytes | |||
| -rw-r--r-- | app/doc/png.d/mtrainmanagement.png | bin | 2212 -> 11791 bytes | |||
| -rw-r--r-- | app/doc/png.d/mview.png | bin | 4108 -> 19613 bytes | |||
| -rw-r--r-- | app/doc/png.d/pan.png | bin | 3929 -> 788 bytes | |||
| -rw-r--r-- | app/doc/png.d/paramsearch.png | bin | 124132 -> 41706 bytes | |||
| -rw-r--r-- | app/doc/png.d/pref.png | bin | 46567 -> 16009 bytes | |||
| -rw-r--r-- | app/doc/png.d/print.png | bin | 46869 -> 57935 bytes | |||
| -rw-r--r-- | app/doc/png.d/problemdata.png | bin | 0 -> 9536 bytes | |||
| -rw-r--r-- | app/doc/png.d/statusbarparallel.png | bin | 12964 -> 4002 bytes | |||
| -rw-r--r-- | app/doc/png.d/statustext.png | bin | 12102 -> 3860 bytes | |||
| -rw-r--r-- | app/doc/png.d/strsel.png | bin | 21330 -> 49244 bytes | |||
| -rw-r--r-- | app/doc/png.d/toolbopt.png | bin | 0 -> 12663 bytes | |||
| -rw-r--r-- | app/doc/png.d/turnsel.png | bin | 18373 -> 50207 bytes | |||
| -rw-r--r-- | app/doc/view_winm.but | 22 | ||||
| -rw-r--r-- | app/doc/warranty.but | 68 |
155 files changed, 804 insertions, 404 deletions
diff --git a/app/doc/CMakeLists.txt b/app/doc/CMakeLists.txt index adc21b3..65f5b70 100644 --- a/app/doc/CMakeLists.txt +++ b/app/doc/CMakeLists.txt @@ -1,12 +1,21 @@ -PROJECT(doc) +project(doc) -CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/intro.but.in ${CMAKE_CURRENT_BINARY_DIR}/intro.but) -CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/clean-html.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/clean-html.cmake @ONLY) -CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/hhc.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/hhc.cmake @ONLY) +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/intro.but.in ${CMAKE_CURRENT_BINARY_DIR}/intro.but) +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/hhc.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/hhc.cmake @ONLY) -FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html) +# +# Create directory for the html stage -SET(HALIBUT_SOURCES +file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html) + +add_custom_target(helpsystem) +set_target_properties( + helpsystem + PROPERTIES FOLDER HelpDocs +) + +target_sources(helpsystem + PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/intro.but ${CMAKE_CURRENT_SOURCE_DIR}/addm.but ${CMAKE_CURRENT_SOURCE_DIR}/changem.but @@ -22,97 +31,137 @@ SET(HALIBUT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/view_winm.but ${CMAKE_CURRENT_SOURCE_DIR}/navigation.but ${CMAKE_CURRENT_SOURCE_DIR}/appendix.but - ${help_BINARY_DIR}/messages.but + ${messagefile_BINARY_DIR}/messages.but ${CMAKE_CURRENT_SOURCE_DIR}/upgrade.but ${CMAKE_CURRENT_SOURCE_DIR}/warranty.but - ) +) + +# +# messages.but is generated in a different directory scope, CMake must not check for existance +set_source_files_properties(${messagefile_BINARY_DIR}/messages.but + PROPERTIES + GENERATED True) # Add a custom command for cleaning the HTML staging directory -ADD_CUSTOM_TARGET(clean-html +add_custom_target(clean-html WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/clean-html.cmake - ) + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_SOURCE_DIR}/clean-html.cmake +) # If we're using the GTK back-end, just generate "vanilla" HTML help files for use with gtkhtml -IF(XTRKCAD_USE_GTK) +if(XTRKCAD_USE_GTK) + + if (APPLE) + target_sources(helpsystem + PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/osxconf.but) + else() + target_sources(helpsystem + PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/linconf.but) + endif() - 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) + get_target_property(halibut_sources helpsystem SOURCES) - ADD_CUSTOM_COMMAND( + add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html - DEPENDS halibut ${HALIBUT_SOURCES} + DEPENDS halibut ${halibut_sources} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/clean-html.cmake - COMMAND halibut ${HALIBUT_SOURCES} + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_SOURCE_DIR}/clean-html.cmake + COMMAND halibut ${halibut_sources} ) - ADD_CUSTOM_TARGET(help-html ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html) + add_custom_target(help-html ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html msgfiles) - INSTALL( + install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR} ) - INSTALL( + install( DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/png.d DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/html ) - INSTALL( + 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 + 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) + add_custom_target(help-index ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/XTrackCAD.helpindex) - INSTALL( + install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj ) - INSTALL( + install( DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/png.d DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj ) - INSTALL( + install( FILES xtrkcad_osx.css DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR}/XTrackCAD.help/Contents/Resources/en.lproj/sty ) - ENDIF(APPLE) + endif() # Otherwise, we're using the Win32 back-end, so generate a compiled HTML help file -ELSE(XTRKCAD_USE_GTK) +else() + find_package(HTMLHelp) - SET(HALIBUT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/chmconf.but ${HALIBUT_SOURCES}) - FILE(GLOB IMAGE_SOURCES png.d/*) - - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/xtrkcad.chm - DEPENDS halibut ${HALIBUT_SOURCES} ${IMAGE_SOURCES} ${CMAKE_CURRENT_SOURCE_DIR}/xtrkcad_win.css - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/clean-html.cmake - COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/png.d ${CMAKE_CURRENT_BINARY_DIR}/html/png.d - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/xtrkcad_win.css ${CMAKE_CURRENT_BINARY_DIR}/html - COMMAND halibut ${HALIBUT_SOURCES} - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/hhc.cmake + if("${HTML_HELP_COMPILER}" STRGREATER "") + target_sources(helpsystem + PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/chmconf.but + ) + file(GLOB IMAGE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/png.d/*) + + # + # Use the Microsoft HTML Help Workshop to create a chm file + # + # Clean the working directory + # Copy the image files and the CSS + # Create the sources for the Help Workshop using halibut + # Build the chm file + # Add the chm file to the installation + + add_custom_target(help-chm ALL DEPENDS ${halibut_sources}) + set_target_properties( + help-chm + PROPERTIES FOLDER HelpDocs ) - - ADD_CUSTOM_TARGET(help-chm ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/xtrkcad.chm) - - INSTALL( - FILES ${CMAKE_CURRENT_BINARY_DIR}/html/xtrkcad.chm - DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR} + get_target_property(halibut_sources helpsystem SOURCES) + + # hhc exits with non-zero code even on success + # workaround is to create an external cmake script that + # invokes hhc and handle its specific exit code + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/hhc.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/hhc.cmake" + @ONLY) + + add_custom_command( + TARGET help-chm + DEPENDS halibut helpsystem ${IMAGE_SOURCES} ${CMAKE_CURRENT_SOURCE_DIR}/xtrkcad_win.css + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_SOURCE_DIR}/clean-html.cmake + COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/png.d ${CMAKE_CURRENT_BINARY_DIR}/html/png.d + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/xtrkcad_win.css ${CMAKE_CURRENT_BINARY_DIR}/html + COMMAND halibut ${halibut_sources} + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/hhc.cmake ) -ENDIF(XTRKCAD_USE_GTK) + install( + FILES ${CMAKE_CURRENT_BINARY_DIR}/html/xtrkcad.chm + DESTINATION ${XTRKCAD_SHARE_INSTALL_DIR} + ) + else() + message(STATUS "HTML Help Workshop not found! CHM Help will not be created.") + endif() +endif() diff --git a/app/doc/addm.but b/app/doc/addm.but index 3ab07ec..a705a26 100644 --- a/app/doc/addm.but +++ b/app/doc/addm.but @@ -16,74 +16,74 @@ The \f{Add Menu} has all the actions related to adding track pieces to the layout. -\dd \i\f{Straight Track} \c{Ctrl+G} - lay straight track pieces of arbitrary lengths +\dd \i{Straight Track} \c{Ctrl+G} - lay straight track pieces of arbitrary lengths \u000 -\dd \i\f{Curve Track} - lay curved track pieces using different modes for selecting start and endpoints and radius (\K{cmdCurve}). +\dd \i{Curve Track} - lay curved track pieces using different modes for selecting start and endpoints and radius (\K{cmdCurve}). \dd \G{png.d/maddcurve.png} \u000 -\dd \i\f{Circle Track} \I{Track, Circle} - place a circle of track by selecting radius, tangent and or center (\K{cmdCircle}). +\dd \i{Circle Track} \I{Track, Circle} - place a circle of track by selecting radius, tangent and or center (\K{cmdCircle}). \dd \G{png.d/maddcircle.png} \u000 -\dd \i\f{Parallel} - \I{Parallel Track} \I{Track, Parallel} \I{Parallel Line} \I{Line, Parallel} +\dd \i{Parallel} - \I{Parallel Track} \I{Track, Parallel} \I{Parallel Line} \I{Line, Parallel} create parallel track or line to existing flex-track, straight or curved track. (\K{cmdParallel}) \dd \G{png.d/maddparallel.png} \u000 -\dd \i\f{Predefined Track} \I{Track, Predefined} \c{Ctrl+T} - select a turnout or a piece of fixed track and place on layout. +\dd \i{Fixed-track} \I{Track, Fixed} \c{Ctrl+T} - select a piece of \f{Fixed-track} and place on layout. \u000 -\dd \i\f{Hand-laid Turnout} \I{Turnout, Hand-laid} \c{Ctrl+Shift+I} - lay a turnout in place on the layout. (\K{cmdHandLaidTurnout}) +\dd \i{Hand-laid Turnout} \I{Turnout, Hand-laid} \c{Ctrl+Shift+I} - lay a turnout in place on the layout. (\K{cmdHandLaidTurnout}) \u000 -\dd \i\f{Structure} \c{Ctrl+Shift+C} - Add a predefined structure to the layout. +\dd \i{Structure} \c{Ctrl+Shift+C} - Add a predefined structure to the layout. \u000 -\dd \i\f{Helix} \c{Ctrl+Shift+H} - Add a helix. (\K{cmdHelix}) +\dd \i{Helix} \c{Ctrl+Shift+H} - Add a helix. (\K{cmdHelix}) \u000 -\dd \i\f{Custom Turntable} \I{Turntable, Custom} \c{Ctrl+Shift+N} - Place a turntable. (\K{cmdTurntable}) +\dd \i{Custom Turntable} \I{Turntable, Custom} \c{Ctrl+Shift+N} - Place a turntable. (\K{cmdTurntable}) \u000 -\dd \i\f{Control Element} - Create a control element. +\dd \i{Control Element} - Create a control element. \u000 -\dd \i\f{Block} \I{Control Element, Block} - Create a block. (\K{cmdBlock}) +\dd \i{Block} \I{Control Element, Block} - Create a block. (\K{cmdBlock}) \u000 -\dd \i\f{Switchmotor} \I{Control Element, Switchmotor} - Create a switchmotor. (\K{cmdSwitchmotor}) +\dd \i{Switchmotor} \I{Control Element, Switchmotor} - Create a switchmotor. (\K{cmdSwitchmotor}) \u000 -\dd \i\f{Signal} \I{Control Element, Signal} - Create a signal. (\K{cmdSignal}) +\dd \i{Signal} \I{Control Element, Signal} - Create a signal. (\K{cmdSignal}) \u000 -\dd \i\f{Control} \I{Control Element, Control} - Create a control. (\K{cmdControl}) +\dd \i{Control} \I{Control Element, Control} - Create a control. (\K{cmdControl}) \u000 -\dd \i\f{Sensor} \I{Control Element, Sensor} - Create a sensor. (\K{cmdSensor}) +\dd \i{Sensor} \I{Control Element, Sensor} - Create a sensor. (\K{cmdSensor}) \rule -\S{cmdCircle} Circle Track +\S{cmdCircle} \i{Circle Track} \G{png.d/maddcircle.png} @@ -122,7 +122,7 @@ You can join to and from circles, after which they become curved tracks. \rule -\S2{cmdCircleFixedRadius} Circle Fixed Radius +\S2{cmdCircleFixedRadius} \i{Circle Fixed Radius} \G{png.d/bcircl1.png} @@ -131,7 +131,7 @@ You can join to and from circles, after which they become curved tracks. \rule -\S2{cmdCircleTangent} Circle Fixed Tangent +\S2{cmdCircleTangent} \i{Circle Fixed Tangent} \G{png.d/bcircl2.png} @@ -139,7 +139,7 @@ You can join to and from circles, after which they become curved tracks. \rule -\S2{cmdCircleCenter} Circle From Center +\S2{cmdCircleCenter} \i{Circle From Center} \G{png.d/bcircl3.png} @@ -147,7 +147,7 @@ You can join to and from circles, after which they become curved tracks. \rule -\S{cmdCurve} Curved Track +\S{cmdCurve} \i{Curved Track} \G{png.d/maddcurve.png} @@ -210,7 +210,7 @@ For Beziers and Cornus, the active control point will be drawn in red and the av \rule -\S2{cmdCurveEndPt} Curved Track from End Point +\S2{cmdCurveEndPt} \i{Curved Track from End Point} \G{png.d/bcurve1.png} @@ -226,7 +226,7 @@ If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the ends will \rule -\S2{cmdCurveTangent} Curved track from Tangent +\S2{cmdCurveTangent} \i{Curved track from Tangent} \G{png.d/bcurve2.png} @@ -240,7 +240,7 @@ If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the end will s \rule -\S2{cmdCurveCenter} Curved Track From Center +\S2{cmdCurveCenter} \i{Curved Track From Center} \G{png.d/bcurve3.png} @@ -253,9 +253,11 @@ If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the end will s \rule -\S2{cmdCurveChord} Curved Track from Chord +\S2{cmdCurveChord} \i{Curved Track from Chord} -\G{png.d/bcurve4.png} (\c{Ctrl+7}) Drag from one endpoint to the other endpoint to form the Chord of the Curve and release. \c{Left-Click} on the center of the track and Drag to form the Curve. +\G{png.d/bcurve4.png} + +(\c{Ctrl+7}) Drag from one endpoint to the other endpoint to form the Chord of the Curve and release. \c{Left-Click} on the center of the track and Drag to form the Curve. The first end point acts like "CurvedTrack From End". If an exitsing track end is selected, the Chord will only move along line orthogonal to the track. While the endpoints are being placed, if \f{MagneticSnap} (\K{cmdMagneticSnap}) is enabled, unless \c{Alt} is held down, they will "Snap" to an open track endpoint of the tracks underneath the cursor and you can only drag out the control point aligned to the end of those tracks. @@ -265,7 +267,7 @@ If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the end will s \rule -\S2{cmdBezier} Curved Bezier Track +\S2{cmdBezier} \i{Curved Bezier Track} \G{png.d/bezier.png} @@ -280,9 +282,11 @@ If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the end will s \rule -\S2{cmdCornu} Create Cornu Track +\S2{cmdCornu} \i{Create Cornu Track} + +\G{png.d/bcornu.png} -\dd \G{png.d/bcornu.png} \c{Left-Click} to place each endpoint on an open track end or just on the layout. +\dd \c{Left-Click} to place each endpoint on an open track end or just on the layout. During the move to the click, if \f{MagneticSnap} (\K{cmdMagneticSnap}) is enabled, an anchor will show when the cursor is near an open end point. This can be inhibited with \e{Alt}. If \f{MagneticSnap} is disabled this will only happen if \e{Alt} is held. If Magnetic Snap does not find a end, if \f{SnapGrid} is enabled, the end will snap to the nearest grid point unless \f{Alt} is held. @@ -310,7 +314,7 @@ If the end is not connected, an anchor will enable the end-angle and radius to b \u000 -\S{cmdHandLaidTurnout} Hand-laid Turnouts +\S{cmdHandLaidTurnout} \i{Hand-laid Turnouts} \G{png.d/bhndldto.png} @@ -335,7 +339,9 @@ Note: the drawing is an approximation to show the location of the \e{Points} and \rule -\S{cmdHelix} Helix Track +\S{cmdHelix} \i{Helix Track} + +\G{png.d/bhelix.png} A helix track is used to change the elevation of track in a restricted space. A helix is drawn as a circle of track, but in 3 dimensions it would resemble a cork screw or the pattern of threads on a bolt. @@ -359,11 +365,12 @@ You can join to a helix in the same way you join to a circle. However, once joi A label for the helix is drawn at it's the center. If the elevations are set (either by a Defined Elevation point or connecting to a Defined Elevation point) for the two ends of the helix then the label contains the computed grade and vertical separation between layers as well as the number of turns and total length. The label can be moved or turned off by the Move Label (\K{cmdMoveLabel}) command. -\rule + +\S{cmdParallel} \i{Parallel Track or Line} \dd \G{png.d/maddparallel.png} -\S{cmdParallel} Parallel Track or Line +\rule You can pick between two Parallel Commands: @@ -377,7 +384,7 @@ You can pick between two Parallel Commands: \rule -\S2{cmdParallelTrack} Parallel Track +\S2{cmdParallelTrack} \i{Parallel Track} \G{png.d/bparallel.png} @@ -405,7 +412,7 @@ These endpoints will be automatically connected. \rule -\S2{cmdParallelLine} Parallel Lines +\S2{cmdParallelLine} \i{Parallel Lines} \G{png.d/bparalleline.png} @@ -415,7 +422,7 @@ Select the Track or Line you want to parallel with \c{Left-Click}, and the new p \rule -\S{cmdStraight} Straight Track +\S{cmdStraight} \i{Straight Track} \G{png.d/bstraigh.png} @@ -427,11 +434,11 @@ If the Snap Grid (\K{cmdGrid}) is enabled then the endpoints will be constrained \rule -\S{cmdStructure} Structure +\S{cmdStructure} \i{Structure} \G{png.d/bstruct.png} -The \f{Structure} command places diagrams of structures (buildings, bridges and other scenic elements) on the layout. The operation is similar to the Turnout (\K{cmdTurnout}) command. +The \f{Structure} command places diagrams of structures (buildings, bridges and other scenic elements) on the layout. The operation is similar to the Fixed-track (\K{cmdNewFixedTrack}) command. \G{png.d/strsel.png} @@ -441,33 +448,33 @@ The \f{Structure Selection} dialog will disappear while dragging on the layout i See the Hot Bar (\K{cmdHotBar}) command for details on placing Structures on the layout. -\f{Structures} are placed on the layout in same way as \f{turnouts} except that there is no \e{Active endpoint} and structures do not align with existing tracks. +\f{Structures} are placed on the layout in same way as \f{Fixed-tracks} except that there is no \e{Active endpoint} and structures do not align with existing tracks. \rule -\S{cmdTurnout} Turnouts +\S{cmdNewFixedTrack} \i{Fixed-track} \G{png.d/bturnout.png} -Turnouts (and sectional track) are created by the \f{Turnout} command \I{Created by Turnout Command}. When you select the turnout command, the \f{Turnout Selection} dialog is displayed which contains a list of available turnouts and sectional track for the current scale (\K{cmdLayout}) and a diagram of the selected turnout. +Fixed-track objects (Turnouts, Sectional Tracks and Grouped Object) are added by the \f{Fixed-track} command, and the \f{Selection} dialog is displayed which contains a list of available turnouts, sectional tracks and grouped objects for the current scale (\K{cmdLayout}) and a diagram of the selected turnout. You can use the Parameter File Dialog (\K{cmdPrmfile}) to control what turnouts are available. \G{png.d/turnsel.png} -Select a turnout from the scrolling list by \c{Left-Click}ing on it. Move to the Layout and \c{Left-Click} where the turnout should be placed. The Turnout will snap to nearby flextracks or open endpoints. By \c{Left-Drag}ing you can move the turnout around. Additional \c{Left-Click}s change the way the turnout is placed. +Select a turnout from the scrolling list by \c{Left-Click}ing on it. Move to the Layout and \c{Left-Click} where the turnout should be placed. The Turnout will snap to nearby flex-tracks or open endpoints. By \c{Left-Drag}ing you can move the turnout around. Additional \c{Left-Click}s change the way the turnout is placed. The \f{New} button invokes the Turnout Designer (\K{cmdTurnoutNew}) dialog. This button displays a pop-up-menu list of various types of turnouts and sectional track. The \f{Turnout Selection} window will disappear while dragging on the layout if the \f{Hide} Check Box on the dialog is set. This is useful if you have a small screen. -See the Hot Bar (\K{cmdHotBar}) command for details on placing Turnouts on the layout. +See the Hot Bar (\K{cmdHotBar}) command for details on placing Fixed-tracks on the layout. \rule -\S{cmdTurntable} Turntables +\S{cmdTurntable} \i{Turntables} \G{png.d/bturntbl.png} @@ -483,7 +490,7 @@ The \f{Turntable Angle} control on the Preferences (\K{cmdPref}) dialog controls \rule -\S{cmdBlock} Block +\S{cmdBlock} \i{Block} \G{png.d/bblock.png} @@ -506,7 +513,7 @@ information, etc. \rule -\S{cmdSwitchmotor} Switchmotor +\S{cmdSwitchmotor} \i{Switchmotor} \G{png.d/bswitchmotor.png} @@ -530,7 +537,7 @@ could be code snippets or I/O device address information, etc. \rule -\S{cmdSignal} Signal +\S{cmdSignal} \i{Signal} \G{png.d/bsignal.png} @@ -554,9 +561,9 @@ causes the aspect to be displayed. \rule -\S{cmdControl} Control +\S{cmdControl} \i{Control} -\G{png.d/bControl.png} +\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 @@ -574,9 +581,9 @@ software to actually effect the state on the control (on or off). \rule -\S{cmdSensor} Sensor +\S{cmdSensor} \i{Sensor} -\G{png.d/bSensor.png} +\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 diff --git a/app/doc/appendix.but b/app/doc/appendix.but index 7c45c4a..3bd5a8e 100644 --- a/app/doc/appendix.but +++ b/app/doc/appendix.but @@ -107,8 +107,6 @@ Menu and sub-menu items are indicated by \e{File>Open}, which means select the \ \f{Edit Box} - an area where you can enter a String, Integer or Floating Point value. -\f{FlexTrack} - an automatic object on the ToolBar that creates a Cornu Track element - \f{Highlighted} - an area on the Canvas which is in inverse-video. \f{Left-Click} - same as \e{Click}, used in contexts where \e{Right-Click} is also used. @@ -166,7 +164,21 @@ curves were variously called easements, Talbot or Euler spirals. \f{Error Message} - an error message displayed in the Status Bar (\K{mainW}) accompanied by a beep. -\f{Flex-track} - Prefabricated flexible sections of track used on a layout. It usually comes in straight, three-foot-long sections which can be bent or shaped as needed. This term is also used for hand-laid track. +\#{TODO} + +\I{Fixed-track}\f{Fixed-track} - +These include Turnouts, Sectional tracks and Grouped objects. +They are defined in Parameter Files (\K{cmdPrmfile}), or created using the \f{Turnout Designer} (\K{cmdTurnoutNew}) or the \f{Group} (\K{cmdGroup}) command. +They are selected for placement on the layout using the \f{Hot Bar} (\K{cmdHotBar}) or the \f{Fixed-Track} (\K{cmdNewFixedTrack}) dialog. +They can not be directly altered, but can be decomposed with the \f{Ungroup} (\K{cmdUngroup}) command and some cases trimed (\K{splitDivide}). + +\I{Flex-track}\f{Flex-track} - +Flexible sections of track used on a layout. +It usually comes in straight, three-foot-long sections which can be bent or shaped as needed. +These include Straight, Curved, Easements, Cornu and Bezier tracks. +This term is also used for hand-laid track. +They are created by invoking the corresponding command and dragging on the layout. +\f{Easements} (\K{cmdEasement}) are created automatically when joining tracks. \f{Frog} - the place on a turnout track where one rail crosses the other. @@ -182,11 +194,10 @@ curves were variously called easements, Talbot or Euler spirals. \f{Points} - the part of the Turnout that moves to select a path. -\f{Reverse Curve} - a piece of track which curves in one direction then changes direction without any appreciable length of straight track between the two curves. - -\f{S-Curve} - a curve which bends in one direction and then the other, forming an S-like shape. +\f{S-Curve} - (aka \f{Reverse Curve}) a curve which bends in one direction and then the other, forming an S-like shape, without any appreciable length of straight track between the two curves \f{Sectional Track} - prefabricated track which cannot be bent, split or changed. +A type of \f{Fixed-Track}. \f{Selected Endpoint} - when selecting track for various reasons the selected endpoint is the one closest to the selection point. @@ -196,6 +207,8 @@ curves were variously called easements, Talbot or Euler spirals. \f{Turnout} - A piece of track that allows a train to go from one track to another. Called a switch on a real railroad. Referred to by number. For example, a no. 6 turnout spreads one unit for each six units of travel measured from the frog (the point at which two rails join to form a V). +Turnouts are a type of 'Fixed-track' which includes Sectional Tracks and Grouped Objects. + \b In \e{XTrackCAD}, \e{Turnouts} also include sectional Tracks, crossings and forms of prefabricated (non-flex) track. \f{Turnout Frog} - the place on the turnout track where one rail crosses the other. @@ -247,7 +260,7 @@ or virtual track circuit in a Tower-LCC or similar device. \rule -\A{} Messages and Explanations +\A{messages} Messages and Explanations \H{messageType} \i{Message Types} @@ -265,13 +278,13 @@ or virtual track circuit in a Tower-LCC or similar device. \u000 -\dd \e{Notices} and \e{Error messages} that might be encounter are listed here with a explanation. The \f{Recent Messages} menu item on the \f{Help} (\K{helpM}) menu contains a list of the most recent messages. Selecting one of the entries presents information on the particular message. +\dd \e{Notices} and \e{Error messages} that might be encountered are listed here with a explanation. The \f{Recent Messages} menu item on the \f{Help} (\K{helpM}) menu contains a list of the most recent messages. Selecting one of the entries presents information on the particular message. \u000 \dd The notation \e{abc|xyx} indicates the message can appear with either of the values (\e{abc} or \e{xyz}). Items in \e{UPPERCASE} indicate numeric (such as lengths) or string (such as filenames) values. -\K{messageList} provides detail explanation of each information or error message. +messageList provides detail explanation of each information or error message. \rule diff --git a/app/doc/changem.but b/app/doc/changem.but index 0e1fc8a..e404801 100644 --- a/app/doc/changem.but +++ b/app/doc/changem.but @@ -12,31 +12,31 @@ The \f{Change Menu} has all functions related to modifying objects that exist on the layout drawing. -\dd \i\f{Properties} - sets \e{XTrackCAD} into \e{Describe} mode. Whenever an object is clicked on while in this mode, the \f{Properties} dialog is opened. This dialog allows direct manipulation of settings such as the objects length, position or orientation. (\K{cmdDescribe}). +\dd \i{Properties} - sets \e{XTrackCAD} into \e{Property} mode. Whenever an object is clicked on while in this mode, the \f{Properties} dialog is opened. This dialog allows direct manipulation of settings such as the objects length, position or orientation. (\K{cmdDescribe}). \u000 -\dd \i\f{Select} - sets \e{XTrackCAD} into \e{Select} mode. Whenever an object is clicked on while in this mode, this selection state of this object is reversed. If an object was unselected it becomes selected, and vice versa. To unselect all objects press the ESC key, use \f{Deselect All} from the \f{Edit} (\K{editM}) menu or \f{Deselect All} from the \f{Pop-up} menu (\K{mouseBcmd}). (\K{cmdSelect}). +\dd \i{Select} - sets \e{XTrackCAD} into \e{Select} mode. Whenever an object is clicked on while in this mode, this selection state of this object is reversed. If an object was unselected it becomes selected, and vice versa. To unselect all objects press the ESC key, use \f{Deselect All} from the \f{Edit} (\K{editM}) menu or \f{Deselect All} from the \f{Pop-up} menu (\K{mouseBcmd}). (\K{cmdSelect}). \rule -\dd \i\f{Move} - move selected object(s). (\K{cmdMove}). +\dd \i{Move} - move selected object(s). (\K{cmdMove}). \u000 -\dd \i\f{Rotate} - rotate selected object(s). (\K{cmdRotate}). +\dd \i{Rotate} - rotate selected object(s). (\K{cmdRotate}). \u000 -\dd \i\f{Flip} - turn selected object(s) over or around. (\K{cmdFlip}). +\dd \i{Flip} - turn selected object(s) over or around. (\K{cmdFlip}). \u000 -\dd \i\f{Loosen Tracks} \I{Track, Loosen} - this command reverses the effect of Connect Two Tracks as applied to sectional track. +\dd \i{Loosen Tracks} \I{Track, Loosen} - this command reverses the effect of Connect Two Tracks as applied to sectional track. \u000 -\dd \i\f{Modify} - modify an existing track, or lines. (\K{cmdModify}). +\dd \i{Modify} - modify an existing track, or lines. (\K{cmdModify}). \u000 @@ -46,13 +46,13 @@ The \f{Change Menu} has all functions related to modifying objects that exist on \u000 -\dd \i\f{Connect Two Tracks} \I{Track, Connect} - creates a connection between track pieces with an option to slightly move the select piece(s) and the pieces they connect to. (\K{cmdConnect}). +\dd \i{Connect Two Tracks} \I{Track, Connect} - creates a connection between track pieces with an option to slightly move the select piece(s) and the pieces they connect to. (\K{cmdConnect}). \u000 \dd \G{png.d/msplit.png} -\dd \i\f{Split} - the \f{Split} commands are used to divide up tracks (\K{cmdSplitTrack}) or split draw objects (\K{cmdSplitDraw}) or use a second Object to Trim (\K{cmdTrimDraw}). +\dd \i{Split} - the \f{Split} commands are used to divide up tracks (\K{cmdSplitTrack}) or split draw objects (\K{cmdSplitDraw}) or use a second Object to Trim (\K{cmdTrimDraw}). The (\K{cmdSplitTrack}) command can be used in one of two ways; \lcont{ @@ -65,37 +65,37 @@ The (\K{cmdSplitTrack}) command can be used in one of two ways; } -\dd \i\f{Move Description} - move the endpoint description of a track piece to another location. (\K{cmdMoveLabel}). +\dd \i{Move Description} - move the endpoint description of a track piece to another location. (\K{cmdMoveLabel}). \rule -\dd \i\f{Raise/Lower Elevations} - raise or lower elevation of selected tracks. (\K{cmdRaiseElev}). +\dd \i{Raise/Lower Elevations} - raise or lower elevation of selected tracks. (\K{cmdRaiseElev}). \u000 -\dd \i\f{Elevation} - define an elevation at specified track location (\K{cmdElevation}). +\dd \i{Elevation} - define an elevation at specified track location (\K{cmdElevation}). \u000 -\dd \i\f{Profile} - display the elevation profile of a definable stretch of track (\K{cmdProfile}). +\dd \i{Profile} - display the elevation profile of a definable stretch of track (\K{cmdProfile}). \u000 -\dd \i\f{Clear Elevations} - remove elevation parameters from selected track(s). +\dd \i{Clear Elevations} - remove elevation parameters from selected track(s). \u000 -\dd \i\f{Recompute Elevations} - performs a global re-computation of dynamic elevations. It should not be necessary to issue this command as elevations are recomputed as required. +\dd \i{Recompute Elevations} - performs a global re-computation of dynamic elevations. It should not be necessary to issue this command as elevations are recomputed as required. \rule -\dd \i\f{Change Scale} - change model scale and/or gauge of layout design. (\K{cmdRescale}) +\dd \i{Change Scale} - change model scale and/or gauge of layout design. (\K{cmdRescale}) \rule \dd \G{png.d/mconvert.png} -\dd \i\f{Convert} - chnages fixed tracks (Straight, Curve, Joint, Bezier) into a Smooth Cornu or vice versa. (\K{cmdConvert}). +\dd \i{Convert} - changes flex-tracks (Straight, Curve, Joint, Bezier) into a Smooth Cornu or vice versa. (\K{cmdConvert}). \rule @@ -114,6 +114,9 @@ The (\K{cmdSplitTrack}) command can be used in one of two ways; \b by ratio (by 181.5%). +If the selected objects have multiple Scales then the 1st From box will display "Multi-Scale". +If the selected objects are all of one Scale and but have different Gauges then the 2nd From box will display "Multi-Gauge". + If resizing by modeling scale then track dimensions, e.g., lengths and radii, will be changed as well. An option is available to disable the resizing of the selected objects. \rule @@ -167,11 +170,11 @@ Dependent upon previous selection, the Convert Track button will look like \G{pn \rule -\S2{cmdConvertTo} Convert Fixed Track(s) to Cornu(s) +\S2{cmdConvertTo} Convert flex-track(s) to Cornu(s) \G{png.d/convertto.png} -This command will take a pre-selected set of fixed track elements (Straights, Curves, Joint or Bezier) and convert them into a set of Cornu Tracks. +This command will take a pre-selected set of flex-track elements (Straights, Curves, Joint or Bezier) and convert them into a set of Cornu Tracks. If there are no selected Tracks, the user can click on a single track. The Cornu(s) will smoothly pass through all the end points of the selected tracks and smoothly join to the end-points (if any). @@ -182,7 +185,7 @@ This command is intended to help conversion of track designs that were made befo \rule -\S2{cmdConvertFrom} Convert Cornu(s) and Bezier(s) to Fixed Track(s) +\S2{cmdConvertFrom} Convert Cornu(s) and Bezier(s) to flex-track(s) \G{png.d/convertfrom.png} @@ -348,7 +351,7 @@ For detail about; \u000 \dd Using Normal Easements where tracks are either joined with a straight or a 'simple curve' \k{joinNormalEasment}, -e.g. one which uses a curve in a single direction as opposed to using reverse curves (\K{generalTerms}) +e.g. one which uses a curve in a single direction as opposed to using a S-Curve (\K{generalTerms}) \u000 @@ -1083,7 +1086,7 @@ Move An Object Using Fixed or Specified amounts of X and Y Translation. A pop-up menu with additional menu items allows you to \f{Move} the selected object(s) through through any amount you specify. -\G{png.d/mmovevariable.png} +\G{png.d/mentermove.png} The \f{Move} command is executed as follows; @@ -1093,17 +1096,16 @@ The \f{Move} command is executed as follows; \n \e{Shift+Right-Click} to raise the Move/Rotate menu. -\lcont{\u000 +\lcont{\u000} Any amount of precise transalation may be entered by \e{Left-Click}ing the \f{Enter Move...} menu item then entering a desired amount of translation in X and Y in the dialog window that appears. \u000 -\G{png.d/dmovetranslate.png} +\G{png.d/dentermove.png} \u000 -} \rule @@ -1141,7 +1143,7 @@ There is a \f{Context Menu} invoked with \e{Right-Click} or \e{Shift plus Right- Labels can be moved by hovering the "hot spots" or over the attached track object. \e{Left-Drag} will reposition it. Elevation labels can be selected by hovering of thier centers or the end point they refer to. Note that end points with elevation mode "None" are not selectable. -\b Cornu, Bezier, Straight, Curve and Joint (Easement) Labels can be moved along the line between the end-points and also laterally. +\b Cornu, Bezier, Straight, Curve and Joint (Easement) Labels can be moved along the line between the end-points and also laterally. \lcont{\u000 @@ -1264,7 +1266,7 @@ The dialog can be closed with the 'X' button in the window's titlebar. \G{png.d/bdescrib.png} -Clicking on the \f{Properties} (Describe Mode) button cancels all active commands, closes any open dialog windows and places focus on the main window. +Clicking on the \f{Properties} (Property Mode) button cancels all active commands, closes any open dialog windows and places focus on the main window. Until an object is selected, the object under the cursor that will be selected with \e{Left-Click} is highlighted in blue. Objects in Frozen Layers will only be highlighted and selected if \f{Shift} is added. @@ -1280,7 +1282,7 @@ The selected object is highlighted by a grey area. \G{png.d/dpropertieshighlight.png} -\S2{drawDescribe} Draw Object Describe Fields +\S2{drawDescribe} Draw Object Property Fields \S3{drawDescribeCommon} Common Draw Object Fields @@ -1318,7 +1320,7 @@ If the Rotate Origin is set to \{0,0\}, the Object has an \e{Absolute} origin. \dt Rotate By -\dd Some Draw objects (Polygon, Polyline, Lines, Curves, Circles, Text) can be rotated about their rotation origin in Describe. +\dd Some Draw objects (Polygon, Polyline, Lines, Curves, Circles, Text) can be rotated about their rotation origin in Properties. In order to rotate them, the \f{Lock To Origin} must be enabled. After the rotation completes, the rotation angle will be set back to zero and all the points of the object will be adjusted to their absolute position in the layout. Negative values of rotation are counter-clockwise. @@ -1332,7 +1334,7 @@ Note that for Text objects, the Rotation also changes the \f{Text Angle}. \dd The color of the line or the fill can be set -\S3{drawDescribeStr} Straight Line Objects Describe Fields +\S3{drawDescribeStr} Straight Line Objects Fields \dt End Pt 1 @@ -1356,7 +1358,7 @@ Note that for Text objects, the Rotation also changes the \f{Text Angle}. \dd The size of the arrows and text can be set to Tine, Small, Medium or Large. -\S3{drawDescribeBench} BenchWork Objects Describe Fields +\S3{drawDescribeBench} BenchWork Objects Fields \dt Lumber @@ -1366,7 +1368,7 @@ Note that for Text objects, the Rotation also changes the \f{Text Angle}. \dd The timber can be orientated "On Edge" which will draw the smaller dimension or "Flat". -\S3{drawDescribeCurve} Curved and Circle Objects Describe Fields +\S3{drawDescribeCurve} Curved and Circle Objects Fields \dt Center @@ -1380,7 +1382,7 @@ Note that for Text objects, the Rotation also changes the \f{Text Angle}. \dd For Curved Lines this is the length of the arc in degrees. If altered it will move the arc to respect the \f{Pivot} control setting. -\S3{drawDescribePoly} Polygon Objects Describe Fields +\S3{drawDescribePoly} Polygon Objects Fields \dt Fill @@ -1402,7 +1404,7 @@ Note that for Text objects, the Rotation also changes the \f{Text Angle}. \dd Straight and Curved Lines, PolyLines, Polygons and Structures can be drawn with dotted, dashed, dash-dotted and dash-dot-dotted lines. -\S3{drawDescribeText} Text Objects Describe Fields +\S3{drawDescribeText} Text Objects Fields \dt Text Angle @@ -1414,7 +1416,7 @@ This will be set by itself or by rotation of the starting position about the Rot \dd For Text objects, whether a line is drawn around the text. -\S2{DescribeCompound} Structures, Sectional Track and Turnouts Describe Fields +\S2{DescribeCompound} Structures, Sectional Track and Turnouts Object Fields \dt Pivot @@ -1425,7 +1427,7 @@ These relative positions are calculated as though the object was rotated by zero \dd The Angle rotates the object about the Pivot point. -\S2{DescribeTrack} Describe Track Fields +\S2{DescribeTrack} Track Object Fields \S3{trackDescribeCommon} Common Track Object Fields @@ -1456,7 +1458,7 @@ This can only be changed if the track is unconnected at that end. The elevation \dd The Pivot control can be set to fix in place the start, or the middle or the end, and it applies to the Length, Track Angle and Angular Length controls. When these are changed the new dimensions are applied so as to keep the locked position in place. -\S3{trackDescribeStr} Straight Track Describe Fields +\S3{trackDescribeStr} Straight Track Fields \dt Track Angle @@ -1464,7 +1466,7 @@ When these are changed the new dimensions are applied so as to keep the locked p \dd The angle of the Track object. This can be set if the track is not connected. It respects the value of the \f{Pivot} field -\S3{trackDescribeCurve} Curved Track Describe Fields +\S3{trackDescribeCurve} Curved Track Object Fields \dt Center @@ -1487,7 +1489,7 @@ When these are changed the new dimensions are applied so as to keep the locked p \dd The ClockWise Angle (the angle from the center to the end position). Can only be modified if the second end of the curve is not connected. -\S3{trackDescribeCornu} Cornu Track Describe Fields +\S3{trackDescribeCornu} Cornu Track Object Fields \dt End Angle @@ -1518,7 +1520,7 @@ It gives an idea of the "sharpness" of the curve. \dd The number of degrees that the curve executes - this number will rise if there are loops in the curve. -\S3{trackDescribeBezier} Cornu Track Describe Fields +\S3{trackDescribeBezier} Bezier Track Object Fields \dt Ctl Pt @@ -1799,7 +1801,11 @@ If \f{SelectZero} is selected in \K{cmdCmdopt} and an point that is not near to \u000 -\G{png.d/mselectcmd.png} or \G{png.d/mselectcontext.png} +\G{png.d/mselectcmd.png} + +or + +\G{png.d/mselectcontext.png} \u000 @@ -1871,21 +1877,6 @@ Upon release of the button, all the selected tracks will be moved and aligned an \u000 -\dd \e{Right-Click} and \e{Shift-Right-Click} - either display a pop-up menu of commands or a set of context commands for the items selected depending on the setting of "Right-Click" in \K{cmdCmdopt}. -The options effects depend on the type of object(s) selected and hovered over. - -\lcont{ -\u000 - -\G{png.d/mselectcmd.png} or \G{png.d/mselectedcontext.png} - -\u000 - -} - -Once Objects are - - Once objects are selected, the following commands operate on them: \b \f{Move} (\K{cmdMove}) the selected objects. @@ -1954,7 +1945,7 @@ For detail about; \u000 -\dd Dividing a section of flex track into two connected pieces or trimming a turnout see \K{splitDivide}. +\dd Dividing a section of flex-track into two connected pieces or trimming a turnout see \K{splitDivide}. \u000 @@ -2006,7 +1997,7 @@ For detail about; \S3{splitDivide} Divide Track -Dividing a section of flex track into two connected pieces; +Dividing a section of flex-track into two connected pieces; \n Click the \f{Split Track} button (\G{png.d/bsplit.png}) to activate the \f{Split Track} command. diff --git a/app/doc/clean-html.cmake b/app/doc/clean-html.cmake new file mode 100644 index 0000000..3b0c500 --- /dev/null +++ b/app/doc/clean-html.cmake @@ -0,0 +1,6 @@ +file(GLOB_RECURSE all_files *) + +if(all_files) + file(REMOVE ${all_files}) +endif(all_files) + diff --git a/app/doc/clean-html.cmake.in b/app/doc/clean-html.cmake.in deleted file mode 100644 index d3b6908..0000000 --- a/app/doc/clean-html.cmake.in +++ /dev/null @@ -1,6 +0,0 @@ -FILE(GLOB_RECURSE ALL_FILES *) - -IF(ALL_FILES) - FILE(REMOVE ${ALL_FILES}) -ENDIF(ALL_FILES) - diff --git a/app/doc/drawm.but b/app/doc/drawm.but index a9555b2..5e27011 100644 --- a/app/doc/drawm.but +++ b/app/doc/drawm.but @@ -50,7 +50,7 @@ Some commands display controls on the Status Line (\K{mainW}) to change line wid \rule -\S{cmdDrawCircles} Circles and Filled Circles +\S{cmdDrawCircles} \i{Circles and Filled Circles} \G{png.d/mdrawcircles.png} @@ -75,7 +75,7 @@ The \f{Circle Line Width} field is a scaled dimension in inches if >0. If 0 it i \rule -\S2{cmdDrawCircleTangent} Draw Circle from Tangent +\S2{cmdDrawCircleTangent} \i{Draw Circle from Tangent} \G{png.d/dcircle3.png} @@ -83,7 +83,7 @@ The \f{Circle Line Width} field is a scaled dimension in inches if >0. If 0 it i \rule -\S2{cmdDrawCircleCenter} Draw Circle from Center +\S2{cmdDrawCircleCenter} \i{Draw Circle from Center} \G{png.d/dcircle2.png} @@ -91,7 +91,7 @@ The \f{Circle Line Width} field is a scaled dimension in inches if >0. If 0 it i \rule -\S2{cmdDrawFilledCircleTangent} Draw Filled Circle from Tangent +\S2{cmdDrawFilledCircleTangent} \i{Draw Filled Circle from Tangent} \G{png.d/dflcrcl3.png} @@ -99,7 +99,7 @@ The \f{Circle Line Width} field is a scaled dimension in inches if >0. If 0 it i \rule -\S2{cmdDrawFilledCircleCenter} Draw Filled Circle from Center +\S2{cmdDrawFilledCircleCenter} \i{Draw Filled Circle from Center} \G{png.d/dflcrcl2.png} @@ -107,7 +107,7 @@ The \f{Circle Line Width} field is a scaled dimension in inches if >0. If 0 it i \rule -\S{cmdDrawCurves} Curved Lines +\S{cmdDrawCurves} \i{Curved Lines} \G{png.d/mdrawcurve.png} @@ -148,7 +148,7 @@ To adjust the curve with the mouse, \e{Left-Click} and \e{Left-Drag} an end or a \rule -\S2{cmdDrawCurveEndPt} Draw Curve from End Point +\S2{cmdDrawCurveEndPt} \i{Draw Curve from End Point} \G{png.d/dcurve1.png} @@ -161,7 +161,7 @@ suppressed if \f{Alt} is held. The second end will act similarly. \rule -\S2{cmdDrawCurveTangent} Draw Curve from Tangent +\S2{cmdDrawCurveTangent} \i{Draw Curve from Tangent} \G{png.d/dcurve2.png} @@ -176,7 +176,7 @@ To complete the command, drag on the red arrows to adjust the curve from the ini \rule -\S2{cmdDrawCurveCenter} Draw Curve from Center +\S2{cmdDrawCurveCenter} \i{Draw Curve from Center} \G{png.d/dcurve3.png} @@ -185,7 +185,7 @@ suppressed if \f{Alt} is held. \rule -\S2{cmdDrawCurveChord} Draw Curve from Chord +\S2{cmdDrawCurveChord} \i{Draw Curve from Chord} \G{png.d/dcurve4.png} @@ -199,7 +199,7 @@ To complete the command, drag on the red arrows to adjust the curve. \rule -\S2{cmdDrawBezierCurve} Draw Bezier Curve +\S2{cmdDrawBezierCurve} \i{Draw Bezier Curve} \G{png.d/dbezier.png} @@ -210,7 +210,7 @@ The first and second ends will act like \K{cmdDrawCurveEndPt} with \f{MagneticSn \rule -\S{cmdNote} Note Variants +\S{cmdNote} \i{Note Variants} \G{png.d/mnote.png} @@ -228,7 +228,7 @@ The \f{Note} command allows you to \rule -\S2{cmdTextNote} Plain Text +\S2{cmdTextNote} \i{Text Note} \G{png.d/bnote.png} \G{png.d/iconnote.png} Click and drag on the Main Canvas (\K{mainW}) to place the note. @@ -241,7 +241,7 @@ When in \f{Properties} (\K{cmdDescribe}) mode, clicking on a \e{Note} will displ \rule -\S2{cmdLinkNote} Weblink +\S2{cmdLinkNote} \i{Weblink} \G{png.d/blink.png} \G{png.d/iconlink.png} Similar to text notes you can place a weblink on the layout. @@ -261,7 +261,7 @@ Double clicking on a weblink icon opens the website in your default browser. \rule -\S2{cmdFileNote} Document +\S2{cmdFileNote} \i{Document} \G{png.d/bfile.png} \G{png.d/iconfile.png} Similar to text notes you can place a reference to a file on the layout. @@ -279,7 +279,7 @@ Double clicking on a document reference icon opens the document in the default \rule -\S{cmdRuler} Ruler +\S{cmdRuler} \i{Ruler} \G{png.d/bruler.png} @@ -291,7 +291,7 @@ Subsequent clicks on the \f{Ruler} button will hide or display the ruler. \rule -\S{cmdAngle} Protractor +\S{cmdAngle} \i{Protractor} \G{png.d/bangle.png} @@ -306,7 +306,7 @@ The points of the \e{Protractor} can be modified using the \f{Modify} (\K{cmdMod \rule -\S{cmdDrawShapes} Shapes +\S{cmdDrawShapes} \i{Draw Shapes} \G{png.d/mdrawshapes.png} @@ -342,7 +342,7 @@ Note that \K{cmdModify} can be used on a Polygon or a Polyline after it has been \rule -\S2{cmdDrawBox} Draw Box +\S2{cmdDrawBox} \i{Draw Box} \G{png.d/dbox.png} @@ -355,7 +355,7 @@ The \f{Box Line Width} field is a scaled dimension in inches if >0. If 0 it is a \rule -\S2{cmdDrawFilledBox} Draw Filled Box +\S2{cmdDrawFilledBox} \i{Draw Filled Box} \G{png.d/dfilbox.png} @@ -365,7 +365,7 @@ The \f{Box Line Width} field is a scaled dimension in inches if >0. If 0 it is a \rule -\S2{cmdDrawPolygon} Draw Polygon +\S2{cmdDrawPolygon} \i{Draw Polygon} \G{png.d/dpoly.png} @@ -392,7 +392,7 @@ On the first polygon side this will be at a multiple of 90 degrees to the axes. \rule -\S2{cmdDrawFilledPolygon} Draw Filled Polygon +\S2{cmdDrawFilledPolygon} \i{Draw Filled Polygon} \G{png.d/dfilbox.png} @@ -422,9 +422,9 @@ On the first polygon side this will be at a multiple of 90 degrees to the axes. \rule -\S2{cmdDrawPolyline} Draw PolyLine +\S2{cmdDrawPolyline} \i{Draw PolyLine} -\G{png.d/dpolyline} +\G{png.d/dpolylin.png} Before the polygon is started the line width and color can be set. The \f{Polyline Line Width} field is a scaled dimension in inches if >0. If 0 it is a 1 pixel wide line at all zooms. If the value is negative, it is a scale-independent number of pixels wide. @@ -459,7 +459,7 @@ On the first polyline segemnt this will be at a multiple of 90 degrees to the ax \rule -\S{cmdDrawStraights} Straight Objects +\S{cmdDrawStraights} \i{Straight Objects} \G{png.d/mdrawstraight.png} @@ -473,13 +473,13 @@ Straight Objects are created by a \e{Left+Drag} (\K{windowTerms}) on the layout. \u000 -\dd (\K{cmdDrawBench}). Creates \i\f{Bench-work} using different types and orientation of lumber. +\dd (\K{cmdDrawBench}). Creates \i{Bench-work} using different types and orientation of lumber. \u000 \dd (\K{cmdDrawTableEdge}). Creates a \f{Table Edge} -\S2{cmdDrawLine} Draw Straight Line +\S2{cmdDrawLine} \i{Draw Straight Line} \G{png.d/dline.png} @@ -500,7 +500,7 @@ Even if \c{Esc} is pressed, the line will already exist, it can be removed with \rule -\S2{cmdDrawDimLine} Draw Dimension Line +\S2{cmdDrawDimLine} \i{Draw Dimension Line} \G{png.d/ddimlin.png} @@ -512,11 +512,11 @@ suppressed if \f{Alt} is held. If \c{Ctrl} is held down during \c{Left+Drag} the line will snap the angle of the new side to a multiple of 90 degrees. -\S2{cmdDrawBench} Draw Benchwork. +\S2{cmdDrawBench} \i{Draw Benchwork} \G{png.d/dbench.png} -Creates \i\f{Bench-work} using different types and orientation of lumber. +Creates \i{Bench-work} using different types and orientation of lumber. \i{Bench-work Notes} @@ -541,7 +541,7 @@ Pressing \c{Enter} or \c{Tab} with the cursor in these boxes will apply the valu Pressing \c{Shift+Tab} on the drawing surface will remove the current object and allow a new one to be drawn. Even if \c{Esc} is pressed, the benchwork will already exist, it can be removed with \f{Undo}. -\S2{cmdDrawTableEdge} Draw Table Edge +\S2{cmdDrawTableEdge} \i{Draw Table Edge} \G{png.d/dtbledge.png} @@ -560,7 +560,7 @@ Even if \c{Esc} is pressed, the edge will already exist, it can be removed with \rule -\S{DrawOrigin} Draw Objects Origin +\S{DrawOrigin} \i{Draw Objects Origin} Some objects will a natural rotation point within them. By setting the object origin to this point, subsequent rotation will be about that point and not the layout origin. This is referred to as a \e{Relative} origin and will be present if the origin is non-zero. @@ -584,7 +584,7 @@ In Origin Mode (entered using \c{'o'} or the Context Menu, there are certain sho \dd \c{'m'} Move the Relative Origin to the middle of the shape (centeroid). -\S{cmdText} Text +\S{cmdText} \i{Text} \G{png.d/btext.png} diff --git a/app/doc/editm.but b/app/doc/editm.but index 1e1e572..5702321 100644 --- a/app/doc/editm.but +++ b/app/doc/editm.but @@ -10,82 +10,86 @@ The \f{Edit Menu} shows commands affecting the \f{Main Canvas} (\K{mainW}). -\dd \i\f{Undo} - Reverses the last command. Up to the last ten commands can be undone. If there are no commands that can be undone the \f{Undo} item is disabled. The \f{Undo} command can also be invoked by the \f{Undo} button (\K{cmdUndo}). +\dd \i{Undo} - Reverses the last command. Up to the last ten commands can be undone. If there are no commands that can be undone the \f{Undo} item is disabled. The \f{Undo} command can also be invoked by the \f{Undo} button (\K{cmdUndo}). \u000 -\dd \i\f{Redo} - Undoes the last Undo command. The \f{Redo} command can also be invoked by the \f{Redo} button (\K{cmdUndo}). +\dd \i{Redo} - Undoes the last Undo command. The \f{Redo} command can also be invoked by the \f{Redo} button (\K{cmdUndo}). \u000 -\dd \i\f{Cut} - Moves the selected objects to the clipboard. +\dd \i{Cut} - Moves the selected objects to the clipboard. \u000 -\dd \i\f{Copy} - Copies the selected objects to the clipboard. +\dd \i{Copy} - Copies the selected objects to the clipboard. \u000 -\dd \i\f{Paste} - Copies the contents of the clipboard to the layout. Using the paste Menu command it will be placed at the center of the screen. +\dd \i{Paste} - Copies the contents of the clipboard to the layout. Using the paste Menu command it will be placed at the center of the screen. If the context menu paste is used or the short-cuts \e{Ctrl+v} or \e{Shift+Insert}, the parts will be placed at the cursor position. Repeated Pastes without moving the cursor result in overlaid copies. The newly pasted parts are in \f{Selected} state and can easily be moved into place. Any previously selected objects are unselected. \u000 -\dd \i\f{Delete} - Deletes the selected objects. +\dd \i{Delete} - Deletes the selected objects. \u000 -\dd \i\f{Move To Current Layer} - move all selected objects to the current Layer (\K{cmdLayer}). +\dd \i{Move To Current Layer} - move all selected objects to the current Layer (\K{cmdLayer}). \u000 -\dd \i\f{Select All} - Selects all objects on the layout. +\dd \i{Select All} - Selects all objects on the layout. \u000 -\dd \i\f{Select Current Layer} - selects all objects in the current Layer (\K{cmdLayer}). +\dd \i{Select Current Layer} - selects all objects in the current Layer (\K{cmdLayer}). \u000 -\dd \i\f{Select By Index} - selects object by index number (\K{cmdSelectIndex}). +\dd \i{Select By Index} - selects object by index number (\K{cmdSelectIndex}). \u000 -\dd \i\f{Deselect All} - unselects all objects on the layout. The same action can be achieved by pressing the ESC key. +\dd \i{Deselect All} - unselects all objects on the layout. The same action can be achieved by pressing the ESC key. \u000 -\dd \i\f{Invert Selection} - selects all unselected objects and unselects all previously selected objects. +\dd \i{Invert Selection} - selects all unselected objects and unselects all previously selected objects. \u000 -\dd \i\f{Select Stranded Track} - selects all track pieces that are not connected to any other objects. This helps cleaning up a drawing after many changes have been made. +\dd \i{Select Stranded Track} - selects all track pieces that are not connected to any other objects. This helps cleaning up a drawing after many changes have been made. \u000 -\dd \i\f{Tunnel}\I{Track, Tunnel} - Hides or reveals selected tracks and adds a tunnel portal symbol where the track passes from one to the other. +\dd \i{Tunnel}\I{Track, Tunnel} - Hides or reveals selected tracks and adds a tunnel portal symbol where the track passes from one to the other. \u000 -\dd \i\f{Bridge}\I{Track, Bridge} - Adds parapet symbols to the sides of the track. +\dd \i{Bridge}\I{Track, Bridge} - Adds or removes parapet symbols and a solid base to the track. The color is selectable (\K{cmdRgbcolor}). \u000 -\dd \i\f{Ties/No Ties}\I{Track Ties}\I{Track No Ties} - Hides or reveals the ties on selected tracks. +\dd \i{Roadbed}\I{Track, Roadbed} - Adds or removes solid roadbed under the track. The color is selectable (\K{cmdRgbcolor}). \u000 -\dd \i\f{Move to Front} - Moves selected object to foreground. +\dd \i{Ties/No Ties}\I{Track Ties}\I{Track No Ties} - Hides or reveals the ties on selected tracks. \u000 -\dd \i\f{Move to Back} - Moves selected object to background. +\dd \i{Move To Front} - Moves selected object to foreground. \u000 -\dd \i\f{Thin, Medium and Thick Tracks} \I{Thin Tracks}\I{Medium Tracks} +\dd \i{Move To Back} - Moves selected object to background. + +\u000 + +\dd \i{Thin, Medium and Thick Tracks} \I{Thin Tracks}\I{Medium Tracks} \I{Thick Tracks}\I{Tracks, Thin}\I{Tracks, Medium}\I{Tracks, Thick} \I{Track Width} - set displayed rail width of selected tracks. @@ -96,7 +100,7 @@ For more information on working with selected objects, see the Select (\K{cmdSel \rule -\S{cmdSelectIndex} Select By Index +\S{cmdSelectIndex} \i{Select By Index} An input window allows one or more index numbers to be entered. Multiple indexes are seperated by commas. @@ -108,7 +112,7 @@ If the object is a tunnel object, and the Display Tunnel option is None, it will When an individual object is selected, its index number is displayed in the Info Message area, another source is the List Parts (\K{cmdEnum}) command with the \f{List Indexes} option. -\S{cmdAboveBelow} "Move To Front" and "Move to Back" +\S{cmdAboveBelow} "Move To Front" and "Move to Back" \I{Move To Front} \I{Move To Back} \G{png.d/btop_bottom.png} @@ -129,6 +133,10 @@ Additional Shortcut keys perform the following: \u000 +\dd \c{Ctrl+R} - Redo + +\u000 + \dd \c{Ctrl+C} - Copy \u000 @@ -146,7 +154,7 @@ Additional Shortcut keys perform the following: \rule -\S{cmdDelete} Delete +\S{cmdDelete} \i{Delete} \G{png.d/bdelete.png} @@ -159,7 +167,7 @@ The \e{Delete} key invokes the Delete command. \rule -\S{cmdTunnel} Tunnel (Hide Tracks) +\S{cmdTunnel} \i{Tunnel (Hide Tracks)} \G{png.d/btunnel.png} @@ -171,32 +179,50 @@ A tunnel portal is drawn where a hidden track connects with an 'unhidden' track. The \f{Draw Tunnels} Radio button group on the \f{Options>Display} dialog (\K{cmdDisplay}) controls whether hidden tracks are not drawn, drawn as dashed lines or drawn as normal lines. + \rule +\S{cmdTies} \i{Ties (Draw or Hide Ties)} -\S{cmdBridge} Bridge (Draw Abutments) +\G{png.d/bties.png} -The \f{Bridge} command is used to add abutments to a track (as on an underbridge). +The \f{Ties} command is used to hide Ties (or reshow them). This may be useful for overlapping track, like dual gauge, or in areas like docks or yards where the track is covered. -Select the tracks you want to be a bridge. Bridge abutments are drawn alongside the track. You can split (\K{cmdSplitTrack}) a track to shorten the length of the bridge, or to add an extra pier to the drawing. +Select the tracks you want to hide or show ties for. -If you perform this action (or use Tunnel) the bridge is removed. \rule -\S{cmdTies} Ties (Draw or Hide Ties) +\S{cmdBridge} \i{Bridge (Draw or Hide Abutments)} -The \f{Ties} command is used to hide Ties (or reshow them). This may be useful for overlapping track, like dual gauge, or in areas like docks or yards where the track is covered. +\G{png.d/bbridge.png} + +The \f{Bridge} command is used to add abutments to a track (as on an underbridge). + +Select the tracks you want to be a bridge. Bridge abutments are drawn alongside the track and a solid layer is added under the ties. You can split (\K{cmdSplitTrack}) a track to shorten the length of the bridge, or to add an extra pier to the drawing. + +If you perform this action on an existing bridge (or use Tunnel) the bridge is removed. -Select the tracks you want to hide or show ties for. \rule +\S{cmdRoadbed} \i{Roadbed (Draw or Hide Base)} + +\G{png.d/broadbed.png} + +The \f{Roadbed} command is used to add a solid color under a track (as roadbed). -\S{cmdUndo} Undo and Redo +Select the tracks you want to have roadbed. A solid roadbed layer is drawn under the track. + +If you perform this action on existing roadbed (or use Tunnel) the roadbed is removed. The bridge option takes precedence over roadbed. + + +\rule + +\S{cmdUndo} Undo and Redo \I{Undo} \I{Redo} \G{png.d/bgundo.png} The \f{Undo} and \f{Redo} buttons invoke the same actions as the \f{Edit} menu items. The name of last command will be displayed as the Balloon Help (\K{windowTerms}) for the \e{Undo} button. The name of last undone command will be displayed as the Balloon Help for the \e{Redo} button. -\rule
\ No newline at end of file +\rule diff --git a/app/doc/filem.but b/app/doc/filem.but index 2fa4dba..412c3c9 100644 --- a/app/doc/filem.but +++ b/app/doc/filem.but @@ -25,19 +25,19 @@ The \f{File Menu} shows file oriented commands for loading and saving layout fil \u000 -\dd \f{Export} - Exports the selected objects to a file in \e{XTrackCAD} (*.xti) format. The exported file can then be imported into another layout design. Refer to the Import command listed below. +\dd \G{png.d/bexport.png} \f{Export} - Exports objects to a file in \e{XTrackCAD} (*.xti) format. If no objects are selected, all objects in visible layers are exported. If objects are selected they are exported. The exported file can then be imported into another layout design. Refer to the Import command listed below. \u000 -\dd \f{Export to Bitmap} - Creates a bitmap file (\K{cmdOutputbitmap}) of the layout. The bitmap can be saved in either JPEG or PNG format. +\dd \G{png.d/bexportbmap.png}\f{Export to Bitmap} - Creates a bitmap file (\K{cmdOutputbitmap}) of the layout. The bitmap can be saved in either JPEG or PNG format. \u000 -\dd \f{Export to DXF} - Exports the selected objects to a file in DXF format (\K{generalTerms}). The exported file can then be imported into other CAD programs. +\dd \G{png.d/bexportdxf.png}\f{Export to DXF} - Exports objects to a file in DXF format (\K{generalTerms}). If no objects are selected, all objects in visible layers are exported. If objects are selected they are exported. The exported file can then be imported into other CAD programs. \u000 -\dd \f{Export to SVG} - Exports the selected objects to a file in SVG format. The exported file can then be imported into a vector drawing program like Inkscape +\dd \G{png.d/bexportsvg.png} \f{Export to SVG} - Exports objects to a file in SVG format. If no objects are selected, all objects in visible layers are exported. If objects are selected they are exported. The exported file can then be imported into a vector drawing program like Inkscape or used for publishing on the web. \u000 @@ -46,11 +46,11 @@ or used for publishing on the web. \u000 -\dd \f{Import} - Displays the file selection dialog which allows selection of an existing \e{XTrackCAD} Import (\K{cmdExport} *.xti) files. This function can be used to transfer parts like a yard design from one layout design to another. +\dd \G{png.d/bimport.png} \f{Import} - Displays the file selection dialog which allows selection of an existing \e{XTrackCAD} Import (\K{cmdExport} *.xti) files. This function can be used to transfer parts like a yard design from one layout design to another. \u000 -\dd \f{Import Module} - Displays the file selection dialog which allows selection of an existing \e{XTrackCAD} Import (\K{cmdExport} *.xti) file. The imported parts are put into a empty layer, sets the layer name to the imported filename and sets the layer to be a module - see (\K{cmdLayer}). +\dd \G{png.d/bimportmod.png} \f{Import Module} - Displays the file selection dialog which allows selection of an existing \e{XTrackCAD} Import (\K{cmdExport} *.xti) file. The imported parts are put into a empty layer, sets the layer name to the imported filename and sets the layer to be a module - see (\K{cmdLayer}). \u000 \dd \G{png.d/bnew.png} \f{New} - Clears the current layout. In case there are any unsaved changes on the current plan, a warning pop-up will be displayed and you'll have the option to cancel the operation. After that the Layout Options (\K{cmdLayout}) dialog will be opened. @@ -65,19 +65,19 @@ or used for publishing on the web. \u000 -\dd \f{Parameter Files} - Displays the \f{Parameter Files} dialog (\K{cmdPrmfile}) to choose parameter files. +\dd \G{png.d/bparam.png} \f{Parameter Files} - Displays the \f{Parameter Files} dialog (\K{cmdPrmfile}) to choose parameter files. \u000 -\dd \f{Print Setup} - Shows the Printer Setup Dialog (\K{printSetup}). +\dd \G{png.d/bsetup.png} \f{Print Setup} - Shows the Printer Setup Dialog (\K{printSetup}). \u000 -\dd \f{Print} - Invokes the Print command (\K{cmdPrint}). +\dd \G{png.d/bprint.png} \f{Print} - Invokes the Print command (\K{cmdPrint}). \u000 -\dd \f{Revert} - Undoes all changes and returns to the last saved layout plan. +\dd \G{png.d/brevert.png} \f{Revert} - Undoes all changes and returns to the last saved layout plan. \u000 @@ -85,15 +85,17 @@ or used for publishing on the web. \u000 -\dd \f{Save As} - This command lets you make a copy of the track plan you are currently working on as an file (.xtc) or an archive (.xtce). It differs from the regular Save command. Save stores your data back into the folder (directory) it originally came from in the same filetype. "Save As" lets you give your plan a different name and/or put it in a different folder on your hard disk and chnage its filetype using the selection box at the bottom of the list of files or by hardcoding the extensions .xtc or .xtce (for an archive). +\dd \G{png.d/bsaveas.png} \f{Save As} - This command lets you make a copy of the track plan you are currently working on as an file (.xtc) or an archive (.xtce). It differs from the regular Save command. Save stores your data back into the folder (directory) it originally came from in the same filetype. "Save As" lets you give your plan a different name and/or put it in a different folder on your hard disk and chnage its filetype using the selection box at the bottom of the list of files or by hardcoding the extensions .xtc or .xtce (for an archive). \rule \S{cmdExport} \i{Export} +\G{png.d/bexport.png} + This menu item displays a file selection dialog where a file name for exported objects can be entered. All selected (\K{cmdSelect}) objects are exported to the file. The export file will have an \c{xti} extension. -\G{png.d/exportfile.png} +\# \G{png.d/exportfile.png} Using the Import command (\k{cmdImport}), an exported file can be imported into another layout design. @@ -101,14 +103,16 @@ Using the Import command (\k{cmdImport}), an exported file can be imported into \S{cmdOutputbitmap} \i{Export to Bitmap} +\G{png.d/bexportbmap.png} + This menu item creates a bitmap file of the layout. \G{png.d/bitmap.png} The \f{Bitmap} dialog specifies the style and size of the bitmap. The check-boxes (\f{Layout Titles}, \f{Borders}, \f{Centerline of Track} and -\f{Background Image}) control +\f{Background Image}) control whether the Layout Title (\K{cmdLayout}), the borders or the track centerlines are printed on the bitmap. If a background image is used it will be -printed if the option is set. +printed if the option is set. The size of the bitmap is smaller if these are disabled. @@ -117,9 +121,9 @@ full size for laying out track. If the Snap Grid (\K{cmdGrid}) is visible then it will be printed on the bitmap. -The \f{DPI} control specifies the number of pixels per inch in the bitmap. Bitmaps must be less than 32,000 pixels in height or width. +The \f{DPI} control specifies the number of pixels per inch in the bitmap. Bitmaps must be less than 32,000 pixels in height or width. The upper value you can enter depends on the size of your trackplan. It is made sure that your bitmap does not exceed these limits. -Larger values will result in a larger bitmap file. +Larger values will result in a larger bitmap file. The bitmap width, height and approximate file size is indicated. @@ -127,16 +131,18 @@ Note: This command can create a very large file and consume a lot of memory and Pressing the \f{OK} button invokes a \f{File Save} dialog so you can choose the file name for the Bitmap. -You can select to create JPEG or PNG files. As a rule of thumb JPEG results in smaller files when you use a backgound image, PNG +You can select to create JPEG or PNG files. As a rule of thumb JPEG results in smaller files when you use a backgound image, PNG does so for trackplans without an image background. \rule \S{ExportDXF} \i{Export to DXF} -This menu item displays a file selection dialog where a file name for exported objects can be entered. All selected (\K{cmdSelect}) objects are exported to the file. The export file will have an \c{xti} extension. +\G{png.d/bexportdxf.png} -\G{png.d/exportfiledxf.png} +This menu item displays a file selection dialog where a file name for exported objects can be entered. All selected (\K{cmdSelect}) objects are exported to the file. The export file will have an \c{dxf} extension. + +\# \G{png.d/exportfiledxf.png} Exported files can then be imported into other CAD programs. @@ -144,25 +150,43 @@ Exported files can then be imported into other CAD programs. \S{ExportSVG} \i{Export to SVG} +\G{png.d/bexportsvg.png} + This menu item displays a file selection dialog where a file name for exported objects can be entered. All selected (\K{cmdSelect}) objects are exported to the file. The export file will have an \c{svg} extension. -Files in SVG format can be used for different purposes. +\# \G{png.d/exportfilesvg.png} + +Files in SVG format can be used for different purposes. -\b SVG files can be loaded into many drawing programs. This makes it possible to enhance and resize the image. Vector images have the advantage of +\b SVG files can be loaded into many drawing programs. This makes it possible to enhance and resize the image. Vector images have the advantage of allowing lossless resizing. -\b Most modern browsers support SVG as an image format. So the resulting file can directly be used to publish your plan on the web. By adding a bit of -Javascript, zooming and panning can be enabled. Appropiate scripts can easily be found using your favorite search engine. -The generated SVG uses the layout description as a title that is shown by some browser. Also the drawing has an 'id' for manipulation by Javascript. +\b Most modern browsers support SVG as an image format. So the resulting file can directly be used to publish your plan on the web. By adding a bit of +Javascript, zooming and panning can be enabled. Appropiate scripts can easily be found using your favorite search engine. +The generated SVG uses the layout description as a title that is shown by some browser. Also the drawing has an 'id' for manipulation by Javascript. This id is derived from the filename by removing all spaces and sticking the word 'id' in front. Eg exporting \c{stonega.xtc} the resulting id will be \c{idstonega}. \rule -\S{cmdImport} Import +\S{cmdImport} \i{Import} + +\G{png.d/bimport.png} Importing displays a file selection dialog to specify the file to import. -\G{png.d/import.png} +\# \G{png.d/import.png} + +After importing the objects from the file, the imported objects are in selected state and therefore are drawn in red. This allows you to easily move and rotate the imported objects to their final position. + +\rule + +\S{cmdImportM} \i{Import as Module} + +\G{png.d/bimportmod.png} + +Importing displays a file selection dialog to specify the file to import as a module. + +\# \G{png.d/importmod.png} After importing the objects from the file, the imported objects are in selected state and therefore are drawn in red. This allows you to easily move and rotate the imported objects to their final position. @@ -170,6 +194,8 @@ After importing the objects from the file, the imported objects are in selected \S{cmdPrmfile} \i{Parameter Files} +\G{png.d/bparam.png} + \e{Parameter Files} contain turnout, sectional track and structure definitions. Loaded Parameter Files are managed with the \f{Parameter Files} dialog. \G{png.d/dprmfile.png} @@ -178,11 +204,11 @@ The dialog contains a list of parameter files. Each file is preceded by a color are usable in the current scale and gauge. \G{png.d/greendot.png} \G{png.d/greenstar.png} Definitions from this file are a perfect fit for the current layout options. The file has been loaded and will be visible in the \f{HotBar}. For track this means that gauge and scale of the track elements -are identical to the layout settings. Prototype definitions (Scale "*") are always a perfect fit. Turnouts and Sectional Track must have the same gauge and usually the same scale unless the scale/gauge combination has been defined to fit. +are identical to the layout settings. Prototype definitions (Scale "*") are always a perfect fit. Turnouts and Sectional Track must have the same gauge and usually the same scale unless the scale/gauge combination has been defined to fit. OO layouts use HO track as an example. \G{png.d/yellowdot.png} \G{png.d/yellowstar.png} Definitions from this file can be used with this layout but do not fit perfectly. A typical example is On30 where HO scale track can be used because the -gauge is the same. But differences in scale may make the track look out of scale. Structures are considered compatible if the scale is within +/-20%. Cars are compatible if the gauge is the same, but the scale can be +/-20%. +gauge is the same. But differences in scale may make the track look out of scale. Structures are considered compatible if the scale is within +/-20%. Cars are compatible if the gauge is the same, but the scale can be +/-20%. Exceptions to this can be defined in the scale definitions. \G{png.d/reddot.png} \G{png.d/redstar.png} This parameter file doesn't contain any usable definitions with current settings. You may want to change the layout options if you want to use elements from @@ -190,32 +216,32 @@ this file (for example altering the Layout Scale). \G{png.d/greydot.png} \G{png.d/greystar.png} This file is loaded but hidden. If it is marked as favorite it will be kept on the -list between runs. +list between runs. Parameter files can be marked as \e{favorite}. The indicator for favorites is a star. The meaning of the colors isn't changed. -Loaded definition files that are marked with a yellow or a green indicator appear on the \f{Hot Bar} (\K{cmdHotBar}). +Loaded definition files that are marked with a yellow or a green indicator appear on the \f{Hot Bar} (\K{cmdHotBar}). -If you \e{unload} a file the definitions are removed from the selection lists and the \f{Hot Bar}. +If you \e{unload} a file the definitions are removed from the selection lists and the \f{Hot Bar}. If the unloaded file was marked as a favorite it can be \e{reloaded} by selecting the \f{Reload} button. -Files that are still loaded can be \e{reloaded} as well. In that case the old definitions are refreshed and extended by the -rereading the file. This can be useful if you want to check changes you made by hand-editing a parameter file. +Files that are still loaded can be \e{reloaded} as well. In that case the old definitions are refreshed and extended by the +rereading the file. This can be useful if you want to check changes you made by hand-editing a parameter file. Note that loading a file does not change the existing definitions in the layout. To do that after loading, use \K{cmdRefreshSpecial}. It is possible to change the state of several files at once. The \f{Select All} button allows you to select all parameter files for the next operation. -In case unloaded files are marked as favorite, their state will be preserved +In case unloaded files are marked as favorite, their state will be preserved between runs of the program. This makes it possible to keep a list of preferred parameter sets between runs of XTrackCAD but hide temporary unused files from the hotbar. That way the hotbar contents can be kept short containing only the currently needed elements. In order to update the defintion of an already loaded file from disk, you can use the \e{Reload} button. This will reload the file contents - with any changes made. -It is the equivalent of using \f{Browse} and selecting the file again. - +It is the equivalent of using \f{Browse} and selecting the file again. + Files can be listed by either their file name or by their contents description. This is controlled by the \f{Show File Names} check box. @@ -244,10 +270,10 @@ Using the Search function you can find and select parameter files that are part of the XTrackCAD installation. Enter a set of one or more words and select the Search button. Search results are shown in the list box. Pressing the \i{Clear Filter} button shows the complete -list again. +list again. -You can subset the search to only search for parameter files who start with contents that fit the current Layout Scale using the \f{Fit} Mode. -The options are "Fit All", "Fit Compatible" and "Fit Exact". Fit Compatible means that structures with +You can subset the search to only search for parameter files who start with contents that fit the current Layout Scale using the \f{Fit} Mode. +The options are "Fit All", "Fit Compatible" and "Fit Exact". Fit Compatible means that structures with Note that the code only looks at the first Turnout, Structure or Car entry to decide on the scale for the entire file. They will correspond to the color icons on the Parameter Files menu once they are loaded \K{cmdPrmfile} when the same Layout scale is in use. @@ -258,8 +284,14 @@ parameter list. \S{cmdPrint} \i{Printing} +\G{png.d/bprint.png} + The \f{Print} command (\f{File>Print}) is used to print all or a portion of the layout. +\G{png.d/bsetup.png} + +The \f{Print Setup} command (\f{File>Print Setup}) is used to set up the printer properties. + When the \f{Print} command is selected a grid, which represents each printed page, is drawn on the layout. Pages can be selected or unselected for printing by placing the mouse over a grid section and clicking the left mouse button. \G{png.d/print.png} @@ -314,7 +346,7 @@ Whether tracks are printed with one or two lines (representing the center line a \u000 -\dd \f{Page Numbers} - to help positioning the individual pages the page number is printed in the center of the page in the format (x/y). +\dd \f{Page Numbers} - to help positioning the individual pages the page number is printed in the center of the page in the format (x/y). x is the page position from left to right, y in from bottom to top, So (1/1) is the page at the bottom left. As an additional aid, the numbers of the next pages are printed on each edge. @@ -385,7 +417,7 @@ If you make printouts in strips at different angles at 1:1 (to follow tracks aro \rule -\S{printSetup} Printer Setup +\S{printSetup} \i{Printer Setup} \S2{Linux} \i{Linux} @@ -415,19 +447,19 @@ The \f{Printer Setup} window contains: \u000 -\e{Note} - -Printing uses a default of 600ppi. It scales the print and text from a default size of 72dpi. +\e{Note} - +Printing uses a default of 600ppi. It scales the print and text from a default size of 72dpi. This is often the expected value for a standard printer driver to work correctly, but will not work if the driver is not accurately setting the ppi available. -To override the printer ppi you can use either the configuration file settings for print or environmental variables. +To override the printer ppi you can use either the configuration file settings for print or environmental variables. These values are set in the Preferences section. \u000 -\n Preferences.PrintScale - The floating point ratio of the real printer dpi to 72. +\n Preferences.PrintScale - The floating point ratio of the real printer dpi to 72. \n Preferences.PrintTextScale - The floating point ratio of the real printer text support to a dpi of 72. This value has no effect unless PrintScale is set to > 0.0. \u000 -These values can also be set using environmental variables if the configuration preference values are not set or they are set to <=0.0. +These values can also be set using environmental variables if the configuration preference values are not set or they are set to <=0.0. \u000 \n XTRKCADPRINTSCALE @@ -482,7 +514,7 @@ The \f{Printer Setup} window contains: \G{png.d/printmargin.png} -The \f{Printer Margins} dialog allows you to configure the selected printer's margins. +The \f{Printer Margins} dialog allows you to configure the selected printer's margins. The margins for the four edges of the printed page are displayed. The default values are fetched from the Operating System. @@ -500,7 +532,7 @@ To check your printer's margin: \u000 -\dd Enable \f{Registration Marks} this prints crosshairs every 6" at scale 1:1. +\dd Enable \f{Registration Marks} this prints crosshairs every 3" or 10cm at scale 1:1. \u000 @@ -522,4 +554,8 @@ To check your printer's margin: Margins values are stored for each printer. +\u000 + +You can also load \f{PrinterMarginTest-A4.xtc} or \f{PrinterMarginTest-Letter.xtc} from \f{Help|Examples}. These files have registration lines in the corners to help determine your printer's margins. + \rule diff --git a/app/doc/helpm.but b/app/doc/helpm.but index b1e3666..a74ea0b 100644 --- a/app/doc/helpm.but +++ b/app/doc/helpm.but @@ -18,7 +18,16 @@ The \f{Help Menu} displays information on various topics. The contents of the me \dd \e{Recent Messages} -The \f{Recent Messages} command opens a cascading menu containing recent error messages and notices you have received. Selecting one of them displays additional information about the message (\K{messageList}). +The \f{Recent Messages} command opens a cascading menu containing recent error messages and notices you have received. Selecting one of them displays additional information about the message. + +The \f{Collect Problem Info} command helps you to put together the information and files that might help the developers to analyze and fix possible bugs. + +\dd \G{png.d/problemdata.png} + +\dd \e{Collect Problem Info} + +The command removes userids and other private information from the files. The results are stored in a compressed (zip-) file and placed in the same +directory as the affected layout file. \dd \G{png.d/dtipofday.png} @@ -36,7 +45,7 @@ The \f{Examples} command displays the list of included example programs which yo \rule -\S{cmdDemo} Demo Mode +\S{cmdDemo} \i{Demo Mode} The \f{Demos} menu item, under the \f{Help} (\K{helpM}) menu, shows a cascading menu of choices to demonstrate various features and commands. diff --git a/app/doc/hhc.cmake.in b/app/doc/hhc.cmake.in index e9f0656..947b1da 100644 --- a/app/doc/hhc.cmake.in +++ b/app/doc/hhc.cmake.in @@ -1,9 +1,9 @@ -EXECUTE_PROCESS( +execute_process( COMMAND "@HTML_HELP_COMPILER@" xtrkcad.hhp - RESULT_VARIABLE RESULTS - OUTPUT_VARIABLE OUTPUT - ERROR_VARIABLE ERROR + RESULT_VARIABLE results + ERROR_VARIABLE error ) -MESSAGE("${OUTPUT}") -MESSAGE("${ERROR}") +if(NOT "${results}" STREQUAL "1") + message(FATAL_ERROR "Creating chm failed! ${error}") +endif() diff --git a/app/doc/hotbar.but b/app/doc/hotbar.but index d6b9cc7..eb4ca76 100644 --- a/app/doc/hotbar.but +++ b/app/doc/hotbar.but @@ -8,9 +8,9 @@ \G{png.d/hotbar.png} -The \e{Hot Bar} starts with a flextrack of the current gauge, and then a scrolling list of all the turnouts, sectional track and structures available through the Turnout (\K{cmdTurnout}) and Structure (\K{cmdStructure}) commands. The Description and/or Part Number under each object can be displayed by enabling the \e{Hot Bar Labels} radio button on the Display (\K{cmdDisplay}) dialog. +The \e{Hot Bar} starts with a flex-track of the current gauge, and then a scrolling list of all the turnouts, sectional track and structures available through the Turnout (\K{cmdNewFixedTrack}) and Structure (\K{cmdStructure}) commands. The Description and/or Part Number under each object can be displayed by enabling the \e{Hot Bar Labels} radio button on the Display (\K{cmdDisplay}) dialog. -Only those items taken from files which are in the current scale/gauge are displayed in the HotBar. They are shown in order - A FlexTrack - then the Contents of Files in the File->Parameter Files... List in listed order - and then any Custom objects created in this Layout as listed in the Manage->Custom Defined Parts dialog. +Only those items taken from files which are in the current scale/gauge are displayed in the HotBar. They are shown in order - A Flex-track - then the Contents of Files in the File->Parameter Files... List in listed order - and then any Custom objects created in this Layout as listed in the Manage->Custom Defined Parts dialog. The arrow buttons on either side of the \e{Hot bar} move the list one object to the right or left. Holding down the Shift key will move the list by greater amounts. About eight \c{Shift+Click}s are required to move the list through the entire range of objects. Also, pressing the keys \c{1} through \c{9} and \c{0} will cause the \e{Hot Bar} to jump relative spots on the list. @@ -22,24 +22,24 @@ For \e{Turnouts}, see below for additional details on the \e{Active EndPoint}. \rule -\S{Flextrack} FlexTrack +\S{Flex-track} \i{Flex-track} -A FlexTrack unit can be placed for convienience on the left-hand side of the HotBar. +A Flex-track unit can be placed for convienience on the left-hand side of the HotBar. This is can be hidden by an option in \K{cmdPref}. It can be recognised because it is the only diagonally facing track element and has a label "FLEX". It is used by \c{Left-Click} selecting it, and \c{Left-Click} clicking on the layout where the first end should be placed, and then \c{Left-Click} for the second end. -If either end is over an unconnected end and \f{Shift} was not held, the flextrack will be connected to the track and the end angle and radius will be set from the track. +If either end is over an unconnected end and \f{Shift} was not held, the flex-track will be connected to the track and the end angle and radius will be set from the track. If an end was not over an unconnected end, it can be manipulated by left dragging out the end angle before releasing. If the second end is not on a track end, differing end angles will produce a smooth curve, if both ends are unconnected, simply \c{Left-Click} without dragging produces a straight track. -Once both ends have been defined, the track can then be manipulated like a \k{chgCornu} Cornu Curved Track, by selecting and moving ends, adding and removing "pins" and altering the end anchor angle and radius if the flextrack is not connected at that end. +Once both ends have been defined, the track can then be manipulated like a \k{chgCornu} Cornu Curved Track, by selecting and moving ends, adding and removing "pins" and altering the end anchor angle and radius if the flex-track is not connected at that end. If the disconnected end is dragged and the button released while over an open end of another track, it will be connected to it in the manner of a Join with a Cornu easement. -A FlexTrack will form a Straight Track if the ends have zero radius and are in a line with opposed end angles. +A Flex-track will form a Straight Track if the ends have zero radius and are in a line with opposed end angles. If the ends are not aligned but the end angles are opposed it will be a simple S-curve. It will be a smooth monotonic curve if the ends are not in a line and the end angle lines and chord form a triangle. Otherwise it will be a complex S-curve. . \rule -\S{hbStructures} Structures +\S{hbStructures} \i{Structures} \e{Structures} are placed on the layout in the same way as turnouts (\K{hbTurnouts}) except no Active EndPoint exists and they do not align with existing track. @@ -48,7 +48,7 @@ Refer to \K{cmdStructure} for information pertaining to use of the \e{Structure} \rule -\S{hbTurnouts} Turnouts +\S{hbTurnouts} \i{Turnouts} \e{Turnouts} have an \e{Active EndPoint} (\K{generalTerms}) which is the handle used to position the \e{Turnout}. You can change the \e{Active EndPoint} by a \c{Shift+Left-Click} which causes the next endpoint to become Active. @@ -58,12 +58,12 @@ If you \c{Left+Drag} a turnout onto a track, the Active EndPoint (\K{generalTerm \c{Right+Drag} or \c{Ctrl+Left+Drag} (\K{windowTerms}) can be used to rotate the turnout on the layout. \c{Shift+Right-Click} (\K{cmdAcclKeys}) displays a pop-up menu allowing you to rotate the turnout by various angles. -When you press the \c{Space} key, the turnout is positioned on the layout. Any tracks that are aligned with any of the turnout's endpoints will be connected to the turnout automatically. If you are using the Turnout (\K{cmdTurnout}) command then you can also click the \e{OK} button on the dialog. +When you press the \c{Space} key, the turnout is positioned on the layout. Any tracks that are aligned with any of the turnout's endpoints will be connected to the turnout automatically. If you are using the Turnout (\K{cmdNewFixedTrack}) command then you can also click the \e{OK} button on the dialog. If you choose another turnout or change commands after beginning to place a turnout on the layout, the turnout will be created as if it is attached to another track. Otherwise it will be removed. If the Drawing Scale is smaller or equal to the Label Scale (\K{cmdDisplay}) then Turnouts will be labeled with their description when drawn. The individual labels can be can be turned off by the Move Description(\K{cmdMoveLabel}) command, or all Turnout labels can be disabled by using the Display (\K{cmdDisplay}) dialog. As well, the length of any connected Flex-track will be indicated at each endpoint. -Refer to \K{cmdTurnout} for information pertaining to use of the \e{Turnout} dialog. +Refer to \K{cmdNewFixedTrack} for information pertaining to use of the \e{Turnout} dialog. \rule diff --git a/app/doc/intro.but.in b/app/doc/intro.but.in index 90109cc..2530cd9 100644 --- a/app/doc/intro.but.in +++ b/app/doc/intro.but.in @@ -27,14 +27,10 @@ Copyright 2020, Martin Fischer, Adam Richards and Dave Bullis \IM{Easements}{Easements and Sectional Track} Easements -\IM{Export}{Export to Bitmap}{Export to DXF} Export - \IM{Window Terms}{XTrackCAD Terms} Glossary \IM{Install directory}{Linux Installation}{Microsoft Windows Installation} Installation -\IM{Copying and Distribution}{GNU General Public License} License - \IM{Add Menu}{File Menu}{Edit Menu}{View Menu}{Change Menu}{Draw Menu}{Manage Menu}{Options Menu} Menus \IM{Entering Values}{Keyboard Shortcuts}{Main Window Overview}{Map Window}{Mouse Actions}{Shortcut Keys}{Typographic Conventions} Navigation @@ -43,8 +39,6 @@ Copyright 2020, Martin Fischer, Adam Richards and Dave Bullis \IM{Additional Shortcut Keys}{Hot Bar}{Keyboard Shortcuts}{Main Drawing Canvas}{Mouse Actions}{Shortcut Keys} Shortcut Keys -\IM{Created by Turnout Command}{Easements and Sectional Track} Sectional Track - \# >>>>>>>>>> Manual Begin's Here <<<<<<<<<< \title \e{XTrackCAD} User's Manual @@ -112,7 +106,7 @@ Be sure to visit the project web page for latest news and updates: \W{http://www \e{XTrackCAD} was designed to operate in a similar way to pencil and paper: You can draw tracks by dragging the mouse, you select and place turnout "templates" anywhere on existing tracks, and you can use fixed radii for initial design. -But extra capabilities have been added that give more power by using FlexTracks (Cornu) you have tracks that automatically redraw as you drag turnouts around, creating smooth curves, you can zoom in and out, and of course, undo and deleting tracks are easier! +But extra capabilities have been added that give more power by using Flex-tracks (Cornu) you have tracks that automatically redraw as you drag turnouts around, creating smooth curves, you can zoom in and out, and of course, undo and deleting tracks are easier! You don't have to be an expert CAD user to make the most of \e{XTrackCAD} but the program will ensure that dimensions, radii and angles are accurate. @@ -160,7 +154,7 @@ On-line demonstrations show the actual operation of many of the program's featur \u000 -\dd The Cornu flextrack features create dynamically variable tracks that optimise the curvature of tracks to ensure a protypical appearance. They alter as the other tracks are moved just as flextrack will in the 12 inches to the foot world! +\dd The Cornu flex-track features create dynamically variable tracks that optimise the curvature of tracks to ensure a protypical appearance. They alter as the other tracks are moved just as flex-track will in the 12 inches to the foot world! \u000 @@ -362,7 +356,7 @@ Refer to \K{keyFeatures} and \K{addFeatures} for a listing of \e{XTrackCAD} feat \u000 -\b Describe objects +\b Edit object properties \u000 @@ -566,7 +560,9 @@ Throughout this manual the following typographic conventions are used to make fi \H{installSoftware} Installation -\e{XTrackCAD} is designed to operate under Linux, Apple MacOS or Microsoft Windows. Information within this section of the manual pertains to installation of the application in either of these environments. +\e{XTrackCAD} is designed to operate under Linux, Apple MacOS or Microsoft Windows. Information within this section of the manual pertains to installation of the application in any of these environments. + +Please see \W{https://sourceforge.net/p/xtrkcad-fork/wiki/DownloadInstall/}{https://sourceforge.net/p/xtrkcad-fork/wiki/DownloadInstall/} for more detals. \rule @@ -603,7 +599,7 @@ The application includes the program, documentation, parameter and example files \lcont{\u000} -\n To run on Apple MacOS, the \e{XQuartz} package must first have been installed - see \W{http://www.xquartz.org}{http://www.xquartz.org}. XQuartz will need to be upgraded after each OS version upgrade. +\n To run on Apple MacOS, the \e{XQhttps://sourceforge.net/projects/xtrkcad-fork/files/XTrackCad/Version%205.3.0/uartz} package must first have been installed - see \W{http://www.xquartz.org}{http://www.xquartz.org}. XQuartz will need to be upgraded after each OS version upgrade. \lcont{\u000} @@ -617,21 +613,16 @@ This sequence may be necessary after each OS upgrade. \S{LinuxInstall} \i{Linux Installation} -\e{XTrackCAD} for LINUX is shipped as a self-extracting archive (executable). +\e{XTrackCAD} is available by a variety of methods: -\n Installing from the self-extracting archive. +\n Installing from your distribution, such as Ubuntu or Fedora -\lcont{ - -\dd After downloading open a command line then +\n Installing the desired version from the XTrkCad release page; \W{https://sourceforge.net/projects/xtrkcad-fork/files/XTrackCad/}{https://sourceforge.net/projects/xtrkcad-fork/files/XTrackCad/} -\dd \c{./\XTCStgzPack --prefix=/usr/local --exclude-subdir} - -\dd This will install the executable in /usr/local/bin. A directory named \c{xtrkcad} will be created in -/usr/local/share and all files will be unpacked into it. +\n Installing from the self-extracting archive. -} +Normally \e{XTrkCAD} is installed in \c{/usr/...} or \c{/usr/local/...}. If you install \e{XTrackCAD} into another directory, set the \c{XTRKCADLIB} environment variable to point to that directory. \rule @@ -694,6 +685,15 @@ Defaults are no modules are logged and loglevel is 1 if omitted from logonctrol \dd set logfile, only needed in conjunction with the debug option. +\u000 + +\dt \c{T} + +\dd Runs all Regression tests (Demos) and exits with 0 if all are successful or with 1 if there any failures. +Regression progress and failures are logged to stdout (Linux and Mac OSX) or xtclog.txt (Windows). + +\u000 + \dt \c{V} \dd Display the xtrkcad version and exit(0). @@ -735,7 +735,7 @@ You can use this menu to choose Metric units (\K{cmdPref}). The Tool Bar contains icons for each of the commands in the Menus. The icons shown can be customized using the \f{View->ToolBar} submenu. -\b The main drawing Mode command is \f{Select} - which is shown with the red arrow icon. From this mode, selected objects can be \f{Modified} as well. A close second is the \f{Describe} mode which allows properties of Objects to be seen and Changed. +\b The main drawing Mode command is \f{Select} - which is shown with the red arrow icon. From this mode, selected objects can be \f{Modified} as well. A close second is the \f{Property} mode which allows properties of Objects to be seen and Changed. \u000 @@ -796,7 +796,7 @@ On MS Windows, the \e{Install} directory is set when you install \e{XTrackCAD}. demos, examples) can be found in the \c{share/xtrkcad} subdirectory underneath the \e{Install} directory. The \e{Working} directory is in your personal profile. -On Linux, the \e{Install} directory is usually \c{/usr/local/lib/xtrkcad/}, but you can change this by defining the \c{XTRKCADLIB} environment variable before starting \e{XTrackCAD}. The working directory is \c{\{HOME\}/.xtrkcad/}. +On Linux, the \e{Install} directory is usually \c{/usr/share/xtrkcad/}, but you can change this by defining the \c{XTRKCADLIB} environment variable before starting \e{XTrackCAD}. The working directory is \c{\{HOME\}/.xtrkcad/}. On Mac OSX, the \e{Install} directory is the application package, usually located in the \c{/Applications} directory. All the included parameters, demos and examples can be found inside the package under the \c{/Applications/xtrkcad/Contents/Resources/xtrkcad} directory. @@ -854,7 +854,7 @@ The check-point frequency is set by the \e{Check Point} field found in the \f{Pr } -\b The \c{xtrkcad.cus} file contains parameter information. This is mostly information created by the \f{Turnout Designer} dialogs (\K{cmdTurnoutNew}) and \f{Group} (\K{cmdGroup}) command. You can use the \f{Edit>Custom Management} dialog to manipulate these parameters. +\b The \c{xtrkcad.cus} file contains parameter information. This is mostly information created by the \f{Turnout Designer} dialogs (\K{cmdTurnoutNew}) and \f{Group} (\K{cmdGroup}) command. You can use the \f{Manage>Custom defined pats} dialog to manipulate these parameters. \u000 @@ -864,9 +864,9 @@ The check-point frequency is set by the \e{Check Point} field found in the \f{Pr \H{uninstall} \i{Removing \e{XTrackCAD}} -Remove \e{XTrackCAD} by deleting the \e{XTrackCAD Install} directory, or application (on Mac OSX), deleting any \c{xtrkcad.*} files from the \e{Working} directory, and deleting any \e{*.xtc} and \e{*.xti} files. +On Linux, please see \e{Removing XTrackCAD} on the \W{https://sourceforge.net/p/xtrkcad-fork/wiki/LinuxInstall}{Linux Install} wiki page. -On MS-Windows only, you can also use the \f{Uninstall} icon in the \e{XTrackCAD} program group. +On MS-Windows you can also use the \f{Uninstall} icon in the \e{XTrackCAD} program group. \rule @@ -881,6 +881,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{https://sourceforge.net/p/xtrkcad-fork/bugs/}{\e{XTrackCAD} Fork Project Site}. +Click \f{Create Ticket}. \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. @@ -917,9 +918,12 @@ Remember the three basics: what you were doing, what you expected to happen, and If you can recreate the problem the \f{Macro>Record} command can be used to record what happened. Try to isolate the problem by creating a minimal layout and recording as few commands as possible. \f{Don't report bugs about old versions.} Every time a new version of \e{XTrackCAD} is released, many enhancements are added and known bugs are fixed. If you're using a version of \e{XTrackCAD} that's more than two revisions older than the latest version, you should upgrade to the latest version to make sure the bug you are experiencing still exists. (It's not a bad idea to upgrade even if your version is only a version behind the most current one.) - \f{Only report one problem in each bug report.} If you encounter two or more bugs that don't appear to be related create a separate bug report for each one. This makes the task of managing work assignments easier and may result in a quicker fix for the problem. +Invoke \f{Help>Collect Problem Info}, +This will create a zip file with information about the state of the program including the layout file, information from the workng directory, recent actions etc. +Please attach this zip file to your report. + \rule @@ -929,6 +933,7 @@ Suggestions for improvements are encouraged and welcome. Submit your suggestion \S{support} \i{User Support} -The developers maintain a forum \W{https://xtrackcad.groups.io/g/main}{\e{XtrackCAD} User Forum} a Wiki at \W{http://www.xtrkcad.org/Wikka/HomePage}{\e{XTrackCAD} Wiki} +The developers maintain a forum at \W{https://xtrackcad.groups.io/g/main}{https://xtrackcad.groups.io/g/main} +and a Wiki at \W{https://sourceforge.net/p/xtrkcad-fork/wiki/Home/}{https://sourceforge.net/p/xtrkcad-fork/wiki/Home/} \rule diff --git a/app/doc/managem.but b/app/doc/managem.but index 2a835c3..dadfa08 100644 --- a/app/doc/managem.but +++ b/app/doc/managem.but @@ -15,7 +15,7 @@ The \f{Manage Menu} shows commands affecting the \f{Main Canvas} (\K{mainW}). \u000 -\dd \f{Custom Management} - displays the \f{Custom Management} (\K{cmdCustmgm}) dialog to manipulate custom turnout, structure and rolling stock designs. +\dd \f{Custom Defined Parts} - displays the \f{Custom Defined Parts} (\K{cmdCustmgm}) dialog to manipulate custom turnout, structure and rolling stock designs. \u000 @@ -55,7 +55,7 @@ The \f{Manage Menu} shows commands affecting the \f{Main Canvas} (\K{mainW}). \rule -\S{cmdCarinv} Car Inventory +\S{cmdCarinv} \i{Car Inventory} This dialog is used to manage your list of cars and locomotives. @@ -65,13 +65,16 @@ The main part of this dialog contains a detailed list of each car and locomotive Cars are placed on the layout by using the \f{Train Simulation} (\K{cmdTrain}) command. -The \f{Find} button will center the \f{Main Window} (\K{mainW}) on the selected car. This button is only enabled for cars which are on the Layout (indicated by \f{Layout} in the Location column). If the car on a track that is hidden and \f{Trains on Hidden Track} (\K{cmdDisplay}) is set to \f{Hide}, then the car (and any attached cars) will be made visible. +The \f{Find} button will center the \f{Main Window} (\K{mainW}) on the selected car. This button is only enabled for cars which are on the Layout (indicated by co-ordinates in the Location column). If the car on a track that is hidden and \f{Trains on Hidden Track} (\K{cmdDisplay}) is set to \f{Hide}, then the car (and any attached cars) will be made visible. The \f{Edit} button invokes the \f{Car} dialog (\K{cmdCarpart}) to modify the selected car. This button is disabled if more than one (or no) car is selected or if the selected car is on the Layout. The \f{Add} button is to add a new Car. Refer to \K{faqsPrototype} if an error occurs when attempting to add inventory to this list. -The \f{Delete} button removes the selected cars from your inventory. This button is disabled if any of the selected cars are on the layout. +The \f{Delete|Shelve} button serves two functions: +If all selected cars are on the layout then this button shows \f{Shelve} and it moves them from the layout and returns them to the \f{Shelf}. +If all selected cars are on the \f{Shelf} then this button shows \f{Delete} and they will be deleted from the Inventory. +Otherwise, the button is blank and disabled. The \f{Import} and \f{Export} buttons read and write a \e{Comma-Separated-Value (CSV)} file. This file format can be read and written by many applications. It can be used to transfer car inventory data between different applications. This file contains the following columns (the first four are required when Importing): @@ -117,7 +120,17 @@ The \f{Import} and \f{Export} buttons read and write a \e{Comma-Separated-Value \u000 -\dd \e{Options} - 2 (Locomotives), 4 (Body Mounted Couplers) +\dd \e{Options} - bit map of + +\lcont{ + +\b 0x0001 - Body Mounted Couplers + +\b 0x0002 - Locomotive + +\b Other bits can be ignored + +} \u000 @@ -125,7 +138,7 @@ The \f{Import} and \f{Export} buttons read and write a \e{Comma-Separated-Value \u000 -\dd \e{Color} - encoded as (Red * 65535 + Green * 256 + Blue) +\dd \e{Color} - encoded as (Red * 65536 + Green * 256 + Blue) \u000 @@ -159,7 +172,7 @@ The \f{List} button creates a text file listing your inventory. \rule -\S2{cmdCarpart} Car Item Dialog +\S2{cmdCarpart} \i{Car Item Dialog} This dialog is invoked from the \f{Car Inventory} (\K{cmdCarinv}) and the \f{Custom Management} (\K{cmdCustmgm}) dialogs. @@ -207,7 +220,7 @@ The dialog contains: \rule -\S2{carpart} \f{Car Part Dialog} +\S2{carpart} \i{Car Part Dialog} This dialog is similar the the \f{Car Item} dialog except that the \f{Car Item Information} section is not displayed. The \f{Manufacturer} Drop Down List is editable so you can enter a new manufacturer, and you must enter a \f{Part Number}. If you are adding a new car part, the \f{Part Number} field will be incremented (if it is a numeric value) so you can enter a number of car parts. @@ -254,7 +267,7 @@ See NMRA TN-7 Curved Track Centerline and Obstacle Clearance Calculation Methodo \rule -\S2{carprototype} \f{Car Prototype Dialog} +\S2{carprototype} \i{Car Prototype Dialog} This dialog is used to create or edit prototype definitions. @@ -278,7 +291,7 @@ Unlike the other dialogs, dimensions in this dialog are in prototype units. Whe \rule -\S{cmdCustmgm} Custom Management +\S{cmdCustmgm} \i{Custom Management} The \f{Custom Management} dialog allows you change the properties of turnouts, sectional track, structures, car parts and prototypes you have designed with the \f{Turnout Designer} (\K{cmdTurnoutNew}), \f{Group} (\K{cmdGroup}) or \f{Car} (\K{cmdCarpart}) commands. You can also move selected objects to a \f{Parameter File} (\K{cmdPrmfile}). @@ -304,7 +317,7 @@ The \f{New} buttons invokes the Car (\K{cmdCarpart}) dialog to create a new \f{C \rule -\S{cmdContmgm} Layout Control Elements Dialog +\S{cmdContmgm} \i{Layout Control Elements Dialog} This dialog is used to manage layout control elements (blocks, switchmotors, and signals). @@ -334,7 +347,7 @@ 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 +\S{cmdGroup} \i{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. @@ -342,21 +355,51 @@ The \f{Group} command combines the selected (\K{cmdSelect}) Lines and Shapes (\K The title will be pre-populated with the title of the last \f{Structure} you \f{ungrouped} (\K{manageM}). -You can include \f{Turnouts}, \f{Sectional}, \f{Straight} or \f{Curved} tracks in the selected objects which allows you to add cosmetic details to a \f{Turnout} definitions, or create a new \f{Turnout} definition. This can also be used to if there are fixed track locations on a structure, like on an engine shed. +You can include \f{Turnouts}, \f{Sectional}, \f{Straight} or \f{Curved} tracks in the selected objects which allows you to add cosmetic details to a \f{Turnout} definitions, or create a new \f{Turnout} definition. This can also be used to if there are fixed-track locations on a structure, like on an engine shed. + +\f{Group} is intended to operate on simple groups of track segments. If you intend to group a large number of track segments, you should consider using \f{Import Module} (see \K{cmdLayer}), To modify a \f{Structure} or \f{Turnout} definition, first place the object on the layout, select and then \f{Ungroup} the object. Now the parts of the object can be edited using the \f{Modify} (\K{cmdModify}), \f{Draw} (\K{cmdDraw}) or other commands. Once completed, select the object parts and use the \f{Group} command to update the definition (or create a new one by changing the title). -The \f{Group} dialog shows the Manufacturer, Description and part number (Title) of the new definition. Initial values are based on selected turnouts and structures or on the last \f{Ungroup}ed object (\K{cmdUngroup}). The dialog also contains a toggle button (\f{Replace with new group}?), which is used if you want to replace the selected objects with the new definition. All fields listed in this dialog window must contain data. +The \f{Group} dialog shows the Manufacturer, Description and part number (Title) of the new definition. Initial values are based on selected turnouts and structures or on the last \f{Ungroup}ed object (\K{cmdUngroup}). +The \f{Turntable/TransferTable/DblSlipSwitch}? toggle button controls whether non-conflicting \f{Paths} should be combined or keep separate, see \f{Paths} below. +The \f{Replace with new group}? toggle button is used if you want to replace the selected objects with the new definition. +All fields listed in this dialog window must contain data. The definition data will be added to the \c{xtrkcad.cus} (\K{directories}) file for later use. Please consider contributing this information for others to use. If you modify a definition from a \e{XTrackCAD} Library parameter file, the new definition will replace the existing definition on the \f{Hot Bar} (\K{cmdHotBar}), otherwise it will be added to the end of the \f{Hot Bar}. You can use the \f{Custom Management} (\K{cmdCustmgm}) dialog to change the title or delete custom definitions. -\f{Note:} There is a limit of 128 track segments in a group. +\f{Note:} +The selected tracks are decomposed into segments, which are simple tracks and drawing object (lines, curves, polygons ... ). +Any track segments must appear in the first 127 segments. +This implies a limit of 127 track segments. + +\dd You can re-order the segment list by + +\lcont{ + +\b Ungroup the selected tracks + +\b Unselect all, and select the tracks you want to group + +\b \f{Move selected objects to bottom} + +\b Add the non-tracks object to the selected track segments + +\b Retry the \f{Group} command + +} + +\f{Paths} define which segments are followed by a train in Train mode. +Normally, if two paths follow paths of separate segments, then the paths are combined. +For example a simple turnout would have two paths, but since the paths share some common segments, the paths are not combined. +A Crossing has two paths but since they don't have any segments in common, the two paths are combined into one. +A Turntable can have many distinct paths but only one would be valid at any time. In this case we don't want to combine paths and the toggle would be checked. \rule -\S{cmdLayer} Layers Dialog +\S{cmdLayer} \i{Layers Dialog} Each object is contained in a layer - which is a custom group of objects that do not have a particular visual order, but can be treated as a set for certain commands. Objects which are created independently of other objects (such as straight tracks (\K{cmdStraight}) or text (\K{cmdText})) are created in the current layer. @@ -410,7 +453,7 @@ The \f{Layer Buttons} on the Tool-bar (\K{mainW}) control which layer is the \f{ The current layer is selected by picking a value from the drop down layer list. If the Layer you've selected was not visible, it will be shown. -You can hide (or show if not visible) the different layers by pushing one of the \f{Layer Buttons} on the Tool-bar (if you have configured the tool-bar (\K{toolbarM}) to show the Layer buttons). If a layer is not visible then the corresponding layer button will be raised. The active or current layer cannot be hidden. +You can hide (or show if not visible) the different layers by pushing one of the \f{Layer Buttons} on the Toolbar (if you have configured the toolbar (\K{toolbarOpts}) to show the Layer buttons). If a layer is not visible then the corresponding layer button will be raised. The active or current layer cannot be hidden. The color of each layer button shows the color that will be used to draw tracks or draw objects in that layer, if you have selected the \f{Color Layers} (\K{cmdDisplay}) on the \f{Display} dialog. The \f{Use Color} button allows this layer to opt in or out - which can be usefu if you want to color other layers but a layer contains pre-colored objects (like Structures or Scenery). @@ -422,7 +465,7 @@ Objects are drawn on the map window, if the Layer they are on has \f{On Map} che \rule -\S{cmdEnum} Parts List +\S{cmdEnum} \i{Parts List} \I{Enumerate} The \f{Parts List} command produces a list of all selected (\K{cmdSelect}) turnouts, sectional track and bench-work. It also computes total length of selected flex-track. @@ -444,7 +487,7 @@ Hint: you can use the \f{Parts List} command to measure the length of selected f \rule -\S{cmdPricelist} Price List +\S{cmdPricelist} \i{Price List} The \f{Price List} dialog allows entry of prices for Turnouts, Sectional Track and Structures. Only those objects from loaded Parameter Files (\K{cmdPrmfile}) or \e{Custom Designs} for the current Scale (\K{cmdLayout}) are listed. @@ -452,17 +495,18 @@ The \f{Price List} dialog allows entry of prices for Turnouts, Sectional Track a The price of a selected object can be changed in the \e{Cost} edit box that's located above the "Price" column. -The price of a length of \e{Flex Track} for the current Scale (\K{cmdLayout}) is listed at the bottom of the dialog. You can specify the \e{Length} in \e{Inches} or \e{Centimeters}. To specify the price for other \e{Scales} change Scale (\K{cmdLayout}) on the Layout (\K{cmdLayout}) window. +The price of a length of \e{Flex-Track} for the current Scale (\K{cmdLayout}) is listed at the bottom of the dialog. You can specify the \e{Length} in \e{Inches} or \e{Centimeters}. To specify the price for other \e{Scales} change Scale (\K{cmdLayout}) on the Layout (\K{cmdLayout}) window. The Parts List (\K{cmdEnum}) dialog lists prices for selected objects if the \e{Prices} check box on the dialog window is selected. \rule -\S{cmdTrain} Train +\S{cmdTrain} \i{Train Mode} \I{Simulation} \G{png.d/btrain.png} The \f{Train} command lets you place and run Trains on the layout. \I{Run Trains}During this command, the Tool Bar and Hot Bar are changed. Most of the Tool Bar buttons are replaced by the \e{Go/Stop} and \e{Exit} buttons. The \e{Go/Stop} button toggles between Pausing all Trains and allowing Trains to Run. The \e{Exit} button terminates the Train Simulation and returns to Layout Design mode. +The Hot Bar becomes the \f{Shelf}. \G{png.d/trainbar.png} @@ -470,19 +514,19 @@ The Parts List (\K{cmdEnum}) dialog lists prices for selected objects if the \e{ \dt \e{Selecting New Cars} -\dd The Hot Bar contains the Cars and Locomotives which are have not been placed on the Layout. Cars are created and managed using the Car Inventory (\K{cmdCarinv}) dialog. +\dd The \f{Shelf} contains the Cars and Locomotives which have not been placed on the Layout. Cars are created and managed using the Car Inventory (\K{cmdCarinv}) dialog. \u000 -\dd Each item on the Hot Bar can represent a group of Cars. Cars can be grouped by Prototype, Manufacturer and/or Part Number. They can also be listed as individual Car Items. This grouping is controlled by \e{Car Labels} Drop Down List on the Display (\K{cmdDisplay}) dialog. +\dd Each item on the \f{Shelf} can represent a group of Cars. Cars can be grouped by Prototype, Manufacturer and/or Part Number. They can also be listed as individual Car Items. This grouping is controlled by \e{Car Labels} Drop Down List on the Display (\K{cmdDisplay}) dialog. \u000 -\dd To place a Car, select it from the Hot Bar. If the Hot Bar is displaying Cars in groups (and not as individual Car Items) then a Drop Down List is displayed on the Status Bar (\K{mainW}) containing the individual Car Items in that group. +\dd To place a Car, select it from the \f{Shelf}. If the \f{Shelf} is displaying Cars in groups (and not as individual Car Items) then a Drop Down List is displayed on the Status Bar (\K{mainW}) containing the individual Car Items in that group. \u000 -\dd If you are not displaying the Hot Bar, then the \e{New Car} button (\G{png.d/bnewcar.png}) will be shown on the Tool Bar. Pressing this button will display the Drop Down List on the Status Bar (\K{mainW}) containing all of your Car Items that have not yet been placed on the layout. +\dd If you are not displaying the \f{Shelf}, then the \e{New Car} button (\G{png.d/bnewcar.png}) will be shown on the Tool Bar. Pressing this button will display the Drop Down List on the Status Bar (\K{mainW}) containing all of your Car Items that have not yet been placed on the layout. \u000 @@ -536,6 +580,12 @@ The Parts List (\K{cmdEnum}) dialog lists prices for selected objects if the \e{ \u000 +\dt \e{Change Reporting number of Car on Layout} + +\dd To change the reporting number, Right-Click over the Car and then select \e{Properties} and update the field. This value will be shown in the car if Labels are shown and in the \e{Train Control} Window. + +\u000 + \dt \e{Trains} \dd A Train consists of one or more Locomotives coupled to other Cars. One Locomotive will be the \e{MU Master} for the Train. The \e{MU Master} can be changed by Right-Clicking on a Locomotive and selecting \e{MU Master} from the pop-up menu. The \e{MU Master} is drawn with a solid Yellow head light indicating the direction is moving. If a Train is split by uncoupling between Locomotives, then two Trains will be created, each with their own \e{MU Master}. @@ -548,7 +598,7 @@ The Parts List (\K{cmdEnum}) dialog lists prices for selected objects if the \e{ \u000 -\dd The \e{Train Control} dialog is used to set the speed and direction of Trains. The dialog contains a list of Trains (listed by their \e{MU Master} Locomotive). Before each Train on the list is either a Red circle (indicating the Train is stopped) or a Green circle (indicating the Train is moving). +\dd The \e{Train Control} dialog is used to set the speed and direction of Trains. The dialog contains a list of Trains (listed by their \e{MU Master} Locomotive reporting number). Before each Train on the list is either a Red circle (indicating the Train is stopped) or a Green circle (indicating the Train is moving). \u000 @@ -622,13 +672,13 @@ The Parts List (\K{cmdEnum}) dialog lists prices for selected objects if the \e{ \rule -\S{cmdTurnoutNew} Turnout Designer +\S{cmdTurnoutNew} \i{Turnout Designer} The \f{Turnout Designer} allows you to define new turnouts and sectional track pieces. \G{png.d/mmanageturnoutdesign.png} -The Turnout Designer sub-menu is pictured above. As demonstrated by the sub-menu a number of different dialogs are available for creation of custom turnout and sectional track components. New turnouts and sectional track is added to Custom Management (\K{cmdCustmgm}) and Turnout Manager (\K{cmdTurnout}) using the \f{Turnout Designer}. +The Turnout Designer sub-menu is pictured above. As demonstrated by the sub-menu a number of different dialogs are available for creation of custom turnout and sectional track components. New turnouts and sectional track is added to Custom Management (\K{cmdCustmgm}) and Turnout Manager (\K{cmdNewFixedTrack}) using the \f{Turnout Designer}. The follow dialog is for a regular turnout. @@ -676,7 +726,7 @@ The rail height (\e{Code}) can be added to the \f{Manufacturer}, e.g., Peco-55, The scale is the current scale from the \f{Scale Drop Down List} on the \f{Layout} dialog (\K{cmdLayout}). -\f{Manufacturer}, \f{Description} and \f{Part Number (#)} comprise the title of the turnout. These values are used in the \f{Turnout Selection dialog} (\K{cmdTurnout}) and the \f{Parts List} (\K{cmdEnum}). For regular and curved turnouts there are separate \f{Descriptions} and \f{Part Numbers} for the right and left hand turnouts. +\f{Manufacturer}, \f{Description} and \f{Part Number (#)} comprise the title of the turnout. These values are used in the \f{Turnout Selection dialog} (\K{cmdNewFixedTrack}) and the \f{Parts List} (\K{cmdEnum}). For regular and curved turnouts there are separate \f{Descriptions} and \f{Part Numbers} for the right and left hand turnouts. The \f{Print} button prints a full size diagram of the turnout. You can use this to check your dimensions and make any required changes. You should expect to make several printouts as you refine your dimensions. @@ -684,7 +734,7 @@ The \f{OK} button completes the design. The new turnout is added to the list in The \f{Cancel} button removes the \f{Turnout Designer} dialog. -\e{Creating \i{Turnout Designs}} +\e{Creating Turnout Designs} \b It is best to start by marking the endpoints of the turnout on a piece of paper. Extend the curved leg of the turnout (try attaching a straight sectional track) and measure the angle. Frog numbers are easiest to calculate. @@ -704,7 +754,7 @@ The \f{Cancel} button removes the \f{Turnout Designer} dialog. \rule -\S{cmdRefreshSpecial} Update Turnouts and Structures +\S{cmdRefreshSpecial} \i{Update Turnouts and Structures} This command updates (or refreshes) selected turnouts, sectional tracks and structures on your layout with the current definitions from the loaded parameter files (\K{cmdPrmfile}). Each selected object that is found in a parameter file is updated with the current definition. @@ -716,8 +766,11 @@ If an object has been updated then it is unselected, otherwise it will remain se \rule -\S{cmdUngroup} Ungroup +\S{cmdUngroup} \i{Ungroup} \f{Ungroup} allows existing definitions to be modified and the resulting objects recombined with the \f{Group} (\K{cmdGroup}) command to update the definition. Turnouts are composed of individual straight and curved segments. Segments that form the points (\K{generalTerms}) of the turnout remain combined as an \e{Ungrouped Turnout}, and the other segments are replaced by straight and curved tracks. -\rule
\ No newline at end of file +One-ended Turnouts (AKA Bumpers) are converted to Staight tracks by \f{Ungroup}. +These can be converted back to a Bumper by manually editting the \f{Grouped} definition and removing the unwanted End-Point by deleting the correspnding \f{E} line. + +\rule diff --git a/app/doc/mk-xtrkcad-manual b/app/doc/mk-xtrkcad-manual new file mode 100755 index 0000000..41c6be5 --- /dev/null +++ b/app/doc/mk-xtrkcad-manual @@ -0,0 +1,136 @@ +#!/bin/sh + +if [ $# -ne 1 ] ; then + echo mk-xtrkcad-manual-html SRCDIR + echo Run from the root of your build directory + echo SRCDIR is the root of your source tree + echo Output will be in XTrackCAD_Users_Manual-VERSION.pdf/.html + exit 1 +fi + +SRCDIR=$1 +BLDDIR=`pwd` + + +# Setup output name +OUTFILE="XTrackCAD_Users_Manual-" +VERSION="Unknown" +if [ -f "${BLDDIR}/xtrkcad-config.h" ] ; then + VERSION=`grep XTRKCAD_VERSION ${BLDDIR}/xtrkcad-config.h|\ + sed -e 's/.*VERSION "//' -e 's/"//'` + echo VERSION=$VERSION +else + echo "Unknown Version" +fi +OUTFILE="${OUTFILE}${VERSION}" + +if [ ! -d ${SRCDIR} ] ; then + echo $SRCDIR does not exist + exit 1 +fi + + +# Check and setup directories +# Find .but files +BUTTDIR="${SRCDIR}/app/doc" +if [ ! -f ${BUTTDIR}/addm.but ] ; then + echo $BUTTDIR does not contain .but files + exit 1 +fi + +# working/output directory +if [ ! -d ${BLDDIR} ] ; then + echo $BLDDIR does not exist + exit 1 +fi + +# .html files +HTMLDIR=${BLDDIR}/app/doc/html +if [ ! -f ${HTMLDIR}/addM.html ] ; then + echo $HTMLDIR does not contain .html files + exit 1 +fi + + +# extract .html file names from .but file +# prepend some headers with 'NEWPAGE ' +# we convert this to html to generate page breaks when printing +extract() { + grep '^\\[ACHS]' $1 |\ + sed \ + -e 's/^\\[ACH][0-9]*{/NEWPAGE /' \ + -e 's/^\\[S][0-9]*{//' \ + -e 's/}.*//' \ + -e '/^$/d' \ + -e 's/$/.html/' ; +} + + +# extract .html refs +cd $BUTTDIR +FILES="\ +contents.html \ +`extract intro.but.in` \ +`extract addm.but` \ +`extract changem.but` \ +`extract drawm.but` \ +`extract editm.but` \ +`extract filem.but` \ +`extract helpm.but` \ +`extract hotbar.but` \ +`extract macrom.but` \ +`extract managem.but` \ +`extract optionm.but` \ +`extract statusbar.but` \ +`extract view_winm.but` \ +`extract navigation.but` \ +`extract appendix.but` \ +`extract ${BLDDIR}/app/help/messages.but` \ +`extract upgrade.but` \ +`extract warranty.but` \ +NEWPAGE \ +IndexPage.html" +#echo $FILES +#exit + +# clean up .html: remove nav line, fix case file names +# create concatenated .html file +cd $HTMLDIR + +> ${BLDDIR}/${OUTFILE}.html +for FILE in ${FILES} ; do + if [ "${FILE}" = "NEWPAGE" ] ; then + # This creates page break when printing from chrome but + # NOT when using pandoc. + # This is an open problem + echo '<div style="break-after:page"></div>' \ + >> ${BLDDIR}/${OUTFILE}.html + else + cat "${FILE}" |\ + grep -v 'Previous.*Next' |\ + sed \ + -e 's/bSensor.png/bsensor.png/'\ + -e 's/bControl.png/bcontrol.png/'\ + -e 's/iconlink.PNG/iconlink.png/'\ + >> ${BLDDIR}/${OUTFILE}.html + fi +done +#) + + +# convert to .pdf if we have pandoc +cd $BLDDIR +if [ -x /usr/bin/pandoc ] ; then + cd $SRCDIR/app/doc/ + pandoc ${BLDDIR}/${OUTFILE}.html \ + --pdf-engine=pdflatex \ + --variable "geometry=margin=0.5in" \ + --variable fontsize=12pt \ + -o "${BLDDIR}/${OUTFILE}.pdf" + echo Output: ${OUTFILE}.pdf +else + # no pandoc: tell user to use chrome + echo Output: ${OUTFILE}.html + echo "Open with Chrome and Print to File as a PDF, from a directory containing png.d/" + echo "You should specify a custom scale of at least 150%" +fi diff --git a/app/doc/navigation.but b/app/doc/navigation.but index f648a70..bd2f703 100644 --- a/app/doc/navigation.but +++ b/app/doc/navigation.but @@ -138,12 +138,13 @@ Eg. in Germany, where the comma is used, the correct value would be\c{LargeIcon \b "@" key in \f{Select}, \f{Modify} and \f{Pan/Zoom}. -\b Mouse Wheel - adding \e{Shift} key or the \e{Mouse Middle Button} will Pan the screen. adding \e{Ctrl} as well makes up Pan left and down Pan right. +\b Mouse Wheel - adding \e{Shift} key will Pan the screen up and down. Adding \e{Ctrl} as well Pans left and right. -\b Horizontal Mouse Wheel - adding \e{Shift} or the \e{Mouse Middle Button} will Pan the screen left and Right (if available) +\b Horizontal Mouse Wheel - adding \e{Shift} key will Pan the screen left and Right (if available) \b Scroll Left and Right - if the scroll left and right guestures are mapped to the trackpad by the operating system, with \e{Shift} depressed the screen will Pan. +\b On mice and systems that support Three Button Mice, holding the \e{Middle Mouse Button} while dragging, will Pan the canvas. } \dd The \f{Main Canvas} can be panned so that the area beyond the room boundaries is shown (the \f{grey} area). The \f{Constrain Drawing Area to Room Boundaries} option on the \f{Display} (\K{cmdDisplay}) dialog under the \f{Options} (\K{optionM}) menu forces the \f{Main Canvas} stop panning once the room boundary is reached. @@ -225,6 +226,8 @@ Otherwise, as much of the room as possible is displayed, and any \f{grey} area w Most Windows open with three standard dialog buttons: \dd \f{Cancel} - Cancels dialog. Layout reverts back to its previous state. +\f{Cancel} may be absent if reverting the action is not applicable. +If the action affected objects on the layout, they can by reverted with the \f{Undo} command. \u000 @@ -420,7 +423,7 @@ Several Shortcut key commands are used in conjunction with the mouse. These comm \u000 -\dd Split flex track - \e{Ctrl+Shift+S} +\dd Split flex-track - \e{Ctrl+Shift+S} \u000 @@ -756,6 +759,8 @@ Note Dialog } } +\dd On some systems support Three Button Mice, holding down the \e{Middle Mouse Button} and dragging will pan the Canvas. Note: not all system support this operation, even with a Three Button Mouse. + \rule \S{cmdManage} Manage Commands @@ -893,7 +898,7 @@ If the click is on an area without objects and \f{SelectZero} is set, all object \dt \e{Double-Left-Click} -\dd Opens Modify for Cornu and Draw Objects other than Text, Activates Link and Document Notes, otherwise opens Describe. +\dd Opens Modify for Cornu and Draw Objects other than Text, Activates Link and Document Notes, otherwise opens Properties. \dt \e{Left+Drag} @@ -938,7 +943,7 @@ Some other commands use the \c{Shift} or \c{Ctrl} key to modify the meaning of b \rule -\S{mouseBcmd} Context Sensitive Menus +\S{mouseBcmd} \i{Context Sensitive Menus} For all commands listed below, a \e{Right-Click} will display a context sensitive pop-up command list menu. For some commands (noted below), a \e{Shift+Right-Click} will display a context sensitive pop-up command options menu. The operation of \e{Right-Click} and \e{Shift+Right-Click} can be reversed by an item on the Command Options (\K{cmdCmdopt}) dialog. @@ -1236,7 +1241,7 @@ The Shortcut key for each command is listed after the command name. \u000 -\dt Turnout Command (\K{cmdTurnout}) - \e{Ctrl+T} +\dt Turnout Command (\K{cmdNewFixedTrack}) - \e{Ctrl+T} \dd Choose next Active endpoint when placing Turnouts - \e{Shift+Left-Click} diff --git a/app/doc/optionm.but b/app/doc/optionm.but index 7e3a69f..8c3bffa 100644 --- a/app/doc/optionm.but +++ b/app/doc/optionm.but @@ -44,7 +44,7 @@ The \f{Options Menu} shows commands to change configuration options. \rule -\S{cmdRgbcolor} Colors Dialog +\S{cmdRgbcolor} \i{Colors Dialog} The \f{Colors} dialog is invoked from the Options (\K{optionM}) menu @@ -90,10 +90,18 @@ The \f{Colors} dialog controls the color that various objects are drawn. \dd \f{Track Ties} - color of ties (if drawn). +\u000 + +\dd \f{Bridge Base} - color of Bridge fill between the parapets. + +\u000 + +\dd \f{Track Roadbed} - color of Roadbed fill under the track. + \rule -\S{cmdCmdopt} Command Option Dialog +\S{cmdCmdopt} \i{Command Option Dialog} The \f{Command Option} dialog is invoked from the Options (\K{optionM}) menu @@ -109,7 +117,7 @@ The \f{Command Option} dialog contains items which control the behavior of some \u000 -\dd \e{Select-Mode} - will either (a) only select the current item unless Ctrl is added or (b) will add the current item to the selection unless Ctrl is added in which case it will only select this item. +\dd \e{Select-Mode} - will either (a) only select the current item unless Ctrl is added or (b) will add the current item to the selection unless Ctrl is added in which case it will only select this item. \u000 @@ -118,7 +126,7 @@ The \f{Command Option} dialog contains items which control the behavior of some \rule -\S{cmdDisplay} Display Dialog +\S{cmdDisplay} \i{Display Dialog} The \f{Display} dialog is invoked from the Options (\K{optionM}) menu @@ -325,7 +333,7 @@ Easements require the possibility of creating track with arbitrary radii. Theref \rule -\S{fontSelW} Font Selection +\S{fontSelW} \i{Font Selection} The font selection dialog allows selection of the font used by the text (\K{cmdText}) command. This command is valid only on UNIX based systems. @@ -334,7 +342,7 @@ The font selection dialog allows selection of the font used by the text (\K{cmdT \rule -\S{cmdLayout} Layout Dialog +\S{cmdLayout} \i{Layout Dialog} The \f{Layout Options} dialog, displayed by the Options (\K{optionM}) or the File (\K{fileM} menu, contains items controlling the current layout. @@ -395,7 +403,7 @@ It can be changed to a new local file and the next \f{Save} will rebuild the pac \rule -\S{cmdPref} Preferences Dialog +\S{cmdPref} \i{Preferences Dialog} This dialog controls some parameters which likely will not be changed frequently. @@ -407,7 +415,7 @@ This dialog controls some parameters which likely will not be changed frequently \u000 -\dd \f{AutoSave} \i{AutoSave} - specifies the number of Check Points taken before an AutoSave. The same number of checkpoints are retained in a circular archive set in the (\K{workDir}) named for the layout file. Setting this value to 0 disables AutoSave. +\dd \f{AutoSave} \i{AutoSave} - specifies the number of Check Points taken before an AutoSave. The same number of checkpoints are retained in a circular archive set in the (\K{workDir}) named for the layout file. Setting this value to 0 disables AutoSave. \u000 @@ -415,7 +423,11 @@ This dialog controls some parameters which likely will not be changed frequently \u000 -\dd \f{Show FlexTrack} - disables the display or \f{FlexTrack} (\K{generalTerms}) which is shown on the left of the Toolbar. +\dd \f{Enable Audio Signals} - turns on beeps for positive confirmations and warnings. + +\u000 + +\dd \f{Show Flex-track} - disables the display or \f{Flex-track} (\K{generalTerms}) which is shown on the left of the Toolbar. \u000 @@ -476,7 +488,7 @@ This dialog controls some parameters which likely will not be changed frequently \rule -\S{cmdSticky} Sticky Dialog +\S{cmdSticky} \i{Sticky Dialog} By default, when commands complete, the defined \f{Default Command} (\K{cmdCmdopt}) becomes active. If a command is \f{sticky}, the defined \f{Default Command} is ignored and the current command remains active after completion. diff --git a/app/doc/png.d/bangle.png b/app/doc/png.d/bangle.png Binary files differindex ee50dc6..c7977f5 100644 --- a/app/doc/png.d/bangle.png +++ b/app/doc/png.d/bangle.png diff --git a/app/doc/png.d/bblock.png b/app/doc/png.d/bblock.png Binary files differindex f5d3593..50b2e09 100644 --- a/app/doc/png.d/bblock.png +++ b/app/doc/png.d/bblock.png diff --git a/app/doc/png.d/bbridge.png b/app/doc/png.d/bbridge.png Binary files differnew file mode 100644 index 0000000..438afe3 --- /dev/null +++ b/app/doc/png.d/bbridge.png diff --git a/app/doc/png.d/bcircl1.png b/app/doc/png.d/bcircl1.png Binary files differindex af861ee..a6177f2 100644 --- a/app/doc/png.d/bcircl1.png +++ b/app/doc/png.d/bcircl1.png diff --git a/app/doc/png.d/bcircl2.png b/app/doc/png.d/bcircl2.png Binary files differindex 41c6087..3632d10 100644 --- a/app/doc/png.d/bcircl2.png +++ b/app/doc/png.d/bcircl2.png diff --git a/app/doc/png.d/bcircl3.png b/app/doc/png.d/bcircl3.png Binary files differindex 7736f53..020111d 100644 --- a/app/doc/png.d/bcircl3.png +++ b/app/doc/png.d/bcircl3.png diff --git a/app/doc/png.d/bcircle.png b/app/doc/png.d/bcircle.png Binary files differindex 327a837..db00f4e 100644 --- a/app/doc/png.d/bcircle.png +++ b/app/doc/png.d/bcircle.png diff --git a/app/doc/png.d/bconnect.png b/app/doc/png.d/bconnect.png Binary files differindex 602dc60..77766e1 100644 --- a/app/doc/png.d/bconnect.png +++ b/app/doc/png.d/bconnect.png diff --git a/app/doc/png.d/bcontrol.png b/app/doc/png.d/bcontrol.png Binary files differindex 4b35f1e..2b67c52 100644 --- a/app/doc/png.d/bcontrol.png +++ b/app/doc/png.d/bcontrol.png diff --git a/app/doc/png.d/bcornu.png b/app/doc/png.d/bcornu.png Binary files differindex 60c632e..dd21a5b 100644 --- a/app/doc/png.d/bcornu.png +++ b/app/doc/png.d/bcornu.png diff --git a/app/doc/png.d/bcurve.png b/app/doc/png.d/bcurve.png Binary files differindex 72b852c..25d2f1c 100644 --- a/app/doc/png.d/bcurve.png +++ b/app/doc/png.d/bcurve.png diff --git a/app/doc/png.d/bcurve1.png b/app/doc/png.d/bcurve1.png Binary files differindex c5bebb3..12a35b6 100644 --- a/app/doc/png.d/bcurve1.png +++ b/app/doc/png.d/bcurve1.png diff --git a/app/doc/png.d/bcurve2.png b/app/doc/png.d/bcurve2.png Binary files differindex e165b7e..3d0266d 100644 --- a/app/doc/png.d/bcurve2.png +++ b/app/doc/png.d/bcurve2.png diff --git a/app/doc/png.d/bcurve3.png b/app/doc/png.d/bcurve3.png Binary files differindex 766758c..4989626 100644 --- a/app/doc/png.d/bcurve3.png +++ b/app/doc/png.d/bcurve3.png diff --git a/app/doc/png.d/bcurve4.png b/app/doc/png.d/bcurve4.png Binary files differindex 81e9856..e1479fd 100644 --- a/app/doc/png.d/bcurve4.png +++ b/app/doc/png.d/bcurve4.png diff --git a/app/doc/png.d/bcurvelin.png b/app/doc/png.d/bcurvelin.png Binary files differnew file mode 100644 index 0000000..349c1a9 --- /dev/null +++ b/app/doc/png.d/bcurvelin.png diff --git a/app/doc/png.d/bdelete.png b/app/doc/png.d/bdelete.png Binary files differindex 245596a..6e46e43 100644 --- a/app/doc/png.d/bdelete.png +++ b/app/doc/png.d/bdelete.png diff --git a/app/doc/png.d/bdescrib.png b/app/doc/png.d/bdescrib.png Binary files differindex 29e011c..3525e0c 100644 --- a/app/doc/png.d/bdescrib.png +++ b/app/doc/png.d/bdescrib.png diff --git a/app/doc/png.d/bdraw.png b/app/doc/png.d/bdraw.png Binary files differindex 0d282c1..c22006b 100644 --- a/app/doc/png.d/bdraw.png +++ b/app/doc/png.d/bdraw.png diff --git a/app/doc/png.d/bdrawsplit.png b/app/doc/png.d/bdrawsplit.png Binary files differnew file mode 100644 index 0000000..5174bec --- /dev/null +++ b/app/doc/png.d/bdrawsplit.png diff --git a/app/doc/png.d/belev.png b/app/doc/png.d/belev.png Binary files differindex 9a73e90..eb16a12 100644 --- a/app/doc/png.d/belev.png +++ b/app/doc/png.d/belev.png diff --git a/app/doc/png.d/bexport.png b/app/doc/png.d/bexport.png Binary files differnew file mode 100644 index 0000000..dd3b90e --- /dev/null +++ b/app/doc/png.d/bexport.png diff --git a/app/doc/png.d/bexportbmap.png b/app/doc/png.d/bexportbmap.png Binary files differnew file mode 100644 index 0000000..1f749e7 --- /dev/null +++ b/app/doc/png.d/bexportbmap.png diff --git a/app/doc/png.d/bexportdxf.png b/app/doc/png.d/bexportdxf.png Binary files differnew file mode 100644 index 0000000..e593c52 --- /dev/null +++ b/app/doc/png.d/bexportdxf.png diff --git a/app/doc/png.d/bexportsvg.png b/app/doc/png.d/bexportsvg.png Binary files differnew file mode 100644 index 0000000..8dea55c --- /dev/null +++ b/app/doc/png.d/bexportsvg.png diff --git a/app/doc/png.d/bezier.png b/app/doc/png.d/bezier.png Binary files differindex e03458e..796b7f2 100644 --- a/app/doc/png.d/bezier.png +++ b/app/doc/png.d/bezier.png diff --git a/app/doc/png.d/bfile.png b/app/doc/png.d/bfile.png Binary files differindex 6c140fb..8d7be9d 100644 --- a/app/doc/png.d/bfile.png +++ b/app/doc/png.d/bfile.png diff --git a/app/doc/png.d/bflip.png b/app/doc/png.d/bflip.png Binary files differindex 6ec7a00..462cd43 100644 --- a/app/doc/png.d/bflip.png +++ b/app/doc/png.d/bflip.png diff --git a/app/doc/png.d/bgsnap.png b/app/doc/png.d/bgsnap.png Binary files differindex 4aebf61..c3a69e6 100644 --- a/app/doc/png.d/bgsnap.png +++ b/app/doc/png.d/bgsnap.png diff --git a/app/doc/png.d/bgundo.png b/app/doc/png.d/bgundo.png Binary files differindex 42d0bce..0af47ef 100644 --- a/app/doc/png.d/bgundo.png +++ b/app/doc/png.d/bgundo.png diff --git a/app/doc/png.d/bgzoom.png b/app/doc/png.d/bgzoom.png Binary files differindex ce244bd..0e3e2af 100644 --- a/app/doc/png.d/bgzoom.png +++ b/app/doc/png.d/bgzoom.png diff --git a/app/doc/png.d/bhelix.png b/app/doc/png.d/bhelix.png Binary files differindex c7ce099..f6896fb 100644 --- a/app/doc/png.d/bhelix.png +++ b/app/doc/png.d/bhelix.png diff --git a/app/doc/png.d/bhndldto.png b/app/doc/png.d/bhndldto.png Binary files differindex 6e13542..bb89eec 100644 --- a/app/doc/png.d/bhndldto.png +++ b/app/doc/png.d/bhndldto.png diff --git a/app/doc/png.d/bimport.png b/app/doc/png.d/bimport.png Binary files differnew file mode 100644 index 0000000..66488b9 --- /dev/null +++ b/app/doc/png.d/bimport.png diff --git a/app/doc/png.d/bimportmod.png b/app/doc/png.d/bimportmod.png Binary files differnew file mode 100644 index 0000000..ee4f375 --- /dev/null +++ b/app/doc/png.d/bimportmod.png diff --git a/app/doc/png.d/bitmap.png.orig b/app/doc/png.d/bitmap.png.orig Binary files differnew file mode 100644 index 0000000..1f749e7 --- /dev/null +++ b/app/doc/png.d/bitmap.png.orig diff --git a/app/doc/png.d/bjoin.png b/app/doc/png.d/bjoin.png Binary files differindex 673793e..e3d91d1 100644 --- a/app/doc/png.d/bjoin.png +++ b/app/doc/png.d/bjoin.png diff --git a/app/doc/png.d/bjoinline.png b/app/doc/png.d/bjoinline.png Binary files differindex 0d88a58..28ea14d 100644 --- a/app/doc/png.d/bjoinline.png +++ b/app/doc/png.d/bjoinline.png diff --git a/app/doc/png.d/blayer.png b/app/doc/png.d/blayer.png Binary files differindex 8b2fe72..2817ea9 100644 --- a/app/doc/png.d/blayer.png +++ b/app/doc/png.d/blayer.png diff --git a/app/doc/png.d/blink.png b/app/doc/png.d/blink.png Binary files differindex 4dfbbe7..70479c1 100644 --- a/app/doc/png.d/blink.png +++ b/app/doc/png.d/blink.png diff --git a/app/doc/png.d/bmenu.png b/app/doc/png.d/bmenu.png Binary files differindex 34ef253..79dd813 100644 --- a/app/doc/png.d/bmenu.png +++ b/app/doc/png.d/bmenu.png diff --git a/app/doc/png.d/bmodify.png b/app/doc/png.d/bmodify.png Binary files differindex 9a534a9..8a5a77c 100644 --- a/app/doc/png.d/bmodify.png +++ b/app/doc/png.d/bmodify.png diff --git a/app/doc/png.d/bmove.png b/app/doc/png.d/bmove.png Binary files differindex 54dc628..ab3639f 100644 --- a/app/doc/png.d/bmove.png +++ b/app/doc/png.d/bmove.png diff --git a/app/doc/png.d/bmovedes.png b/app/doc/png.d/bmovedes.png Binary files differindex b76b878..cdda765 100644 --- a/app/doc/png.d/bmovedes.png +++ b/app/doc/png.d/bmovedes.png diff --git a/app/doc/png.d/bnew.png b/app/doc/png.d/bnew.png Binary files differindex 7ffeb65..e02cfa6 100644 --- a/app/doc/png.d/bnew.png +++ b/app/doc/png.d/bnew.png diff --git a/app/doc/png.d/bnewcar.png b/app/doc/png.d/bnewcar.png Binary files differindex 61b8ff9..c7773dc 100644 --- a/app/doc/png.d/bnewcar.png +++ b/app/doc/png.d/bnewcar.png diff --git a/app/doc/png.d/bnote.png b/app/doc/png.d/bnote.png Binary files differindex b91518b..ade9df5 100644 --- a/app/doc/png.d/bnote.png +++ b/app/doc/png.d/bnote.png diff --git a/app/doc/png.d/bopen.png b/app/doc/png.d/bopen.png Binary files differindex 247fe38..89e08cb 100644 --- a/app/doc/png.d/bopen.png +++ b/app/doc/png.d/bopen.png diff --git a/app/doc/png.d/bparallel.png b/app/doc/png.d/bparallel.png Binary files differindex 5f92b6d..47b7631 100644 --- a/app/doc/png.d/bparallel.png +++ b/app/doc/png.d/bparallel.png diff --git a/app/doc/png.d/bparalleline.png b/app/doc/png.d/bparalleline.png Binary files differindex 43a6223..9e2f4dd 100644 --- a/app/doc/png.d/bparalleline.png +++ b/app/doc/png.d/bparalleline.png diff --git a/app/doc/png.d/bparam.png b/app/doc/png.d/bparam.png Binary files differnew file mode 100644 index 0000000..7e49dfc --- /dev/null +++ b/app/doc/png.d/bparam.png diff --git a/app/doc/png.d/bprint.png b/app/doc/png.d/bprint.png Binary files differnew file mode 100644 index 0000000..43a7c45 --- /dev/null +++ b/app/doc/png.d/bprint.png diff --git a/app/doc/png.d/brevert.png b/app/doc/png.d/brevert.png Binary files differnew file mode 100644 index 0000000..57f6d72 --- /dev/null +++ b/app/doc/png.d/brevert.png diff --git a/app/doc/png.d/broadbed.png b/app/doc/png.d/broadbed.png Binary files differnew file mode 100644 index 0000000..86325a0 --- /dev/null +++ b/app/doc/png.d/broadbed.png diff --git a/app/doc/png.d/brotate.png b/app/doc/png.d/brotate.png Binary files differindex db7b615..731b943 100644 --- a/app/doc/png.d/brotate.png +++ b/app/doc/png.d/brotate.png diff --git a/app/doc/png.d/bruler.png b/app/doc/png.d/bruler.png Binary files differindex a44a0c3..2d68473 100644 --- a/app/doc/png.d/bruler.png +++ b/app/doc/png.d/bruler.png diff --git a/app/doc/png.d/bsave.png b/app/doc/png.d/bsave.png Binary files differindex deb9d7c..8f3fca8 100644 --- a/app/doc/png.d/bsave.png +++ b/app/doc/png.d/bsave.png diff --git a/app/doc/png.d/bsaveas.png b/app/doc/png.d/bsaveas.png Binary files differnew file mode 100644 index 0000000..534babd --- /dev/null +++ b/app/doc/png.d/bsaveas.png diff --git a/app/doc/png.d/bselect.png b/app/doc/png.d/bselect.png Binary files differindex f980d62..1768915 100644 --- a/app/doc/png.d/bselect.png +++ b/app/doc/png.d/bselect.png diff --git a/app/doc/png.d/bsensor.png b/app/doc/png.d/bsensor.png Binary files differindex c573757..deeed57 100644 --- a/app/doc/png.d/bsensor.png +++ b/app/doc/png.d/bsensor.png diff --git a/app/doc/png.d/bsetup.png b/app/doc/png.d/bsetup.png Binary files differnew file mode 100644 index 0000000..7aa4289 --- /dev/null +++ b/app/doc/png.d/bsetup.png diff --git a/app/doc/png.d/bsignal.png b/app/doc/png.d/bsignal.png Binary files differindex a1c1ab0..ae853fc 100644 --- a/app/doc/png.d/bsignal.png +++ b/app/doc/png.d/bsignal.png diff --git a/app/doc/png.d/bsplit.png b/app/doc/png.d/bsplit.png Binary files differindex 7185efe..831596a 100644 --- a/app/doc/png.d/bsplit.png +++ b/app/doc/png.d/bsplit.png diff --git a/app/doc/png.d/bstraigh.png b/app/doc/png.d/bstraigh.png Binary files differindex 4c8aac6..2efe34d 100644 --- a/app/doc/png.d/bstraigh.png +++ b/app/doc/png.d/bstraigh.png diff --git a/app/doc/png.d/bstruct.png b/app/doc/png.d/bstruct.png Binary files differindex b361450..4930b4d 100644 --- a/app/doc/png.d/bstruct.png +++ b/app/doc/png.d/bstruct.png diff --git a/app/doc/png.d/bswitchmotor.png b/app/doc/png.d/bswitchmotor.png Binary files differindex 93333ae..169b2d2 100644 --- a/app/doc/png.d/bswitchmotor.png +++ b/app/doc/png.d/bswitchmotor.png diff --git a/app/doc/png.d/btext.png b/app/doc/png.d/btext.png Binary files differindex 530a18e..d4115d0 100644 --- a/app/doc/png.d/btext.png +++ b/app/doc/png.d/btext.png diff --git a/app/doc/png.d/bties.png b/app/doc/png.d/bties.png Binary files differnew file mode 100644 index 0000000..c2b50a2 --- /dev/null +++ b/app/doc/png.d/bties.png diff --git a/app/doc/png.d/btop_bottom.png b/app/doc/png.d/btop_bottom.png Binary files differindex d2fb217..ae8b2c6 100644 --- a/app/doc/png.d/btop_bottom.png +++ b/app/doc/png.d/btop_bottom.png diff --git a/app/doc/png.d/btrain.png b/app/doc/png.d/btrain.png Binary files differindex 2cdba2d..f84b19c 100644 --- a/app/doc/png.d/btrain.png +++ b/app/doc/png.d/btrain.png diff --git a/app/doc/png.d/btunnel.png b/app/doc/png.d/btunnel.png Binary files differindex d861dde..815663a 100644 --- a/app/doc/png.d/btunnel.png +++ b/app/doc/png.d/btunnel.png diff --git a/app/doc/png.d/bturnout.png b/app/doc/png.d/bturnout.png Binary files differindex f25a568..9789e5a 100644 --- a/app/doc/png.d/bturnout.png +++ b/app/doc/png.d/bturnout.png diff --git a/app/doc/png.d/bturntbl.png b/app/doc/png.d/bturntbl.png Binary files differindex 9f13800..d261bbb 100644 --- a/app/doc/png.d/bturntbl.png +++ b/app/doc/png.d/bturntbl.png diff --git a/app/doc/png.d/caritem.png b/app/doc/png.d/caritem.png Binary files differindex 3ba7dda..8eaf5a8 100644 --- a/app/doc/png.d/caritem.png +++ b/app/doc/png.d/caritem.png diff --git a/app/doc/png.d/carpart.png b/app/doc/png.d/carpart.png Binary files differindex ae54364..c720f20 100644 --- a/app/doc/png.d/carpart.png +++ b/app/doc/png.d/carpart.png diff --git a/app/doc/png.d/carproto.png b/app/doc/png.d/carproto.png Binary files differindex 0b3298f..548ac1e 100644 --- a/app/doc/png.d/carproto.png +++ b/app/doc/png.d/carproto.png diff --git a/app/doc/png.d/celev.png b/app/doc/png.d/celev.png Binary files differindex bf312ef..a2c91d8 100644 --- a/app/doc/png.d/celev.png +++ b/app/doc/png.d/celev.png diff --git a/app/doc/png.d/cgroup.png b/app/doc/png.d/cgroup.png Binary files differindex c42df49..7b7bffb 100644 --- a/app/doc/png.d/cgroup.png +++ b/app/doc/png.d/cgroup.png diff --git a/app/doc/png.d/colorw.png b/app/doc/png.d/colorw.png Binary files differindex 4d7fa91..a0acc32 100644 --- a/app/doc/png.d/colorw.png +++ b/app/doc/png.d/colorw.png diff --git a/app/doc/png.d/convertfrom.png b/app/doc/png.d/convertfrom.png Binary files differindex 9c16665..53b55e4 100644 --- a/app/doc/png.d/convertfrom.png +++ b/app/doc/png.d/convertfrom.png diff --git a/app/doc/png.d/convertto.png b/app/doc/png.d/convertto.png Binary files differindex bd70934..260bc1d 100644 --- a/app/doc/png.d/convertto.png +++ b/app/doc/png.d/convertto.png diff --git a/app/doc/png.d/custmgm.png b/app/doc/png.d/custmgm.png Binary files differindex acb04ae..778ecfb 100644 --- a/app/doc/png.d/custmgm.png +++ b/app/doc/png.d/custmgm.png diff --git a/app/doc/png.d/dbench.png b/app/doc/png.d/dbench.png Binary files differindex 862f162..594bb16 100644 --- a/app/doc/png.d/dbench.png +++ b/app/doc/png.d/dbench.png diff --git a/app/doc/png.d/dbezier.png b/app/doc/png.d/dbezier.png Binary files differindex 0a81063..ca40ccb 100644 --- a/app/doc/png.d/dbezier.png +++ b/app/doc/png.d/dbezier.png diff --git a/app/doc/png.d/dbox.png b/app/doc/png.d/dbox.png Binary files differindex 7f11d4c..e03fb33 100644 --- a/app/doc/png.d/dbox.png +++ b/app/doc/png.d/dbox.png diff --git a/app/doc/png.d/dcircle1.png b/app/doc/png.d/dcircle1.png Binary files differnew file mode 100644 index 0000000..745e044 --- /dev/null +++ b/app/doc/png.d/dcircle1.png diff --git a/app/doc/png.d/dcircle2.png b/app/doc/png.d/dcircle2.png Binary files differindex 9080eaf..d39c2e3 100644 --- a/app/doc/png.d/dcircle2.png +++ b/app/doc/png.d/dcircle2.png diff --git a/app/doc/png.d/dcircle3.png b/app/doc/png.d/dcircle3.png Binary files differindex 70a2d30..0676c52 100644 --- a/app/doc/png.d/dcircle3.png +++ b/app/doc/png.d/dcircle3.png diff --git a/app/doc/png.d/dcurve1.png b/app/doc/png.d/dcurve1.png Binary files differindex c0ca63b..66361ba 100644 --- a/app/doc/png.d/dcurve1.png +++ b/app/doc/png.d/dcurve1.png diff --git a/app/doc/png.d/dcurve2.png b/app/doc/png.d/dcurve2.png Binary files differindex 7a4f75d..9c6a21d 100644 --- a/app/doc/png.d/dcurve2.png +++ b/app/doc/png.d/dcurve2.png diff --git a/app/doc/png.d/dcurve3.png b/app/doc/png.d/dcurve3.png Binary files differindex a68aebf..fea2ba3 100644 --- a/app/doc/png.d/dcurve3.png +++ b/app/doc/png.d/dcurve3.png diff --git a/app/doc/png.d/dcurve4.png b/app/doc/png.d/dcurve4.png Binary files differindex d337fa1..408a308 100644 --- a/app/doc/png.d/dcurve4.png +++ b/app/doc/png.d/dcurve4.png diff --git a/app/doc/png.d/ddimlin.png b/app/doc/png.d/ddimlin.png Binary files differindex adc471d..49d9488 100644 --- a/app/doc/png.d/ddimlin.png +++ b/app/doc/png.d/ddimlin.png diff --git a/app/doc/png.d/dentermove.png b/app/doc/png.d/dentermove.png Binary files differnew file mode 100644 index 0000000..1ec8b34 --- /dev/null +++ b/app/doc/png.d/dentermove.png diff --git a/app/doc/png.d/dfilbox.png b/app/doc/png.d/dfilbox.png Binary files differindex 4e75f0b..d20421c 100644 --- a/app/doc/png.d/dfilbox.png +++ b/app/doc/png.d/dfilbox.png diff --git a/app/doc/png.d/dfilpoly.png b/app/doc/png.d/dfilpoly.png Binary files differindex 36893ad..d714dab 100644 --- a/app/doc/png.d/dfilpoly.png +++ b/app/doc/png.d/dfilpoly.png diff --git a/app/doc/png.d/dflcrcl2.png b/app/doc/png.d/dflcrcl2.png Binary files differindex cd57434..0e9e1f7 100644 --- a/app/doc/png.d/dflcrcl2.png +++ b/app/doc/png.d/dflcrcl2.png diff --git a/app/doc/png.d/dflcrcl3.png b/app/doc/png.d/dflcrcl3.png Binary files differindex 34942cd..c702428 100644 --- a/app/doc/png.d/dflcrcl3.png +++ b/app/doc/png.d/dflcrcl3.png diff --git a/app/doc/png.d/dlayer.png b/app/doc/png.d/dlayer.png Binary files differdeleted file mode 100644 index ebb5be7..0000000 --- a/app/doc/png.d/dlayer.png +++ /dev/null diff --git a/app/doc/png.d/dlayers.png b/app/doc/png.d/dlayers.png Binary files differindex 923787c..200ef81 100644 --- a/app/doc/png.d/dlayers.png +++ b/app/doc/png.d/dlayers.png diff --git a/app/doc/png.d/dline.png b/app/doc/png.d/dline.png Binary files differindex 11ad69f..2f4c996 100644 --- a/app/doc/png.d/dline.png +++ b/app/doc/png.d/dline.png diff --git a/app/doc/png.d/dpoly.png b/app/doc/png.d/dpoly.png Binary files differindex 7998634..577983e 100644 --- a/app/doc/png.d/dpoly.png +++ b/app/doc/png.d/dpoly.png diff --git a/app/doc/png.d/dpolylin.png b/app/doc/png.d/dpolylin.png Binary files differnew file mode 100644 index 0000000..d66cd2b --- /dev/null +++ b/app/doc/png.d/dpolylin.png diff --git a/app/doc/png.d/dprmfile.png b/app/doc/png.d/dprmfile.png Binary files differindex ba5170a..189695c 100644 --- a/app/doc/png.d/dprmfile.png +++ b/app/doc/png.d/dprmfile.png diff --git a/app/doc/png.d/dproperties.png b/app/doc/png.d/dproperties.png Binary files differindex 0938437..8ad79f2 100644 --- a/app/doc/png.d/dproperties.png +++ b/app/doc/png.d/dproperties.png diff --git a/app/doc/png.d/dtbledge.png b/app/doc/png.d/dtbledge.png Binary files differindex 52eb1ed..3f8e019 100644 --- a/app/doc/png.d/dtbledge.png +++ b/app/doc/png.d/dtbledge.png diff --git a/app/doc/png.d/easew.png b/app/doc/png.d/easew.png Binary files differindex cc71900..fe8f950 100644 --- a/app/doc/png.d/easew.png +++ b/app/doc/png.d/easew.png diff --git a/app/doc/png.d/exportfile.png b/app/doc/png.d/exportfile.png Binary files differindex 0608fba..a6132a8 100644 --- a/app/doc/png.d/exportfile.png +++ b/app/doc/png.d/exportfile.png diff --git a/app/doc/png.d/exportfiledxf.png b/app/doc/png.d/exportfiledxf.png Binary files differindex 7612fba..9b6dbf0 100644 --- a/app/doc/png.d/exportfiledxf.png +++ b/app/doc/png.d/exportfiledxf.png diff --git a/app/doc/png.d/exportfilesvg.png b/app/doc/png.d/exportfilesvg.png Binary files differnew file mode 100644 index 0000000..89d3919 --- /dev/null +++ b/app/doc/png.d/exportfilesvg.png diff --git a/app/doc/png.d/grid.png b/app/doc/png.d/grid.png Binary files differindex 8771cd2..f84971d 100644 --- a/app/doc/png.d/grid.png +++ b/app/doc/png.d/grid.png diff --git a/app/doc/png.d/iconlink.PNG b/app/doc/png.d/iconlink.png Binary files differindex 0f189e2..0f189e2 100644 --- a/app/doc/png.d/iconlink.PNG +++ b/app/doc/png.d/iconlink.png diff --git a/app/doc/png.d/import.png b/app/doc/png.d/import.png Binary files differindex e68363e..3dfeb4b 100644 --- a/app/doc/png.d/import.png +++ b/app/doc/png.d/import.png diff --git a/app/doc/png.d/importmod.png b/app/doc/png.d/importmod.png Binary files differnew file mode 100644 index 0000000..64b2807 --- /dev/null +++ b/app/doc/png.d/importmod.png diff --git a/app/doc/png.d/madd.png b/app/doc/png.d/madd.png Binary files differindex bde4a7f..7acde07 100644 --- a/app/doc/png.d/madd.png +++ b/app/doc/png.d/madd.png diff --git a/app/doc/png.d/map.png b/app/doc/png.d/map.png Binary files differindex 6400bf1..e784dfa 100644 --- a/app/doc/png.d/map.png +++ b/app/doc/png.d/map.png diff --git a/app/doc/png.d/mchange.png b/app/doc/png.d/mchange.png Binary files differindex e09079c..65bebe5 100644 --- a/app/doc/png.d/mchange.png +++ b/app/doc/png.d/mchange.png diff --git a/app/doc/png.d/medit.png b/app/doc/png.d/medit.png Binary files differindex 2ffa681..ccb7858 100644 --- a/app/doc/png.d/medit.png +++ b/app/doc/png.d/medit.png diff --git a/app/doc/png.d/mentermove.png b/app/doc/png.d/mentermove.png Binary files differnew file mode 100644 index 0000000..42dcb54 --- /dev/null +++ b/app/doc/png.d/mentermove.png diff --git a/app/doc/png.d/mhelp.png b/app/doc/png.d/mhelp.png Binary files differindex 158657e..512677b 100644 --- a/app/doc/png.d/mhelp.png +++ b/app/doc/png.d/mhelp.png diff --git a/app/doc/png.d/mrotatevariable.png b/app/doc/png.d/mrotatevariable.png Binary files differnew file mode 100644 index 0000000..9a7744b --- /dev/null +++ b/app/doc/png.d/mrotatevariable.png diff --git a/app/doc/png.d/mselectcmd.png b/app/doc/png.d/mselectcmd.png Binary files differindex 07a4c20..464a88a 100644 --- a/app/doc/png.d/mselectcmd.png +++ b/app/doc/png.d/mselectcmd.png diff --git a/app/doc/png.d/mselectcontext.png b/app/doc/png.d/mselectcontext.png Binary files differindex fe6a34c..814d78d 100644 --- a/app/doc/png.d/mselectcontext.png +++ b/app/doc/png.d/mselectcontext.png diff --git a/app/doc/png.d/mtoolbar.png b/app/doc/png.d/mtoolbar.png Binary files differdeleted file mode 100644 index e54424e..0000000 --- a/app/doc/png.d/mtoolbar.png +++ /dev/null diff --git a/app/doc/png.d/mtrainmanagement.png b/app/doc/png.d/mtrainmanagement.png Binary files differindex 0ffa218..3878bab 100644 --- a/app/doc/png.d/mtrainmanagement.png +++ b/app/doc/png.d/mtrainmanagement.png diff --git a/app/doc/png.d/mview.png b/app/doc/png.d/mview.png Binary files differindex 61fff8c..f379845 100644 --- a/app/doc/png.d/mview.png +++ b/app/doc/png.d/mview.png diff --git a/app/doc/png.d/pan.png b/app/doc/png.d/pan.png Binary files differindex 653ee4d..d4ebd72 100644 --- a/app/doc/png.d/pan.png +++ b/app/doc/png.d/pan.png diff --git a/app/doc/png.d/paramsearch.png b/app/doc/png.d/paramsearch.png Binary files differindex 2aca111..7cb061c 100644 --- a/app/doc/png.d/paramsearch.png +++ b/app/doc/png.d/paramsearch.png diff --git a/app/doc/png.d/pref.png b/app/doc/png.d/pref.png Binary files differindex 57940a6..5da4aa3 100644 --- a/app/doc/png.d/pref.png +++ b/app/doc/png.d/pref.png diff --git a/app/doc/png.d/print.png b/app/doc/png.d/print.png Binary files differindex e8a6863..60ce46a 100644 --- a/app/doc/png.d/print.png +++ b/app/doc/png.d/print.png diff --git a/app/doc/png.d/problemdata.png b/app/doc/png.d/problemdata.png Binary files differnew file mode 100644 index 0000000..fccde93 --- /dev/null +++ b/app/doc/png.d/problemdata.png diff --git a/app/doc/png.d/statusbarparallel.png b/app/doc/png.d/statusbarparallel.png Binary files differindex 0ab73a5..f55e596 100644 --- a/app/doc/png.d/statusbarparallel.png +++ b/app/doc/png.d/statusbarparallel.png diff --git a/app/doc/png.d/statustext.png b/app/doc/png.d/statustext.png Binary files differindex ac9fc02..dfa20ae 100644 --- a/app/doc/png.d/statustext.png +++ b/app/doc/png.d/statustext.png diff --git a/app/doc/png.d/strsel.png b/app/doc/png.d/strsel.png Binary files differindex bcc43f2..403d33f 100644 --- a/app/doc/png.d/strsel.png +++ b/app/doc/png.d/strsel.png diff --git a/app/doc/png.d/toolbopt.png b/app/doc/png.d/toolbopt.png Binary files differnew file mode 100644 index 0000000..2fbd650 --- /dev/null +++ b/app/doc/png.d/toolbopt.png diff --git a/app/doc/png.d/turnsel.png b/app/doc/png.d/turnsel.png Binary files differindex b2e1b6d..60d8ff3 100644 --- a/app/doc/png.d/turnsel.png +++ b/app/doc/png.d/turnsel.png diff --git a/app/doc/view_winm.but b/app/doc/view_winm.but index f814c3f..50005a9 100644 --- a/app/doc/view_winm.but +++ b/app/doc/view_winm.but @@ -26,19 +26,19 @@ The \f{View Menu} shows commands affecting the display of the \f{Main Canvas} (\ \u000 -\dd \f{Show Snap-Grid} - Toggles display of the \f{Snap Grid} on and off. +\dd \f{Show Snap-Grid} - \I{Snap Grid} Toggles display of the \f{Snap Grid} on and off. \u000 -\dd \f{Magnetic Snap On/Off} - Toggles Magnets (\K{cmdMagneticSnap}) for Add Operations on and off. The magnets make tracks auto-align and shapes touch when the cursor or object is close. They can be defeated on each operation by holding down \e{Alt}. If the Magnets are off, holding down \e{Alt} will enable them. +\dd \f{Magnetic Snap On/Off} - Toggles \i{Magnetic Snap} (\K{cmdMagneticSnap}) for Add Operations on and off. The magnets make tracks auto-align and shapes touch when the cursor or object is close. They can be defeated on each operation by holding down \e{Alt}. If the Magnets are off, holding down \e{Alt} will enable them. \u000 -\dd \G{png.d/bmap.png} \f{ Show/Hide Map} - Toggles display of the \f{Map Window} on and off. +\dd \G{png.d/bmap.png} \f{ Show/Hide Map} - Toggles display of the \f{Map Window} \I{Map Window} on and off. \u000 -\dd \f{Tool-bar} - Command button groups displayed on the \f{Tool-bar} are selected using the Tool-bar Configuration Menu (\K{toolbarM}). +\dd \f{Toolbar Options} - Command button groups displayed on the \f{Toolbar} are selected using the Toolbar Options Dialog (\K{toolbarOpts}). \u000 @@ -84,7 +84,7 @@ This enables snapping to be inhibited for a single part of an operation (or conv \rule -\S{cmdGrid} Grid Dialog +\S{cmdGrid} \i{Grid Dialog} The \f{Grid} dialog, displayed by \f{Change Grid} on the View (\K{viewM}) menu, specifies the origin, angle and other parameters of the Snap Grid. The Snap Grid can sbe used to snap the position of the cursor during the \f{Curve} (\K{cmdCurve}), \f{Circle} (\K{cmdCircle}), \f{Cornu} (\K{cmdCornu}), \f{Modify} (\K{cmdModify}), \f{Straight} (\K{cmdStraight}), \f{Draw} (\K{cmdDraw}) and \f{Turntable} (\K{cmdTurntable}) commands. @@ -125,11 +125,12 @@ Whether the Snap Grid is drawn is controlled by the \f{Show} check-box. Also, i \rule -\S{toolbarM}Tool-bar Configuration +\S{toolbarOpts} \i{Toolbar Options} -\G{png.d/mtoolbar.png} +\G{png.d/toolbopt.png} -Command button groups displayed on the \f{Tool-bar} are selected using the Tool-bar Configuration Menu (\K{toolbarM}). If none of the command button groups are selected, the \f{Tool-bar} is not shown. +Command button groups displayed on the \f{Toolbar} are selected using the Toolbar Options Dialog (\K{toolbarOpts}). If none of the command button groups are selected, the \f{Toolbar} is not shown. +\f{Select All} quickly selects all button groups for display. \f{Invert} inverts the current selection eg. displayed groups will be switched off and vice versa. \rule @@ -177,8 +178,7 @@ Pressing the middle Zoom button on the Tool Bar pop-ups a list of Zoom factors t \u000 -\dd The Pan function can be accessed using the Mouse Wheel with \e{Shift} of the \e{Mouse Middle Button}. Adding \e{Ctrl} as well as \e{Shift} chnages Up to Left and Down to Right. -Pan Left and Right can also be driven by the Horizontal Mouse Wheel (if available) or the Scroll Left/Right Guestures (if mapped by the Operating System). +\dd See \f{Main Window Overview} (\K{mainW}) for details on how to \f{Pan} the \f{Main Canvas}. \rule @@ -199,4 +199,4 @@ The \f{Window Menu} typically contains selections for bringing any open window i \dd Apart from bringing the \f{Map Window} (\K{cmdMap}) to the foreground, the \f{Map} menu item can also be used to re-opened a closed \f{Map Window}. -\rule
\ No newline at end of file +\rule diff --git a/app/doc/warranty.but b/app/doc/warranty.but index d52b7fa..7502c38 100644 --- a/app/doc/warranty.but +++ b/app/doc/warranty.but @@ -10,7 +10,7 @@ covered by the Creative Commons Attribution-ShareAlike 2.5 License Agreement. \rule -\H{warranty} Warranty +\H{warranty} \i{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. @@ -24,14 +24,14 @@ covered by the Creative Commons Attribution-ShareAlike 2.5 License Agreement. \e{XTrackCAD} is \XTCCopyRight and licensed as free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. -You should have received a copy of the GNU General Public License along with this program; see the file named COPYING or refer to \K{GNUGPLicense}. If not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +You should have received a copy of the GNU General Public License along with this program; see the file named COPYING or refer to \K{GNUGPLicense}. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA \e{XTrackCAD} Fork is a project for further development of the original \e{XTrackCAD} software. Refer to the project homepage at http://www.xtrkcad.org/ for news and current releases. \rule -\H{GNUGPLicense} \ii{GNU General Public License} +\H{GNUGPLicense} \ii{GNU General Public License} \i{License} \dd GNU GENERAL PUBLIC LICENSE @@ -41,13 +41,13 @@ You should have received a copy of the GNU General Public License along with thi \dd Copyright (C) 1989, 1991 Free Software Foundation, Inc. -\dd 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +\dd 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. \e{Preamble} -The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it @@ -149,6 +149,64 @@ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE \f{END OF TERMS AND CONDITIONS} +\f{How to Apply These Terms to Your New Programs} + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + +\dd <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> + +\u000 + +\dd This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + +\u000 + +\dd This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +\u000 + +\dd You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + +\dd Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + +\dd Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + +\u000 + +\dd <signature of Ty Coon>, 1 April 1989 + +\u000 + +\dd Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + \rule \H{Contributions} \ii{Contributions} |
