blob: 8379172ff170f7740ab5ac06794ff0cf6c834b43 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
This document is a guide for using asciidoc markup
Master Document file Headers, first line replace en with two letter language code
---------------------------------------------------------------------------------
:lversion: {sys: cat ../VERSION}
Getting Started V{lversion}, {localdate}
=================================
:lang: en
:masterdir: {indir}
:leveloffset: 1
The EMC Team
The parameters are interpreted well before the load files lang-xx.conf and the other files .conf
It is particularly important for the parameters as :lang:
The typical authorized attributes : doctype, lang, encoding, icons, data-uri, toc, numbered
More information here
http://www.methods.co.nz/asciidoc/userguide.html#_introduction
8.2 Header
Titles
======
= Document Title (level 0) = Note: level 0 can only be once per file!
== Section title (level 1) == Note: trailing delimiter is optional.
=== Section title (level 2) ===
Links
=====
[[anchor]]
<<anchor,caption>>
Example
[[sub:torpodeos]]
<<sub:torpodeos,bombs>>
only bombs will show in the text with an underline so always provide a caption for a link
Listing Block for G Code and terminal output
============================================
---- < 4 dashes start of block
lines of code
...
more code
---- < 4 dashes end of block
< 1 blank line after
Literal blocks
==============
.... < 4 periods start the block
literal block
will show up
just as you type it.
.... < 4 periods end the block
< 1 blank line after
Lists
=====
* bullet
** bullet
. numbered
.. numbered
List Item Continuation
* List item paragaph one
continued with a single plus hard left.
+
List item one continued
with a second paragraph
and first line of second paragraph must be hard left.
HAL pins and parameters use the following format for consistency
* 'parport.<p>.pin-<n>-out' (bit) Drives a physical output pin.
bulleted list with the pin name emphasized by surrounding it with
single quotes.
Images
======
put all images in the images subdirectory
image::<target>[<attributes>]
example
image::images/axis.png[]
image::images/tiger.png["Tiger image",align="center"]
If the image is small and displays too big in the pdf you can
use the scaledwidth="60%" attribute
Inline Images
=============
Same as images except only one : is used and no attributes are used between
the []
My text has an image in it image:images/axisbutton.png[]
Figures
=======
Use the following format for figures so any links to the anchor will move to
correct place. Only create a link to a figure if it is somewhere else and not
the next thing you see when scrolling down. Just say something like "in the
following figure..."
[[fig:Parport-block-diag]]
.Parport Block Diagram
image::images/parport-block-diag.png[align="center"]
Notes and Warnings
==================
Inline example
NOTE: This is an example note.
Paragraph example
[NOTE]
This is an example note of the
paragraph style.
Styles include
NOTE TIP IMPORTANT WARNING CAUTION
Escaping a character
====================
Normally characters like ' and * would not print unless you use \' or \* then
they will print as normal characters.
Making a horizontal labeled list.
[horizontal]
Label:: The text about the label
Latexmath is broken at the moment and trashes the HTML. A work around is to use open office math
to create the math image and gimp to screen capture and save to a png.
check asciidoc cheatsheet http://powerman.name/doc/asciidoc or user manual
http://www.methods.co.nz/asciidoc/userguide.html for details about format.
|
