On 3/24/14 02:00 , Francis Tisserant wrote:
> fix some broken links
>
> Signed-off-by: Francis Tisserant <ti...@free.fr>
>
>
> http://git.linuxcnc.org/?p=linuxcnc.git;a=commitdiff;h=0aceb27

Hi Francis, thanks for all your work on the docs (French and others).

The only feedback i have is about an asciidoc syntax issue i ran in to 
last year and did not publicize well: anchors must be on the line before 
the section heading they describe, or the html gets kind of messed up.

I think maybe you already know this - you often make the right syntax, 
like this:

> --- a/docs/src/config/emc2hal_es.txt
> +++ b/docs/src/config/emc2hal_es.txt
> @@ -17,7 +17,8 @@ Make sure the documents build after translating.
>
>   See also the man pages 'motion(9)'.
>
> -== Motion [[sec:motion]]
> +[[sec:motion]]
> +== Motion


I only bring it up because sometimes you preserve the old, pre-existing 
incorrect syntax, even when fixing bugs there, like this:

> -=== [TRAJ] Section [[sub:traj-section]]
> +=== [TRAJ] Section [[sub:[TRAJ]-section]]


This is not that big a deal, it only affects the html anchor names, and 
it causes some browsers to take you to the line after the heading 
instead of the heading itself, which can be a bit confusing.  The old, 
buggy syntax is all over our docs.

Thanks again for all the work you're doing on the docs, it's much 
appreciated.


-- 
Sebastian Kuzminsky

------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/13534_NeoTech
_______________________________________________
Emc-developers mailing list
Emc-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/emc-developers

Reply via email to