Skip to content

Commit

Permalink
docs: fix gcode asciidoc markup
Browse files Browse the repository at this point in the history
Before this commit, the g-code.html document lacks a document <title>.
Looks like asciidoc needs the document title on the first line of the
txt input.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
  • Loading branch information
SebKuzminsky committed Oct 6, 2016
1 parent 94873cb commit ebc38ef
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/src/gcode/g-code.txt
@@ -1,6 +1,5 @@
[[cha:g-codes]] (((G Codes)))

= G Codes
[[cha:g-codes]] (((G Codes)))

:ini: {basebackend@docbook:'':ini}
:hal: {basebackend@docbook:'':hal}
Expand Down

4 comments on commit ebc38ef

@tseufl
Copy link
Contributor

@tseufl tseufl commented on ebc38ef Oct 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SebKuzminsky
there are many more in the web (without title) I saw a few days ago.
Manual editing is a lot of work ...

http://linuxcnc.org/docs/2.4/html/common_Stepper_Diagnostics_fr.html
http://linuxcnc.org/docs/2.7/html/common/linux-faq.html
http://linuxcnc.org/docs/2.2/html/hal_pyvcp.html
http://linuxcnc.org/docs/2.3/html/common_Stepper_Diagnostics_fr.html
http://linuxcnc.org/docs/2.3/html/hal_pyvcp_fr.html
http://linuxcnc.org/docs/2.7/html/getting-started/running-linuxcnc.html
http://linuxcnc.org/docs/2.7/html/user/user-concepts.html
http://linuxcnc.org/docs/2.7/html/gcode/machining-center.html
http://linuxcnc.org/docs/2.7/html/lathe/lathe-user.html
http://linuxcnc.org/docs/2.7/html/gui/ngcgui.html
http://linuxcnc.org/docs/2.7/html/examples/gcode.html
http://linuxcnc.org/docs/2.7/html/gcode/rs274ngc.html
http://linuxcnc.org/docs/2.7/html/install/latency-test.html
http://linuxcnc.org/docs/2.7/html/config/stepper-quickstart.html
http://linuxcnc.org/docs/2.7/html/config/stepper.html
http://linuxcnc.org/docs/2.7/html/hal/halui-examples.html
http://linuxcnc.org/docs/2.7/html/hal/parallel-port.html
http://linuxcnc.org/docs/2.7/html/drivers/ax5214h.html
http://linuxcnc.org/docs/2.7/html/drivers/gm.html
http://linuxcnc.org/docs/2.7/html/examples/pci-parallel-port.html
http://linuxcnc.org/docs/2.7/html/examples/mpg.html
http://linuxcnc.org/docs/2.7/html/examples/gs2-example.html
http://linuxcnc.org/docs/2.7/html/hal/twopass.html
http://linuxcnc.org/docs/2.7/html/hal/tutorial.html
http://linuxcnc.org/docs/2.7/html/hal/halshow.html
http://linuxcnc.org/docs/2.7/html/hal/haltcl.html
http://linuxcnc.org/docs/2.7/html/motion/kinematics.html
http://linuxcnc.org/docs/2.7/html/common/overleaf.html
http://linuxcnc.org/docs/2.2/html/config_stepper_fr.html
http://linuxcnc.org/docs/2.3/html/common_integrator_intro.html
http://linuxcnc.org/docs/2.2/html/common_integrator_intro.html
http://linuxcnc.org/docs/2.2/html/hal_components.html
http://linuxcnc.org/docs/devel/html/getting-started/system-requirements.html
http://linuxcnc.org/docs/devel/html/getting-started/running-linuxcnc.html
http://linuxcnc.org/docs/devel/html/getting-started/updating-linuxcnc.html
http://linuxcnc.org/docs/devel/html/user/user-foreword.html
http://linuxcnc.org/docs/devel/html/user/user-intro.html
http://linuxcnc.org/docs/devel/html/user/user-concepts.html
http://linuxcnc.org/docs/devel/html/lathe/lathe-user.html
http://linuxcnc.org/docs/devel/html/gui/axis.html
http://linuxcnc.org/docs/devel/html/gui/gmoccapy.html
http://linuxcnc.org/docs/devel/html/gui/touchy.html
http://linuxcnc.org/docs/devel/html/gui/tklinuxcnc.html
http://linuxcnc.org/docs/devel/html/gcode/o-code.html
http://linuxcnc.org/docs/devel/html/gcode/other-code.html
http://linuxcnc.org/docs/devel/html/examples/gcode.html
http://linuxcnc.org/docs/devel/html/gui/image-to-gcode.html
http://linuxcnc.org/docs/devel/html/gcode/rs274ngc.html
http://linuxcnc.org/docs/devel/html/config/integrator-concepts.html
http://linuxcnc.org/docs/devel/html/config/stepper-quickstart.html
http://linuxcnc.org/docs/devel/html/config/stepper.html
http://linuxcnc.org/docs/devel/html/hal/halui-examples.html
http://linuxcnc.org/docs/devel/html/config/python-interface.html
http://linuxcnc.org/docs/devel/html/gui/vismach.html
http://linuxcnc.org/docs/devel/html/hal/parallel-port.html
http://linuxcnc.org/docs/devel/html/drivers/ax5214h.html
http://linuxcnc.org/docs/devel/html/drivers/gm.html
http://linuxcnc.org/docs/devel/html/drivers/gs2.html
http://linuxcnc.org/docs/devel/html/drivers/motenc.html
http://linuxcnc.org/docs/devel/html/drivers/mb2hal.html
http://linuxcnc.org/docs/devel/html/drivers/opto22.html
http://linuxcnc.org/docs/devel/html/drivers/pico-ppmc.html
http://linuxcnc.org/docs/devel/html/drivers/pluto-p.html
http://linuxcnc.org/docs/devel/html/drivers/shuttle.html
http://linuxcnc.org/docs/devel/html/ladder/ladder-intro.html
http://linuxcnc.org/docs/devel/html/examples/pci-parallel-port.html
http://linuxcnc.org/docs/devel/html/examples/gs2-example.html
http://linuxcnc.org/docs/devel/html/hal/intro.html
http://linuxcnc.org/docs/devel/html/hal/twopass.html
http://linuxcnc.org/docs/devel/html/hal/halshow.html
http://linuxcnc.org/docs/devel/html/hal/hal-examples.html
http://linuxcnc.org/docs/devel/html/hal/comp.html
http://linuxcnc.org/docs/devel/html/hal/haltcl.html
http://linuxcnc.org/docs/devel/html/hal/halmodule.html
http://linuxcnc.org/docs/devel/html/motion/kinematics.html
http://linuxcnc.org/docs/devel/html/motion/5-axis-kinematics.html
http://linuxcnc.org/docs/devel/html/code/rs274.html
http://linuxcnc.org/docs/devel/html/common/overleaf.html
http://linuxcnc.org/docs/devel/html/common/emc-history.html
http://linuxcnc.org/docs/devel/html/ladder/ladder_examples_fr.html
http://linuxcnc.org/docs/devel/html/common/overleaf_fr.html
http://linuxcnc.org/docs/2.6/html/ladder/ladder_examples_fr.html
http://linuxcnc.org/docs/2.6/html/common/overleaf_fr.html
http://linuxcnc.org/docs/2.5/html/ladder/ladder_examples_fr.html
http://linuxcnc.org/docs/2.5/html/common/overleaf_fr.html
http://linuxcnc.org/docs/2.3/html/common_integrator_intro_fr.html
http://linuxcnc.org/docs/2.7/html/ladder/ladder_examples_fr.html
http://linuxcnc.org/docs/2.7/html/common/overleaf_fr.html

