-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.html
573 lines (508 loc) · 20.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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
<!DOCTYPE html>
<html>
<head>
<title>RoboCJK</title>
<link rel="stylesheet" href="manual/style.css">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<link rel="icon" type="image/png" href="manual/img/RoboCJKIcon.png" />
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono&display=swap" rel="stylesheet">
</head>
<body>
<div>
<div class = "title"><h1>RoboCJK</h1></div>
<div class='section'>
<h2>Introduction</h2>
<div class= "row cell text">
<div class="column">
<p>
RoboCJK is a git based collaborativ tool to develop CJK typefaces.
</p>
<p>
<!-- First of all, the RoboCJK work only on Git repository. <br> -->
The tool will commit / push / pull automatically.
</p>
<p>
First step you have to open the terminal and type the next command:<br>
<div STYLE="padding-left: 4%; color:#48799c;"> cd my/repository/path<br> </div>
<div STYLE="padding-left: 4%; color:#48799c;"> git pull </div>
</p>
<p>
The terminal will ask your git username and password.<br>
Then the roboCJK is ready to use.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Create new project</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/newProject_login.mp4" type="video/mp4"/>
New project Demo
</video>
</div>
<div class="column">
<p>
Load a git Repository.
</p>
<p>
A window will ask your git's username/password and your git's hostlocker. If you are the owner of the git host, you can add the git host password to let RoboCJK create the lockers repositories.
Then click on «New project »
</p>
<p>
Save the project in your repo.<br>
It will appear on the pop up button with .rcjk extension ( myProject.rcjk )<br>
</p>
<p>
You can have as many as you want .rcjk project in the same repository.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Fonts infos</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<p>
<img src="manual/img/fontsinfos.png" width=50%>
</p>
</div>
<div class="column">
<p>
The font infos button will open a sheet above the main window
</p>
<p>
• You can create the axis of the final variable font <br>
</p>
<p>
• Put a default glyph width<br>
</p>
• Load a data base, which should be a .txt file, listing character to components. Example:<br><br>
<div STYLE="padding-left: 6%; color:#48799c;">觇:占见</div>
<div STYLE="padding-left: 6%; color:#48799c;">俰:亻禾口</div>
<div STYLE="padding-left: 6%; color:#48799c;">縻:广木木幺小 <br><br></div>
<p>
Find out our own free han database on our GitHub <br><a href="https://github.com/BlackFoundryCom/HanGlyphComposition/blob/master/GlyphsDeepComposition/Characters2DeepComponents.txt" target="_blank">BlackFoundryCom / HanGlyphComposition </a> <br>
And our free hangul database <br><a href="https://github.com/BlackFoundryCom/HangulGlyphComposition/blob/master/GlyphsDeepComposition/Characters2DeepComponents.txt" target="_blank">BlackFoundryCom / HangulGlyphComposition</a>
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Atomic Element</h2>
<div class= "row cell">
<span>
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/atomicElement.mp4" type="video/mp4"/>
Atomic Element Demo
</video>
</div>
<div class="column">
<p>
Click on the button ‘new AE’ to create a new atomic element. Rename it as you want. <br>
Double click on the item, it will open a glyph window.
</p>
<p class="warning">
An atomic element is only made of outlines.
</p>
<p>
To have a variability of it, you have to draw the variants in different layers of the glyph
To link the layers between them, click on ‘+’. A sheet will open above the glyph window. Select the layer you want, name it and add it.
Then an item will appear on the glyph window’s bottom left with the name of the layer and a slider.
By moving the slider, you will see the result of the interpolation between the foreground and layers.
You can link as many layer as you want.
Be careful, all outlines in layers have to be interpolatable with the foreground.
</p>
<p class = "ready">
Your atomic element is ready!
</p>
</div>
</span>
</div>
</div>
<div class='section'>
<h2>Deep Component</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/deepComponent.mp4" type="video/mp4"/>
Deep Component Demo
</video>
</div>
<div class="column">
<p>
Click on the button ‘new DC’ to create a new deep component. Rename it as you want. <br>
Double click on the item, it will open a glyph window.
<p class="warning">
A deep component can be made only of atomic elements, no outline are allowed.
</p>
<p>
To add an atomic element, right click -> add atomic element. <br>
A sheet will open above the glyph window. Select the atomic element you want, add it.
</p>
<p>
The atomic element will appear in green color. (Green means master axis on deep component)
By clicking inside an atomic element, the atomic element will be selected (color will change to turquoise color).
All its axis will appear in the bottom left list (Atomic element’s Axis section). Drag their slider to modify the selected instance.
</p>
<p>
The atomic element instance can receive three kind of additional transformation, such as:<br>
<div STYLE="padding-left: 6%;">– Offset x / y</div>
<div STYLE="padding-left: 6%;">– Scale x / y</div>
<div STYLE="padding-left: 6%;">– Rotation<br><br></div>
For more information about how to manage the transformation look out <br>
<a class = "js-scrollTo" href="#transformation">Transformation section</a>
</p>
<p>
In the Deep component’s Axis section, by clicking on ‘+’ button you will add a new Axis on your deep component.
You cans rename it, and add as many axis as you want.
An item will appear and it will automatically copy the master in your axis. The color will become light orange.
Double click in any axis item to go in. Then hit space bar to go back on the master (the color will go back to green)
Then add the transformation you want on atomic elements in this deep component axis.
</p>
<p class = "ready">
Your deep component is ready!
</p>
</div>
</div>
<div class="row cell subsection">
<div class="column" STYLE="text-align:center;">
<p>
<img src="manual/img/deepComponentFloatinWindow.png" width=50%>
</p>
</div>
<div class="column">
<p>
This Floating Window appear automatically while opening a deep component window, if there is a loaded database.
The aim is to display all the related character glyph. And If they have been drawn in outline, to display the character above the deep component to test the extrems
</p>
<p>
Double click on a character and, if it do not already exist in the font will create it, and open it.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Character Glyph</h2>
<div class= "row cell">
<div>
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/characterGlyph.mp4" type="video/mp4"/>
Character Glyph Demo
</video>
</div>
<div class="column">
<p>
By clicking on ‘new DC’ a sheet will open, with different option of creation.
</p>
<p>
On the first section « custom », you can type all characters or glyphs names (separate with space) you want to add.
If there is a database loaded you can create in the same time the deep components they need (by keeping active the bottom left check box)
</p>
<p>
On the second section « Related to deep components » will work only if a database is loaded.
On the left a list display all the deep components existing in the current font.
By selecting items, it will display on the right all the characters you can entirely draw.
Then add it.
Or by clicking on the Bottom button « Add all possible characters » it will add all the characters you can entirely do with your current set of deep components.
</p>
<p class="warning">
A character glyph can be made of deep components and/or outlines. The outlines variations will be made between the default layer and the variation’s name layer.
</p>
<p>
To add a deep component, right click -> add deep component. <br>
A sheet will open above the glyph window. Select the deep component you want, add it.
</p>
<p>
The deep component will appear in purple color. (Purple means master axis on character glyph)
By clicking inside a deep component, the deep component will be selected (color will change to turquoise color).
All its axis will appear in the bottom left list (Deep Component’s Axis section). Drag their slider to modify the selected instance.
</p>
<p>
The deep component instance can receive three kind of additional transformation, such as:<br>
<div STYLE="padding-left: 6%;">– Offset x / y</div>
<div STYLE="padding-left: 6%;">– Scale x / y</div>
<div STYLE="padding-left: 6%;">– Rotation<br><br></div>
For more information about how to manage the transformation look out <br>
<a class = "js-scrollTo" href="#transformation">Transformation section</a>
</p>
<p>
In the Font Variation’s Axis section, by clicking on ‘+’ button you will add a new Axis on your character glyph.
A sheet will open above the glyph window, to choose an axis already existing in the font infos.
</p>
<p>
An item will appear and it will automatically copy the master in your axis. The color will become light red.
Double click in any axis item to go in. Then hit space bar to go back on the master (the color will go back to purple)
Then add the transformation you want on deep components in this character glyph axis.
</p>
<p class = "ready">
Your character glyph is ready!
</p>
</div>
</div>
</div>
<div class="row cell subsection">
<div class="column" STYLE="text-align:center;">
<p>
<img src="manual/img/characterGlyphFloatinWindow.png" width=50%>
</p>
</div>
<div class="column">
<p>
This Floating Window appear automatically while opening a character glyph window, if there is a loaded database.
The aim is to display the composition of the character glyph. The firts column show the structure and the second column show the version existing in font of each deep component.
</p>
<p>
Double click on a version and it import the deep component.
</p>
<p>
By clicking on the bottom left button, you can edit the database.
</p>
</div>
</div>
<div class="row cell subsection">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/importDCFromAnotherCG.mp4" type="video/mp4"/>
Import deep component instance from another character glyph
</video>
</div>
<div class="column">
<p>
To import a deep component instance from a specific character glyph, click right -> Import Deep Component from another Character Glyph.
</p>
<p>
A window will open, type the glyph name or the character. Its deep components will appear on the left list.
</p>
<p>
By double clicking on an item, it will import the deep component with its settings.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Text Center</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/textCenter.mp4" type="video/mp4"/>
Text Center
</video>
</div>
<div class="column">
<p>
Text center allows to type text and test it with the font variations.
</p>
<p>
In the input field, on the top, you can type the glyphs names (separate with space or '/') or type the character.
</p>
<p>
You can as well display all the glyphs that use the same deep component.
</p>
<p>
On the left there is a list of all the project's deep components.
</p>
<p>
By selecting one, its versions will appear on the right.
</p>
<p>
Select a version and all the glyphs that use this deep component version will be set in the text center.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Lock Controller</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/lockController.mp4" type="video/mp4"/>
Lock Controller
</video>
</div>
<div class="column">
<p>
RoboCJK is a collaborativ tool based on a lock system.
</p>
<p class="warning">
You can only edit a glyph if it's locked for you.
</p>
<p>
There is many way to lock a glyph:<br>
<div STYLE="padding-left: 6%;">– At its creation. </div>
<div STYLE="padding-left: 6%;">– On opening its glyph window. (if it's not already locked by someone else, otherwise the glyph window will not be opened)</div>
<div STYLE="padding-left: 6%;">– On the Lock controller</div>
</p>
<p>
But there is only one way to unlock glyphs, it's in the lock controller.
</p>
<p>
The lock controller will open a sheet, where you can handle the lock and unlock.
</p>
<p>
To lock glyphs, type their names (separate with space) or their character. And then lock.
</p>
<p>
In the unlock section, a list will show you all your locked glyphs. You can handle the unlock, for the selected glyphs or for all.
</p>
</div>
</div>
</div>
<div class='section' id="transformation">
<h2>Transformation</h2>
<div class= "cell text">
<p>
Each elements can receive three kind of transformation, such as: <br>
<div STYLE="padding-left: 4%;">– Offset x / y</div>
<div STYLE="padding-left: 4%;">– Scale x / y</div>
<div STYLE="padding-left: 4%;">– Rotation </div>
</p>
<p>
There is three way to do a transformation:<br>
<div STYLE="padding-left: 4%;">– with the keyboard</div>
<div STYLE="padding-left: 4%;">– with mouse with a specific tool, in the glyphwindow</div>
<div STYLE="padding-left: 4%;">– with a popover above the selected element</div>
</p>
<p>
<h3>
Key board (On the selected elements):
</h3>
<p>
<div STYLE="padding-left: 4%;">Offset:</div>
<div STYLE="padding-left: 6%;">1 unit with ←, →, ↑, ↓</div>
<div STYLE="padding-left: 6%;">10 unit with ⇧←, ⇧→, ⇧↑, ⇧↓</div>
<div STYLE="padding-left: 6%;">100 unit with ⌘⇧←, ⌘⇧→, ⌘⇧↑, ⌘⇧↓</div>
</p><p>
<div STYLE="padding-left: 4%;">Rotation:</div>
<div STYLE="padding-left: 6%;">1° with ⌥←, ⌥→</div>
<div STYLE="padding-left: 6%;">3° with ⌥⇧←, ⌥⇧→</div>
<div STYLE="padding-left: 6%;">6° with ⌘⌥⇧←, ⌘⌥⇧→</div>
</p><p>
<div STYLE="padding-left: 4%;">Scale:</div>
<div STYLE="padding-left: 6%;">10/1000 ⇪←, ⇪→, ⇪↑, ⇪↓</div>
<div STYLE="padding-left: 6%;">100/1000 ⇪⇧←, ⇪⇧→, ⇪⇧↑, ⇪⇧↓</div>
</p><p>
<div STYLE="padding-left: 4%;">Duplicate selected elements:</div>
<div STYLE="padding-left: 6%;">⌥ d </div>
</p>
</p>
<p>
<h3>
Mouse (On the selected elements):
</h3>
<div STYLE="padding-left: 4%;">Select the transformation tool in the glyph window tool bar</div>
<p>
<div STYLE="padding-left: 4%;">Offset:</div>
<div STYLE="padding-left: 6%;">click and drag</div>
</p>
<p>
<div STYLE="padding-left: 4%;">Rotation:</div>
<div STYLE="padding-left: 6%;">⌥ click and drag</div>
</p>
<p>
<div STYLE="padding-left: 4%;">Scale:</div>
<div STYLE="padding-left: 6%;">⌘ click and drag</div>
</p>
</p>
<p>
<h3>
Popover (On one selected element):
</h3>
<div STYLE="padding-left: 4%;">Double click on the selected element, with any tool, a popover will open. <br>Displaying all the transformations datas, which are all editable. <br>You can as well copy the data, and paste it in another element</div>
</p>
</div>
</div>
<div class='section'>
<h2>PDF proofer</h2>
<div class= "row cell">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/pdfProoferPage.mp4" type="video/mp4"/>
PDF Proofer Page Section
</video>
</div>
<div class="column">
<p>
The PDF Proofer allows to export PDF files supporting deep components.
</p>
<p>
The first section is the page manager.
</p>
<p>
You can add/remove pages, change their size, change number of columns/lines, change the weight of margins and the background color.
</p>
<p>
On the right side, the lines and columns are represented by grey rectangles. (These rectangles won't be exported in the final pdf).
</p>
</div>
</div>
<div class="row cell subsection">
<div class="column" STYLE="text-align:center;">
<video width="90%" controls="controls" outline="none">
<source src="manual/img/pdfProoferTextBoxes.mp4" type="video/mp4"/>
PDF Proofer Text Section
</video>
</div>
<div class="column">
<p>
The second section manages the texts.
</p>
<p>
Select a text box in the Box list. A Red stroke will show you the selected box (This red stroke won't be exported in the final pdf).
</p>
<p>
In the selected box you can select the font. It can be your current .rcjk project font, or a font from your fontbook.
</p>
<p>
Then type your text, change the fontsize, the color, tracking, lineheight and alignment.
</p>
<p class = "ready">
Your PDF is ready, export it with the bottom button.
</p>
</div>
</div>
</div>
<div class='section'>
<h2>Additional tools</h2>
<div class= "cell text">
<p>
Find out our free additional tools on our <a href="https://github.com/BlackFoundryCom" target="_blank">github</a>
</p>
<p>
<a href="https://github.com/BlackFoundryCom/CJK-Design-Frame" target="_blank">• CJK design frame</a> <br>
<div STYLE="padding-left: 4%;">A RoboFont extension to display a design frame useful for Chinese, Japanese or Korean typeface design in the glyph window.</div>
</p>
<p>
<a href="https://github.com/BlackFoundryCom/reference-viewer" target="_blank">• Reference Viewer</a> <br>
<div STYLE="padding-left: 4%;">A Robofont extension to display reference fonts in the glyph window.</div>
</p>
<p>
<a href="https://github.com/BlackFoundryCom/Power-Ruler" target="_blank">• Power Ruler</a> <br>
<div STYLE="padding-left: 4%;">A RoboFont extension to display the distances between glyph's contours and deep components, along a line.</div>
</p>
</div>
</div>
</div>
<footer>
<div class="cell text" STYLE="text-align: right; margin-right:5%;">
<p>
<a href="https://github.com/BlackFoundryCom/black-robo-cjk" target="_blank">RoboCJK</a> is under <a href="https://github.com/BlackFoundryCom/black-robo-cjk/blob/master/LICENSE" target="_blank">GNU GENERAL PUBLIC LICENSE</a> © Copyright 2020 <a href="https://www.black-foundry.com" target="_blank">Black[Foundry]</a>
</p>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script>
$(document).ready(function() {
$('.js-scrollTo').on('click', function() {
var page = $(this).attr('href');
var speed = 750;
$('html, body').animate( { scrollTop: $(page).offset().top }, speed );
return false;
});
});
</script>
</body>
</html>