forked from vimoutliner/vimoutliner
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvotl.txt
1121 lines (945 loc) · 39.2 KB
/
votl.txt
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
*votl.txt* For Vim version 8.1 Last change: 2021-04-23
*vo* *votl* *vimoutliner*
VimOutliner 0.5.0~
VimOutliner is an outline processor designed with lighting fast authoring as
the main feature, it also has many of the same features as Grandview, More,
Thinktank, Ecco, etc. These features include tree expand/collapse, tree
promotion/demotion, level sensitive colors, interoutline linking, checkboxes
and body text.
License |votl-license|
Version |votl-version|
VimOutliner philosophy |votl-philosophy|
Running VimOutliner |votl-running|
VimOutliner configuration file |vimoutlinerrc|
Backslash Leader commands |votl-command|
Basic VimOutliner activities |votl-activities|
Menu |votl-menu|
Vim Outliner objects |votl-objects|
Advanced |votl-advanced|
Executable Lines |votl-executable-lines|
Plugins |votl-plugins|
Checkboxes |votl-checkbox|
Hoisting |votl-hoisting|
Clock |votl-clock|
Scripts |votl-scripts|
votl_maketags.py |votl-maketags|
otl2html.py |otl2html|
Using VimOutliner on other file types |votl-other-files|
Troubleshooting |votl-troubleshooting|
Other information |votl-other-info|
==============================================================================
License *votl-license*
VimOutliner Copyright (C) 2001, 2003 by Steve Litt
Copyright (C) 2004, 2014 by Noel Henson
Licensed under the GNU General Public License (GPL), version 2
Absolutely no warranty, see COPYING file for details.
HTML: http://www.gnu.org/copyleft/gpl.html
Text: http://www.gnu.org/copyleft/gpl.txt
==============================================================================
VimOutliner Philosophy *votl-philosophy*
Authoring Speed~
VimOutliner is an outline processor with many of the same features as
Grandview, More, Thinktank, Ecco, etc. Features include tree expand/collapse,
tree promotion/demotion, level sensitive colors, interoutline linking, and
body text.
What sets VimOutliner apart from the rest is that it's been constructed from
the ground up for fast and easy authoring. Keystrokes are quick and easy,
especially for someone knowing the Vim editor. The mouse is completely
unnecessary (but is supported to the extent that Vim supports the mouse). Many
of the VimOutliner commands start with a backslash because that's very
quick to type.
Many outliners are prettier than VimOutliner. Most other outliners are more
intuitive for the newbie not knowing Vim. Many outliners are more featureful
than VimOutliner (although VimOutliner gains features monthly and is already
very powerful). Some outliners are faster on lookup than VimOutliner. But as
far as we know, NO outliner is faster at getting information out of your mind
and into an outline than VimOutliner.
VimOutliner will always give you lightning fast authoring. That's our basic,
underlying philosophy, and will never change, no matter what features are
added.
Vim Integration~
Earlier VimOutliner versions prided themselves on being stand alone
applications, self-contained in a single directory with a special script to
run everything.
As of 0.3.0, VimOutliner is packaged as a Vim Plugin, eliminating the need for
the ol script, which many saw as clumsy. Given that all VimOutliner features
are produced by the Vim engine, it makes perfect sense to admit that
VimOutliner is an add-on to Vim.
Therefore VimOutliner now prides itself in being a Vim plugin. With the
VimOutliner package installed, the Vim editor yields the VimOutliner feature
set for files whose extensions are listed as votl types in
$HOME/.vim/ftplugin/votl.vim.
==============================================================================
Running VimOutliner *votl-running*
Vim Knowledge~
You needn't be a Vim expert to use VimOutliner. If you know the basics --
inserting and deleting line-wise and character-wise, moving between command and
insert modes, use of Visual Mode selections,and reformatting, you should be
well equipped to use VimOutliner.
Run Vim or GVim and follow the instruction on :help |tutor|
VimOutliner is a set of Vim scripts and configurations. Its features all come
from the Vim editor's engine. If you do not know Vim, you'll need to learn the
Vim basics before using VimOutliner. Start by taking the Vim tutorial. The
tutorial should take about 2 hours.
VimOutliner is so fast, that if you often use outlining, you'll make up that
time within a week.
*vimoutlinerrc*
VimOutliner configuration file~
Custom configuration (and small custom extensions) should be written to
the vimoutlinerrc file. It is a regular vimscript file and the first of
the files searched in the following locations will be used:
* a file .vimoutlinerrc (notice the leading dot) in the users $HOME or
$HOME/.vimoutliner directory
* a file vimoutlinerrc (name without the leading dot) in the users
$HOME, $HOME/.vimoutliner, or $HOME/.vim directory
* a file vimoutlinerrc (again without the leading dot) in the folder
where the VimOutliner is run from (that could be again $HOME/.vim
directory with manual installation or for example
$HOME/.vim/bundle/vimoutliner when using pathogen)
Many global variables can be also set in the normal vim manner in the
user's $VIMRC file. See general vim documentation for more details for
individual variables.
*votl-command*
Backslash Leader Commands~
Traditionally (meaning in terms of the VimOutliner traditions ;)) all
VimOutliner were features accessed through keyboard commands starting
with two commas. The backslash followed by a character is incredibly
fast to type. However, with more widespread use of the VimOutliner some
developers felt that all idiosyncrasies should be eliminated and
VimOutliner should behave as a normal vim plugin. Therefore now we
don't redefine this command leader (as it is called in the Vim lingo)
and unless the user redefines it on her own (in |vimoutlinerrc|) it
defaults to backslash. If you configure VimOutliner to use different key
combination, you have to mentally replace it everywhere in this
documentation.
If you are friend of the ancient régime, then just uncomment the line in
|vimoutlinerrc| (see more about the locations where you should put it):
"let maplocalleader = ',,' " uncomment for compatibility with
" previous versions of VO
We expect to create more leader commands, so try not to create your own,
as they may clash with later leader commands. If you have an
exceptionally handy command, please report it to the VimOutliner list. Perhaps
others could benefit from it.
Command List Description ~
\D all VimOutliner reserved command
\H all reserved for manual de-hoisting (add-on)
\h all reserved for hoisting (add-on)
\1 all set foldlevel=0
\2 all set foldlevel=1
\3 all set foldlevel=2
\4 all set foldlevel=3
\5 all set foldlevel=4
\6 all set foldlevel=5
\7 all set foldlevel=6
\8 all set foldlevel=7
\9 all set foldlevel=8
\0 all set foldlevel=99999
\- all Draw dashed line
\f normal Directory listing of the current directory
\s normal Sort sub-tree under cursor ascending
\S normal Sort sub-tree under cursor descending
\t normal Append timestamp (HH:MM:SS) to heading
\T normal Pre-pend timestamp (HH:MM:SS) to heading
\t insert Insert timestamp (HH:MM:SS) at cursor
\d normal Append datestamp (YYYY-MM-DD) to heading
\d insert Insert datestamp (YYYY-MM-DD) at cursor
\D normal Pre-pend datestamp (YYYY-MM-DD) to heading
\B normal Make body text start with a space
\b normal Make body text start with a colon and space
\w insert Save changes and return to insert mode
\e normal Execute the executable tag line under cursor
Other VimOutliner Commands~
Naturally, almost all Vim commands work in VimOutliner. Besides
the leader commands VimOutliner suggests a few extra commands.
To further enhance your VimOutliner experience add the following
lines to your .vimrc file.
>
map <silent> <buffer> <C-K> <Plug>VO_FollowLink
map <silent> <buffer> <C-N> <Plug>VO_JumpBack
<
which will add the following mappings
<C-K> normal Follow tag/interoutline (Synonym for Ctrl+])
<C-N> normal Return from tag (Synonym for Ctrl+T)
To get a quick overview of all VimOutliner commands type ":help votl_cheatsheet" in vim.
*votl-activities*
Basic VimOutliner activities~
How do I collapse a tree within command mode?
zc
(note: a full list of folding commands |fold-commands|)
How do I expand a tree within command mode?
To expand one level:
zo
To expand all the way down
zO
How do I demote a headline?
In command mode, >>
In insert mode at start of the line, press the Tab key
In insert mode within the headline, CTRL-T
How do I promote a headline?
In command mode, <<
In insert mode at start of the line, press the Backspace key
In insert mode within the headline, CTRL-D
How do I promote or demote several consecutive headlines?
Highlight the lines with the V command
Press < to promote or > to demote. You can precede
the < or > with a count to promote or demote several levels
How do I promote or demote an entire tree?
Collapse the tree
Use << or >> as appropriate
How do I collapse an entire outline?
\1
How do I maximally expand an entire outline?
\0
How do I expand an outline down to the third level?
\3
How do I move a tree?
Use Vim's visual cut and paste
How do I create body text?
Open a blank line below a headline
Start the line with a colon followed by a space
Continue to type. Your text will wrap
How do I reformat body text?
Highlight (Shift+V) the body text to be reformatted
Use the gq command to reformat
How do I reformat one paragraph of body text?
The safest way is highlighting.
DANGER! Other methods can reformat genuine headlines.
How do I switch between colon based and space based body text?
\b for colon based, \B for space based
How do I perform a word count?
Use the command :w !wc
The space before the exclamation point is a MUST.
*votl-menu*
Menu~
There is a simple menu included in Vim Outliner when running in GUI mode.
Named 'VO', you can usually find it right next to the 'Help' menu. There are
commands to change the fold level and select alternate color schemes. There is
also entries for common tools.
The last tool item calls a shell script, 'myotl2html.sh'. This script should
be provided by the user and is not included in VO releases. A sample
myotl2html.sh script might look like this:
>
#!/bin/sh
otl2html.py -S pjtstat.css $1 > $HOME/public_html/$1.html
<
If you have several different types of reports you create regularly, you can
create your own menu entries. Just add lines like these to your
|vimoutlinerrc| file: >
>
amenu &VO.&Reports.&Big\ Project :!otl2html.py -S big.css % > %.html
amenu &VO.&Reports.&Hot\ List :!otl2html.py -S todo.css % > %.html
amenu &VO.&Reports.&Weekly :!otl2html.py -S weekly.css % > %.html
<
I'm sure you get the idea.
*votl-objects*
Vim Outliner Objects~
There are several object/line types that VO supports. The most common on
simple headings and body text. Simple headings are tab-indented line that
start with any non-whitespace character except: : ; | < >. These characters
specify other objects. Here is a list of each of the non-heading types:
Start Description~
: body text (wrapping)
; Pre-formatted body text (non-wrapping)
| table
> user-defined, text block (wrapping)
< user-defined, Pre-formatted text block (non-wrapping)
The body text marker, :, is used to specify lines that are
automatically wrapped and reformatted. VO and post-processors (see
|votl-scripts|) are free to wrap and reformat this text as well as use
proportional fonts. A post-processor will probably change the
appearance of what you have written. If you are writing a book or
other document, most of the information you enter will be body text.
Here is an example:
>
Kirby the Wonder Dog
: Kirby is nine years old. He understand about 70-100
: English words. Kirby also understands 11 different hand
: signals. He is affectionate, playful and attentive.
:
: His breeding is unknown. He appears to be a mix between
: a German shepherd and a collie.
<
When folded, body text looks something like this:
>
Kirby the Wonder Dog
[TEXT] -------------------------------- (6 lines)
<
The Pre-formatted text marker, ;, is used to mark text that should not be
reformatted nor wrapped by VO or any post-processor. A post-processor would
use a fixed-width font, like courier, to render these lines. A post-processor
will probably not change the appearance of what you have written. This is
useful for making text picture, program code or other format-dependent text.
Here is an example:
>
Output waveform
; _______ ______
; _____/ \______________/
; |-10us--|----35us------|
<
When folded, Pre-formatted body text looks something like this:
>
Output waveform
[TEXT BLOCK] -------------------------- (6 lines)
<
The table marker, |, is used to create tables. This is an excellent way to
show tabular data. The marker is used as if it were are real vertical line. A
|| (double-|) is optionally used to mark a table heading line. This is useful
for post-processors.
Here is an example:
>
Pets
|| Name | Age | Animal | Inside/Outside |
| Kirby | 9 | dog | both |
| Hoover | 1 | dog | both |
| Sophia | 9 | cat | inside |
<
There is no automatic alignment of columns yet. It must be done manually. The
otl2html.py post-processor does have alignment functions. See |otl2html|
for more information.
When folded, a table looks something like this:
>
Pets
[TABLE] ------------------------------- (4 lines)
<
User-defined text is similar to body text but more flexible and its use is
not pre-defined by Vim Outliner. The basic, user-defined text block marker, >,
behaves just like body text.
For example:
>
Kirby the Wonder Dog
> Kirby is nine years old. He understand about 70-100
> English words. Kirby also understands 11 different hand
> signals. He is affectionate, playful and attentive.
>
> His breeding is unknown. He appears to be a mix between
> a German shepherd and a collie.
<
When folded, body text looks something like this:
>
Kirby the Wonder Dog
[USER] -------------------------------- (6 lines)
<
But, unlike body text, user-defined text can be expanded. You could have
user-defined text types. If you were writing a book, in addition to body text
for paragraphs you might need special paragraphs for tips and warnings.
User-defined text blocks can accomplish this:
>
>Tips
> Don't forget to back up your computer daily. You don't
> need to back up the entire computer. You just need to
> backup up the files that have changed.
>Warning
>Never store you backup floppy disks on the side of you
>file cabinets by adhering them with magnets.
<
A post processor will know how to remove the style tags (Tips and Warning) and
you want the text to be formatted.
When folded, the above would appear as:
>
[USER Tips] --------------------------- (4 lines)
[USER Warning]------------------------- (3 lines)
<
The user-defined, pre-formatted text block marker, <, behaves just like
pre-formatted text. But like >, it leaves the functional definition up to the
user. A simple user-defined, pre-formatted text block could be:
>
Tux
< _.._
< .-' `-.
< : ;
< ; ,_ _, ;
< : \{" "}/ :
< ,'.'"=..=''.'.
< ; / \ / \ ;
< .' ; '.__.' ; '.
< .-' .' '. '-.
< .' ; ; '.
< / / \ \
< ; ; ; ;
< ; `-._ _.-' ;
< ; ""--. .--"" ;
< '. _ ; ; _ .'
< {""..' '._.-. .-._.' '..""}
< \ ; ; /
< : : : :
< : :.__.: :
< \ /"-..-"\ / fsc
< '-.__.' '.__.-'
<
When folded it would be:
>
Tux
[USER BLOCK] -------------------------- (6 lines)
<
Like user-defined text, these blocks can be given user-defined styles. For
example:
>
<ASCIIart
< _.._
< .-' `-.
< : ;
< ; ,_ _, ;
< : \{" "}/ :
< ,'.'"=..=''.'.
< ; / \ / \ ;
< .' ; '.__.' ; '.
< .-' .' '. '-.
< .' ; ; '.
< / / \ \
< ; ; ; ;
< ; `-._ _.-' ;
< ; ""--. .--"" ;
< '. _ ; ; _ .'
< {""..' '._.-. .-._.' '..""}
< \ ; ; /
< : : : :
< : :.__.: :
< \ /"-..-"\ / fsc
< '-.__.' '.__.-'
<Code
< getRXDN macro
<
< local gRXD1, gRXD2
< bcf STATUS,C
< btfsc FLAGS,SERPOL
<
< goto gRXD1
< btfsc RXDN
< bsf STATUS,C
< goto gRXD2
<
< gRXD1 btfss RXDN
< bsf STATUS,C
< nop
< gRXD2
< endm
<
When folded, the above would appear as:
>
[USER BLOCK ASCIIart] ----------------- (22 lines)
[USER BLOCK Code] --------------------- (17 lines)
<
==============================================================================
Advanced VimOutliner *votl-advanced*
*votl-executable-lines*
Executable Lines~
Executable lines enable you to launch any command from a specially constructed
headline within VimOutliner. The line must be constructed like this:
>
Description _exe_ command
<
Here's an example to pull up Troubleshooters.Com:
>
Troubleshooters.Com _exe_ mozilla http://www.troubleshooters.com
<
Executable lines offer the huge benefit of a single-source knowledge tree,
where all your knowledge, no matter what its format, exists within a single
tree of outlines connected with inter-outline links and executable lines.
A more efficient and feature rich way to achieve this might be to use the UTL
plugin for vim. See the scripts section at http://www.vim.org
==============================================================================
Plugins *votl-plugins*
The VimOutliner distribution currently includes plugins for easy handling
of checkboxes, hoisting (see below), smart paste, clocking, math and format.
The checkboxes tags and smart paste plugins are enabled by default. The
hoisting, clocking, math and format plugins are disabled by default. To
enable these plugins look for the easy instructions for this in your
|vimoutlinerrc| file.
More information below and in the plugin files in the directory where
the VimOutliner is run from (either $HOME/.vim/vimoutliner/plugin for
manual installation or $HOME/.vim/bundle/vimoutliner/plugin when using
pathogen).
*votl-checkbox*
Checkboxes~
Checkboxes enable VimOutliner to understand tasks and calculate the current
status of todo-lists etc. Three special notations are used:
>
[_] an unchecked item or incomplete task
[X] a checked item or complete task
% a placeholder for percentage of completion
<
Several \-commands make up the user interface:
>
\cb Insert a check box on the current line or each line of the currently
selected range (including lines in selected but closed folds). This
command is currently not aware of body text. Automatic recalculation
of is performed for the entire root-parent branch that contains the
updated child. (see \cz)
\cx Toggle check box state (percentage aware)
\cd Delete check boxes
\c% Create a check box with percentage placeholder except on childless
parents
\cp Create a check box with percentage placeholder on all headings
\cz Compute completion for the tree below the current heading.
<
How do I use it?
Start with a simple example. Let's start planning a small party, say a barbecue.
1. Make the initial outline.
>
Barbecue
Guests
Bill and Barb
Larry and Louise
Marty and Mary
Chris and Christine
David and Darla
Noel and Susan
Food
Chicken
Ribs
Corn on the cob
Salad
Desert
Beverages
Soda
Iced Tea
Beer
Party Favors
Squirt guns
Hats
Name tags
Materials
Paper Plates
Napkins
Trash Containers
<
2. Add the check boxes.
This can be done by visually selecting them and typing \cb. When done, you
should see this:
>
[_] Barbecue
[_] Guests
[_] Bill and Barb
[_] Larry and Louise
[_] Marty and Mary
[_] Chris and Christine
[_] David and Darla
[_] Noel and Susan
[_] Food
[_] Chicken
[_] Ribs
[_] Corn on the cob
[_] Salad
[_] Desert
[_] Beverages
[_] Soda
[_] Iced Tea
[_] Beer
[_] Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] Materials
[_] Paper Plates
[_] Napkins
[_] Trash Containers
<
3. Now check off what's done.
Checking off what is complete is easy with the
\cx command. Just place the cursor on a heading and \cx it. Now you can see
what's done as long as the outline is fully expanded.
>
[_] Barbecue
[_] Guests
[X] Bill and Barb
[X] Larry and Louise
[X] Marty and Mary
[X] Chris and Christine
[X] David and Darla
[X] Noel and Susan
[_] Food
[X] Chicken
[X] Ribs
[_] Corn on the cob
[_] Salad
[X] Desert
[_] Beverages
[_] Soda
[X] Iced Tea
[X] Beer
[_] Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] Materials
[X] Paper Plates
[_] Napkins
[X] Trash Containers
<
4. Now summarize what's done.
You can summarize what is done with the \cz command. Place the cursor on the
'Barbecue' heading and \cz it. The command will recursively process the
outline and update the check boxes of the parent headlines. You should see:
(Note: the only change is on the 'Guests' heading. It changed because all of
its children are complete.)
>
[_] Barbecue
[X] Guests
[X] Bill and Barb
[X] Larry and Louise
[X] Marty and Mary
[X] Chris and Christine
[X] David and Darla
[X] Noel and Susan
[_] Food
[X] Chicken
[X] Ribs
[_] Corn on the cob
[_] Salad
[X] Desert
[_] Beverages
[_] Soda
[X] Iced Tea
[X] Beer
[_] Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] Materials
[X] Paper Plates
[_] Napkins
[X] Trash Containers
<
5. Add percentages for a better view.
You can get a much better view of what's going on, especially with collapsed
headings, if you add percentages. Place a % on each heading that has children
like this:
>
[_] % Barbecue
[X] % Guests
[X] Bill and Barb
[X] Larry and Louise
[X] Marty and Mary
[X] Chris and Christine
[X] David and Darla
[X] Noel and Susan
[_] % Food
[X] Chicken
[X] Ribs
[_] Corn on the cob
[_] Salad
[X] Desert
[_] % Beverages
[_] Soda
[X] Iced Tea
[X] Beer
[_] % Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] % Materials
[X] Paper Plates
[_] Napkins
[X] Trash Containers
<
6. Now compute the percentage of completion.
After adding the % symbols, place the cursor on the 'Barbecue' heading and
execute \cz as before. Keep in mind that the recursive percentages are
weighted. You should see:
>
[_] 58% Barbecue
[X] 100% Guests
[X] Bill and Barb
[X] Larry and Louise
[X] Marty and Mary
[X] Chris and Christine
[X] David and Darla
[X] Noel and Susan
[_] 60% Food
[X] Chicken
[X] Ribs
[_] Corn on the cob
[_] Salad
[X] Desert
[_] 66% Beverages
[_] Soda
[X] Iced Tea
[X] Beer
[_] 0% Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] 66% Materials
[X] Paper Plates
[_] Napkins
[X] Trash Containers
<
7. Complete a few more just for fun.
Mark Salad and Soda and you should see the outline below. Try playing around
with zc and zo to see the effects of opening and closing folds. Even if you
place the cursor on 'Barbecue' and zo it, you still have a good understanding
of how complete the project is.
>
[_] 69% Barbecue
[X] 100% Guests
[X] Bill and Barb
[X] Larry and Louise
[X] Marty and Mary
[X] Chris and Christine
[X] David and Darla
[X] Noel and Susan
[_] 80% Food
[X] Chicken
[X] Ribs
[_] Corn on the cob
[X] Salad
[X] Desert
[X] 100% Beverages
[X] Soda
[X] Iced Tea
[X] Beer
[_] 0% Party Favors
[_] Squirt guns
[_] Hats
[_] Name tags
[_] 66% Materials
[X] Paper Plates
[_] Napkins
[X] Trash Containers
<
*votl-hoisting*
Hoisting~
Hoisting is a way to focus on the offspring of the currently selected outline
item. The sub items will be presented as top level items in the automatically
extracted hoist-file located in the same directory as the main outline file.
You cannot hoist parts of an already hoisted file again.
To enable this plugin uncomment the following line in |vimoutlinerrc|:
>
"let g:vo_modules_load .= ':newhoist'
<
Once it is enabled, you hoist the subtopics of the currently selected
item with
\h Hoist the subtopics into a temporary file
The changes are merged back into the original file by closing the temporary
hoist file with
:q :wq :x ZZ
If something went wrong, you can perform a manual de-hoisting with the
following procedure:
Open the main file in VimOutliner Search for the line containing the __hoist
tag On this line, do
\H Manual de-hoisting
*votl-clock*
Clock~
The clock plugin is a little imitation of a nice feature from emacs org mode.
The clockpugin allows to track times and summarize them up in the parent
heading.
To enable this plugin uncomment the following line in |vimoutlinerrc|:
>
"let g:vo_modules_load .= ':clock'
<
To start clocking you need to write a heading containing times in square
brackets like shown below. After the closing bracket -> indicates the place
where the calculated time is written. The arrow can be followed by a char to
indicate to unit in which the time is displayed. Use 's' for seconds, 'm' for
minutes, 'h' for hours and 'd' for days. If no unit is given hours are used.
>
Year 2011 -> d
January ->
Monday, 3th [08:30:00 -- 17:45:00] -> m
Tuesday, 3th [08:50:25 -- 18:00:02] -> s
<
To summarize the times up within the outline headings ending with -> {char}
use
\cu Clock update with the cursor somewhere in the hierarchy.
After that the outline should look like this:
>
Year 2011 -> 0.77 d
January -> 18.41 h
Monday, 3th [08:30:00 -- 17:45:00] -> 555.00 m
Tuesday, 3th [08:50:25 -- 18:00:02] -> 32977 s
<
Every time the times are changed or the units where changed use \cu to update
all times within the hierarchy.
Mappings for fast clocking:
\cs Clock start. Date and current time as start and end time are
written at cursor position. Works in normal mode and insert mode.
>
Year 2011 -> 0.77 d
January -> 18.41 h
Monday, 3th [08:30:00 -- 17:45:00] -> 555.00 m
Tuesday, 3th [08:50:25 -- 18:00:02] -> 32977 s
2011-10-11 [01:32:11 -- 01:32:11] ->
>
To set a new end time, place the cursor at the desired line and use following
mapping:
\cS Clock stop. Set the end time to current time. This works also in
normal mode and insert mode.
>
Year 2011 -> 0.77 d
January -> 18.41 h
Monday, 3th [08:30:00 -- 17:45:00] -> 555.00 m
Tuesday, 3th [08:50:25 -- 18:00:02] -> 32977 s
2011-10-11 [01:32:11 -- 01:42:19] -> 0.17 h
>
At the moment there are no user defined time formats supported. And it's not
possible to clock times over the midnight like [22:25:00 -- 01:00:00], but
it's usable for the most important cases.
==============================================================================
Scripts *votl-scripts*
The VimOutliner distribution currently includes many useful
external scripts to support interoutline links, HTML export and
more. Details on a couple of the scripts appear in this section; for
the others see the usage section in the scripts. You can
also find several of these scripts on
https://sites.google.com/site/vimoutlinerinfo/scripts-for-vimoutliner.
The following instructions assume you have taken one of the recommended
steps in the `Helper Scripts` subsection of README.md so that you can
run the scripts without needing to spell out their location.
Interoutline Linking~
votl_maketags.py *votl-maketags*
This script supports links between different files. To create such a
link you should enter _tag_TTT where TTT is the tag name on one line,
and the file to which it links on the next line, indented. The target
path may use ~/ or ~user/ and environment variables like `$HOME`,
`${HOME}`, or `%HOME%` on Windows. If the path is relative, it will be
interpreted relative to the directory of the file in which the tag
reference occurs.
votl_maketags accepts one or more file names as arguments. Each will
be scanned for links. This writes to VimOutliner's tag file
`~/.vim/vimoutliner/votl_tags.tag`, creating any necessary directories
and files. If any target files are missing, votl_maketags will create
them.
Running votl_maketags repeatedly with different file arguments will
probably accumulate the results, but do so at your own risk. You can
delete votl_tags.tag and rerun votl_maketags to get a fresh start.
After having done that, if you are over the _tag_TTT in the source
file and press CTRL-] it should take you to the target, and CTRL-T in
the target will take you back.
Testing Inter-Outline Linking
Place the following two lines in $HOME/votl_test.otl:
>
_tag_newfile
votl_newfile.otl
<
Note that in the preceding, the 2nd line should be indented from the
first. Save the result. At the command prompt, run
>
votl_maketags.py $HOME/votl_test.otl
vim $HOME/votl_test.otl
<
In vim, do this:
- Cursor to the _tag_newfile marker
- Press CTRL-]
You should be brought to $HOME/votl_newfile.otl
- Press CTRL-T
You should be brought back to $HOME/votl_test.otl
This might also be achieved more efficiently by using the UTL plugin for
linking to other files and text. Check out the plugin at:
http://www.vim.org/scripts/script.php?script_id=293
HTML~
otl2html.py *otl2html*
This script transforms an outline into an HTML file. Get more
detailed information with
>
$ otl2html.py --help
<
This script does not adhere to the VimOutliner naming convention with the
'votl_' prefix because it is not necessary for any VimOutliner functionality.
It is provided both as a useful tool for creating HTML pages and HTML slides
from outlines and as a working demonstration of how to convert .otl files to
other formats.
==============================================================================
Using VimOutliner On Other File Types *votl-other-files*
How to use VimOutliner on non .otl files~
Vim plugins like VimOutliner are file extension based, meaning that if
you want to use VimOutliner on a file extension other than .otl, you
must declare that file extension in $HOME/.vim/ftdetect/votl.vim. In
this section we'll use the .emdl extension (Easy Menu Definition
Language) as an example.
To enable VimOutliner work with .emdl files, do this:
>
vim $HOME/.vim/ftdetect/votl.vim
<
Insert the following line as the last line of the file:
>
au! BufRead,BufNewFile *.emdl setfiletype votl
<
Save and exit
>
gvim $HOME/votl_test.emdl