-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
458 lines (456 loc) · 33.9 KB
/
index.html
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.16">
<title>Up and Running With Collagen</title>
<link rel="stylesheet" href="./docs/styles/collagen.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="/docs/styles/syntax-theme.css">
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>Up and Running With Collagen</h1>
<div id="toc" class="toc2">
<div id="toctitle">Contents</div>
<ul class="sectlevel1">
<li><a href="#_introduction">Introduction</a></li>
<li><a href="#_using_collagen">Using Collagen</a>
<ul class="sectlevel2">
<li><a href="#_a_basic_example">A Basic Example</a></li>
<li><a href="#_a_more_complicated_example">A More Complicated Example</a></li>
<li><a href="#_memes">Memes</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Collagen is a program that takes as input a folder containing zero or more image files
(<code>.jpeg</code>, <code>.png</code>, etc.) and a JSON manifest file describing the layout of these images
along with SVG components such as shapes and text, and produces as output a single SVG
file with all assets embedded.</p>
</div>
<div class="paragraph">
<p>This allows a user to combine several graphics into a single file that can be displayed as an image without compromising on visual quality or file size.<sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_using_collagen">Using Collagen</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The input to Collagen is a folder containing at the very least a <code>collagen.json</code> manifest file describing the layout of the resulting SVG.
If the manifest specifies any image files (by their path relative to the folder), then those image files must also be present at the expected path in the folder.
An input folder satisfying these criteria will be referred to as a <em>skeleton</em>.</p>
</div>
<div class="sect2">
<h3 id="_a_basic_example">A Basic Example</h3>
<div class="paragraph">
<p>An example of a simple input-output pair is below.
Suppose you have the following simple skeleton at directory <code>example-01</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="text"><span></span>example-01
├── collagen.json
└── images
└── smiley.jpg</code></pre>
</div>
</div>
<div class="paragraph">
<p>Where <a href="tests/examples/kitty-nesting-smiley/skeleton/smiley/skeleton/images/smiley.jpg" target="_blank" rel="noopener"><code>images/smiley.jpg</code></a> is the following image (whose native size is 380×380 pixels):</p>
</div>
<div class="imageblock">
<div class="content">
<img src="tests/examples/kitty-nesting-smiley/skeleton/smiley/skeleton/images/smiley.jpg" alt="smiley" width="200px">
</div>
</div>
<div class="paragraph">
<p>And where <a href="tests/examples/kitty-nesting-smiley/skeleton/smiley/skeleton/collagen.json" target="_blank" rel="noopener"><code>collagen.json</code></a> contains the following:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>
<span class="tok-nt">"vars"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <i class="conum" data-value="1"></i><b>(1)</b>
<span class="tok-nt">"bubble_text"</span><span class="tok-p">:</span> <span class="tok-s2">"Collagen!!"</span><span class="tok-p">,</span>
<span class="tok-nt">"nose_color"</span><span class="tok-p">:</span> <span class="tok-s2">"#f00"</span><span class="tok-p">,</span>
<span class="tok-nt">"text_color"</span><span class="tok-p">:</span> <span class="tok-s2">"#000"</span>
<span class="tok-p">},</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"viewBox"</span><span class="tok-p">:</span> <span class="tok-s2">"0 0 500 400"</span> <span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"image_path"</span><span class="tok-p">:</span> <span class="tok-s2">"images/smiley.jpg"</span><span class="tok-p">,</span> <i class="conum" data-value="2"></i><b>(2)</b>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"transform"</span><span class="tok-p">:</span> <span class="tok-s2">"translate(0 100) scale(1.3)"</span> <span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"circle"</span><span class="tok-p">,</span> <i class="conum" data-value="3"></i><b>(3)</b>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"cx"</span><span class="tok-p">:</span> <span class="tok-mi">123</span><span class="tok-p">,</span>
<span class="tok-nt">"cy"</span><span class="tok-p">:</span> <span class="tok-mi">240</span><span class="tok-p">,</span>
<span class="tok-nt">"r"</span><span class="tok-p">:</span> <span class="tok-mi">15</span><span class="tok-p">,</span>
<span class="tok-nt">"fill"</span><span class="tok-p">:</span> <span class="tok-s2">"{nose_color}"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke"</span><span class="tok-p">:</span> <span class="tok-s2">"#000"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke-width"</span><span class="tok-p">:</span> <span class="tok-mi">3</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"path"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"d"</span><span class="tok-p">:</span> <span class="tok-s2">"M 230 140 L 265 120 A 100 40 0 1 0 235 110 Z"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke"</span><span class="tok-p">:</span> <span class="tok-s2">"#000"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke-width"</span><span class="tok-p">:</span> <span class="tok-mi">3</span><span class="tok-p">,</span>
<span class="tok-nt">"fill"</span><span class="tok-p">:</span> <span class="tok-s2">"#fff"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"text"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"{bubble_text}"</span><span class="tok-p">,</span> <i class="conum" data-value="4"></i><b>(4)</b>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-mi">250</span><span class="tok-p">,</span>
<span class="tok-nt">"y"</span><span class="tok-p">:</span> <span class="tok-mi">97</span><span class="tok-p">,</span>
<span class="tok-nt">"text-anchor"</span><span class="tok-p">:</span> <span class="tok-s2">"start"</span><span class="tok-p">,</span>
<span class="tok-nt">"dominant-baseline"</span><span class="tok-p">:</span> <span class="tok-s2">"top"</span><span class="tok-p">,</span>
<span class="tok-nt">"font-family"</span><span class="tok-p">:</span> <span class="tok-s2">"Impact"</span><span class="tok-p">,</span>
<span class="tok-nt">"font-size"</span><span class="tok-p">:</span> <span class="tok-mi">30</span><span class="tok-p">,</span>
<span class="tok-nt">"fill"</span><span class="tok-p">:</span> <span class="tok-s2">"{text_color}"</span>
<span class="tok-p">}</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>A dictionary of variables. In <code>text</code> and <code>attrs</code> values, variables enclosed in curly brackets will have their value substituted.
For example, if <code>vars</code> contains values for <code>dx</code> and <code>dy</code>, then a translation could be applied with <code>"transform": "translate({dx} {dy})"</code>.
If a child’s <code>vars</code> doesn’t contain a variable that the child needs the value of, the variable’s value will be looked up by walking up the list of ancestors until the root is reached (i.e., variable scopes are nested).</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>To include an image, just give its relative path.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Most other tags are specified with the <code>tag</code> field, which contains the name of the SVG tag to use.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>If a tag has a <code>text</code> field, the given text will be the content of the tag, as in <code><text>your text here</text></code>.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Then, running the following command:<sup class="footnote">[<a id="_footnoteref_2" class="footnote" href="#_footnotedef_2" title="View footnote.">2</a>]</sup></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>cargo run -- -i example-01 -o example-01.svg</code></pre>
</div>
</div>
<div class="paragraph">
<p>Will produce the following file, <a href="tests/examples/kitty-nesting-smiley/skeleton/smiley/out.svg" target="_blank" rel="noopener"><code>examples-01.svg</code></a>:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="tests/examples/kitty-nesting-smiley/skeleton/smiley/out.svg" alt="out" width="500">
</div>
</div>
<div class="paragraph">
<p>If you zoom in, you’ll see the smiley face’s pixels.
But because the nose and speech bubble are SVG elements (i.e., vector graphics, not raster) they look nice and smooth and crisp even when zoomed in.
That’s the whole point!
Perfectly precise vector graphics can coexist alongside raster graphics.
(This simple example shows just one image, but of course we could include arbitrarily many by simply adding more children of the form <code>{"image_path": <path>}</code>.)</p>
</div>
</div>
<div class="sect2">
<h3 id="_a_more_complicated_example">A More Complicated Example</h3>
<div class="paragraph">
<p>As we’ve seen, we can include raster images in skeletons; it would be silly if we couldn’t also include other skeletons!
Nested skeletons can be included by adding a child of the form <code>{"clgn_path": <path>}</code>.
(Whereas a standalone skeleton gets turned into a <code><svg></code> tag, a nested skeleton will reside in a <code><g></code> tag.)
Let’s include the above skeleton in another (and just for fun, let’s add a photo of a kitten (<a href="https://commons.wikimedia.org/w/index.php?title=File:Cute_grey_kitten.jpg&oldid=479136954" target="_blank" rel="noopener">source</a>) too, because why not):</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="text"><span></span>example-02
├── collagen.json
├── example-01
│ ├── collagen.json
│ └── images
│ └── smiley.jpg
└── kitty.jpg</code></pre>
</div>
</div>
<div class="paragraph">
<p>Where <a href="tests/examples/kitty-nesting-smiley/skeleton/collagen.json" target="_blank" rel="noopener"><code>example-02/collagen.json</code></a> is below:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"viewBox"</span><span class="tok-p">:</span> <span class="tok-s2">"0 0 300 250"</span> <span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"rect"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"10"</span><span class="tok-p">,</span>
<span class="tok-nt">"y"</span><span class="tok-p">:</span> <span class="tok-s2">"10"</span><span class="tok-p">,</span>
<span class="tok-nt">"width"</span><span class="tok-p">:</span> <span class="tok-s2">"275"</span><span class="tok-p">,</span>
<span class="tok-nt">"height"</span><span class="tok-p">:</span> <span class="tok-s2">"225"</span><span class="tok-p">,</span>
<span class="tok-nt">"fill"</span><span class="tok-p">:</span> <span class="tok-s2">"#ddd"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke"</span><span class="tok-p">:</span> <span class="tok-s2">"#00f"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke-width"</span><span class="tok-p">:</span> <span class="tok-s2">"10"</span><span class="tok-p">,</span>
<span class="tok-nt">"stroke-dasharray"</span><span class="tok-p">:</span> <span class="tok-s2">"10 10"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"g"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"transform"</span><span class="tok-p">:</span> <span class="tok-s2">"translate(50 25) scale(.5)"</span> <span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"clgn_path"</span><span class="tok-p">:</span> <span class="tok-s2">"./example-01"</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"image_path"</span><span class="tok-p">:</span> <span class="tok-s2">"./kitty.jpg"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"transform"</span><span class="tok-p">:</span> <span class="tok-s2">"translate(180 150) scale(.15)"</span> <span class="tok-p">}</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Here’s <a href="tests/examples/kitty-nesting-smiley/out.svg" target="_blank" rel="noopener">the result</a> when you run <code>cargo run -- -i example-02 -o example-02.svg</code>:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="tests/examples/kitty-nesting-smiley/out.svg" alt="out" width="600">
</div>
</div>
<div class="paragraph">
<p>So, as far as Collagen is concerned, skeletons act more or less the same as raster images, in the sense that the path is sufficient to include them.
The only difference is that the path to a skeleton child is given by the key <code>clgn_path</code> instead of <code>image_path</code>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_memes">Memes</h3>
<div class="paragraph">
<p>A format that makes it easy to place text on images?
Sounds like it would be perfect for memes.</p>
</div>
<div class="listingblock">
<div class="title"><a href="tests/examples/drake-user-specified-font/skeleton/collagen.json" target="_blank" rel="noopener"><code>example-03/collagen.json</code></a></div>
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"viewBox"</span><span class="tok-p">:</span> <span class="tok-s2">"0 0 800 650"</span> <span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"fonts"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"name"</span><span class="tok-p">:</span> <span class="tok-s2">"Impact"</span><span class="tok-p">,</span>
<span class="tok-nt">"path"</span><span class="tok-p">:</span> <span class="tok-s2">"./impact.woff2"</span> <i class="conum" data-value="1"></i><b>(1)</b>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"image_path"</span><span class="tok-p">:</span> <span class="tok-s2">"./drake-small.jpg"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"width"</span><span class="tok-p">:</span> <span class="tok-mi">800</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"vars"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-mi">550</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-mi">50</span>
<span class="tok-p">},</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"text"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"font-family"</span><span class="tok-p">:</span> <span class="tok-s2">"Impact"</span><span class="tok-p">,</span> <i class="conum" data-value="2"></i><b>(2)</b>
<span class="tok-nt">"font-size"</span><span class="tok-p">:</span> <span class="tok-mi">50</span><span class="tok-p">,</span>
<span class="tok-nt">"color"</span><span class="tok-p">:</span> <span class="tok-s2">"black"</span><span class="tok-p">,</span>
<span class="tok-nt">"text-anchor"</span><span class="tok-p">:</span> <span class="tok-s2">"middle"</span><span class="tok-p">,</span>
<span class="tok-nt">"vertical-align"</span><span class="tok-p">:</span> <span class="tok-s2">"top"</span><span class="tok-p">,</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"y"</span><span class="tok-p">:</span> <span class="tok-mi">420</span>
<span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"Using SVG-based text,"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-mi">0</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"which is infinitely"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"zoomable and has"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"no artifacts"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Hmm, why might we need the path to a <code>woff2</code> file?</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>It’s not a meme unless it uses the <a href="https://en.wikipedia.org/wiki/Impact_(typeface)" target="_blank" rel="noopener">Impact font</a>.
But what if our device doesn’t have Impact on it?
(iPhones don’t, for instance.)</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><a href="tests/examples/drake-user-specified-font/skeleton/collagen.json" target="_blank" rel="noopener"><code>example-03/collagen.json</code></a> produces the following meme:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="tests/examples/drake-user-specified-font/out.svg" alt="out" width="600">
</div>
</div>
<div class="paragraph">
<p>If you’re on a device that doesn’t include the <a href="https://en.wikipedia.org/wiki/Impact_(typeface)" target="_blank" rel="noopener">Impact font</a> (which includes iPhones, for one), you might wonder what magic occurred that made the bottom pane’s font show up correctly — as Impact and not, say, Times New Roman.
After all, if the specified <code>font-face</code> is not available — and Impact is not available on iPhones — the browser will fall back to another font.
So, for maximum portability, Collagen allows <em>embedding</em> fonts in SVGs — that’s how we got Impact to show up on devices that don’t have the font natively.
Of course, if you stick to web-safe fonts or you <em>know</em> that the recipient has all the fonts you want to use, then you can just refer to the fonts by name and they’ll show up correctly.
But if you want to use fonts that aren’t on the receiving device, then you can still get a portable file by embedding the font in the SVG.</p>
</div>
<div class="paragraph">
<p>For reference, here’s the file above but without the font embedded.</p>
</div>
<div class="listingblock">
<div class="title"><a href="tests/examples/drake-no-font/skeleton/collagen.json" target="_blank" rel="noopener"><code>example-04/collagen.json</code></a></div>
<div class="content">
<pre class="pygments highlight"><code data-lang="json"><span></span><span class="tok-p">{</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span> <span class="tok-nt">"viewBox"</span><span class="tok-p">:</span> <span class="tok-s2">"0 0 800 650"</span> <span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span> <i class="conum" data-value="1"></i><b>(1)</b>
<span class="tok-p">{</span>
<span class="tok-nt">"image_path"</span><span class="tok-p">:</span> <span class="tok-s2">"./drake-small.jpg"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"width"</span><span class="tok-p">:</span> <span class="tok-mi">800</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"vars"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-mi">550</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-mi">50</span>
<span class="tok-p">},</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"text"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"font-family"</span><span class="tok-p">:</span> <span class="tok-s2">"Impact"</span><span class="tok-p">,</span>
<span class="tok-nt">"font-size"</span><span class="tok-p">:</span> <span class="tok-mi">50</span><span class="tok-p">,</span>
<span class="tok-nt">"color"</span><span class="tok-p">:</span> <span class="tok-s2">"black"</span><span class="tok-p">,</span>
<span class="tok-nt">"text-anchor"</span><span class="tok-p">:</span> <span class="tok-s2">"middle"</span><span class="tok-p">,</span>
<span class="tok-nt">"vertical-align"</span><span class="tok-p">:</span> <span class="tok-s2">"top"</span><span class="tok-p">,</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"y"</span><span class="tok-p">:</span> <span class="tok-mi">420</span>
<span class="tok-p">},</span>
<span class="tok-nt">"children"</span><span class="tok-p">:</span> <span class="tok-p">[</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"Using SVG-based text,"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-mi">0</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"which is infinitely"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"zoomable and has"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">},</span>
<span class="tok-p">{</span>
<span class="tok-nt">"tag"</span><span class="tok-p">:</span> <span class="tok-s2">"tspan"</span><span class="tok-p">,</span>
<span class="tok-nt">"text"</span><span class="tok-p">:</span> <span class="tok-s2">"no artifacts"</span><span class="tok-p">,</span>
<span class="tok-nt">"attrs"</span><span class="tok-p">:</span> <span class="tok-p">{</span>
<span class="tok-nt">"x"</span><span class="tok-p">:</span> <span class="tok-s2">"{x}"</span><span class="tok-p">,</span>
<span class="tok-nt">"dy"</span><span class="tok-p">:</span> <span class="tok-s2">"{dy}"</span>
<span class="tok-p">}</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span>
<span class="tok-p">]</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This time, we didn’t embed Impact.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Now, if you view the result in a desktop browser, it should look the same as above, but on a mobile device the font in the bottom pane might be Times New Roman (or some other fallback font) instead of Impact.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="tests/examples/drake-no-font/out.svg" alt="out" width="600">
</div>
</div>
<div class="paragraph">
<p>So it’s nice to be able to embed fonts (although it’s not great for the resulting file size…).</p>
</div>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
<div class="footnote" id="_footnotedef_1">
<a href="#_footnoteref_1">1</a>. Technically base64 encoding data does increase its size by about a third. However, you don’t need to pay this cost when transmitting the file; you can transmit the raw components and then use Collagen to encode them into an SVG on the receiving end. In other words, Collagen is akin to compression such as gunzip: it allows a smaller payload to be transmitted as long as the receiving end can turn it back into something useful.
</div>
<div class="footnote" id="_footnotedef_2">
<a href="#_footnoteref_2">2</a>. At some point <code>cargo run --</code> will be replaced with an actual standalone executable <code>clgn</code>.
</div>
</div>
</body>
</html>