Gentle persons:
This message covers editorial issues I found reviewing the HTML files on
http://www.linuxcnc.org/docs/2.5/ concerning the (English) HAL manual.
In this email I shall call them parts. I have titled my comments on each
part according to the link title in index.html and given the linked-to
HTML file name in parentheses
---
System Requirements (...)
Getting EMC2 (...)
Updating EMC2 (...)
Nothing jumps out at me in these parts.
---
Stepper Quickstart (stepper/stepper_quickstart.html)
In section 4. Machine Information, the link to http://wiki.linuxcnc.org
is malformed (sorry, I overlooked this on in my previous message).
The source text reads <a href="">http://wiki.linuxcnc.org</a>
The URL should be repeated between the quotation marks.
---
Stepper Configuration Wizard (config/stepconf.html)
Two figures showing the wiring for NC and NO switches are missing. (The
HTML page I'm looking at was Last updated 2012-01-07 10:36:05 CDT).
---
<http://www.linuxcnc.org/docs/2.5/html/config/pncconf.html>Point and
Click Configuration Wizard (Mesa) (config/pncconf.html)
This is tough part to review since I have no relevant cards or
experience to draw on.
In section 4. Basic Machine Information under "Computer Response Time"
the word hiccup is misspelled "hicup". (See, I had to find something.
I've probably missed others here and elsewhere so I'm not going to get
all shirty about it:-) )
In section 8. Axis Configuration under "Open Loop Test" there is mention
of "Machinery Handbook standards" and later on in this section there is
reference to "Machinists handbook". I presume these are both references
to the "Machinery's Handbook" published by Industrial Press. We need
better attribution (e.g., a full footnote?) to it. I just browsed my
26th edition of the Handbook and believe this section is talking about
the section "axis nomenclature" in the chapter "Numerical Control".
In the same section under "From the manual" the typography for the
described procedure seems a bit odd. As I read it, the first step in the
procedure is denoted by a "bullet" while the remainder are denoted by
"1.", "2.", "3." Maybe I just don't understand but shouldn't they be
steps 1-4? Also, what does it mean to say "From the manual"? What
manual? There are several rather ambiguous references to manuals in the
part.
In a number of places in this part the word "it's" (which means "it is")
is used in the sense of a possessive and should be "its". Similarly, in
at least one place "its" is used in the sense of "it is" and should be
"it's".How's that for true nitpicking?
---
Copy and Run (...)
No comments.
---
Linux FAQ (common/Linux_FAQ.html)
The first sentence is a little awkward. I would change "new to Linux
user" to "user new to Linux".
Sections 1, 2, and 3 seem to mix and match different styles to indicate
walking down a pull-down menu. Do we say, for example,
"Applications/CNC/EMC2" or "Applications, CNC, EMC2" (my personal
favorite is to write "Applications > CNC > EMC2")?
In section 6.4 Finding a File the description of the find command is
misleading. Find automatically searches the directory tree rooted at the
given file name. The "-L" option directs it to follow symbolic links in
so doing.
I could quibble about what isn't said in section 6.5 Searching for Text
and the use of the "-r" option but it gets complicated in a hurry.
---
That's all she wrote.
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
Emc-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-developers
