On 1/7/2012 7:28 AM, John Thornton wrote: > Hi Kent, > > Are you reading the HTML or the PDF? The HTML is easier to convey which > file your reading and that makes it much easier to find and fix any > errors. Thanks for proof reading them. > > Thanks > John >
Hi, John. Once again I'm in the position for apologizing for my herky-jerky interaction but this weekend I hope to catch up with myself. To begin, I took your advice and switched to reading the HTML first. I'll be sending messages to you and the emc-developers list concerning each "manual" starting with the HAL manual (which I needed to read for another reason). 1) Call me Mr. Anal-Retentive, but I like consistency in what we call things. The docs sometimes but not always use EMC and EMC2 interchangeably along with variations in u/l-case. In most cases, this probably doesn't matter. I'll try to identify any confusing cases as I go along. Mostly, I think this is a good issue for a style guide for future doc authors. Similarly, we have six different variations of "g code" (107), "g-code" (111), "G code" (25), "G-code" (294), "G Code" (142), and "G-Code" (95). The numbers in parentheses are the number of occurrences I found in the .txt files (all languages). I doubt these variations confuse most readers and wouldn't fix the existing files until everything else is done. However, this is a another good issue for a style guide. 2) Not counting the man pages and RTAPI call listings, there are exactly and approximately 78 individual HTML files linked to from index.html (looking at docweb today). I compared the titles given in the links in index.html to the titles given in the HTML files themselves. Only about 1/3 are the same. The remainder differ from a little to a lot. I'm not sure what to recommend here. Sometimes I like the link title and sometimes the HTML title. I do think they should be reconciled. Presumably in the PDF docs, the section titles will be drawn from the same source text that created the HTML titles so there is reason to be sure we like the titles in the files. Here is my accounting (the following is set in fixed width in my mail client. I hope the formatting doesn't get too chewed up.) Link Title HTML file Title Heading G Code quick reference EMC2 "G-Code" Quick Reference *Getting Started (Manual)* System Requirements Computer Getting EMC2 About EMC2 Updating EMC2 Upgrading EMC2 Stepper Quickstart Stepper Configuration Stepper Configuration Wizard Stepconf Wizard Point and Click Configuration Wizard (Mesa) Mesa Wizard Copy and Run Running EMC2 Linux FAQ Linux FAQ *User Manual* Foreword Foreword Introduction EMC2 User Introduction Important User Concepts User Concepts GUI: Axis Axis GUI: Touchy Touchy NGCGUI NGCGUI GUI: TkEMC TkEMC GUI: Mini Mini GUI: Keystick Keystick Machining Center Info CNC Machine Overview Coordinates Coordinate System Tool Compensation Tool Compensation Gcode Overview G Code Overview G-Codes G Codes M-Codes M Codes O-Codes O Codes Other Codes Other Codes Gcode Examples G-Code Examples Lathe User Information Lathe Specifics Image to Gcode Image-to-gcode RS-274NGC Gcode RS274NGC Programs *Integrator Manual* Important Integrator Concepts Important Concepts Latency Test Latency Test Startup Options Starting EMC2 INI Configuration INI File Homing Configuration Homing Configuration Lathe Configuration Lathe Core Components Core Components Stepper Configuration Stepper Configuration Python Virtual Control Panels (pyVCP) PyVCP pyVCP Examples PyVCP Examples Glade Virtual Control Panel Glade VCP HALUI Pin Reference HAL User Interface Parallel Port Drivers Parallel Port AX5214H Driver AX5214H GS2 Driver GS2 VFD HostMot2 Driver Mesa HostMot2 Motenc Driver Motenc Opto22 Driver Opto22 PCI Pico PPMC Driver Pico PPMC Pluto-P Driver Pluto-P Servo-To-Go Driver Servo-To-Go Kinematics Kinematics Tweaking Steppers Stepper Tuning PID theory PID Tuning Ladder Introduction Ladder Programming ClassicLadder Classic Ladder ClassicLadder Examples Ladder Examples PCI Parallel Port Second Parallel Port Spindle Example Spindle Control MPG Example MPG Pendant GS2 Example GS2 Spindle *HAL Manual* Introduction HAL Introduction Basic HAL Info Basic HAL HAL Advanced Tutorial HAL Tutorial Canonical Devices Canonical Device Interfaces General Reference General Reference Information HAL Tools HAL Tools and Utilities Halshow Halshow HAL Components HAL Components Realtime Components Realtime Comps HAL Examples HAL Examples Creating HAL components with Comp Creating HAL components with Comp Creating Userspace Python Components Userspace HAL Components *Developer Manual* Code Notes Code Notes NML Messages NML Messages Style Guide Coding Style *Cross Reference, Glossary, Copyright* Cross Reference Index ?linked file is missing? Glossary Glossary Copyright and Documentation License Legal Section Regards, Kent ------------------------------------------------------------------------------ RSA(R) Conference 2012 Mar 27 - Feb 2 Save $400 by Jan. 27 Register now! http://p.sf.net/sfu/rsa-sfdev2dev2 _______________________________________________ Emc-developers mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/emc-developers