@tseufl
Copy link
Contributor

@tseufl tseufl commented on ebc38ef Oct 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SebKuzminsky
This update creates a new problem ...
Look at the pictures
g-code cha
g-code cha_source


In this page there is no problem and the page is displayed on the web correctly with title:
-> src: https://github.com/LinuxCNC/linuxcnc/blob/master/docs/src/hal/canonical-devices.txt
-> web: http://linuxcnc.org/docs/2.7/html/hal/canonical-devices.html
The [[anchor]] is set, but (((xxx))) is not used.
The [[anchor]] apparently not to be the problem. (((xxx))) appears to produce the problem.

AsciiDoc User Guide:
(http://www.methods.co.nz/asciidoc/userguide.html#_indexes)
??? note: Index entries only really make sense if you are generating DocBook markup — DocBook conversion programs automatically generate an index at the point an Index section appears in source document. ???

@SebKuzminsky
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! That g-code.html bug is fixed in 2.7 now.

The rest of the problems you pointed out in 2.7 should be fixed in the seb/2.7/asciidoc-fixes branch. Preview docs will show up here in the next few hours: http://buildbot.linuxcnc.org/doc/

The problems in older branches will not get fixed (at least by me).

@tseufl
Copy link
Contributor

@tseufl tseufl commented on ebc38ef Oct 9, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.