summaryrefslogtreecommitdiffstats
path: root/spec.html
blob: a8b8a7dd33a021d5f4fe9defdab0d05a6dd99dab (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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <meta name="generator" content="pandoc" />
  <title></title>
  <style type="text/css">code{white-space: pre;}

svg line,
svg path,
svg circle {
  stroke: #000;
}
svg circle {
  fill: #000;
} 

  </style>
</head>
<body>
<h2 id="svgbob-specification">Svgbob specification</h2>
<p>Svgbob is a diagramming model which uses common typing characters to approximate the shape</p>
<table>
<thead>
<tr class="header">
<th>characters</th>
<th>names</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>-</code></td>
<td>dash, hypen, minus</td>
<td>for horizontal lines</td>
</tr>
<tr class="even">
<td><code>_</code></td>
<td>underscore</td>
<td>for horizontal lines</td>
</tr>
<tr class="odd">
<td><code>\|</code></td>
<td>pipe, or</td>
<td>for vertical lines</td>
</tr>
<tr class="even">
<td><code>/</code></td>
<td>forward slash</td>
<td>for lines slanted to the right</td>
</tr>
<tr class="odd">
<td><code>\\</code></td>
<td>backslash</td>
<td>for lines slanted to the left</td>
</tr>
<tr class="even">
<td><code>+</code></td>
<td>plus, add, cross</td>
<td>for sharp intersection</td>
</tr>
<tr class="odd">
<td><code>.</code></td>
<td>dot, period</td>
<td>for rounded corner intersection</td>
</tr>
<tr class="even">
<td><code>,</code></td>
<td>comma</td>
<td>for rounded corner intersection</td>
</tr>
<tr class="odd">
<td><code>'</code></td>
<td>single quote</td>
<td>for rounded corner intersection</td>
</tr>
<tr class="even">
<td><code>`</code></td>
<td>backtick</td>
<td>for rounded corner intersection</td>
</tr>
<tr class="odd">
<td><code>(</code></td>
<td>open parenthesis</td>
<td>rounded side of an arc</td>
</tr>
<tr class="even">
<td><code>)</code></td>
<td>close parenthesis</td>
<td>rounded side of an arc</td>
</tr>
<tr class="odd">
<td><code>[</code></td>
<td>open braces</td>
<td>rectangular corner</td>
</tr>
<tr class="even">
<td><code>]</code></td>
<td>close braces</td>
<td>rectangular corner</td>
</tr>
<tr class="odd">
<td><code>*</code></td>
<td>asterisk</td>
<td>for emphasized intersection</td>
</tr>
<tr class="even">
<td><code>o</code></td>
<td>lowercase letter <code>o</code></td>
<td>for intersection</td>
</tr>
<tr class="odd">
<td><code>O</code></td>
<td>uppercase letter <code>O</code></td>
<td>for intersection</td>
</tr>
<tr class="even">
<td><code>^</code></td>
<td>caret</td>
<td>for arrow up</td>
</tr>
<tr class="odd">
<td><code>v</code></td>
<td>lowercase letter <code>v</code></td>
<td>for arrow down</td>
</tr>
<tr class="even">
<td><code>V</code></td>
<td>lowercase letter <code>V</code></td>
<td>for arrow down</td>
</tr>
<tr class="odd">
<td><code>&lt;</code></td>
<td>lesser than</td>
<td>for arrow left</td>
</tr>
<tr class="even">
<td><code>&gt;</code></td>
<td>greater than</td>
<td>for arrow right</td>
</tr>
<tr class="odd">
<td><code>=</code></td>
<td>equal sign</td>
<td>for double horizontal line</td>
</tr>
<tr class="even">
<td><code>x</code></td>
<td>lowercase letter <code>x</code></td>
<td>for intersection</td>
</tr>
<tr class="odd">
<td><code>X</code></td>
<td>uppercase letter <code>X</code></td>
<td>for intersection</td>
</tr>
</tbody>
</table>
<h2 id="principle">Principle</h2>
<p>The rendered shape should closely resembles to that of the ascii drawing / formation.</p>
<h2 id="non-goals">Non-goals</h2>
<p>The goal is NOT to be able to make graphs and diagrams with less effort.</p>
<h2 id="default-sizes">Default sizes</h2>
<p>Text height is 2 times the text width, both should be a multiple of 4.</p>
<p>Default values: - text width = 8px; - text height = 16px;</p>
<table style="width:26%;">
<colgroup>
<col width="26%" />
</colgroup>
<tbody>
<tr class="odd">
<td>## Horizontal line <code>-</code> - if next to an alphanumeric character it will be rendered as text. - if next to another drawing character, it will be rendered as a line. - if alone it will be rendered as a line.</td>
</tr>
<tr class="even">
<td><strong>Example 1:</strong></td>
</tr>
<tr class="odd">
<td>|text | svg |rendered |------|---------------------------------------|-------------- |<code>-</code> |<code>&lt;line x1=&quot;0&quot; y1=&quot;8&quot; x2=&quot;8&quot; y2=&quot;8&quot;/&gt;</code> |<svg width="16" height="8"><line x1="0" y1="8" x2="8" y2="8"/></svg> |<code>--</code> |<code>&lt;line x1=&quot;0&quot; y1=&quot;8&quot; x2=&quot;16&quot; y2=&quot;8&quot;/&gt;</code> |<svg width="16" height="16"><line x1="0" y1="8" x2="16" y2="8"/></svg> |<code>----</code>|<code>&lt;line x1=&quot;0&quot; y1=&quot;8&quot; x2=&quot;32&quot; y2=&quot;8&quot;/&gt;</code> |<svg width="32" height="16"><line x1="0" y1="8" x2="32" y2="8"/></svg></td>
</tr>
<tr class="even">
<td><strong>Example 3:</strong> Next to an alphanumeric character</td>
</tr>
<tr class="odd">
<td>|text |svg |rendered |------|------------------------------|------- |<code>1-</code> |<code>&lt;text x=&quot;2&quot; y=&quot;12&quot;&gt;1-&lt;/text&gt;</code>|<svg width="32" height="16"><text x="2" y="12">1-</text></svg> |<code>-a</code> |<code>&lt;text x=&quot;2&quot; y=&quot;12&quot;&gt;-a&lt;/text&gt;</code>|<svg width="32" height="16"><text x="2" y="12">-a</text></svg></td>
</tr>
<tr class="even">
<td><strong>Example 4:</strong> Used together with text</td>
</tr>
<tr class="odd">
<td>|text |svg |rendered |-----------|-------------------------------------|---------- |<code>opt-in</code> |<code>&lt;text x=&quot;2&quot; y=&quot;12&quot;&gt;opt-in&lt;/text&gt;</code> |<svg width="48" height="16"><text x="2" y="12">opt-in</text></svg> |<code>chat-room</code>|<code>&lt;text x=&quot;2&quot; y=&quot;12&quot;&gt;chat-room&lt;/text&gt;</code>|<svg width="144" height="16"><text x="2" y="12">chat-room</text></svg></td>
</tr>
</tbody>
</table>
<h2 id="verti