forked from kewapo/The-Tiddlywiki-Manual
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathThe_Book.lyx
18282 lines (13220 loc) · 318 KB
/
The_Book.lyx
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass scrbook
\use_default_options false
\begin_modules
customHeadersFooters
tcolorbox
\end_modules
\maintain_unincluded_children false
\language english
\language_package babel
\inputencoding auto
\fontencoding global
\font_roman "lmodern" "default"
\font_sans "lmss" "default"
\font_typewriter "lmtt" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\use_dash_ligatures false
\graphics default
\default_output_format pdf2
\output_sync 1
\bibtex_command default
\index_command default
\paperfontsize 10
\spacing single
\use_hyperref true
\pdf_title "The Tiddlywiki manual"
\pdf_author "Luis Javier González Caballero"
\pdf_bookmarks true
\pdf_bookmarksnumbered true
\pdf_bookmarksopen true
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle true
\pdf_quoted_options "linkcolor=blue, urlcolor=blue, citecolor=blue"
\papersize a4paper
\use_geometry true
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\index Índice
\shortcut idx
\color #008000
\end_index
\leftmargin 3cm
\topmargin 3cm
\rightmargin 2cm
\bottommargin 2cm
\headheight 1cm
\headsep 1cm
\footskip 1cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 2
\paperpagestyle plain
\listings_params "showtabs={true;}"
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Standard
\begin_inset Note Note
status open
\begin_layout Itemize
Changes:
\end_layout
\begin_deeper
\begin_layout Itemize
The map, with a description of all trip.
\end_layout
\begin_layout Itemize
Chapter 6 (new)
\end_layout
\begin_layout Itemize
Mechanisms new chapter
\end_layout
\end_deeper
\end_inset
\end_layout
\begin_layout Standard
\begin_inset External
template PDFPages
filename cover page.pdf
\end_inset
\end_layout
\begin_layout Title
Tiddlywiki
\end_layout
\begin_layout Title
Advanced Customization
\end_layout
\begin_layout Author
Coordinator: Luis Javier González Caballero
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
\shape italic
Written with the help of the people of the
\begin_inset CommandInset href
LatexCommand href
name "tiddlywiki google group"
target "https://groups.google.com/forum/#!forum/tiddlywiki"
literal "false"
\end_inset
\end_layout
\begin_layout Publishers
\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="2">
<features booktabs="true" tabularvalignment="middle">
<column alignment="left" valignment="top">
<column alignment="left" valignment="top">
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size larger
Collaborators
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size larger
Collaboration
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="left" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Dr.
Rizwan Ishak
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Chapter 6
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="left" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Mohammad Rahmani
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Chapter 11
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Eskha
\end_layout
\end_inset
</cell>
<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size large
Chapter 12
\end_layout
\end_inset
</cell>
</row>
</lyxtabular>
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Newpage pagebreak
\end_inset
\end_layout
\begin_layout Standard
\begin_inset CommandInset toc
LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Standard
\begin_inset External
template PDFPages
filename Tiddlywiki_map.pdf
lyxscale 110
scale 80
\end_inset
\end_layout
\begin_layout Chapter*
The Long Trip
\end_layout
\begin_layout Standard
\begin_inset VSpace 3cm
\end_inset
\end_layout
\begin_layout Standard
\shape italic
Tiddlywiki is the mix of many technologies: from HTML and CSS to the javascript
code.
This box show all of this technologies:
\end_layout
\begin_layout Standard
\begin_inset Flex Color Box
status open
\begin_layout Enumerate
\series bold
\shape smallcaps
Start city
\series default
\shape default
: when you first discover tiddlywiki you donwload an empty wiki and you
start adding tiddlers.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
Markup Language city:
\series default
\shape default
The first you discover is the Wikitext format.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
Fields Village:
\series default
\shape default
You travel through Tags plain and realize the existence of Fields.
Here are the Transclusion hills.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The HTML Land:
\series default
\shape default
If you go deeper, you realize that HTML is at the bottom of everything.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The CSS Plain:
\series default
\shape default
Soon you want to change the look of your tiddler.
You must deal with CSS at the Styles zone.
And with the templates hills.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The Filters Magic Academy:
\series default
\shape default
Suddenly you must learn a mysterious and exoteric language: Filters.
You do so in this hidden academy...
if you find it.
If you do not learn this, you never master Tiddlywiki.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The javascript Mountains:
\series default
\shape default
Now you have already reached a place where few people have been.
You will write here your macros and your first javascript code: the widgets.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The plugins abyss:
\series default
\shape default
Now its time to reach the plugins abyss and start sharing your wikis.
This is an important step.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
Node.js Hills:
\series default
\shape default
This is not a place for anyone.
Here you find the npm shore and you will find the github way.
\end_layout
\begin_layout Enumerate
\series bold
\shape smallcaps
The Developers Highlands:
\series default
\shape default
The last step.
You have already been in all places and now you reach the Highlands.
Here you can collaborate with the developers and with the great master
of all masters.
This is a very sparsely populated place.
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
Introduction
\end_layout
\begin_layout Section
Key points
\end_layout
\begin_layout Standard
\begin_inset Flex Color Box
status collapsed
\begin_layout Itemize
\size footnotesize
Tiddlywiki is more than a note-taking application.
\end_layout
\begin_layout Itemize
\size footnotesize
It is an advanced way of organizing your information.
\end_layout
\begin_layout Itemize
\size footnotesize
All notes you will add to it are called tiddlers.
\end_layout
\begin_layout Itemize
\size footnotesize
You can download an empty wiki from its web site.
\end_layout
\begin_layout Itemize
\size footnotesize
It is portable and multi platform.
\end_layout
\begin_layout Itemize
\size footnotesize
To add format to your text inside the tiddlers you use format characters:
//text// for italics, __text__ for underline, [[Tiddler]] for links etc.
This is called Wikitext.
\end_layout
\begin_layout Itemize
\size footnotesize
It use tags to organize, classify etc the tiddlers.
\end_layout
\begin_layout Itemize
\size footnotesize
It use fields to add extra information to the tiddlers.
For example the created date field, the modified date field etc.
\end_layout
\begin_layout Itemize
\size footnotesize
You can include the information of a tiddler inside another tiddler without
writing twice.
This is called Transclusion.
\end_layout
\begin_layout Itemize
\size footnotesize
You can use templates to personalize the way that tiddlywiki shows the tiddlers.
\end_layout
\begin_layout Itemize
\size footnotesize
Tiddlywiki uses Filters to get a group of tiddlers.
Filters are written in a little language inside tiddlywiki.
For example, to get all tiddlers tagged with the
\begin_inset Quotes eld
\end_inset
Person
\begin_inset Quotes erd
\end_inset
tag you write {{{ [tag[Person]] }}}.
\end_layout
\begin_layout Itemize
\size footnotesize
You can add code to your wiki in Macros and Widgets.
This is used to personalize the wiki.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Newpage clearpage
\end_inset
\end_layout
\begin_layout Section
What is tiddlywiki
\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Float figure
placement bh
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
\begin_inset CommandInset label
LatexCommand label
name "fig:What-is-Tiddlywiki"
\end_inset
What is Tiddlywiki
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\noindent
\align center
\begin_inset Graphics
filename Images/TW concept.png
lyxscale 50
scale 25
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
In this section we will talk about:
\end_layout
\begin_layout Itemize
TW description.
\end_layout
\begin_layout Itemize
TW philosophy.
\end_layout
\begin_layout Itemize
TW as a single page application.
\end_layout
\begin_layout Itemize
What are tiddlers.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
TiddlyWiki is a personal and a non-linear notebook for organizing and sharing
complex information.
It is an open-source single page application wiki in the form of a single
HTML file that includes all javascript code, the CSS format and the content.
It is designed to be easy to customize and re-shape depending on application.
It facilitates re-use of content by dividing it into small pieces called
Tiddlers.
It is not an application but a large html page that runs in almost all
web browsers so it is very portable: you can use it in a USB stick, in
a phone or tablet or as a web page in some internet servers.
Tiddlywiki is made of tiddlers: little text areas or notes with a title
and a content.
You can add all the tiddlers you want and each of them will contain certain
information.
\end_layout
\begin_layout Standard
It was created by the British software developer Jeremy Ruston in 2004.
Tiddlywiki is free and open source software and is distributed under the
terms of the BSD license.
\end_layout
\begin_layout Standard
Tiddlywiki introduces the concept of microcontent: the smallest structured
and addressable piece of information, the smallest semantically meaningful
units.
This small piece of information is called tiddler.
The purpose of this tiddlers is recording and organizing information is
so that it can be used as many times as necessary.
\end_layout
\begin_layout Standard
You can find the basic information of Tiddlywiki in the web site:
\begin_inset Flex URL
status open
\begin_layout Plain Layout
https://tiddlywiki.com/
\end_layout
\end_inset
.
I recommend you take a look.
\end_layout
\begin_layout Section
Starting with tiddlywiki
\end_layout
\begin_layout Standard
\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
In this section we will talk about:
\end_layout
\begin_layout Itemize
Where we can find tiddlywiki.
\end_layout
\begin_layout Itemize
How to download and a basic usage.
\end_layout
\begin_layout Itemize
Tagging tiddlers.
\end_layout
\begin_layout Itemize
Transclusion and filters.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Float figure
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
\begin_inset CommandInset label
LatexCommand label
name "fig:GettingStarted"
\end_inset
The first run of Tiddlywiki
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\noindent
\align center
\begin_inset Graphics
filename Images/GettingStarted.png
scale 60
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The first step will be download an empty wiki page to our computer:
\end_layout
\begin_layout Enumerate
Go to
\begin_inset Flex URL
status open
\begin_layout Plain Layout
https://tiddlywiki.com/
\end_layout
\end_inset
.
\end_layout
\begin_layout Enumerate
Look for the tiddler
\begin_inset Quotes eld
\end_inset
GettingStarted
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Enumerate
Click on the red button,
\begin_inset Quotes eld
\end_inset
Download Empty
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Enumerate
Save the empty tiddlywiki in your computer.
\end_layout
\begin_layout Standard
Once you have the file you can open it with the browser (best with Firefox
or Chrome).
You will see the page of the Figure
\begin_inset CommandInset ref
LatexCommand ref
reference "fig:GettingStarted"
plural "false"
caps "false"
noprefix "false"
\end_inset
.
Assign a title and a subtitle to your wiki.
You will notice that the tick icon above the subtitle change to red.
\end_layout
\begin_layout Standard
This shows us an important thing: as an html web page, the TW file can't
save by itself.
You musts save them by hand if you don't want to loose the data.
Click in this red icon and save the file in the same location (maybe you
have to configure your browser).
The next time you open the empty wiki in the browser the title and subtitle
will have changed.
Other operations you can do is to create an initial tiddler and change
the
\begin_inset Quotes eld
\end_inset
Default tiddlers
\begin_inset Quotes erd
\end_inset
text area to the title of this first tiddler.
To create tiddlers you will click on the "plus" icon under the subtitle.
\end_layout
\begin_layout Standard
The First Rule of using Tiddlywiki: backup your wiki file regularly retaining
some backward copies.
\end_layout
\begin_layout Standard
I insist: while you can edit any TiddlyWiki (even tiddlywiki.com), the changes
will only exist on the editor's computer, so if you close the browser without
saving your wiki you will lose your work,
\end_layout
\begin_layout Section
Reasons to use tiddlywiki
\end_layout
\begin_layout Standard
\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
In this section we will talk about:
\end_layout
\begin_layout Itemize
TW as a way of organizing notes.
\end_layout
\begin_layout Itemize
TW as a toolbox.
\end_layout
\begin_layout Itemize
Basic uses of TW.
\end_layout
\begin_layout Itemize
The TW community.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
You have powerful reasons to use tiddlywiki:
\end_layout
\begin_layout Itemize
You can use them without installing any software.
\end_layout
\begin_layout Itemize
It is multiplaform: use your wiki in your tablet, mac, linux, windows or
phone systems.
\end_layout
\begin_layout Itemize
It is portable: you can put in a USB stick, copy to your computer or upload
to many internet servers.
\end_layout
\begin_layout Itemize
Its nonlinear approach allows you to use the information in new and helpfull
ways.
\end_layout
\begin_layout Itemize
You can organize your information and knowledge your way.
\end_layout
\begin_layout Itemize
You can change the appearance and behavior of your wiki and adapt them to
your preferences.
\end_layout
\begin_layout Itemize
Tiddlywiki promotes information sharing.
\end_layout
\begin_layout Section
Elements of TW
\end_layout
\begin_layout Subsection
The screen
\end_layout
\begin_layout Standard
When you open a Tiddlywiki file you can see a left size with all open tiddlers
and a right side with the title, buttons, and menus.
In chapter 3 we will see the whole screen (look at the Figure
\begin_inset CommandInset ref
LatexCommand ref
reference "fig:The-screen-Tiddlywiki"
plural "false"
caps "false"
noprefix "false"
\end_inset
).
\end_layout
\begin_layout Subsection
Tiddlers
\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Float figure
placement h
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
\begin_inset CommandInset label
LatexCommand label
name "fig:A-tiddler"
\end_inset
A tiddler
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\noindent
\align center
\begin_inset Graphics
filename Images/A tiddler.png
scale 70
\end_inset