doing 2.0.9.pre → 2.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +20 -0
  3. data/.yardoc/complete +0 -0
  4. data/.yardoc/object_types +0 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/.yardopts +1 -0
  8. data/CHANGELOG.md +1 -1
  9. data/Gemfile.lock +30 -10
  10. data/README.md +1 -1
  11. data/Rakefile +8 -1
  12. data/bin/doing +76 -30
  13. data/doc/Array.html +135 -0
  14. data/doc/Doing/Color.html +506 -0
  15. data/doc/Doing/Configuration.html +680 -0
  16. data/doc/Doing/Errors/DoingNoTraceError.html +186 -0
  17. data/doc/Doing/Errors/DoingRuntimeError.html +186 -0
  18. data/doc/Doing/Errors/DoingStandardError.html +186 -0
  19. data/doc/Doing/Errors/EmptyInput.html +186 -0
  20. data/doc/Doing/Errors/NoResults.html +186 -0
  21. data/doc/Doing/Errors/PluginException.html +248 -0
  22. data/doc/Doing/Errors/UserCancelled.html +186 -0
  23. data/doc/Doing/Errors/WrongCommand.html +186 -0
  24. data/doc/Doing/Errors.html +191 -0
  25. data/doc/Doing/Hooks.html +364 -0
  26. data/doc/Doing/Item.html +1385 -0
  27. data/doc/Doing/Items.html +393 -0
  28. data/doc/Doing/LogAdapter.html +1650 -0
  29. data/doc/Doing/Note.html +535 -0
  30. data/doc/Doing/Pager.html +268 -0
  31. data/doc/Doing/Plugins.html +849 -0
  32. data/doc/Doing/Util.html +870 -0
  33. data/doc/Doing/WWID.html +4827 -0
  34. data/doc/Doing.html +145 -0
  35. data/doc/GLI/Commands/MarkdownDocumentListener.html +763 -0
  36. data/doc/GLI/Commands.html +115 -0
  37. data/doc/GLI.html +115 -0
  38. data/doc/Hash.html +332 -0
  39. data/doc/Status.html +292 -0
  40. data/doc/String.html +1714 -0
  41. data/doc/Symbol.html +250 -0
  42. data/doc/Time.html +182 -0
  43. data/doc/_index.html +411 -0
  44. data/doc/class_list.html +51 -0
  45. data/doc/css/common.css +1 -0
  46. data/doc/css/full_list.css +58 -0
  47. data/doc/css/style.css +497 -0
  48. data/doc/file.README.html +123 -0
  49. data/doc/file_list.html +56 -0
  50. data/doc/frames.html +17 -0
  51. data/doc/index.html +123 -0
  52. data/doc/js/app.js +314 -0
  53. data/doc/js/full_list.js +216 -0
  54. data/doc/js/jquery.js +4 -0
  55. data/doc/method_list.html +1867 -0
  56. data/doc/top-level-namespace.html +112 -0
  57. data/doing.gemspec +5 -1
  58. data/doing.rdoc +86 -16
  59. data/example_plugin.rb +6 -6
  60. data/lib/doing/array.rb +1 -1
  61. data/lib/doing/configuration.rb +14 -12
  62. data/lib/doing/hash.rb +1 -1
  63. data/lib/doing/item.rb +101 -17
  64. data/lib/doing/log_adapter.rb +123 -113
  65. data/lib/doing/note.rb +1 -1
  66. data/lib/doing/plugin_manager.rb +5 -5
  67. data/lib/doing/plugins/export/csv_export.rb +1 -1
  68. data/lib/doing/plugins/export/template_export.rb +5 -7
  69. data/lib/doing/plugins/import/calendar_import.rb +1 -1
  70. data/lib/doing/plugins/import/doing_import.rb +4 -4
  71. data/lib/doing/plugins/import/timing_import.rb +5 -3
  72. data/lib/doing/string.rb +75 -22
  73. data/lib/doing/symbol.rb +9 -5
  74. data/lib/doing/time.rb +1 -1
  75. data/lib/doing/util.rb +18 -11
  76. data/lib/doing/version.rb +1 -1
  77. data/lib/doing/wwid.rb +419 -326
  78. data/lib/doing/wwidfile.rb +5 -5
  79. data/lib/doing.rb +2 -1
  80. data/lib/examples/plugins/say_export.rb +6 -6
  81. data/rdocfixer.rb +1 -1
  82. data/yard_templates/default/method_details/setup.rb +3 -0
  83. metadata +117 -4
