Discussion of EMC docs

More
12 Sep 2011 20:04 #13136 by cmorley
In the developers mail-list there has been a discussion of the state of the docs for 2.5.

See here for HTML of all available docs 2.2 -master
www.linuxcnc.org/docs/

I would like to hear from users about their opinion of what is good or bad, helpful or misleading.
The 2.5 currently have been reorganized and IMHO need some work ( it is a work in progress)

What docs do people typically or actually, look at?

Please Log in or Create an account to join the conversation.

More
12 Sep 2011 20:17 - 12 Sep 2011 20:18 #13137 by BigJohnT
Replied by BigJohnT on topic Re:Discussion of EMC docs
Hi Chris,

I'd like to see:

Quick Start / Getting Started as it is now focused on downloading, installing, and wizards.

User Manual focused on GUI's and their use and user concepts that need to be known before running a CNC machine.

Integrator Manual focused on information needed when building/configuring a machine.
Halscope would make more sense in the Integrators manual than in the HAL manual.
All the components should be in the Integrators manual.

G-Code Reference Manual that covers G-Code and programming ngc files.

Using HAL (without EMC) focused on command line and stand alone use of HAL.

What I look at once a machine is up and running is the G-Code and not much else.

My Penny
John
Last edit: 12 Sep 2011 20:18 by BigJohnT.

Please Log in or Create an account to join the conversation.

More
12 Sep 2011 21:05 #13142 by cmorley
Replied by cmorley on topic Re:Discussion of EMC docs
I quite agree with you and I think this is rough what you had for 2.4
it's a little hard to know because the HTML and PDF are organized differently.
(I'm looking at the HTML I kinda hate PDF)

I guess we should define what the different manuals are for (all MHO here):

getting started
- This would be for a new user coming with no linux background but likely MACH 3 experience (meaning using some MACH terminology and explaining EMC's equivalent term would be helpful)
- it should discuss what EMC is capable of in broad terms
- should discuss the different hardware choices in broad terms ( this divides fairly nicely to steppers and servos or parallel port and hardware card.
- talk about homing and limit switches as I think most MACH users don't use these and can't understand why we do
- the two Wizards for configuration in detail
- might talk of installing different buildbot versions of EMC - I think I would leave compiling discussions to the integrator manual.
- promote the WIKI IRC and forum for information - the strengths and weakness of each.
- written without a lot of geeky type wording but at the same time introducing some important terminology
User manual
- all GUI's in detail as far as using them little or nothing about HAL connections in them that should be for the integrators manual
- maybe the Gcodes and programming in here?

Integrators
-This ends up mostly about HAL and how other components connect to HAL
this probably needs a larger discussion then i have time to write at the moment
-discuss compiling EMC

developers
- talk about standards for such things as new GUI's connecttion to HAL (EG loading postgui_halfile)
-component naming conventions

thats good for a staring conversation - I think it's important to write it down.
opinions?

Please Log in or Create an account to join the conversation.

More
12 Sep 2011 21:14 #13143 by BigJohnT
Replied by BigJohnT on topic Re:Discussion of EMC docs
The only pain I have now with the 2.4 docs is wading through the User Manual to get to the G-Codes, that is why I think it should be separate PDF document.

I would not bring Mach into the manuals at all. If anything a wiki page for converting from Mach to EMC.

John

Please Log in or Create an account to join the conversation.

More
12 Sep 2011 23:56 #13147 by cmorley
Replied by cmorley on topic Re:Discussion of EMC docs
I meant just some of the MACH terms (screens vrs GUI) nothing big.
but it may be unnecessary. If they are willing to go from MACH to EMC then they are willing to learn the new terms straight away.
not gonna give those MACH guys an inch hey John :)

Please Log in or Create an account to join the conversation.

More
13 Sep 2011 06:08 #13150 by step4linux
good idea Chris to bring this up here.

Just two quick comments out of my head:
getting started:
- As this is mainly for beginners (?), build-bot might be confusing
generally:
- haven't seen too much about gladeVCP

I will review actual docs and hopefully come back with more comments.

Gerd

Please Log in or Create an account to join the conversation.

More
13 Sep 2011 08:36 #13155 by cmorley
Replied by cmorley on topic Re:Discussion of EMC docs
getting started - yes for beginners - yes you may be right about build bot but then again i think more then a few use an unreleased version of EMC
and this is the easiest way to get it.

lots about gladevcp :
www.linuxcnc.org/docs/2.5/html/gui/gladevcp.html

Please Log in or Create an account to join the conversation.

More
13 Sep 2011 09:38 #13156 by step4linux
another question:
was there any attempt up to now to create a german translation ?

Please Log in or Create an account to join the conversation.

More
13 Sep 2011 11:57 #13161 by BigJohnT
Replied by BigJohnT on topic Re:Discussion of EMC docs
Seems to be some translations in Deutsch, Español, and Français here...

www.linuxcnc.org/docview/2.5/html/

Don't know how they are done... or if they are correct.

John

Please Log in or Create an account to join the conversation.

More
13 Sep 2011 12:00 #13162 by BigJohnT
Replied by BigJohnT on topic Re:Discussion of EMC docs
step4linux wrote:

- haven't seen too much about gladeVCP


GladeVCP would only be in the 2.5 docs

www.linuxcnc.org/docview/2.5/html/

John

Please Log in or Create an account to join the conversation.

Time to create page: 0.081 seconds
Powered by Kunena Forum