index.tmpl
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1" /> 7 <title>LinuxCNC</title> 8 <link rel="stylesheet" type="text/css" href="index.css" /> 9 <script type="text/javascript"> 10 //<![CDATA[ 11 var sections = [['sec0', 'sec1', 'sec2', 'sec3', 'sec4', 'sec5', 'sec6', 12 'sec7', 'sec8', 'sec9', 'sec10','sec11','sec12','sec13', 'sec14', 'sec15'], 13 ['man_1', 'man_9','man_3hal', 'man_3rtapi', 'man_3hm2', 'man_3']]; 14 15 function storeOK() { // Check for HTML5 Local Storage 16 try { 17 return 'localStorage' in window && window['localStorage'] !== null; 18 } catch (e) { 19 return false; 20 } 21 } 22 23 function toggle(sec){ 24 var e = document.getElementById(sec); 25 var i = document.getElementById(sec + '_image'); 26 if(!e)return true; 27 if(e.style.display=="none"){ 28 e.style.display="block" 29 i.src = 'minus.png'; 30 if (storeOK()){localStorage.setItem(sec, "block");} 31 } 32 else { 33 e.style.display="none" 34 i.src = 'plus.png'; 35 if (storeOK()){localStorage.setItem(sec, "none");} 36 } 37 return false; 38 } 39 40 function toggle_section(a){ 41 if (a.id.substring(0,3) === "doc"){var s = 0;} 42 if (a.id.substring(0,3) === "man"){var s = 1;} 43 if (a.value.substring(0,6) === "Expand"){ 44 for (var i in sections[s]){ 45 document.getElementById(sections[s][i]).style.display = 'block'; 46 document.getElementById(sections[s][i] + '_image').src = 'minus.png'; 47 if (storeOK()){localStorage.setItem(sections[s][i], "block");} 48 } 49 } 50 else{ 51 for (var i in sections[s]){ 52 document.getElementById(sections[s][i]).style.display = 'none'; 53 document.getElementById(sections[s][i] + '_image').src = 'plus.png'; 54 if (storeOK()){localStorage.setItem(sections[s][i], "none");} 55 } 56 } 57 } 58 59 function setup_page(){ 60 for (var s in sections){ 61 for (var i in sections[s]){ 62 if (localStorage.getItem(sections[s][i]) != null){ 63 if (localStorage.getItem(sections[s][i]) === "block"){ 64 document.getElementById(sections[s][i]).style.display = 'block'; 65 document.getElementById(sections[s][i] + '_image').src = 'minus.png'; 66 } 67 else{ 68 document.getElementById(sections[s][i]).style.display = 'none'; 69 document.getElementById(sections[s][i] + '_image').src = 'plus.png'; 70 } 71 } 72 else{ 73 document.getElementById(sections[s][i]).style.display = 'none'; 74 document.getElementById(sections[s][i] + '_image').src = 'plus.png'; 75 } 76 } 77 } 78 } 79 //]]> 80 </script> 81 </head> 82 <body onload="return setup_page()"> 83 84 <!-- Even though this template file will open in a browser do not open it in a browser it to test changes 85 open the /html/index.html file in your browser after building the documents 86 If this is the .html file do not edit it, edit the .tmpl file then build the documents --> 87 <div style="text-align: center"> 88 <img src="linuxcnc-logo-chips.png" alt="LinuxCNC Logo" width="175"/> 89 </div> 90 91 <h3>LinuxCNC version <strong>@VERSION@</strong></h3> 92 93 <div style="margin-top: 0em; margin-bottom: 1em; line-height: 150%"> 94 <p>Translated Documents <a href="index_es.html">Español</a> * 95 <a href="index_fr.html">Français</a></p> 96 <p><a href="http://linuxcnc.org">LinuxCNC Home Page</a> * 97 <a href="http://wiki.linuxcnc.org/cgi-bin/wiki.pl">Wiki Community</a> * 98 <a href="gcode.html">G Code Quick Reference</a></p> 99 </div> 100 <p><input type="button" id="docExpand" value="Expand Documents" onclick="return toggle_section(this);"/> 101 <input type="button" id="docCollapse" value="Collapse Documents" onclick="return toggle_section(this);"/></p> 102 <p><a onclick="return toggle('sec0')"><img id="sec0_image" src="plus.png" alt="plus" style="border:0; margin-right:5px; vertical-align:middle;"/>Getting Started with LinuxCNC</a></p> 103 104 <div id="sec0"> 105 <ul> 106 <li><a href="getting-started/about-linuxcnc.html">About LinuxCNC</a></li> 107 <li><a href="getting-started/system-requirements.html">System Requirements</a></li> 108 <li><a href="getting-started/getting-linuxcnc.html">Getting LinuxCNC</a></li> 109 <li><a href="getting-started/running-linuxcnc.html">Configuration Launcher</a></li> 110 <li><a href="getting-started/updating-linuxcnc.html">Updating LinuxCNC</a></li> 111 <li><a href="common/linux-faq.html">Linux FAQ</a></li> 112 </ul> 113 </div> 114 115 <p><a onclick="return toggle('sec1')"><img id="sec1_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Configuration Wizards</a></p> 116 <div id="sec1"> 117 <ul> 118 <li><a class="tooltips" href="config/stepconf.html">Stepconf, Parallel Port Stepper Configurator</a></li> 119 <li><a class="tooltips" href="config/pncconf.html">Pncconf, Mesa Hardware Configurator</a></li> 120 </ul> 121 </div> 122 123 <p><a onclick="return toggle('sec2')"><img id="sec2_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>General User Information</a></p> 124 <div id="sec2"> 125 <ul> 126 <li><a href="user/user-foreword.html">User Foreword</a></li> 127 <li><a href="user/user-intro.html">LinuxCNC User Introduction</a></li> 128 <li><a href="user/user-concepts.html">Important User Concepts</a></li> 129 <li><a href="user/starting-linuxcnc.html">Starting LinuxCNC</a></li> 130 <li><a href="gcode/machining-center.html">CNC Machine Overview</a></li> 131 <li><a href="lathe/lathe-user.html">Lathe User Information</a></li> 132 <li><a href="plasma/plasma-cnc-primer.html">Plasma CNC Primer</a></li> 133 </ul> 134 </div> 135 136 <p><a onclick="return toggle('sec3')"><img id="sec3_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>User Interfaces</a></p> 137 <div id="sec3"> 138 <ul> 139 <li><a href="gui/axis.html">Axis, Keyboard GUI</a></li> 140 <li><a href="gui/gmoccapy.html">Gmoccapy, Touchscreen GUI</a> <a href="gui/gmoccapy-hu.html"> hu(Magyar)</a></li> 141 <li><a href="gui/touchy.html">Touchy, Touchscreen GUI</a></li> 142 <li><a href="gui/gscreen.html">Gscreen, Customizable Touchscreen GUI</a></li> 143 <li><a href="gui/ngcgui.html">NGCGUI, Subroutine GUI</a></li> 144 <li><a href="gui/tklinuxcnc.html">TkLinuxCNC, (no opengl) GUI</a></li> 145 <li><a href="plasma/plasmac-user-guide.html">PlasmaC, A Complete Plasma Cutting Configuration</a></li> 146 </ul> 147 </div> 148 149 <p><a onclick="return toggle('sec4')"><img id="sec4_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>G code Programming</a></p> 150 <div id="sec4"> 151 <ul> 152 <li><a href="gcode/coordinates.html">Coordinate System</a></li> 153 <li><a href="gcode/tool-compensation.html">Tool Compensation</a></li> 154 <li><a href="gui/tooledit.html">Tool Table Editor</a></li> 155 <li><a href="gcode/overview.html">G Code Overview</a></li> 156 <li><a href="gcode/g-code.html">G Codes</a></li> 157 <li><a href="gcode/m-code.html">M Codes</a></li> 158 <li><a href="gcode/o-code.html">O Codes</a></li> 159 <li><a href="gcode/other-code.html">Other Codes</a></li> 160 <li><a href="examples/gcode.html">G Code Examples</a></li> 161 <li><a href="gui/image-to-gcode.html">Image to G Code</a></li> 162 <li><a href="gcode/rs274ngc.html">RS274/NGC Differences</a></li> 163 </ul> 164 </div> 165 166 <p><a onclick="return toggle('sec5')"><img id="sec5_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Configuration</a></p> 167 <div id="sec5"> 168 <ul> 169 <li><a href="config/integrator-concepts.html">Integrator Concepts</a></li> 170 <li><a href="install/latency-test.html">Latency Test</a></li> 171 <li><a href="motion/tweaking-steppers.html">Stepper Tuning</a></li> 172 <li><a href="config/ini-config.html">INI Configuration</a></li> 173 <li><a href="config/ini-homing.html">Homing Configuration</a></li> 174 <li><a href="config/lathe-config.html">Lathe Configuration</a></li> 175 <li><a href="config/stepper-quickstart.html">Stepper Quick Start</a></li> 176 <li><a href="config/stepper.html">Stepper Configuration</a></li> 177 <li><a href="config/stepper-diagnostics.html">Stepper Diagnostics</a></li> 178 </ul> 179 </div> 180 181 <p><a onclick="return toggle('sec6')"><img id="sec6_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Virtual Control Panels</a></p> 182 <div id="sec6"> 183 <ul> 184 <li><a href="gui/pyvcp.html">Python Virtual Control Panel</a></li> 185 <li><a href="gui/pyvcp-examples.html">PyVCP Examples</a></li> 186 <li><a href="gui/gladevcp.html">Glade Virtual Control Panel</a></li> 187 <li><a href="gui/gscreen.html">Gscreen</a></li> 188 <li><a href="gui/qtvcp.html">QTvcp</a></li> 189 <li><a href="gui/qtvcp_widgets.html">QTvcp -widgets</a></li> 190 <li><a href="gui/qtvcp_libraries.html">QTvcp -libraries</a></li> 191 <li><a href="gui/qtvcp_custom_widgets.html">QTvcp -Custom Widgets</a></li> 192 <li><a href="gui/qtvcp_code_snippets.html">QTvcp -Code Snippets</a></li> 193 <li><a href="gui/qtvcp_development.html">QTvcp -Development</a></li> 194 </ul> 195 </div> 196 197 <p><a onclick="return toggle('sec7')"><img id="sec7_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>User Interface Programming</a></p> 198 <div id="sec7"> 199 <ul> 200 <li><a href="gui/panelui.html">Panelui</a></li> 201 <li><a class="tooltips" href="gui/halui.html">HALUI, Hardware Abstract Layer User Interface</a></li> 202 <li><a href="hal/halui-examples.html">HALUI examples</a></li> 203 <li><a href="config/python-interface.html">Python Interface</a></li> 204 <li><a href="gui/GStat.html">GStat Module</a></li> 205 <li><a href="gui/vismach.html">Vismach Virtual Machines</a></li> 206 </ul> 207 </div> 208 209 <p><a onclick="return toggle('sec8')"><img id="sec8_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Hardware Drivers</a></p> 210 <div id="sec8"> 211 <ul> 212 <li><a href="hal/parallel-port.html">Parallel Port Driver</a></li> 213 <li><a href="drivers/ax5214h.html">AX5214H Driver</a></li> 214 <li><a href="drivers/gm.html">General Mechatronics GM6-PCI Driver</a></li> 215 <li><a href="drivers/gs2.html">GS2 Driver</a></li> 216 <li><a href="drivers/hostmot2.html">Mesa HostMot2 Driver</a></li> 217 <li><a href="drivers/motenc.html">Motenc Driver</a></li> 218 <li><a href="drivers/mb2hal.html">Modbus to HAL Driver</a></li> 219 <li><a href="drivers/opto22.html">Opto22 Driver</a></li> 220 <li><a href="drivers/pico-ppmc.html">Pico Drivers</a></li> 221 <li><a href="drivers/pluto-p.html">Pluto P Driver</a></li> 222 <li><a href="drivers/servo-to-go.html">Servo To Go Driver</a></li> 223 <li><a href="drivers/shuttle.html">ShuttleXpress and ShuttlePRO Driver</a></li> 224 <li><a href="drivers/vfs11.html">VFS11 Driver</a></li> 225 <li><a href="drivers/mitsub_vfd.html">Mitsubishi VFD Driver</a></li> 226 </ul> 227 </div> 228 229 <p><a onclick="return toggle('sec9')"><img id="sec9_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Classicladder</a></p> 230 <div id="sec9"> 231 Classicladder is a software PLC (Programmable Logic Controller) built 232 into LinuxCNC. 233 <ul> 234 <li><a href="ladder/ladder-intro.html">Classicladder Introduction</a></li> 235 <li><a href="ladder/classic-ladder.html">ClassicLadder Programming</a></li> 236 <li><a href="ladder/ladder-examples.html">ClassicLadder Examples</a></li> 237 </ul> 238 </div> 239 240 <p><a onclick="return toggle('sec10')"><img id="sec10_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Hardware Examples</a></p> 241 <div id="sec10"> 242 <ul> 243 <li><a href="examples/pci-parallel-port.html">PCI Parallel Port Example</a></li> 244 <li><a href="examples/spindle.html">Spindle Control Example</a></li> 245 <li><a href="examples/mpg.html">MPG Example</a></li> 246 <li><a href="examples/gs2-example.html">GS2 Example</a></li> 247 </ul> 248 </div> 249 250 <p><a onclick="return toggle('sec11')"><img id="sec11_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>HAL (Hardware Abstraction Layer)</a></p> 251 <div id="sec11"> 252 <ul> 253 <li><a href="hal/intro.html">HAL Introduction</a></li> 254 <li><a href="hal/basic-hal.html">Basic HAL Tutorial</a></li> 255 <li><a href="hal/twopass.html">HAL Twopass</a></li> 256 <li><a href="hal/tutorial.html">Advanced HAL Tutorial</a></li> 257 <li><a href="config/core-components.html">Core HAL Components</a></li> 258 <li><a href="hal/components.html">HAL Component List</a></li> 259 <li><a href="hal/rtcomps.html">HAL Component Descriptions</a></li> 260 <li><a href="hal/halshow.html">Halshow</a></li> 261 <li><a href="hal/hal-examples.html">HAL Examples</a></li> 262 <li><a href="hal/comp.html">HAL Component Generator</a></li> 263 <li><a href="hal/haltcl.html">HAL TCL Files</a></li> 264 <li><a href="hal/halmodule.html">Creating Userspace Python Components</a></li> 265 <li><a href="hal/canonical-devices.html">Canonical Device Interfaces</a></li> 266 <li><a href="hal/tools.html">HAL Tools</a></li> 267 </ul> 268 </div> 269 270 <p><a onclick="return toggle('sec12')"><img id="sec12_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Advanced Topics</a></p> 271 <div id="sec12"> 272 <ul> 273 <li><a href="motion/kinematics.html">Kinematics</a></li> 274 <li><a href="motion/5-axis-kinematics.html">5-Axis-Kinematics</a></li> 275 <li><a href="motion/pid-theory.html">PID theory</a></li> 276 <li><a href="remap/remap.html">Remap: Extending LinuxCNC</a></li> 277 <li><a href="config/moveoff.html">Moveoff Component</a></li> 278 <li><a href="code/rs274.html">Stand Alone Interpreter</a></li> 279 <li><a href="motion/external-offsets.html">External Offsets</a></li> 280 </ul> 281 </div> 282 283 <p><a onclick="return toggle('sec13')"><img id="sec13_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Integrator Information</a></p> 284 <div id="sec13"> 285 <ul> 286 <li><a href="integrator/steppers.html">Stepper Information</a></li> 287 <li><a href="integrator/stepper-timing.html">Stepper Drive Timing</a></li> 288 <li><a href="integrator/wiring.html">Best Wiring Practices</a></li> 289 </ul> 290 </div> 291 292 <p><a onclick="return toggle('sec14')"><img id="sec14_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Developer Information</a></p> 293 <div id="sec14"> 294 <ul> 295 <li><a href="hal/general-ref.html">General Reference</a></li> 296 <li><a href="code/code-notes.html">Code Notes</a></li> 297 <li><a href="code/nml-messages.html">NML Messages</a></li> 298 <li><a href="code/style-guide.html">Style Guide</a></li> 299 <li><a href="code/adding-configs.html">Adding Configs for Selection</a></li> 300 <li><a href="code/contributing-to-linuxcnc.html">Contributing to LinuxCNC</a></li> 301 <li><a href="code/building-linuxcnc.html">Building LinuxCNC</a></li> 302 </ul> 303 </div> 304 305 <p><a onclick="return toggle('sec15')"><img id="sec15_image" src="plus.png" alt="plus" style="border:0;margin-right:5px;vertical-align:middle;"/>Glossary, Copyright, History & Overview</a></p> 306 <div id="sec15"> 307 <ul> 308 <li><a href="common/overleaf.html">LinuxCNC Document Overview</a></li> 309 <li><a href="common/emc-history.html">LinuxCNC History</a></li> 310 <li><a href="common/glossary.html">Glossary</a></li> 311 <li><a href="common/gpld-copyright.html">Copyright & Documentation License</a></li> 312 </ul> 313 </div> 314 315 <h3>Man Pages</h3> 316 <div style="margin-top: 0em; margin-bottom: 1em; line-height: 150%"> 317 <p>For more information about man pages see the <a href="common/linux-faq.html">Linux FAQ</a></p> 318 </div> 319 <p><input type="button" id="manExpand" value="Expand Man Pages" onclick="return toggle_section(this);"/> 320 <input type="button" id="manCollapse" value="Collapse Man Pages" onclick="return toggle_section(this);"/></p>