@@ -0,0 +1,4827 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Doing::WWID
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Doing::WWID";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (W)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
41
+ &raquo;
42
+ <span class="title">WWID</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Doing::WWID
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Doing::WWID</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/doing/wwid.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>Main &quot;What Was I Doing&quot; methods</p>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+
112
+ </div>
113
+
114
+
115
+
116
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#additional_configs-instance_method" title="#additional_configs (instance method)">#<strong>additional_configs</strong> &#x21d2; Object </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+ <span class="note title readonly">readonly</span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute additional_configs.</p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#auto_tag-instance_method" title="#auto_tag (instance method)">#<strong>auto_tag</strong> &#x21d2; Object </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute auto_tag.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong> &#x21d2; Object </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute config.</p>
194
+ </div></span>
195
+
196
+ </li>
197
+
198
+
199
+ <li class="public ">
200
+ <span class="summary_signature">
201
+
202
+ <a href="#config_file-instance_method" title="#config_file (instance method)">#<strong>config_file</strong> &#x21d2; Object </a>
203
+
204
+
205
+
206
+ </span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute config_file.</p>
220
+ </div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> &#x21d2; Object </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+
236
+
237
+ <span class="note title readonly">readonly</span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute content.</p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#current_section-instance_method" title="#current_section (instance method)">#<strong>current_section</strong> &#x21d2; Object </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+ <span class="note title readonly">readonly</span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute current_section.</p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ <li class="public ">
282
+ <span class="summary_signature">
283
+
284
+ <a href="#default_option-instance_method" title="#default_option (instance method)">#<strong>default_option</strong> &#x21d2; Object </a>
285
+
286
+
287
+
288
+ </span>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute default_option.</p>
302
+ </div></span>
303
+
304
+ </li>
305
+
306
+
307
+ <li class="public ">
308
+ <span class="summary_signature">
309
+
310
+ <a href="#doing_file-instance_method" title="#doing_file (instance method)">#<strong>doing_file</strong> &#x21d2; Object </a>
311
+
312
+
313
+
314
+ </span>
315
+
316
+
317
+
318
+
319
+ <span class="note title readonly">readonly</span>
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute doing_file.</p>
330
+ </div></span>
331
+
332
+ </li>
333
+
334
+
335
+ </ul>
336
+
337
+
338
+
339
+
340
+
341
+ <h2>
342
+ Instance Method Summary
343
+ <small><a href="#" class="summary_toggle">collapse</a></small>
344
+ </h2>
345
+
346
+ <ul class="summary">
347
+
348
+ <li class="public ">
349
+ <span class="summary_signature">
350
+
351
+ <a href="#act_on-instance_method" title="#act_on (instance method)">#<strong>act_on</strong>(items, opt = {}) &#x21d2; Object </a>
352
+
353
+
354
+
355
+ </span>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+ <span class="summary_desc"><div class='inline'><p>Perform actions on a set of entries.</p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ <li class="public ">
372
+ <span class="summary_signature">
373
+
374
+ <a href="#add_item-instance_method" title="#add_item (instance method)">#<strong>add_item</strong>(title, section = nil, opt = {}) &#x21d2; Object </a>
375
+
376
+
377
+
378
+ </span>
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <span class="summary_desc"><div class='inline'><p>Adds an entry.</p>
389
+ </div></span>
390
+
391
+ </li>
392
+
393
+
394
+ <li class="public ">
395
+ <span class="summary_signature">
396
+
397
+ <a href="#add_section-instance_method" title="#add_section (instance method)">#<strong>add_section</strong>(title) &#x21d2; Object </a>
398
+
399
+
400
+
401
+ </span>
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+ <span class="summary_desc"><div class='inline'><p>Adds a section.</p>
412
+ </div></span>
413
+
414
+ </li>
415
+
416
+
417
+ <li class="public ">
418
+ <span class="summary_signature">
419
+
420
+ <a href="#all_tags-instance_method" title="#all_tags (instance method)">#<strong>all_tags</strong>(items, opt: {}) &#x21d2; Object </a>
421
+
422
+
423
+
424
+ </span>
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+ <span class="summary_desc"><div class='inline'></div></span>
435
+
436
+ </li>
437
+
438
+
439
+ <li class="public ">
440
+ <span class="summary_signature">
441
+
442
+ <a href="#archive-instance_method" title="#archive (instance method)">#<strong>archive</strong>(section = @config[&#39;current_section&#39;], options = {}) &#x21d2; Object </a>
443
+
444
+
445
+
446
+ </span>
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+ <span class="summary_desc"><div class='inline'><p>Move entries from a section to Archive or other specified section.</p>
457
+ </div></span>
458
+
459
+ </li>
460
+
461
+
462
+ <li class="public ">
463
+ <span class="summary_signature">
464
+
465
+ <a href="#autotag-instance_method" title="#autotag (instance method)">#<strong>autotag</strong>(text) &#x21d2; Object </a>
466
+
467
+
468
+
469
+ </span>
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+ <span class="summary_desc"><div class='inline'><p>Uses &#39;autotag&#39; configuration to turn keywords into tags for time tracking.</p>
480
+ </div></span>
481
+
482
+ </li>
483
+
484
+
485
+ <li class="public ">
486
+ <span class="summary_signature">
487
+
488
+ <a href="#choose_from-instance_method" title="#choose_from (instance method)">#<strong>choose_from</strong>(options, prompt: &#39;Make a selection: &#39;, multiple: false, sorted: true, fzf_args: []) &#x21d2; String </a>
489
+
490
+
491
+
492
+ </span>
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+ <span class="summary_desc"><div class='inline'><p>Generate a menu of options and allow user selection.</p>
503
+ </div></span>
504
+
505
+ </li>
506
+
507
+
508
+ <li class="public ">
509
+ <span class="summary_signature">
510
+
511
+ <a href="#choose_from_items-instance_method" title="#choose_from_items (instance method)">#<strong>choose_from_items</strong>(items, opt = {}, include_section: false) &#x21d2; Object </a>
512
+
513
+
514
+
515
+ </span>
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+ <span class="summary_desc"><div class='inline'></div></span>
526
+
527
+ </li>
528
+
529
+
530
+ <li class="public ">
531
+ <span class="summary_signature">
532
+
533
+ <a href="#choose_section-instance_method" title="#choose_section (instance method)">#<strong>choose_section</strong> &#x21d2; String </a>
534
+
535
+
536
+
537
+ </span>
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+ <span class="summary_desc"><div class='inline'><p>Generate a menu of sections and allow user selection.</p>
548
+ </div></span>
549
+
550
+ </li>
551
+
552
+
553
+ <li class="public ">
554
+ <span class="summary_signature">
555
+
556
+ <a href="#choose_view-instance_method" title="#choose_view (instance method)">#<strong>choose_view</strong> &#x21d2; String </a>
557
+
558
+
559
+
560
+ </span>
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+ <span class="summary_desc"><div class='inline'><p>Generate a menu of views and allow user selection.</p>
571
+ </div></span>
572
+
573
+ </li>
574
+
575
+
576
+ <li class="public ">
577
+ <span class="summary_signature">
578
+
579
+ <a href="#chronify-instance_method" title="#chronify (instance method)">#<strong>chronify</strong>(input, future: false, guess: :begin) &#x21d2; DateTime </a>
580
+
581
+
582
+
583
+ </span>
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+ <span class="summary_desc"><div class='inline'><p>Converts input string into a Time object when input takes on the following formats: - interval format e.g.</p>
594
+ </div></span>
595
+
596
+ </li>
597
+
598
+
599
+ <li class="public ">
600
+ <span class="summary_signature">
601
+
602
+ <a href="#chronify_qty-instance_method" title="#chronify_qty (instance method)">#<strong>chronify_qty</strong>(qty) &#x21d2; Integer </a>
603
+
604
+
605
+
606
+ </span>
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+ <span class="summary_desc"><div class='inline'><p>Converts simple strings into seconds that can be added to a Time object.</p>
617
+ </div></span>
618
+
619
+ </li>
620
+
621
+
622
+ <li class="public ">
623
+ <span class="summary_signature">
624
+
625
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(filename = nil) &#x21d2; Object </a>
626
+
627
+
628
+
629
+ </span>
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+ <span class="summary_desc"><div class='inline'><p>Create a new doing file.</p>
640
+ </div></span>
641
+
642
+ </li>
643
+
644
+
645
+ <li class="public ">
646
+ <span class="summary_signature">
647
+
648
+ <a href="#dedup-instance_method" title="#dedup (instance method)">#<strong>dedup</strong>(items, no_overlap = false) &#x21d2; Object </a>
649
+
650
+
651
+
652
+ </span>
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+ <span class="summary_desc"><div class='inline'><p>Remove items from a list that already exist in @content.</p>
663
+ </div></span>
664
+
665
+ </li>
666
+
667
+
668
+ <li class="public ">
669
+ <span class="summary_signature">
670
+
671
+ <a href="#delete_item-instance_method" title="#delete_item (instance method)">#<strong>delete_item</strong>(item, single: false) &#x21d2; Object </a>
672
+
673
+
674
+
675
+ </span>
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+ <span class="summary_desc"><div class='inline'><p>Delete an item from the index.</p>
686
+ </div></span>
687
+
688
+ </li>
689
+
690
+
691
+ <li class="public ">
692
+ <span class="summary_signature">
693
+
694
+ <a href="#edit_last-instance_method" title="#edit_last (instance method)">#<strong>edit_last</strong>(section: &#39;All&#39;, options: {}) &#x21d2; Object </a>
695
+
696
+
697
+
698
+ </span>
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <span class="summary_desc"><div class='inline'><p>Edit the last entry.</p>
709
+ </div></span>
710
+
711
+ </li>
712
+
713
+
714
+ <li class="public ">
715
+ <span class="summary_signature">
716
+
717
+ <a href="#filter_items-instance_method" title="#filter_items (instance method)">#<strong>filter_items</strong>(items = [], opt: {}) &#x21d2; Object </a>
718
+
719
+
720
+
721
+ </span>
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+ <span class="summary_desc"><div class='inline'><p>Filter items based on search criteria.</p>
732
+ </div></span>
733
+
734
+ </li>
735
+
736
+
737
+ <li class="public ">
738
+ <span class="summary_signature">
739
+
740
+ <a href="#fork_editor-instance_method" title="#fork_editor (instance method)">#<strong>fork_editor</strong>(input = &#39;&#39;) &#x21d2; Object </a>
741
+
742
+
743
+
744
+ </span>
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+ <span class="summary_desc"><div class='inline'><p>Create a process for an editor and wait for the file handle to return.</p>
755
+ </div></span>
756
+
757
+ </li>
758
+
759
+
760
+ <li class="public ">
761
+ <span class="summary_signature">
762
+
763
+ <a href="#format_input-instance_method" title="#format_input (instance method)">#<strong>format_input</strong>(input) &#x21d2; Array </a>
764
+
765
+
766
+
767
+ </span>
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+ <span class="summary_desc"><div class='inline'><p>Takes a multi-line string and formats it as an entry.</p>
778
+ </div></span>
779
+
780
+ </li>
781
+
782
+
783
+ <li class="public ">
784
+ <span class="summary_signature">
785
+
786
+ <a href="#format_time-instance_method" title="#format_time (instance method)">#<strong>format_time</strong>(seconds, human: false) &#x21d2; Object </a>
787
+
788
+
789
+
790
+ </span>
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+ <span class="summary_desc"><div class='inline'><p>Format human readable time from seconds.</p>
801
+ </div></span>
802
+
803
+ </li>
804
+
805
+
806
+ <li class="public ">
807
+ <span class="summary_signature">
808
+
809
+ <a href="#get_interval-instance_method" title="#get_interval (instance method)">#<strong>get_interval</strong>(item, formatted: true, record: true) &#x21d2; Object </a>
810
+
811
+
812
+
813
+ </span>
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+ <span class="summary_desc"><div class='inline'><p>Gets the interval between entry&#39;s start date and @done date.</p>
824
+ </div></span>
825
+
826
+ </li>
827
+
828
+
829
+ <li class="public ">
830
+ <span class="summary_signature">
831
+
832
+ <a href="#get_view-instance_method" title="#get_view (instance method)">#<strong>get_view</strong>(title) &#x21d2; Object </a>
833
+
834
+
835
+
836
+ </span>
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+ <span class="summary_desc"><div class='inline'><p>Gets a view from configuration.</p>
847
+ </div></span>
848
+
849
+ </li>
850
+
851
+
852
+ <li class="public ">
853
+ <span class="summary_signature">
854
+
855
+ <a href="#guess_section-instance_method" title="#guess_section (instance method)">#<strong>guess_section</strong>(frag, guessed: false, suggest: false) &#x21d2; Object </a>
856
+
857
+
858
+
859
+ </span>
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+ <span class="summary_desc"><div class='inline'><p>Attempt to match a string with an existing section.</p>
870
+ </div></span>
871
+
872
+ </li>
873
+
874
+
875
+ <li class="public ">
876
+ <span class="summary_signature">
877
+
878
+ <a href="#guess_view-instance_method" title="#guess_view (instance method)">#<strong>guess_view</strong>(frag, guessed: false, suggest: false) &#x21d2; Object </a>
879
+
880
+
881
+
882
+ </span>
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+ <span class="summary_desc"><div class='inline'><p>Attempt to match a string with an existing view.</p>
893
+ </div></span>
894
+
895
+ </li>
896
+
897
+
898
+ <li class="public ">
899
+ <span class="summary_signature">
900
+
901
+ <a href="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(paths, opt = {}) &#x21d2; Object </a>
902
+
903
+
904
+
905
+ </span>
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+ <span class="summary_desc"><div class='inline'><p>Imports external entries.</p>
916
+ </div></span>
917
+
918
+ </li>
919
+
920
+
921
+ <li class="public ">
922
+ <span class="summary_signature">
923
+
924
+ <a href="#init_doing_file-instance_method" title="#init_doing_file (instance method)">#<strong>init_doing_file</strong>(path = nil) &#x21d2; Object </a>
925
+
926
+
927
+
928
+ </span>
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+ <span class="summary_desc"><div class='inline'><p>Initializes the doing file.</p>
939
+ </div></span>
940
+
941
+ </li>
942
+
943
+
944
+ <li class="public ">
945
+ <span class="summary_signature">
946
+
947
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; WWID </a>
948
+
949
+
950
+
951
+ </span>
952
+
953
+
954
+ <span class="note title constructor">constructor</span>
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+ <span class="summary_desc"><div class='inline'><p>Initializes the object.</p>
964
+ </div></span>
965
+
966
+ </li>
967
+
968
+
969
+ <li class="public ">
970
+ <span class="summary_signature">
971
+
972
+ <a href="#interactive-instance_method" title="#interactive (instance method)">#<strong>interactive</strong>(opt = {}) &#x21d2; Object </a>
973
+
974
+
975
+
976
+ </span>
977
+
978
+
979
+
980
+
981
+
982
+
983
+
984
+
985
+
986
+ <span class="summary_desc"><div class='inline'><p>Display an interactive menu of entries.</p>
987
+ </div></span>
988
+
989
+ </li>
990
+
991
+
992
+ <li class="public ">
993
+ <span class="summary_signature">
994
+
995
+ <a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong>(times: true, section: nil, options: {}) &#x21d2; Object </a>
996
+
997
+
998
+
999
+ </span>
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+ <span class="summary_desc"><div class='inline'><p>Show the last entry.</p>
1010
+ </div></span>
1011
+
1012
+ </li>
1013
+
1014
+
1015
+ <li class="public ">
1016
+ <span class="summary_signature">
1017
+
1018
+ <a href="#last_entry-instance_method" title="#last_entry (instance method)">#<strong>last_entry</strong>(opt = {}) &#x21d2; Object </a>
1019
+
1020
+
1021
+
1022
+ </span>
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+ <span class="summary_desc"><div class='inline'><p>Get the last entry.</p>
1033
+ </div></span>
1034
+
1035
+ </li>
1036
+
1037
+
1038
+ <li class="public ">
1039
+ <span class="summary_signature">
1040
+
1041
+ <a href="#last_note-instance_method" title="#last_note (instance method)">#<strong>last_note</strong>(section = &#39;All&#39;) &#x21d2; Object </a>
1042
+
1043
+
1044
+
1045
+ </span>
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+ <span class="summary_desc"><div class='inline'><p>Return the content of the last note for a given section.</p>
1056
+ </div></span>
1057
+
1058
+ </li>
1059
+
1060
+
1061
+ <li class="public ">
1062
+ <span class="summary_signature">
1063
+
1064
+ <a href="#list_date-instance_method" title="#list_date (instance method)">#<strong>list_date</strong>(dates, section, times = nil, output = nil, opt = {}) &#x21d2; Object </a>
1065
+
1066
+
1067
+
1068
+ </span>
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+ <span class="summary_desc"><div class='inline'><p>Display entries within a date range.</p>
1079
+ </div></span>
1080
+
1081
+ </li>
1082
+
1083
+
1084
+ <li class="public ">
1085
+ <span class="summary_signature">
1086
+
1087
+ <a href="#list_section-instance_method" title="#list_section (instance method)">#<strong>list_section</strong>(opt = {}) &#x21d2; Object </a>
1088
+
1089
+
1090
+
1091
+ </span>
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+ <span class="summary_desc"><div class='inline'><p>Display contents of a section based on options.</p>
1102
+ </div></span>
1103
+
1104
+ </li>
1105
+
1106
+
1107
+ <li class="public ">
1108
+ <span class="summary_signature">
1109
+
1110
+ <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; Object </a>
1111
+
1112
+
1113
+
1114
+ </span>
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+ <span class="summary_desc"><div class='inline'><p>Logger.</p>
1125
+ </div></span>
1126
+
1127
+ </li>
1128
+
1129
+
1130
+ <li class="public ">
1131
+ <span class="summary_signature">
1132
+
1133
+ <a href="#move_item-instance_method" title="#move_item (instance method)">#<strong>move_item</strong>(item, section, label: true) &#x21d2; Item </a>
1134
+
1135
+
1136
+
1137
+ </span>
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+ <span class="summary_desc"><div class='inline'><p>Move item from current section to destination section.</p>
1148
+ </div></span>
1149
+
1150
+ </li>
1151
+
1152
+
1153
+ <li class="public ">
1154
+ <span class="summary_signature">
1155
+
1156
+ <a href="#next_item-instance_method" title="#next_item (instance method)">#<strong>next_item</strong>(item, options = {}) &#x21d2; Item </a>
1157
+
1158
+
1159
+
1160
+ </span>
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+ <span class="summary_desc"><div class='inline'><p>Get next item in the index.</p>
1171
+ </div></span>
1172
+
1173
+ </li>
1174
+
1175
+
1176
+ <li class="public ">
1177
+ <span class="summary_signature">
1178
+
1179
+ <a href="#recent-instance_method" title="#recent (instance method)">#<strong>recent</strong>(count = 10, section = nil, opt = {}) &#x21d2; Object </a>
1180
+
1181
+
1182
+
1183
+ </span>
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+ <span class="summary_desc"><div class='inline'><p>Show recent entries.</p>
1194
+ </div></span>
1195
+
1196
+ </li>
1197
+
1198
+
1199
+ <li class="public ">
1200
+ <span class="summary_signature">
1201
+
1202
+ <a href="#repeat_item-instance_method" title="#repeat_item (instance method)">#<strong>repeat_item</strong>(item, opt = {}) &#x21d2; Object </a>
1203
+
1204
+
1205
+
1206
+ </span>
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+ <span class="summary_desc"><div class='inline'></div></span>
1217
+
1218
+ </li>
1219
+
1220
+
1221
+ <li class="public ">
1222
+ <span class="summary_signature">
1223
+
1224
+ <a href="#repeat_last-instance_method" title="#repeat_last (instance method)">#<strong>repeat_last</strong>(opt = {}) &#x21d2; Object </a>
1225
+
1226
+
1227
+
1228
+ </span>
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+ <span class="summary_desc"><div class='inline'><p>Restart the last entry.</p>
1239
+ </div></span>
1240
+
1241
+ </li>
1242
+
1243
+
1244
+ <li class="public ">
1245
+ <span class="summary_signature">
1246
+
1247
+ <a href="#reset_item-instance_method" title="#reset_item (instance method)">#<strong>reset_item</strong>(item, resume: false) &#x21d2; Object </a>
1248
+
1249
+
1250
+
1251
+ </span>
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+ <span class="summary_desc"><div class='inline'></div></span>
1262
+
1263
+ </li>
1264
+
1265
+
1266
+ <li class="public ">
1267
+ <span class="summary_signature">
1268
+
1269
+ <a href="#restore_backup-instance_method" title="#restore_backup (instance method)">#<strong>restore_backup</strong>(file) &#x21d2; Object </a>
1270
+
1271
+
1272
+
1273
+ </span>
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+ <span class="summary_desc"><div class='inline'><p>Restore a backed up version of a file.</p>
1284
+ </div></span>
1285
+
1286
+ </li>
1287
+
1288
+
1289
+ <li class="public ">
1290
+ <span class="summary_signature">
1291
+
1292
+ <a href="#rotate-instance_method" title="#rotate (instance method)">#<strong>rotate</strong>(opt = {}) &#x21d2; Object </a>
1293
+
1294
+
1295
+
1296
+ </span>
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+ <span class="summary_desc"><div class='inline'><p>Rename doing file with date and start fresh one.</p>
1307
+ </div></span>
1308
+
1309
+ </li>
1310
+
1311
+
1312
+ <li class="public ">
1313
+ <span class="summary_signature">
1314
+
1315
+ <a href="#sections-instance_method" title="#sections (instance method)">#<strong>sections</strong> &#x21d2; Array </a>
1316
+
1317
+
1318
+
1319
+ </span>
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+ <span class="summary_desc"><div class='inline'><p>List sections.</p>
1330
+ </div></span>
1331
+
1332
+ </li>
1333
+
1334
+
1335
+ <li class="public ">
1336
+ <span class="summary_signature">
1337
+
1338
+ <a href="#stop_start-instance_method" title="#stop_start (instance method)">#<strong>stop_start</strong>(target_tag, opt = {}) &#x21d2; Object </a>
1339
+
1340
+
1341
+
1342
+ </span>
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+ <span class="summary_desc"><div class='inline'><p>Accepts one tag and the raw text of a new item if the passed tag is on any item, it&#39;s replaced with @done.</p>
1353
+ </div></span>
1354
+
1355
+ </li>
1356
+
1357
+
1358
+ <li class="public ">
1359
+ <span class="summary_signature">
1360
+
1361
+ <a href="#tag_groups-instance_method" title="#tag_groups (instance method)">#<strong>tag_groups</strong>(items, opt: {}) &#x21d2; Object </a>
1362
+
1363
+
1364
+
1365
+ </span>
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+ <span class="summary_desc"><div class='inline'></div></span>
1376
+
1377
+ </li>
1378
+
1379
+
1380
+ <li class="public ">
1381
+ <span class="summary_signature">
1382
+
1383
+ <a href="#tag_item-instance_method" title="#tag_item (instance method)">#<strong>tag_item</strong>(item, tags, remove: false, date: false, single: false) &#x21d2; Item </a>
1384
+
1385
+
1386
+
1387
+ </span>
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+ <span class="summary_desc"><div class='inline'><p>Tag an item from the index.</p>
1398
+ </div></span>
1399
+
1400
+ </li>
1401
+
1402
+
1403
+ <li class="public ">
1404
+ <span class="summary_signature">
1405
+
1406
+ <a href="#tag_last-instance_method" title="#tag_last (instance method)">#<strong>tag_last</strong>(opt = {}) &#x21d2; Object </a>
1407
+
1408
+
1409
+
1410
+ </span>
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+ <span class="summary_desc"><div class='inline'><p>Tag the last entry or X entries.</p>
1421
+ </div></span>
1422
+
1423
+ </li>
1424
+
1425
+
1426
+ <li class="public ">
1427
+ <span class="summary_signature">
1428
+
1429
+ <a href="#tag_times-instance_method" title="#tag_times (instance method)">#<strong>tag_times</strong>(format: :text, sort_by_name: false, sort_order: &#39;asc&#39;) &#x21d2; Object </a>
1430
+
1431
+
1432
+
1433
+ </span>
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ <span class="summary_desc"><div class='inline'><p>Get total elapsed time for all tags in selection.</p>
1444
+ </div></span>
1445
+
1446
+ </li>
1447
+
1448
+
1449
+ <li class="public ">
1450
+ <span class="summary_signature">
1451
+
1452
+ <a href="#today-instance_method" title="#today (instance method)">#<strong>today</strong>(times = true, output = nil, opt = {}) &#x21d2; Object </a>
1453
+
1454
+
1455
+
1456
+ </span>
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+ <span class="summary_desc"><div class='inline'><p>Show all entries from the current day.</p>
1467
+ </div></span>
1468
+
1469
+ </li>
1470
+
1471
+
1472
+ <li class="public ">
1473
+ <span class="summary_signature">
1474
+
1475
+ <a href="#update_item-instance_method" title="#update_item (instance method)">#<strong>update_item</strong>(old_item, new_item) &#x21d2; Object </a>
1476
+
1477
+
1478
+
1479
+ </span>
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+ <span class="summary_desc"><div class='inline'><p>Update an item in the index with a modified item.</p>
1490
+ </div></span>
1491
+
1492
+ </li>
1493
+
1494
+
1495
+ <li class="public ">
1496
+ <span class="summary_signature">
1497
+
1498
+ <a href="#views-instance_method" title="#views (instance method)">#<strong>views</strong> &#x21d2; Array </a>
1499
+
1500
+
1501
+
1502
+ </span>
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+ <span class="summary_desc"><div class='inline'><p>List available views.</p>
1513
+ </div></span>
1514
+
1515
+ </li>
1516
+
1517
+
1518
+ <li class="public ">
1519
+ <span class="summary_signature">
1520
+
1521
+ <a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(file = nil, backup: true) &#x21d2; Object </a>
1522
+
1523
+
1524
+
1525
+ </span>
1526
+
1527
+
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+ <span class="summary_desc"><div class='inline'><p>Write content to file or STDOUT.</p>
1536
+ </div></span>
1537
+
1538
+ </li>
1539
+
1540
+
1541
+ <li class="public ">
1542
+ <span class="summary_signature">
1543
+
1544
+ <a href="#yesterday-instance_method" title="#yesterday (instance method)">#<strong>yesterday</strong>(section, times = nil, output = nil, opt = {}) &#x21d2; Object </a>
1545
+
1546
+
1547
+
1548
+ </span>
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+ <span class="summary_desc"><div class='inline'><p>Show entries from the previous day.</p>
1559
+ </div></span>
1560
+
1561
+ </li>
1562
+
1563
+
1564
+ <li class="public ">
1565
+ <span class="summary_signature">
1566
+
1567
+ <a href="#yn-instance_method" title="#yn (instance method)">#<strong>yn</strong>(question, default_response: false) &#x21d2; Bool </a>
1568
+
1569
+
1570
+
1571
+ </span>
1572
+
1573
+
1574
+
1575
+
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+ <span class="summary_desc"><div class='inline'><p>Ask a yes or no question in the terminal.</p>
1582
+ </div></span>
1583
+
1584
+ </li>
1585
+
1586
+
1587
+ </ul>
1588
+
1589
+
1590
+ <div id="constructor_details" class="method_details_list">
1591
+ <h2>Constructor Details</h2>
1592
+
1593
+ <div class="method_details first">
1594
+ <h3 class="signature first" id="initialize-instance_method">
1595
+
1596
+ #<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Doing::WWID (class)">WWID</a></span></tt>
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+ </h3><div class="docstring">
1603
+ <div class="discussion">
1604
+ <p>Initializes the object.</p>
1605
+
1606
+
1607
+ </div>
1608
+ </div>
1609
+ <div class="tags">
1610
+
1611
+
1612
+ </div>
1613
+ </div>
1614
+
1615
+ </div>
1616
+
1617
+ <div id="instance_attr_details" class="attr_details">
1618
+ <h2>Instance Attribute Details</h2>
1619
+
1620
+
1621
+ <span id=""></span>
1622
+ <div class="method_details first">
1623
+ <h3 class="signature first" id="additional_configs-instance_method">
1624
+
1625
+ #<strong>additional_configs</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1626
+
1627
+
1628
+
1629
+
1630
+
1631
+ </h3><div class="docstring">
1632
+ <div class="discussion">
1633
+ <p>Returns the value of attribute additional_configs.</p>
1634
+
1635
+
1636
+ </div>
1637
+ </div>
1638
+ <div class="tags">
1639
+
1640
+
1641
+ </div>
1642
+ </div>
1643
+
1644
+
1645
+ <span id="auto_tag=-instance_method"></span>
1646
+ <div class="method_details ">
1647
+ <h3 class="signature " id="auto_tag-instance_method">
1648
+
1649
+ #<strong>auto_tag</strong> &#x21d2; <tt>Object</tt>
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+ </h3><div class="docstring">
1656
+ <div class="discussion">
1657
+ <p>Returns the value of attribute auto_tag.</p>
1658
+
1659
+
1660
+ </div>
1661
+ </div>
1662
+ <div class="tags">
1663
+
1664
+
1665
+ </div>
1666
+ </div>
1667
+
1668
+
1669
+ <span id="config=-instance_method"></span>
1670
+ <div class="method_details ">
1671
+ <h3 class="signature " id="config-instance_method">
1672
+
1673
+ #<strong>config</strong> &#x21d2; <tt>Object</tt>
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+ </h3><div class="docstring">
1680
+ <div class="discussion">
1681
+ <p>Returns the value of attribute config.</p>
1682
+
1683
+
1684
+ </div>
1685
+ </div>
1686
+ <div class="tags">
1687
+
1688
+
1689
+ </div>
1690
+ </div>
1691
+
1692
+
1693
+ <span id="config_file=-instance_method"></span>
1694
+ <div class="method_details ">
1695
+ <h3 class="signature " id="config_file-instance_method">
1696
+
1697
+ #<strong>config_file</strong> &#x21d2; <tt>Object</tt>
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+ </h3><div class="docstring">
1704
+ <div class="discussion">
1705
+ <p>Returns the value of attribute config_file.</p>
1706
+
1707
+
1708
+ </div>
1709
+ </div>
1710
+ <div class="tags">
1711
+
1712
+
1713
+ </div>
1714
+ </div>
1715
+
1716
+
1717
+ <span id=""></span>
1718
+ <div class="method_details ">
1719
+ <h3 class="signature " id="content-instance_method">
1720
+
1721
+ #<strong>content</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+ </h3><div class="docstring">
1728
+ <div class="discussion">
1729
+ <p>Returns the value of attribute content.</p>
1730
+
1731
+
1732
+ </div>
1733
+ </div>
1734
+ <div class="tags">
1735
+
1736
+
1737
+ </div>
1738
+ </div>
1739
+
1740
+
1741
+ <span id=""></span>
1742
+ <div class="method_details ">
1743
+ <h3 class="signature " id="current_section-instance_method">
1744
+
1745
+ #<strong>current_section</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+ </h3><div class="docstring">
1752
+ <div class="discussion">
1753
+ <p>Returns the value of attribute current_section.</p>
1754
+
1755
+
1756
+ </div>
1757
+ </div>
1758
+ <div class="tags">
1759
+
1760
+
1761
+ </div>
1762
+ </div>
1763
+
1764
+
1765
+ <span id="default_option=-instance_method"></span>
1766
+ <div class="method_details ">
1767
+ <h3 class="signature " id="default_option-instance_method">
1768
+
1769
+ #<strong>default_option</strong> &#x21d2; <tt>Object</tt>
1770
+
1771
+
1772
+
1773
+
1774
+
1775
+ </h3><div class="docstring">
1776
+ <div class="discussion">
1777
+ <p>Returns the value of attribute default_option.</p>
1778
+
1779
+
1780
+ </div>
1781
+ </div>
1782
+ <div class="tags">
1783
+
1784
+
1785
+ </div>
1786
+ </div>
1787
+
1788
+
1789
+ <span id=""></span>
1790
+ <div class="method_details ">
1791
+ <h3 class="signature " id="doing_file-instance_method">
1792
+
1793
+ #<strong>doing_file</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+ </h3><div class="docstring">
1800
+ <div class="discussion">
1801
+ <p>Returns the value of attribute doing_file.</p>
1802
+
1803
+
1804
+ </div>
1805
+ </div>
1806
+ <div class="tags">
1807
+
1808
+
1809
+ </div>
1810
+ </div>
1811
+
1812
+ </div>
1813
+
1814
+
1815
+ <div id="instance_method_details" class="method_details_list">
1816
+ <h2>Instance Method Details</h2>
1817
+
1818
+
1819
+ <div class="method_details first">
1820
+ <h3 class="signature first" id="act_on-instance_method">
1821
+
1822
+ #<strong>act_on</strong>(items, opt = {}) &#x21d2; <tt>Object</tt>
1823
+
1824
+
1825
+
1826
+
1827
+
1828
+ </h3><div class="docstring">
1829
+ <div class="discussion">
1830
+ <p>Perform actions on a set of entries. If
1831
+ no valid action is included in the opt
1832
+ hash and the terminal is a TTY, a menu
1833
+ will be presented</p>
1834
+
1835
+
1836
+ </div>
1837
+ </div>
1838
+ <div class="tags">
1839
+ <p class="tag_title">Parameters:</p>
1840
+ <ul class="param">
1841
+
1842
+ <li>
1843
+
1844
+ <span class='name'>items</span>
1845
+
1846
+
1847
+ <span class='type'></span>
1848
+
1849
+
1850
+
1851
+ &mdash;
1852
+ <div class='inline'><p>The items to affect</p>
1853
+ </div>
1854
+
1855
+ </li>
1856
+
1857
+ <li>
1858
+
1859
+ <span class='name'>opt</span>
1860
+
1861
+
1862
+ <span class='type'></span>
1863
+
1864
+
1865
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1866
+
1867
+
1868
+ &mdash;
1869
+ <div class='inline'><p>The actions and options. Can
1870
+ include :editor, :delete, :tag,
1871
+ :flag, :finish, :cancel, :archive,
1872
+ :output, :save_to, :again, and
1873
+ :resume</p>
1874
+ </div>
1875
+
1876
+ </li>
1877
+
1878
+ </ul>
1879
+
1880
+
1881
+ </div>
1882
+ </div>
1883
+
1884
+ <div class="method_details ">
1885
+ <h3 class="signature " id="add_item-instance_method">
1886
+
1887
+ #<strong>add_item</strong>(title, section = nil, opt = {}) &#x21d2; <tt>Object</tt>
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+ </h3><div class="docstring">
1894
+ <div class="discussion">
1895
+ <p>Adds an entry</p>
1896
+
1897
+
1898
+ </div>
1899
+ </div>
1900
+ <div class="tags">
1901
+ <p class="tag_title">Parameters:</p>
1902
+ <ul class="param">
1903
+
1904
+ <li>
1905
+
1906
+ <span class='name'>title</span>
1907
+
1908
+
1909
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1910
+
1911
+
1912
+
1913
+ &mdash;
1914
+ <div class='inline'><p>The entry title</p>
1915
+ </div>
1916
+
1917
+ </li>
1918
+
1919
+ <li>
1920
+
1921
+ <span class='name'>section</span>
1922
+
1923
+
1924
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1925
+
1926
+
1927
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1928
+
1929
+
1930
+ &mdash;
1931
+ <div class='inline'><p>The section to add to</p>
1932
+ </div>
1933
+
1934
+ </li>
1935
+
1936
+ <li>
1937
+
1938
+ <span class='name'>opt</span>
1939
+
1940
+
1941
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
1942
+
1943
+
1944
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1945
+
1946
+
1947
+ &mdash;
1948
+ <div class='inline'><p>Additional Options: :date, :note, :back, :timed</p>
1949
+ </div>
1950
+
1951
+ </li>
1952
+
1953
+ </ul>
1954
+
1955
+
1956
+ </div>
1957
+ </div>
1958
+
1959
+ <div class="method_details ">
1960
+ <h3 class="signature " id="add_section-instance_method">
1961
+
1962
+ #<strong>add_section</strong>(title) &#x21d2; <tt>Object</tt>
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+ </h3><div class="docstring">
1969
+ <div class="discussion">
1970
+ <p>Adds a section.</p>
1971
+
1972
+
1973
+ </div>
1974
+ </div>
1975
+ <div class="tags">
1976
+ <p class="tag_title">Parameters:</p>
1977
+ <ul class="param">
1978
+
1979
+ <li>
1980
+
1981
+ <span class='name'>title</span>
1982
+
1983
+
1984
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1985
+
1986
+
1987
+
1988
+ &mdash;
1989
+ <div class='inline'><p>The new section title</p>
1990
+ </div>
1991
+
1992
+ </li>
1993
+
1994
+ </ul>
1995
+
1996
+
1997
+ </div>
1998
+ </div>
1999
+
2000
+ <div class="method_details ">
2001
+ <h3 class="signature " id="all_tags-instance_method">
2002
+
2003
+ #<strong>all_tags</strong>(items, opt: {}) &#x21d2; <tt>Object</tt>
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+ </h3>
2010
+ </div>
2011
+
2012
+ <div class="method_details ">
2013
+ <h3 class="signature " id="archive-instance_method">
2014
+
2015
+ #<strong>archive</strong>(section = @config[&#39;current_section&#39;], options = {}) &#x21d2; <tt>Object</tt>
2016
+
2017
+
2018
+
2019
+
2020
+
2021
+ </h3><div class="docstring">
2022
+ <div class="discussion">
2023
+ <p>Move entries from a section to Archive or other specified
2024
+ section</p>
2025
+
2026
+
2027
+ </div>
2028
+ </div>
2029
+ <div class="tags">
2030
+ <p class="tag_title">Parameters:</p>
2031
+ <ul class="param">
2032
+
2033
+ <li>
2034
+
2035
+ <span class='name'>section</span>
2036
+
2037
+
2038
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2039
+
2040
+
2041
+ <em class="default">(defaults to: <tt>@config[&#39;current_section&#39;]</tt>)</em>
2042
+
2043
+
2044
+ &mdash;
2045
+ <div class='inline'><p>The source section</p>
2046
+ </div>
2047
+
2048
+ </li>
2049
+
2050
+ <li>
2051
+
2052
+ <span class='name'>options</span>
2053
+
2054
+
2055
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
2056
+
2057
+
2058
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
2059
+
2060
+
2061
+ &mdash;
2062
+ <div class='inline'><p>Options</p>
2063
+ </div>
2064
+
2065
+ </li>
2066
+
2067
+ </ul>
2068
+
2069
+
2070
+ </div>
2071
+ </div>
2072
+
2073
+ <div class="method_details ">
2074
+ <h3 class="signature " id="autotag-instance_method">
2075
+
2076
+ #<strong>autotag</strong>(text) &#x21d2; <tt>Object</tt>
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+ </h3><div class="docstring">
2083
+ <div class="discussion">
2084
+ <p>Uses &#39;autotag&#39; configuration to turn keywords into tags for time tracking.
2085
+ Does not repeat tags in a title, and only converts the first instance of an
2086
+ untagged keyword</p>
2087
+
2088
+
2089
+ </div>
2090
+ </div>
2091
+ <div class="tags">
2092
+ <p class="tag_title">Parameters:</p>
2093
+ <ul class="param">
2094
+
2095
+ <li>
2096
+
2097
+ <span class='name'>text</span>
2098
+
2099
+
2100
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2101
+
2102
+
2103
+
2104
+ &mdash;
2105
+ <div class='inline'><p>The text to tag</p>
2106
+ </div>
2107
+
2108
+ </li>
2109
+
2110
+ </ul>
2111
+
2112
+
2113
+ </div>
2114
+ </div>
2115
+
2116
+ <div class="method_details ">
2117
+ <h3 class="signature " id="choose_from-instance_method">
2118
+
2119
+ #<strong>choose_from</strong>(options, prompt: &#39;Make a selection: &#39;, multiple: false, sorted: true, fzf_args: []) &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+ </h3><div class="docstring">
2126
+ <div class="discussion">
2127
+ <p>Generate a menu of options and allow user selection</p>
2128
+
2129
+
2130
+ </div>
2131
+ </div>
2132
+ <div class="tags">
2133
+
2134
+ <p class="tag_title">Returns:</p>
2135
+ <ul class="return">
2136
+
2137
+ <li>
2138
+
2139
+
2140
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2141
+
2142
+
2143
+
2144
+ &mdash;
2145
+ <div class='inline'><p>The selected option</p>
2146
+ </div>
2147
+
2148
+ </li>
2149
+
2150
+ </ul>
2151
+
2152
+ </div>
2153
+ </div>
2154
+
2155
+ <div class="method_details ">
2156
+ <h3 class="signature " id="choose_from_items-instance_method">
2157
+
2158
+ #<strong>choose_from_items</strong>(items, opt = {}, include_section: false) &#x21d2; <tt>Object</tt>
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+ </h3>
2165
+ </div>
2166
+
2167
+ <div class="method_details ">
2168
+ <h3 class="signature " id="choose_section-instance_method">
2169
+
2170
+ #<strong>choose_section</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
2171
+
2172
+
2173
+
2174
+
2175
+
2176
+ </h3><div class="docstring">
2177
+ <div class="discussion">
2178
+ <p>Generate a menu of sections and allow user selection</p>
2179
+
2180
+
2181
+ </div>
2182
+ </div>
2183
+ <div class="tags">
2184
+
2185
+ <p class="tag_title">Returns:</p>
2186
+ <ul class="return">
2187
+
2188
+ <li>
2189
+
2190
+
2191
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2192
+
2193
+
2194
+
2195
+ &mdash;
2196
+ <div class='inline'><p>The selected section name</p>
2197
+ </div>
2198
+
2199
+ </li>
2200
+
2201
+ </ul>
2202
+
2203
+ </div>
2204
+ </div>
2205
+
2206
+ <div class="method_details ">
2207
+ <h3 class="signature " id="choose_view-instance_method">
2208
+
2209
+ #<strong>choose_view</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+ </h3><div class="docstring">
2216
+ <div class="discussion">
2217
+ <p>Generate a menu of views and allow user selection</p>
2218
+
2219
+
2220
+ </div>
2221
+ </div>
2222
+ <div class="tags">
2223
+
2224
+ <p class="tag_title">Returns:</p>
2225
+ <ul class="return">
2226
+
2227
+ <li>
2228
+
2229
+
2230
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2231
+
2232
+
2233
+
2234
+ &mdash;
2235
+ <div class='inline'><p>The selected view name</p>
2236
+ </div>
2237
+
2238
+ </li>
2239
+
2240
+ </ul>
2241
+
2242
+ </div>
2243
+ </div>
2244
+
2245
+ <div class="method_details ">
2246
+ <h3 class="signature " id="chronify-instance_method">
2247
+
2248
+ #<strong>chronify</strong>(input, future: false, guess: :begin) &#x21d2; <tt>DateTime</tt>
2249
+
2250
+
2251
+
2252
+
2253
+
2254
+ </h3><div class="docstring">
2255
+ <div class="discussion">
2256
+ <p>Converts input string into a Time object when input takes on the
2257
+ following formats:
2258
+ - interval format e.g. &#39;1d2h30m&#39;, &#39;45m&#39; etc.
2259
+ - a semantic phrase e.g. &#39;yesterday 5:30pm&#39;
2260
+ - a strftime e.g. &#39;2016-03-15 15:32:04 PDT&#39;</p>
2261
+
2262
+
2263
+ </div>
2264
+ </div>
2265
+ <div class="tags">
2266
+ <p class="tag_title">Parameters:</p>
2267
+ <ul class="param">
2268
+
2269
+ <li>
2270
+
2271
+ <span class='name'>input</span>
2272
+
2273
+
2274
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2275
+
2276
+
2277
+
2278
+ &mdash;
2279
+ <div class='inline'><p>String to chronify</p>
2280
+ </div>
2281
+
2282
+ </li>
2283
+
2284
+ </ul>
2285
+
2286
+ <p class="tag_title">Returns:</p>
2287
+ <ul class="return">
2288
+
2289
+ <li>
2290
+
2291
+
2292
+ <span class='type'>(<tt>DateTime</tt>)</span>
2293
+
2294
+
2295
+
2296
+ &mdash;
2297
+ <div class='inline'><p>result</p>
2298
+ </div>
2299
+
2300
+ </li>
2301
+
2302
+ </ul>
2303
+ <p class="tag_title">Raises:</p>
2304
+ <ul class="raise">
2305
+
2306
+ <li>
2307
+
2308
+
2309
+ <span class='type'>(<tt>InvalidTimeExpression</tt>)</span>
2310
+
2311
+
2312
+
2313
+ </li>
2314
+
2315
+ </ul>
2316
+
2317
+ </div>
2318
+ </div>
2319
+
2320
+ <div class="method_details ">
2321
+ <h3 class="signature " id="chronify_qty-instance_method">
2322
+
2323
+ #<strong>chronify_qty</strong>(qty) &#x21d2; <tt>Integer</tt>
2324
+
2325
+
2326
+
2327
+
2328
+
2329
+ </h3><div class="docstring">
2330
+ <div class="discussion">
2331
+ <p>Converts simple strings into seconds that can be added to a Time
2332
+ object</p>
2333
+
2334
+
2335
+ </div>
2336
+ </div>
2337
+ <div class="tags">
2338
+ <p class="tag_title">Parameters:</p>
2339
+ <ul class="param">
2340
+
2341
+ <li>
2342
+
2343
+ <span class='name'>qty</span>
2344
+
2345
+
2346
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2347
+
2348
+
2349
+
2350
+ &mdash;
2351
+ <div class='inline'><p>HH:MM or XX[dhm]<a href="1d2h30m,%2045m,%0A1.5d,%201h20m,%20etc.">[XXhm][XXm]</a></p>
2352
+ </div>
2353
+
2354
+ </li>
2355
+
2356
+ </ul>
2357
+
2358
+ <p class="tag_title">Returns:</p>
2359
+ <ul class="return">
2360
+
2361
+ <li>
2362
+
2363
+
2364
+ <span class='type'>(<tt>Integer</tt>)</span>
2365
+
2366
+
2367
+
2368
+ &mdash;
2369
+ <div class='inline'><p>seconds</p>
2370
+ </div>
2371
+
2372
+ </li>
2373
+
2374
+ </ul>
2375
+
2376
+ </div>
2377
+ </div>
2378
+
2379
+ <div class="method_details ">
2380
+ <h3 class="signature " id="create-instance_method">
2381
+
2382
+ #<strong>create</strong>(filename = nil) &#x21d2; <tt>Object</tt>
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+ </h3><div class="docstring">
2389
+ <div class="discussion">
2390
+ <p>Create a new doing file</p>
2391
+
2392
+
2393
+ </div>
2394
+ </div>
2395
+ <div class="tags">
2396
+
2397
+
2398
+ </div>
2399
+ </div>
2400
+
2401
+ <div class="method_details ">
2402
+ <h3 class="signature " id="dedup-instance_method">
2403
+
2404
+ #<strong>dedup</strong>(items, no_overlap = false) &#x21d2; <tt>Object</tt>
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+ </h3><div class="docstring">
2411
+ <div class="discussion">
2412
+ <p>Remove items from a list that already exist in @content</p>
2413
+
2414
+
2415
+ </div>
2416
+ </div>
2417
+ <div class="tags">
2418
+ <p class="tag_title">Parameters:</p>
2419
+ <ul class="param">
2420
+
2421
+ <li>
2422
+
2423
+ <span class='name'>items</span>
2424
+
2425
+
2426
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2427
+
2428
+
2429
+
2430
+ &mdash;
2431
+ <div class='inline'><p>The items to deduplicate</p>
2432
+ </div>
2433
+
2434
+ </li>
2435
+
2436
+ <li>
2437
+
2438
+ <span class='name'>no_overlap</span>
2439
+
2440
+
2441
+ <span class='type'>(<tt>Boolean</tt>)</span>
2442
+
2443
+
2444
+ <em class="default">(defaults to: <tt>false</tt>)</em>
2445
+
2446
+
2447
+ &mdash;
2448
+ <div class='inline'><p>Remove items with overlapping time spans</p>
2449
+ </div>
2450
+
2451
+ </li>
2452
+
2453
+ </ul>
2454
+
2455
+
2456
+ </div>
2457
+ </div>
2458
+
2459
+ <div class="method_details ">
2460
+ <h3 class="signature " id="delete_item-instance_method">
2461
+
2462
+ #<strong>delete_item</strong>(item, single: false) &#x21d2; <tt>Object</tt>
2463
+
2464
+
2465
+
2466
+
2467
+
2468
+ </h3><div class="docstring">
2469
+ <div class="discussion">
2470
+ <p>Delete an item from the index</p>
2471
+
2472
+
2473
+ </div>
2474
+ </div>
2475
+ <div class="tags">
2476
+ <p class="tag_title">Parameters:</p>
2477
+ <ul class="param">
2478
+
2479
+ <li>
2480
+
2481
+ <span class='name'>item</span>
2482
+
2483
+
2484
+ <span class='type'></span>
2485
+
2486
+
2487
+
2488
+ &mdash;
2489
+ <div class='inline'><p>The item</p>
2490
+ </div>
2491
+
2492
+ </li>
2493
+
2494
+ </ul>
2495
+
2496
+
2497
+ </div>
2498
+ </div>
2499
+
2500
+ <div class="method_details ">
2501
+ <h3 class="signature " id="edit_last-instance_method">
2502
+
2503
+ #<strong>edit_last</strong>(section: &#39;All&#39;, options: {}) &#x21d2; <tt>Object</tt>
2504
+
2505
+
2506
+
2507
+
2508
+
2509
+ </h3><div class="docstring">
2510
+ <div class="discussion">
2511
+ <p>Edit the last entry</p>
2512
+
2513
+
2514
+ </div>
2515
+ </div>
2516
+ <div class="tags">
2517
+ <p class="tag_title">Parameters:</p>
2518
+ <ul class="param">
2519
+
2520
+ <li>
2521
+
2522
+ <span class='name'>section</span>
2523
+
2524
+
2525
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2526
+
2527
+
2528
+ <em class="default">(defaults to: <tt>&#39;All&#39;</tt>)</em>
2529
+
2530
+
2531
+ &mdash;
2532
+ <div class='inline'><p>The section, default &quot;All&quot;</p>
2533
+ </div>
2534
+
2535
+ </li>
2536
+
2537
+ </ul>
2538
+
2539
+
2540
+ </div>
2541
+ </div>
2542
+
2543
+ <div class="method_details ">
2544
+ <h3 class="signature " id="filter_items-instance_method">
2545
+
2546
+ #<strong>filter_items</strong>(items = [], opt: {}) &#x21d2; <tt>Object</tt>
2547
+
2548
+
2549
+
2550
+
2551
+
2552
+ </h3><div class="docstring">
2553
+ <div class="discussion">
2554
+ <p>Filter items based on search criteria</p>
2555
+
2556
+
2557
+ </div>
2558
+ </div>
2559
+ <div class="tags">
2560
+ <p class="tag_title">Parameters:</p>
2561
+ <ul class="param">
2562
+
2563
+ <li>
2564
+
2565
+ <span class='name'>items</span>
2566
+
2567
+
2568
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2569
+
2570
+
2571
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
2572
+
2573
+
2574
+ &mdash;
2575
+ <div class='inline'><p>The items to filter (if empty, filters all items)</p>
2576
+ </div>
2577
+
2578
+ </li>
2579
+
2580
+ <li>
2581
+
2582
+ <span class='name'>opt</span>
2583
+
2584
+
2585
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
2586
+
2587
+
2588
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
2589
+
2590
+
2591
+ &mdash;
2592
+ <div class='inline'><p>The filter parameters</p>
2593
+ </div>
2594
+
2595
+ </li>
2596
+
2597
+ </ul>
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+ <p class="tag_title">Options Hash (<tt>opt:</tt>):</p>
2605
+ <ul class="option">
2606
+
2607
+ <li>
2608
+ <span class="name">:section</span>
2609
+ <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2610
+ <span class="default">
2611
+
2612
+ </span>
2613
+
2614
+ </li>
2615
+
2616
+ <li>
2617
+ <span class="name">:unfinished</span>
2618
+ <span class="type">(<tt>Boolean</tt>)</span>
2619
+ <span class="default">
2620
+
2621
+ </span>
2622
+
2623
+ </li>
2624
+
2625
+ <li>
2626
+ <span class="name">:tag</span>
2627
+ <span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2628
+ <span class="default">
2629
+
2630
+ &mdash; default:
2631
+ <tt>Array or comma-separated string</tt>
2632
+
2633
+ </span>
2634
+
2635
+ </li>
2636
+
2637
+ <li>
2638
+ <span class="name">:tag_bool</span>
2639
+ <span class="type">(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
2640
+ <span class="default">
2641
+
2642
+ &mdash; default:
2643
+ <tt>:and</tt>, <tt>:or</tt>, <tt>:not</tt>
2644
+
2645
+ </span>
2646
+
2647
+ </li>
2648
+
2649
+ <li>
2650
+ <span class="name">:search</span>
2651
+ <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2652
+ <span class="default">
2653
+
2654
+ &mdash; default:
2655
+ <tt>string</tt>, <tt>optional regex with //</tt>
2656
+
2657
+ </span>
2658
+
2659
+ </li>
2660
+
2661
+ <li>
2662
+ <span class="name">:date_filter</span>
2663
+ <span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2664
+ <span class="default">
2665
+
2666
+ </span>
2667
+
2668
+ &mdash; <div class='inline'><p>[[Time]start, [Time]end]</p>
2669
+ </div>
2670
+
2671
+ </li>
2672
+
2673
+ <li>
2674
+ <span class="name">:only_timed</span>
2675
+ <span class="type">(<tt>Boolean</tt>)</span>
2676
+ <span class="default">
2677
+
2678
+ </span>
2679
+
2680
+ </li>
2681
+
2682
+ <li>
2683
+ <span class="name">:before</span>
2684
+ <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2685
+ <span class="default">
2686
+
2687
+ &mdash; default:
2688
+ <tt>Date/Time string</tt>, <tt>unparsed</tt>
2689
+
2690
+ </span>
2691
+
2692
+ </li>
2693
+
2694
+ <li>
2695
+ <span class="name">:after</span>
2696
+ <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2697
+ <span class="default">
2698
+
2699
+ &mdash; default:
2700
+ <tt>Date/Time string</tt>, <tt>unparsed</tt>
2701
+
2702
+ </span>
2703
+
2704
+ </li>
2705
+
2706
+ <li>
2707
+ <span class="name">:today</span>
2708
+ <span class="type">(<tt>Boolean</tt>)</span>
2709
+ <span class="default">
2710
+
2711
+ </span>
2712
+
2713
+ </li>
2714
+
2715
+ <li>
2716
+ <span class="name">:yesterday</span>
2717
+ <span class="type">(<tt>Boolean</tt>)</span>
2718
+ <span class="default">
2719
+
2720
+ </span>
2721
+
2722
+ </li>
2723
+
2724
+ <li>
2725
+ <span class="name">:count</span>
2726
+ <span class="type">(<tt>Number</tt>)</span>
2727
+ <span class="default">
2728
+
2729
+ &mdash; default:
2730
+ <tt>Number to return</tt>
2731
+
2732
+ </span>
2733
+
2734
+ </li>
2735
+
2736
+ <li>
2737
+ <span class="name">:age</span>
2738
+ <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2739
+ <span class="default">
2740
+
2741
+ &mdash; default:
2742
+ <tt>&#39;old&#39; or &#39;new&#39;</tt>
2743
+
2744
+ </span>
2745
+
2746
+ </li>
2747
+
2748
+ </ul>
2749
+
2750
+
2751
+
2752
+ </div>
2753
+ </div>
2754
+
2755
+ <div class="method_details ">
2756
+ <h3 class="signature " id="fork_editor-instance_method">
2757
+
2758
+ #<strong>fork_editor</strong>(input = &#39;&#39;) &#x21d2; <tt>Object</tt>
2759
+
2760
+
2761
+
2762
+
2763
+
2764
+ </h3><div class="docstring">
2765
+ <div class="discussion">
2766
+ <p>Create a process for an editor and wait for the file handle to return</p>
2767
+
2768
+
2769
+ </div>
2770
+ </div>
2771
+ <div class="tags">
2772
+ <p class="tag_title">Parameters:</p>
2773
+ <ul class="param">
2774
+
2775
+ <li>
2776
+
2777
+ <span class='name'>input</span>
2778
+
2779
+
2780
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2781
+
2782
+
2783
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
2784
+
2785
+
2786
+ &mdash;
2787
+ <div class='inline'><p>Text input for editor</p>
2788
+ </div>
2789
+
2790
+ </li>
2791
+
2792
+ </ul>
2793
+
2794
+ <p class="tag_title">Raises:</p>
2795
+ <ul class="raise">
2796
+
2797
+ <li>
2798
+
2799
+
2800
+ <span class='type'>(<tt>MissingEditor</tt>)</span>
2801
+
2802
+
2803
+
2804
+ </li>
2805
+
2806
+ </ul>
2807
+
2808
+ </div>
2809
+ </div>
2810
+
2811
+ <div class="method_details ">
2812
+ <h3 class="signature " id="format_input-instance_method">
2813
+
2814
+ #<strong>format_input</strong>(input) &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
2815
+
2816
+
2817
+
2818
+
2819
+
2820
+ </h3><div class="docstring">
2821
+ <div class="discussion">
2822
+ <p>Takes a multi-line string and formats it as an entry</p>
2823
+
2824
+
2825
+ </div>
2826
+ </div>
2827
+ <div class="tags">
2828
+ <p class="tag_title">Parameters:</p>
2829
+ <ul class="param">
2830
+
2831
+ <li>
2832
+
2833
+ <span class='name'>input</span>
2834
+
2835
+
2836
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2837
+
2838
+
2839
+
2840
+ &mdash;
2841
+ <div class='inline'><p>The string to parse</p>
2842
+ </div>
2843
+
2844
+ </li>
2845
+
2846
+ </ul>
2847
+
2848
+ <p class="tag_title">Returns:</p>
2849
+ <ul class="return">
2850
+
2851
+ <li>
2852
+
2853
+
2854
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2855
+
2856
+
2857
+
2858
+ &mdash;
2859
+ <div class='inline'><p>[[String]title, [Note]note]</p>
2860
+ </div>
2861
+
2862
+ </li>
2863
+
2864
+ </ul>
2865
+ <p class="tag_title">Raises:</p>
2866
+ <ul class="raise">
2867
+
2868
+ <li>
2869
+
2870
+
2871
+ <span class='type'>(<tt>EmptyInput</tt>)</span>
2872
+
2873
+
2874
+
2875
+ </li>
2876
+
2877
+ </ul>
2878
+
2879
+ </div>
2880
+ </div>
2881
+
2882
+ <div class="method_details ">
2883
+ <h3 class="signature " id="format_time-instance_method">
2884
+
2885
+ #<strong>format_time</strong>(seconds, human: false) &#x21d2; <tt>Object</tt>
2886
+
2887
+
2888
+
2889
+
2890
+
2891
+ </h3><div class="docstring">
2892
+ <div class="discussion">
2893
+ <p>Format human readable time from seconds</p>
2894
+
2895
+
2896
+ </div>
2897
+ </div>
2898
+ <div class="tags">
2899
+ <p class="tag_title">Parameters:</p>
2900
+ <ul class="param">
2901
+
2902
+ <li>
2903
+
2904
+ <span class='name'>seconds</span>
2905
+
2906
+
2907
+ <span class='type'>(<tt>Integer</tt>)</span>
2908
+
2909
+
2910
+
2911
+ &mdash;
2912
+ <div class='inline'><p>Seconds</p>
2913
+ </div>
2914
+
2915
+ </li>
2916
+
2917
+ </ul>
2918
+
2919
+
2920
+ </div>
2921
+ </div>
2922
+
2923
+ <div class="method_details ">
2924
+ <h3 class="signature " id="get_interval-instance_method">
2925
+
2926
+ #<strong>get_interval</strong>(item, formatted: true, record: true) &#x21d2; <tt>Object</tt>
2927
+
2928
+
2929
+
2930
+
2931
+
2932
+ </h3><div class="docstring">
2933
+ <div class="discussion">
2934
+ <p>Gets the interval between entry&#39;s start
2935
+ date and @done date</p>
2936
+
2937
+
2938
+ </div>
2939
+ </div>
2940
+ <div class="tags">
2941
+ <p class="tag_title">Parameters:</p>
2942
+ <ul class="param">
2943
+
2944
+ <li>
2945
+
2946
+ <span class='name'>item</span>
2947
+
2948
+
2949
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
2950
+
2951
+
2952
+
2953
+ &mdash;
2954
+ <div class='inline'><p>The entry</p>
2955
+ </div>
2956
+
2957
+ </li>
2958
+
2959
+ <li>
2960
+
2961
+ <span class='name'>formatted</span>
2962
+
2963
+
2964
+ <span class='type'>(<tt>Boolean</tt>)</span>
2965
+
2966
+
2967
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2968
+
2969
+
2970
+ &mdash;
2971
+ <div class='inline'><p>Return human readable
2972
+ time (default seconds)</p>
2973
+ </div>
2974
+
2975
+ </li>
2976
+
2977
+ <li>
2978
+
2979
+ <span class='name'>record</span>
2980
+
2981
+
2982
+ <span class='type'>(<tt>Boolean</tt>)</span>
2983
+
2984
+
2985
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2986
+
2987
+
2988
+ &mdash;
2989
+ <div class='inline'><p>Add the interval to the
2990
+ total for each tag</p>
2991
+ </div>
2992
+
2993
+ </li>
2994
+
2995
+ </ul>
2996
+
2997
+ <p class="tag_title">Returns:</p>
2998
+ <ul class="return">
2999
+
3000
+ <li>
3001
+
3002
+
3003
+ <span class='type'></span>
3004
+
3005
+
3006
+
3007
+
3008
+ <div class='inline'><p>Interval in seconds, or [d, h, m] array if
3009
+ formatted is true. False if no end date or
3010
+ interval is 0</p>
3011
+ </div>
3012
+
3013
+ </li>
3014
+
3015
+ </ul>
3016
+
3017
+ </div>
3018
+ </div>
3019
+
3020
+ <div class="method_details ">
3021
+ <h3 class="signature " id="get_view-instance_method">
3022
+
3023
+ #<strong>get_view</strong>(title) &#x21d2; <tt>Object</tt>
3024
+
3025
+
3026
+
3027
+
3028
+
3029
+ </h3><div class="docstring">
3030
+ <div class="discussion">
3031
+ <p>Gets a view from configuration</p>
3032
+
3033
+
3034
+ </div>
3035
+ </div>
3036
+ <div class="tags">
3037
+ <p class="tag_title">Parameters:</p>
3038
+ <ul class="param">
3039
+
3040
+ <li>
3041
+
3042
+ <span class='name'>title</span>
3043
+
3044
+
3045
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3046
+
3047
+
3048
+
3049
+ &mdash;
3050
+ <div class='inline'><p>The title of the view to retrieve</p>
3051
+ </div>
3052
+
3053
+ </li>
3054
+
3055
+ </ul>
3056
+
3057
+
3058
+ </div>
3059
+ </div>
3060
+
3061
+ <div class="method_details ">
3062
+ <h3 class="signature " id="guess_section-instance_method">
3063
+
3064
+ #<strong>guess_section</strong>(frag, guessed: false, suggest: false) &#x21d2; <tt>Object</tt>
3065
+
3066
+
3067
+
3068
+
3069
+
3070
+ </h3><div class="docstring">
3071
+ <div class="discussion">
3072
+ <p>Attempt to match a string with an existing section</p>
3073
+
3074
+
3075
+ </div>
3076
+ </div>
3077
+ <div class="tags">
3078
+ <p class="tag_title">Parameters:</p>
3079
+ <ul class="param">
3080
+
3081
+ <li>
3082
+
3083
+ <span class='name'>frag</span>
3084
+
3085
+
3086
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3087
+
3088
+
3089
+
3090
+ &mdash;
3091
+ <div class='inline'><p>The user-provided string</p>
3092
+ </div>
3093
+
3094
+ </li>
3095
+
3096
+ <li>
3097
+
3098
+ <span class='name'>guessed</span>
3099
+
3100
+
3101
+ <span class='type'>(<tt>Boolean</tt>)</span>
3102
+
3103
+
3104
+ <em class="default">(defaults to: <tt>false</tt>)</em>
3105
+
3106
+
3107
+ &mdash;
3108
+ <div class='inline'><p>already guessed and failed</p>
3109
+ </div>
3110
+
3111
+ </li>
3112
+
3113
+ </ul>
3114
+
3115
+
3116
+ </div>
3117
+ </div>
3118
+
3119
+ <div class="method_details ">
3120
+ <h3 class="signature " id="guess_view-instance_method">
3121
+
3122
+ #<strong>guess_view</strong>(frag, guessed: false, suggest: false) &#x21d2; <tt>Object</tt>
3123
+
3124
+
3125
+
3126
+
3127
+
3128
+ </h3><div class="docstring">
3129
+ <div class="discussion">
3130
+ <p>Attempt to match a string with an existing view</p>
3131
+
3132
+
3133
+ </div>
3134
+ </div>
3135
+ <div class="tags">
3136
+ <p class="tag_title">Parameters:</p>
3137
+ <ul class="param">
3138
+
3139
+ <li>
3140
+
3141
+ <span class='name'>frag</span>
3142
+
3143
+
3144
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3145
+
3146
+
3147
+
3148
+ &mdash;
3149
+ <div class='inline'><p>The user-provided string</p>
3150
+ </div>
3151
+
3152
+ </li>
3153
+
3154
+ <li>
3155
+
3156
+ <span class='name'>guessed</span>
3157
+
3158
+
3159
+ <span class='type'>(<tt>Boolean</tt>)</span>
3160
+
3161
+
3162
+ <em class="default">(defaults to: <tt>false</tt>)</em>
3163
+
3164
+
3165
+ &mdash;
3166
+ <div class='inline'><p>already guessed</p>
3167
+ </div>
3168
+
3169
+ </li>
3170
+
3171
+ </ul>
3172
+
3173
+
3174
+ </div>
3175
+ </div>
3176
+
3177
+ <div class="method_details ">
3178
+ <h3 class="signature " id="import-instance_method">
3179
+
3180
+ #<strong>import</strong>(paths, opt = {}) &#x21d2; <tt>Object</tt>
3181
+
3182
+
3183
+
3184
+
3185
+
3186
+ </h3><div class="docstring">
3187
+ <div class="discussion">
3188
+ <p>Imports external entries</p>
3189
+
3190
+
3191
+ </div>
3192
+ </div>
3193
+ <div class="tags">
3194
+ <p class="tag_title">Parameters:</p>
3195
+ <ul class="param">
3196
+
3197
+ <li>
3198
+
3199
+ <span class='name'>paths</span>
3200
+
3201
+
3202
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3203
+
3204
+
3205
+
3206
+ &mdash;
3207
+ <div class='inline'><p>Path to JSON report file</p>
3208
+ </div>
3209
+
3210
+ </li>
3211
+
3212
+ <li>
3213
+
3214
+ <span class='name'>opt</span>
3215
+
3216
+
3217
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3218
+
3219
+
3220
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3221
+
3222
+
3223
+ &mdash;
3224
+ <div class='inline'><p>Additional Options</p>
3225
+ </div>
3226
+
3227
+ </li>
3228
+
3229
+ </ul>
3230
+
3231
+
3232
+ </div>
3233
+ </div>
3234
+
3235
+ <div class="method_details ">
3236
+ <h3 class="signature " id="init_doing_file-instance_method">
3237
+
3238
+ #<strong>init_doing_file</strong>(path = nil) &#x21d2; <tt>Object</tt>
3239
+
3240
+
3241
+
3242
+
3243
+
3244
+ </h3><div class="docstring">
3245
+ <div class="discussion">
3246
+ <p>Initializes the doing file.</p>
3247
+
3248
+
3249
+ </div>
3250
+ </div>
3251
+ <div class="tags">
3252
+ <p class="tag_title">Parameters:</p>
3253
+ <ul class="param">
3254
+
3255
+ <li>
3256
+
3257
+ <span class='name'>path</span>
3258
+
3259
+
3260
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3261
+
3262
+
3263
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3264
+
3265
+
3266
+ &mdash;
3267
+ <div class='inline'><p>Override path to a doing file, optional</p>
3268
+ </div>
3269
+
3270
+ </li>
3271
+
3272
+ </ul>
3273
+
3274
+
3275
+ </div>
3276
+ </div>
3277
+
3278
+ <div class="method_details ">
3279
+ <h3 class="signature " id="interactive-instance_method">
3280
+
3281
+ #<strong>interactive</strong>(opt = {}) &#x21d2; <tt>Object</tt>
3282
+
3283
+
3284
+
3285
+
3286
+
3287
+ </h3><div class="docstring">
3288
+ <div class="discussion">
3289
+ <p>Display an interactive menu of entries</p>
3290
+
3291
+
3292
+ </div>
3293
+ </div>
3294
+ <div class="tags">
3295
+ <p class="tag_title">Parameters:</p>
3296
+ <ul class="param">
3297
+
3298
+ <li>
3299
+
3300
+ <span class='name'>opt</span>
3301
+
3302
+
3303
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3304
+
3305
+
3306
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3307
+
3308
+
3309
+ &mdash;
3310
+ <div class='inline'><p>Additional options</p>
3311
+ </div>
3312
+
3313
+ </li>
3314
+
3315
+ </ul>
3316
+
3317
+ <p class="tag_title">Raises:</p>
3318
+ <ul class="raise">
3319
+
3320
+ <li>
3321
+
3322
+
3323
+ <span class='type'>(<tt>NoResults</tt>)</span>
3324
+
3325
+
3326
+
3327
+ </li>
3328
+
3329
+ </ul>
3330
+
3331
+ </div>
3332
+ </div>
3333
+
3334
+ <div class="method_details ">
3335
+ <h3 class="signature " id="last-instance_method">
3336
+
3337
+ #<strong>last</strong>(times: true, section: nil, options: {}) &#x21d2; <tt>Object</tt>
3338
+
3339
+
3340
+
3341
+
3342
+
3343
+ </h3><div class="docstring">
3344
+ <div class="discussion">
3345
+ <p>Show the last entry</p>
3346
+
3347
+
3348
+ </div>
3349
+ </div>
3350
+ <div class="tags">
3351
+ <p class="tag_title">Parameters:</p>
3352
+ <ul class="param">
3353
+
3354
+ <li>
3355
+
3356
+ <span class='name'>times</span>
3357
+
3358
+
3359
+ <span class='type'>(<tt>Bool</tt>)</span>
3360
+
3361
+
3362
+ <em class="default">(defaults to: <tt>true</tt>)</em>
3363
+
3364
+
3365
+ &mdash;
3366
+ <div class='inline'><p>Show times</p>
3367
+ </div>
3368
+
3369
+ </li>
3370
+
3371
+ <li>
3372
+
3373
+ <span class='name'>section</span>
3374
+
3375
+
3376
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3377
+
3378
+
3379
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3380
+
3381
+
3382
+ &mdash;
3383
+ <div class='inline'><p>Section to pull from, default Currently</p>
3384
+ </div>
3385
+
3386
+ </li>
3387
+
3388
+ </ul>
3389
+
3390
+
3391
+ </div>
3392
+ </div>
3393
+
3394
+ <div class="method_details ">
3395
+ <h3 class="signature " id="last_entry-instance_method">
3396
+
3397
+ #<strong>last_entry</strong>(opt = {}) &#x21d2; <tt>Object</tt>
3398
+
3399
+
3400
+
3401
+
3402
+
3403
+ </h3><div class="docstring">
3404
+ <div class="discussion">
3405
+ <p>Get the last entry</p>
3406
+
3407
+
3408
+ </div>
3409
+ </div>
3410
+ <div class="tags">
3411
+ <p class="tag_title">Parameters:</p>
3412
+ <ul class="param">
3413
+
3414
+ <li>
3415
+
3416
+ <span class='name'>opt</span>
3417
+
3418
+
3419
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3420
+
3421
+
3422
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3423
+
3424
+
3425
+ &mdash;
3426
+ <div class='inline'><p>Additional Options</p>
3427
+ </div>
3428
+
3429
+ </li>
3430
+
3431
+ </ul>
3432
+
3433
+
3434
+ </div>
3435
+ </div>
3436
+
3437
+ <div class="method_details ">
3438
+ <h3 class="signature " id="last_note-instance_method">
3439
+
3440
+ #<strong>last_note</strong>(section = &#39;All&#39;) &#x21d2; <tt>Object</tt>
3441
+
3442
+
3443
+
3444
+
3445
+
3446
+ </h3><div class="docstring">
3447
+ <div class="discussion">
3448
+ <p>Return the content of the last note for a given section</p>
3449
+
3450
+
3451
+ </div>
3452
+ </div>
3453
+ <div class="tags">
3454
+ <p class="tag_title">Parameters:</p>
3455
+ <ul class="param">
3456
+
3457
+ <li>
3458
+
3459
+ <span class='name'>section</span>
3460
+
3461
+
3462
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3463
+
3464
+
3465
+ <em class="default">(defaults to: <tt>&#39;All&#39;</tt>)</em>
3466
+
3467
+
3468
+ &mdash;
3469
+ <div class='inline'><p>The section to retrieve from, default
3470
+ All</p>
3471
+ </div>
3472
+
3473
+ </li>
3474
+
3475
+ </ul>
3476
+
3477
+ <p class="tag_title">Raises:</p>
3478
+ <ul class="raise">
3479
+
3480
+ <li>
3481
+
3482
+
3483
+ <span class='type'>(<tt>NoEntryError</tt>)</span>
3484
+
3485
+
3486
+
3487
+ </li>
3488
+
3489
+ </ul>
3490
+
3491
+ </div>
3492
+ </div>
3493
+
3494
+ <div class="method_details ">
3495
+ <h3 class="signature " id="list_date-instance_method">
3496
+
3497
+ #<strong>list_date</strong>(dates, section, times = nil, output = nil, opt = {}) &#x21d2; <tt>Object</tt>
3498
+
3499
+
3500
+
3501
+
3502
+
3503
+ </h3><div class="docstring">
3504
+ <div class="discussion">
3505
+ <p>Display entries within a date range</p>
3506
+
3507
+
3508
+ </div>
3509
+ </div>
3510
+ <div class="tags">
3511
+ <p class="tag_title">Parameters:</p>
3512
+ <ul class="param">
3513
+
3514
+ <li>
3515
+
3516
+ <span class='name'>dates</span>
3517
+
3518
+
3519
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
3520
+
3521
+
3522
+
3523
+ &mdash;
3524
+ <div class='inline'><p>[start, end]</p>
3525
+ </div>
3526
+
3527
+ </li>
3528
+
3529
+ <li>
3530
+
3531
+ <span class='name'>section</span>
3532
+
3533
+
3534
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3535
+
3536
+
3537
+
3538
+ &mdash;
3539
+ <div class='inline'><p>The section</p>
3540
+ </div>
3541
+
3542
+ </li>
3543
+
3544
+ <li>
3545
+
3546
+ <span class='name'>times</span>
3547
+
3548
+
3549
+ <span class='type'>(<tt>Bool</tt>)</span>
3550
+
3551
+
3552
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3553
+
3554
+
3555
+ &mdash;
3556
+ <div class='inline'><p>Show times</p>
3557
+ </div>
3558
+
3559
+ </li>
3560
+
3561
+ <li>
3562
+
3563
+ <span class='name'>output</span>
3564
+
3565
+
3566
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3567
+
3568
+
3569
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3570
+
3571
+
3572
+ &mdash;
3573
+ <div class='inline'><p>Output format</p>
3574
+ </div>
3575
+
3576
+ </li>
3577
+
3578
+ <li>
3579
+
3580
+ <span class='name'>opt</span>
3581
+
3582
+
3583
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3584
+
3585
+
3586
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3587
+
3588
+
3589
+ &mdash;
3590
+ <div class='inline'><p>Additional Options</p>
3591
+ </div>
3592
+
3593
+ </li>
3594
+
3595
+ </ul>
3596
+
3597
+
3598
+ </div>
3599
+ </div>
3600
+
3601
+ <div class="method_details ">
3602
+ <h3 class="signature " id="list_section-instance_method">
3603
+
3604
+ #<strong>list_section</strong>(opt = {}) &#x21d2; <tt>Object</tt>
3605
+
3606
+
3607
+
3608
+
3609
+
3610
+ </h3><div class="docstring">
3611
+ <div class="discussion">
3612
+ <p>Display contents of a section based on options</p>
3613
+
3614
+
3615
+ </div>
3616
+ </div>
3617
+ <div class="tags">
3618
+ <p class="tag_title">Parameters:</p>
3619
+ <ul class="param">
3620
+
3621
+ <li>
3622
+
3623
+ <span class='name'>opt</span>
3624
+
3625
+
3626
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3627
+
3628
+
3629
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3630
+
3631
+
3632
+ &mdash;
3633
+ <div class='inline'><p>Additional Options</p>
3634
+ </div>
3635
+
3636
+ </li>
3637
+
3638
+ </ul>
3639
+
3640
+
3641
+ </div>
3642
+ </div>
3643
+
3644
+ <div class="method_details ">
3645
+ <h3 class="signature " id="logger-instance_method">
3646
+
3647
+ #<strong>logger</strong> &#x21d2; <tt>Object</tt>
3648
+
3649
+
3650
+
3651
+
3652
+
3653
+ </h3><div class="docstring">
3654
+ <div class="discussion">
3655
+ <p>Logger</p>
3656
+
3657
+ <p>Responds to :debug, :info, :warn, and :error</p>
3658
+
3659
+ <p>Each method takes a topic, and a message or block</p>
3660
+
3661
+ <p>Example: debug(&#39;Hooks&#39;, &#39;Hook 1 triggered&#39;)</p>
3662
+
3663
+
3664
+ </div>
3665
+ </div>
3666
+ <div class="tags">
3667
+
3668
+
3669
+ </div>
3670
+ </div>
3671
+
3672
+ <div class="method_details ">
3673
+ <h3 class="signature " id="move_item-instance_method">
3674
+
3675
+ #<strong>move_item</strong>(item, section, label: true) &#x21d2; <tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>
3676
+
3677
+
3678
+
3679
+
3680
+
3681
+ </h3><div class="docstring">
3682
+ <div class="discussion">
3683
+ <p>Move item from current section to
3684
+ destination section</p>
3685
+
3686
+
3687
+ </div>
3688
+ </div>
3689
+ <div class="tags">
3690
+ <p class="tag_title">Parameters:</p>
3691
+ <ul class="param">
3692
+
3693
+ <li>
3694
+
3695
+ <span class='name'>item</span>
3696
+
3697
+
3698
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
3699
+
3700
+
3701
+
3702
+ &mdash;
3703
+ <div class='inline'><p>The item to move</p>
3704
+ </div>
3705
+
3706
+ </li>
3707
+
3708
+ <li>
3709
+
3710
+ <span class='name'>section</span>
3711
+
3712
+
3713
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3714
+
3715
+
3716
+
3717
+ &mdash;
3718
+ <div class='inline'><p>The destination section</p>
3719
+ </div>
3720
+
3721
+ </li>
3722
+
3723
+ </ul>
3724
+
3725
+ <p class="tag_title">Returns:</p>
3726
+ <ul class="return">
3727
+
3728
+ <li>
3729
+
3730
+
3731
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
3732
+
3733
+
3734
+
3735
+ &mdash;
3736
+ <div class='inline'><p>Updated item</p>
3737
+ </div>
3738
+
3739
+ </li>
3740
+
3741
+ </ul>
3742
+
3743
+ </div>
3744
+ </div>
3745
+
3746
+ <div class="method_details ">
3747
+ <h3 class="signature " id="next_item-instance_method">
3748
+
3749
+ #<strong>next_item</strong>(item, options = {}) &#x21d2; <tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>
3750
+
3751
+
3752
+
3753
+
3754
+
3755
+ </h3><div class="docstring">
3756
+ <div class="discussion">
3757
+ <p>Get next item in the index</p>
3758
+
3759
+
3760
+ </div>
3761
+ </div>
3762
+ <div class="tags">
3763
+ <p class="tag_title">Parameters:</p>
3764
+ <ul class="param">
3765
+
3766
+ <li>
3767
+
3768
+ <span class='name'>item</span>
3769
+
3770
+
3771
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
3772
+
3773
+
3774
+
3775
+ &mdash;
3776
+ <div class='inline'><p>target item</p>
3777
+ </div>
3778
+
3779
+ </li>
3780
+
3781
+ <li>
3782
+
3783
+ <span class='name'>options</span>
3784
+
3785
+
3786
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3787
+
3788
+
3789
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3790
+
3791
+
3792
+ &mdash;
3793
+ <div class='inline'><p>additional options</p>
3794
+ </div>
3795
+
3796
+ </li>
3797
+
3798
+ </ul>
3799
+
3800
+ <p class="tag_title">Returns:</p>
3801
+ <ul class="return">
3802
+
3803
+ <li>
3804
+
3805
+
3806
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
3807
+
3808
+
3809
+
3810
+ &mdash;
3811
+ <div class='inline'><p>the next chronological item in the index</p>
3812
+ </div>
3813
+
3814
+ </li>
3815
+
3816
+ </ul>
3817
+
3818
+ <p class="tag_title">See Also:</p>
3819
+ <ul class="see">
3820
+
3821
+ <li><span class='object_link'><a href="#filter_items-instance_method" title="Doing::WWID#filter_items (method)">#filter_items</a></span></li>
3822
+
3823
+ </ul>
3824
+
3825
+ </div>
3826
+ </div>
3827
+
3828
+ <div class="method_details ">
3829
+ <h3 class="signature " id="recent-instance_method">
3830
+
3831
+ #<strong>recent</strong>(count = 10, section = nil, opt = {}) &#x21d2; <tt>Object</tt>
3832
+
3833
+
3834
+
3835
+
3836
+
3837
+ </h3><div class="docstring">
3838
+ <div class="discussion">
3839
+ <p>Show recent entries</p>
3840
+
3841
+
3842
+ </div>
3843
+ </div>
3844
+ <div class="tags">
3845
+ <p class="tag_title">Parameters:</p>
3846
+ <ul class="param">
3847
+
3848
+ <li>
3849
+
3850
+ <span class='name'>count</span>
3851
+
3852
+
3853
+ <span class='type'>(<tt>Integer</tt>)</span>
3854
+
3855
+
3856
+ <em class="default">(defaults to: <tt>10</tt>)</em>
3857
+
3858
+
3859
+ &mdash;
3860
+ <div class='inline'><p>The number to show</p>
3861
+ </div>
3862
+
3863
+ </li>
3864
+
3865
+ <li>
3866
+
3867
+ <span class='name'>section</span>
3868
+
3869
+
3870
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3871
+
3872
+
3873
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
3874
+
3875
+
3876
+ &mdash;
3877
+ <div class='inline'><p>The section to show from, default Currently</p>
3878
+ </div>
3879
+
3880
+ </li>
3881
+
3882
+ <li>
3883
+
3884
+ <span class='name'>opt</span>
3885
+
3886
+
3887
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3888
+
3889
+
3890
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3891
+
3892
+
3893
+ &mdash;
3894
+ <div class='inline'><p>Additional Options</p>
3895
+ </div>
3896
+
3897
+ </li>
3898
+
3899
+ </ul>
3900
+
3901
+
3902
+ </div>
3903
+ </div>
3904
+
3905
+ <div class="method_details ">
3906
+ <h3 class="signature " id="repeat_item-instance_method">
3907
+
3908
+ #<strong>repeat_item</strong>(item, opt = {}) &#x21d2; <tt>Object</tt>
3909
+
3910
+
3911
+
3912
+
3913
+
3914
+ </h3>
3915
+ </div>
3916
+
3917
+ <div class="method_details ">
3918
+ <h3 class="signature " id="repeat_last-instance_method">
3919
+
3920
+ #<strong>repeat_last</strong>(opt = {}) &#x21d2; <tt>Object</tt>
3921
+
3922
+
3923
+
3924
+
3925
+
3926
+ </h3><div class="docstring">
3927
+ <div class="discussion">
3928
+ <p>Restart the last entry</p>
3929
+
3930
+
3931
+ </div>
3932
+ </div>
3933
+ <div class="tags">
3934
+ <p class="tag_title">Parameters:</p>
3935
+ <ul class="param">
3936
+
3937
+ <li>
3938
+
3939
+ <span class='name'>opt</span>
3940
+
3941
+
3942
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
3943
+
3944
+
3945
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
3946
+
3947
+
3948
+ &mdash;
3949
+ <div class='inline'><p>Additional Options</p>
3950
+ </div>
3951
+
3952
+ </li>
3953
+
3954
+ </ul>
3955
+
3956
+
3957
+ </div>
3958
+ </div>
3959
+
3960
+ <div class="method_details ">
3961
+ <h3 class="signature " id="reset_item-instance_method">
3962
+
3963
+ #<strong>reset_item</strong>(item, resume: false) &#x21d2; <tt>Object</tt>
3964
+
3965
+
3966
+
3967
+
3968
+
3969
+ </h3>
3970
+ </div>
3971
+
3972
+ <div class="method_details ">
3973
+ <h3 class="signature " id="restore_backup-instance_method">
3974
+
3975
+ #<strong>restore_backup</strong>(file) &#x21d2; <tt>Object</tt>
3976
+
3977
+
3978
+
3979
+
3980
+
3981
+ </h3><div class="docstring">
3982
+ <div class="discussion">
3983
+ <p>Restore a backed up version of a file</p>
3984
+
3985
+
3986
+ </div>
3987
+ </div>
3988
+ <div class="tags">
3989
+ <p class="tag_title">Parameters:</p>
3990
+ <ul class="param">
3991
+
3992
+ <li>
3993
+
3994
+ <span class='name'>file</span>
3995
+
3996
+
3997
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
3998
+
3999
+
4000
+
4001
+ &mdash;
4002
+ <div class='inline'><p>The filepath to restore</p>
4003
+ </div>
4004
+
4005
+ </li>
4006
+
4007
+ </ul>
4008
+
4009
+
4010
+ </div>
4011
+ </div>
4012
+
4013
+ <div class="method_details ">
4014
+ <h3 class="signature " id="rotate-instance_method">
4015
+
4016
+ #<strong>rotate</strong>(opt = {}) &#x21d2; <tt>Object</tt>
4017
+
4018
+
4019
+
4020
+
4021
+
4022
+ </h3><div class="docstring">
4023
+ <div class="discussion">
4024
+ <p>Rename doing file with date and start fresh one</p>
4025
+
4026
+
4027
+ </div>
4028
+ </div>
4029
+ <div class="tags">
4030
+
4031
+
4032
+ </div>
4033
+ </div>
4034
+
4035
+ <div class="method_details ">
4036
+ <h3 class="signature " id="sections-instance_method">
4037
+
4038
+ #<strong>sections</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
4039
+
4040
+
4041
+
4042
+
4043
+
4044
+ </h3><div class="docstring">
4045
+ <div class="discussion">
4046
+ <p>List sections</p>
4047
+
4048
+
4049
+ </div>
4050
+ </div>
4051
+ <div class="tags">
4052
+
4053
+ <p class="tag_title">Returns:</p>
4054
+ <ul class="return">
4055
+
4056
+ <li>
4057
+
4058
+
4059
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
4060
+
4061
+
4062
+
4063
+ &mdash;
4064
+ <div class='inline'><p>section titles</p>
4065
+ </div>
4066
+
4067
+ </li>
4068
+
4069
+ </ul>
4070
+
4071
+ </div>
4072
+ </div>
4073
+
4074
+ <div class="method_details ">
4075
+ <h3 class="signature " id="stop_start-instance_method">
4076
+
4077
+ #<strong>stop_start</strong>(target_tag, opt = {}) &#x21d2; <tt>Object</tt>
4078
+
4079
+
4080
+
4081
+
4082
+
4083
+ </h3><div class="docstring">
4084
+ <div class="discussion">
4085
+ <p>Accepts one tag and the raw text of a new item if the
4086
+ passed tag is on any item, it&#39;s replaced with @done.
4087
+ if new_item is not nil, it&#39;s tagged with the passed
4088
+ tag and inserted. This is for use where only one
4089
+ instance of a given tag should exist (@meanwhile)</p>
4090
+
4091
+
4092
+ </div>
4093
+ </div>
4094
+ <div class="tags">
4095
+ <p class="tag_title">Parameters:</p>
4096
+ <ul class="param">
4097
+
4098
+ <li>
4099
+
4100
+ <span class='name'>target_tag</span>
4101
+
4102
+
4103
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4104
+
4105
+
4106
+
4107
+ &mdash;
4108
+ <div class='inline'><p>Tag to replace</p>
4109
+ </div>
4110
+
4111
+ </li>
4112
+
4113
+ <li>
4114
+
4115
+ <span class='name'>opt</span>
4116
+
4117
+
4118
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
4119
+
4120
+
4121
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
4122
+
4123
+
4124
+ &mdash;
4125
+ <div class='inline'><p>Additional Options</p>
4126
+ </div>
4127
+
4128
+ </li>
4129
+
4130
+ </ul>
4131
+
4132
+
4133
+ </div>
4134
+ </div>
4135
+
4136
+ <div class="method_details ">
4137
+ <h3 class="signature " id="tag_groups-instance_method">
4138
+
4139
+ #<strong>tag_groups</strong>(items, opt: {}) &#x21d2; <tt>Object</tt>
4140
+
4141
+
4142
+
4143
+
4144
+
4145
+ </h3>
4146
+ </div>
4147
+
4148
+ <div class="method_details ">
4149
+ <h3 class="signature " id="tag_item-instance_method">
4150
+
4151
+ #<strong>tag_item</strong>(item, tags, remove: false, date: false, single: false) &#x21d2; <tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>
4152
+
4153
+
4154
+
4155
+
4156
+
4157
+ </h3><div class="docstring">
4158
+ <div class="discussion">
4159
+ <p>Tag an item from the index</p>
4160
+
4161
+
4162
+ </div>
4163
+ </div>
4164
+ <div class="tags">
4165
+ <p class="tag_title">Parameters:</p>
4166
+ <ul class="param">
4167
+
4168
+ <li>
4169
+
4170
+ <span class='name'>item</span>
4171
+
4172
+
4173
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
4174
+
4175
+
4176
+
4177
+ &mdash;
4178
+ <div class='inline'><p>The item to tag</p>
4179
+ </div>
4180
+
4181
+ </li>
4182
+
4183
+ <li>
4184
+
4185
+ <span class='name'>tags</span>
4186
+
4187
+
4188
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4189
+
4190
+
4191
+
4192
+ &mdash;
4193
+ <div class='inline'><p>The tag to apply</p>
4194
+ </div>
4195
+
4196
+ </li>
4197
+
4198
+ <li>
4199
+
4200
+ <span class='name'>remove</span>
4201
+
4202
+
4203
+ <span class='type'>(<tt>Boolean</tt>)</span>
4204
+
4205
+
4206
+ <em class="default">(defaults to: <tt>false</tt>)</em>
4207
+
4208
+
4209
+ &mdash;
4210
+ <div class='inline'><p>remove tags?</p>
4211
+ </div>
4212
+
4213
+ </li>
4214
+
4215
+ <li>
4216
+
4217
+ <span class='name'>date</span>
4218
+
4219
+
4220
+ <span class='type'>(<tt>Boolean</tt>)</span>
4221
+
4222
+
4223
+ <em class="default">(defaults to: <tt>false</tt>)</em>
4224
+
4225
+
4226
+ &mdash;
4227
+ <div class='inline'><p>Include timestamp?</p>
4228
+ </div>
4229
+
4230
+ </li>
4231
+
4232
+ <li>
4233
+
4234
+ <span class='name'>single</span>
4235
+
4236
+
4237
+ <span class='type'>(<tt>Boolean</tt>)</span>
4238
+
4239
+
4240
+ <em class="default">(defaults to: <tt>false</tt>)</em>
4241
+
4242
+
4243
+ &mdash;
4244
+ <div class='inline'><p>Log as a single change?</p>
4245
+ </div>
4246
+
4247
+ </li>
4248
+
4249
+ </ul>
4250
+
4251
+ <p class="tag_title">Returns:</p>
4252
+ <ul class="return">
4253
+
4254
+ <li>
4255
+
4256
+
4257
+ <span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
4258
+
4259
+
4260
+
4261
+ &mdash;
4262
+ <div class='inline'><p>updated item</p>
4263
+ </div>
4264
+
4265
+ </li>
4266
+
4267
+ </ul>
4268
+
4269
+ </div>
4270
+ </div>
4271
+
4272
+ <div class="method_details ">
4273
+ <h3 class="signature " id="tag_last-instance_method">
4274
+
4275
+ #<strong>tag_last</strong>(opt = {}) &#x21d2; <tt>Object</tt>
4276
+
4277
+
4278
+
4279
+
4280
+
4281
+ </h3><div class="docstring">
4282
+ <div class="discussion">
4283
+ <p>Tag the last entry or X entries</p>
4284
+
4285
+
4286
+ </div>
4287
+ </div>
4288
+ <div class="tags">
4289
+ <p class="tag_title">Parameters:</p>
4290
+ <ul class="param">
4291
+
4292
+ <li>
4293
+
4294
+ <span class='name'>opt</span>
4295
+
4296
+
4297
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
4298
+
4299
+
4300
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
4301
+
4302
+
4303
+ &mdash;
4304
+ <div class='inline'><p>Additional Options (see</p>
4305
+
4306
+ <h1 id="filter_items-for-filtering">filter_items for filtering</h1>
4307
+
4308
+ <p>options)</p>
4309
+ </div>
4310
+
4311
+ </li>
4312
+
4313
+ </ul>
4314
+
4315
+ <p class="tag_title">Raises:</p>
4316
+ <ul class="raise">
4317
+
4318
+ <li>
4319
+
4320
+
4321
+ <span class='type'>(<tt>NoResults</tt>)</span>
4322
+
4323
+
4324
+
4325
+ </li>
4326
+
4327
+ </ul>
4328
+
4329
+ <p class="tag_title">See Also:</p>
4330
+ <ul class="see">
4331
+
4332
+ <li><span class='object_link'><a href="#filter_items-instance_method" title="Doing::WWID#filter_items (method)">#filter_items</a></span></li>
4333
+
4334
+ </ul>
4335
+
4336
+ </div>
4337
+ </div>
4338
+
4339
+ <div class="method_details ">
4340
+ <h3 class="signature " id="tag_times-instance_method">
4341
+
4342
+ #<strong>tag_times</strong>(format: :text, sort_by_name: false, sort_order: &#39;asc&#39;) &#x21d2; <tt>Object</tt>
4343
+
4344
+
4345
+
4346
+
4347
+
4348
+ </h3><div class="docstring">
4349
+ <div class="discussion">
4350
+ <p>Get total elapsed time for all tags in
4351
+ selection</p>
4352
+
4353
+
4354
+ </div>
4355
+ </div>
4356
+ <div class="tags">
4357
+ <p class="tag_title">Parameters:</p>
4358
+ <ul class="param">
4359
+
4360
+ <li>
4361
+
4362
+ <span class='name'>format</span>
4363
+
4364
+
4365
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4366
+
4367
+
4368
+ <em class="default">(defaults to: <tt>:text</tt>)</em>
4369
+
4370
+
4371
+ &mdash;
4372
+ <div class='inline'><p>return format (html,
4373
+ json, or text)</p>
4374
+ </div>
4375
+
4376
+ </li>
4377
+
4378
+ <li>
4379
+
4380
+ <span class='name'>sort_by_name</span>
4381
+
4382
+
4383
+ <span class='type'>(<tt>Boolean</tt>)</span>
4384
+
4385
+
4386
+ <em class="default">(defaults to: <tt>false</tt>)</em>
4387
+
4388
+
4389
+ &mdash;
4390
+ <div class='inline'><p>Sort by name if true, otherwise by time</p>
4391
+ </div>
4392
+
4393
+ </li>
4394
+
4395
+ <li>
4396
+
4397
+ <span class='name'>sort_order</span>
4398
+
4399
+
4400
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4401
+
4402
+
4403
+ <em class="default">(defaults to: <tt>&#39;asc&#39;</tt>)</em>
4404
+
4405
+
4406
+ &mdash;
4407
+ <div class='inline'><p>The sort order (asc or desc)</p>
4408
+ </div>
4409
+
4410
+ </li>
4411
+
4412
+ </ul>
4413
+
4414
+
4415
+ </div>
4416
+ </div>
4417
+
4418
+ <div class="method_details ">
4419
+ <h3 class="signature " id="today-instance_method">
4420
+
4421
+ #<strong>today</strong>(times = true, output = nil, opt = {}) &#x21d2; <tt>Object</tt>
4422
+
4423
+
4424
+
4425
+
4426
+
4427
+ </h3><div class="docstring">
4428
+ <div class="discussion">
4429
+ <p>Show all entries from the current day</p>
4430
+
4431
+
4432
+ </div>
4433
+ </div>
4434
+ <div class="tags">
4435
+ <p class="tag_title">Parameters:</p>
4436
+ <ul class="param">
4437
+
4438
+ <li>
4439
+
4440
+ <span class='name'>times</span>
4441
+
4442
+
4443
+ <span class='type'>(<tt>Boolean</tt>)</span>
4444
+
4445
+
4446
+ <em class="default">(defaults to: <tt>true</tt>)</em>
4447
+
4448
+
4449
+ &mdash;
4450
+ <div class='inline'><p>show times</p>
4451
+ </div>
4452
+
4453
+ </li>
4454
+
4455
+ <li>
4456
+
4457
+ <span class='name'>output</span>
4458
+
4459
+
4460
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4461
+
4462
+
4463
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
4464
+
4465
+
4466
+ &mdash;
4467
+ <div class='inline'><p>output format</p>
4468
+ </div>
4469
+
4470
+ </li>
4471
+
4472
+ <li>
4473
+
4474
+ <span class='name'>opt</span>
4475
+
4476
+
4477
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
4478
+
4479
+
4480
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
4481
+
4482
+
4483
+ &mdash;
4484
+ <div class='inline'><p>Options</p>
4485
+ </div>
4486
+
4487
+ </li>
4488
+
4489
+ </ul>
4490
+
4491
+
4492
+ </div>
4493
+ </div>
4494
+
4495
+ <div class="method_details ">
4496
+ <h3 class="signature " id="update_item-instance_method">
4497
+
4498
+ #<strong>update_item</strong>(old_item, new_item) &#x21d2; <tt>Object</tt>
4499
+
4500
+
4501
+
4502
+
4503
+
4504
+ </h3><div class="docstring">
4505
+ <div class="discussion">
4506
+ <p>Update an item in the index with a modified item</p>
4507
+
4508
+
4509
+ </div>
4510
+ </div>
4511
+ <div class="tags">
4512
+ <p class="tag_title">Parameters:</p>
4513
+ <ul class="param">
4514
+
4515
+ <li>
4516
+
4517
+ <span class='name'>old_item</span>
4518
+
4519
+
4520
+ <span class='type'></span>
4521
+
4522
+
4523
+
4524
+ &mdash;
4525
+ <div class='inline'><p>The old item</p>
4526
+ </div>
4527
+
4528
+ </li>
4529
+
4530
+ <li>
4531
+
4532
+ <span class='name'>new_item</span>
4533
+
4534
+
4535
+ <span class='type'></span>
4536
+
4537
+
4538
+
4539
+ &mdash;
4540
+ <div class='inline'><p>The new item</p>
4541
+ </div>
4542
+
4543
+ </li>
4544
+
4545
+ </ul>
4546
+
4547
+ <p class="tag_title">Raises:</p>
4548
+ <ul class="raise">
4549
+
4550
+ <li>
4551
+
4552
+
4553
+ <span class='type'>(<tt>ItemNotFound</tt>)</span>
4554
+
4555
+
4556
+
4557
+ </li>
4558
+
4559
+ </ul>
4560
+
4561
+ </div>
4562
+ </div>
4563
+
4564
+ <div class="method_details ">
4565
+ <h3 class="signature " id="views-instance_method">
4566
+
4567
+ #<strong>views</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
4568
+
4569
+
4570
+
4571
+
4572
+
4573
+ </h3><div class="docstring">
4574
+ <div class="discussion">
4575
+ <p>List available views</p>
4576
+
4577
+
4578
+ </div>
4579
+ </div>
4580
+ <div class="tags">
4581
+
4582
+ <p class="tag_title">Returns:</p>
4583
+ <ul class="return">
4584
+
4585
+ <li>
4586
+
4587
+
4588
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
4589
+
4590
+
4591
+
4592
+ &mdash;
4593
+ <div class='inline'><p>View names</p>
4594
+ </div>
4595
+
4596
+ </li>
4597
+
4598
+ </ul>
4599
+
4600
+ </div>
4601
+ </div>
4602
+
4603
+ <div class="method_details ">
4604
+ <h3 class="signature " id="write-instance_method">
4605
+
4606
+ #<strong>write</strong>(file = nil, backup: true) &#x21d2; <tt>Object</tt>
4607
+
4608
+
4609
+
4610
+
4611
+
4612
+ </h3><div class="docstring">
4613
+ <div class="discussion">
4614
+ <p>Write content to file or STDOUT</p>
4615
+
4616
+
4617
+ </div>
4618
+ </div>
4619
+ <div class="tags">
4620
+ <p class="tag_title">Parameters:</p>
4621
+ <ul class="param">
4622
+
4623
+ <li>
4624
+
4625
+ <span class='name'>file</span>
4626
+
4627
+
4628
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4629
+
4630
+
4631
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
4632
+
4633
+
4634
+ &mdash;
4635
+ <div class='inline'><p>The filepath to write to</p>
4636
+ </div>
4637
+
4638
+ </li>
4639
+
4640
+ </ul>
4641
+
4642
+
4643
+ </div>
4644
+ </div>
4645
+
4646
+ <div class="method_details ">
4647
+ <h3 class="signature " id="yesterday-instance_method">
4648
+
4649
+ #<strong>yesterday</strong>(section, times = nil, output = nil, opt = {}) &#x21d2; <tt>Object</tt>
4650
+
4651
+
4652
+
4653
+
4654
+
4655
+ </h3><div class="docstring">
4656
+ <div class="discussion">
4657
+ <p>Show entries from the previous day</p>
4658
+
4659
+
4660
+ </div>
4661
+ </div>
4662
+ <div class="tags">
4663
+ <p class="tag_title">Parameters:</p>
4664
+ <ul class="param">
4665
+
4666
+ <li>
4667
+
4668
+ <span class='name'>section</span>
4669
+
4670
+
4671
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4672
+
4673
+
4674
+
4675
+ &mdash;
4676
+ <div class='inline'><p>The section</p>
4677
+ </div>
4678
+
4679
+ </li>
4680
+
4681
+ <li>
4682
+
4683
+ <span class='name'>times</span>
4684
+
4685
+
4686
+ <span class='type'>(<tt>Bool</tt>)</span>
4687
+
4688
+
4689
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
4690
+
4691
+
4692
+ &mdash;
4693
+ <div class='inline'><p>Show times</p>
4694
+ </div>
4695
+
4696
+ </li>
4697
+
4698
+ <li>
4699
+
4700
+ <span class='name'>output</span>
4701
+
4702
+
4703
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4704
+
4705
+
4706
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
4707
+
4708
+
4709
+ &mdash;
4710
+ <div class='inline'><p>Output format</p>
4711
+ </div>
4712
+
4713
+ </li>
4714
+
4715
+ <li>
4716
+
4717
+ <span class='name'>opt</span>
4718
+
4719
+
4720
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
4721
+
4722
+
4723
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
4724
+
4725
+
4726
+ &mdash;
4727
+ <div class='inline'><p>Additional Options</p>
4728
+ </div>
4729
+
4730
+ </li>
4731
+
4732
+ </ul>
4733
+
4734
+
4735
+ </div>
4736
+ </div>
4737
+
4738
+ <div class="method_details ">
4739
+ <h3 class="signature " id="yn-instance_method">
4740
+
4741
+ #<strong>yn</strong>(question, default_response: false) &#x21d2; <tt>Bool</tt>
4742
+
4743
+
4744
+
4745
+
4746
+
4747
+ </h3><div class="docstring">
4748
+ <div class="discussion">
4749
+ <p>Ask a yes or no question in the terminal</p>
4750
+
4751
+
4752
+ </div>
4753
+ </div>
4754
+ <div class="tags">
4755
+ <p class="tag_title">Parameters:</p>
4756
+ <ul class="param">
4757
+
4758
+ <li>
4759
+
4760
+ <span class='name'>question</span>
4761
+
4762
+
4763
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
4764
+
4765
+
4766
+
4767
+ &mdash;
4768
+ <div class='inline'><p>The question
4769
+ to ask</p>
4770
+ </div>
4771
+
4772
+ </li>
4773
+
4774
+ <li>
4775
+
4776
+ <span class='name'>default_response</span>
4777
+
4778
+
4779
+ <span class='type'>(<tt>Bool</tt>)</span>
4780
+
4781
+
4782
+ <em class="default">(defaults to: <tt>false</tt>)</em>
4783
+
4784
+
4785
+ &mdash;
4786
+ <div class='inline'><p>default
4787
+ response if no input</p>
4788
+ </div>
4789
+
4790
+ </li>
4791
+
4792
+ </ul>
4793
+
4794
+ <p class="tag_title">Returns:</p>
4795
+ <ul class="return">
4796
+
4797
+ <li>
4798
+
4799
+
4800
+ <span class='type'>(<tt>Bool</tt>)</span>
4801
+
4802
+
4803
+
4804
+ &mdash;
4805
+ <div class='inline'><p>yes or no</p>
4806
+ </div>
4807
+
4808
+ </li>
4809
+
4810
+ </ul>
4811
+
4812
+ </div>
4813
+ </div>
4814
+
4815
+ </div>
4816
+
4817
+ </div>
4818
+
4819
+ <div id="footer">
4820
+ Generated on Thu Nov 18 16:39:12 2021 by
4821
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
4822
+ 0.9.26 (ruby-3.0.1).
4823
+ </div>
4824
+
4825
+ </div>
4826
+ </body>
4827
+ </html>