-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdocs.html
1060 lines (910 loc) · 31.9 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta content='Notes and to-do list outliner for Android. Notebooks in org mode format, synced with a directory on your mobile device, Dropbox, or WebDAV.' name='description'>
<title>Orgzly | Notes & To-Do Lists</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css">
<link rel="stylesheet" href="/assets/index.css">
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-dark">
<div class="container align-items-center">
<a class="navbar-brand" href="/"><img src="assets/logo.svg" alt="Orgzly" width="24" /></a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav">
</ul>
<ul class="navbar-nav ms-auto">
<li><a class="nav-link" href="/docs">Documentation</a></li>
</ul>
</div>
</div>
</nav>
<div id="page-docs" class="container">
<div class="row mt-5">
<div class="col">
<h1 class="display-4">Documentation</h1>
<p class="lead">A bit of Everything</p>
</div>
</div>
<div class="row mt-3">
<div class="col">
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#synchronization">Syncing Notebooks</a>
<ul>
<li><a href="#72c5baa">Repository Types</a>
<ul>
<li><a href="#sync-repo-dropbox">Dropbox</a></li>
<li><a href="#sync-repo-webdav">WebDAV</a></li>
<li><a href="#sync-repo-directory">Directory (local storage)</a></li>
</ul>
</li>
<li><a href="#9a103af">Status Messages</a>
<ul>
<li><a href="#3a30eae">No change</a></li>
<li><a href="#c005876">Saved to URL</a></li>
<li><a href="#77c53bc">Loaded from URL</a></li>
<li><a href="#0eb6241">Notebook has no link and one or more remote notebooks with the same name exist</a></li>
<li><a href="#4268ee7">Notebook has no link and multiple repositories exist</a></li>
<li><a href="#both-local-and-remote-notebook-have-been-modified">Both local and remote notebook have been modified</a>
<ul>
<li><a href="#cd5aaec">Manually merging the two, conflicting files when using Dropbox</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org-mode">Notes for Org mode users</a>
<ul>
<li><a href="#d25f20c">Generated Org files</a></li>
</ul>
</li>
<li><a href="#orgc553add">Ignoring files in a repository</a></li>
</ul>
</li>
<li><a href="#links">Links</a>
<ul>
<li><a href="#6874100">Web page</a></li>
<li><a href="#21a1d14">Email</a></li>
<li><a href="#0630ac2">Telephone number</a></li>
<li><a href="#93214ea">Location</a></li>
<li><a href="#a7a9f79">File</a></li>
<li><a href="#33542dd">Note</a></li>
<li><a href="#9d5f3b9">Notebook</a></li>
</ul>
</li>
<li><a href="#search">Search</a>
<ul>
<li><a href="#search-expressions">Search expressions</a></li>
<li><a href="#search-sorting">Sorting</a></li>
<li><a href="#search-agenda">Agenda</a></li>
<li><a href="#search-examples">Examples</a></li>
<li><a href="#b0b0976">Search Results</a></li>
</ul>
</li>
<li><a href="#faq">FAQ</a>
<ul>
<li><a href="#cost">How much does it cost?</a></li>
<li><a href="#source-code">Is the source code available?</a></li>
<li><a href="#96f0fcb">I don't use Google Play, any alternatives?</a></li>
<li><a href="#f695589">Dropbox sync option is missing</a></li>
<li><a href="#ios">Is there an iOS version?</a></li>
</ul>
</li>
<li><a href="#privacy">Privacy Policy</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
</div>
</div>
<div id="outline-container-synchronization" class="outline-2">
<h2 id="synchronization">Syncing Notebooks</h2>
<div class="outline-text-2" id="text-synchronization">
<p>
You can sync your notebooks with a directory on your device, or
with a few different repository types: Dropbox, WebDAV, and (experimental) Git.
</p>
<p>
Notebooks are written as plain text files in <a href="https://orgmode.org">Org mode</a> file format.
</p>
<p>
Synchronization is currently manual – you have to initiate it
yourself by clicking the <code>Sync</code> button. Button is located in the
navigation drawer.
</p>
</div>
<div id="outline-container-72c5baa" class="outline-3">
<h3 id="72c5baa">Repository Types</h3>
<div class="outline-text-3" id="text-72c5baa">
</div>
<div id="outline-container-sync-repo-dropbox" class="outline-4">
<h4 id="sync-repo-dropbox">Dropbox</h4>
<div class="outline-text-4" id="text-sync-repo-dropbox">
<p>
The Dropbox app is not required for syncing, instead you will allow
Orgzly to contact Dropbox on your behalf using the browser.
</p>
<ul class="org-ul">
<li>Go to <code>Settings</code></li>
<li>Click on <code>Sync</code></li>
<li>Click on <code>Repositories</code></li>
<li>Click on <code>Dropbox</code> (if you already have some repositories, click the plus icon first)</li>
<li>Enter the directory inside Dropbox (without "Dropbox" part)</li>
</ul>
</div>
</div>
<div id="outline-container-sync-repo-webdav" class="outline-4">
<h4 id="sync-repo-webdav">WebDAV</h4>
<div class="outline-text-4" id="text-sync-repo-webdav">
<p>
You can sync your notebooks over WebDAV with any service that supports
it, such as <a href="https://nextcloud.com/">Nextcloud</a>, for example.
</p>
<ul class="org-ul">
<li>Go to <code>Settings</code></li>
<li>Click on <code>Sync</code></li>
<li>Click on <code>Repositories</code></li>
<li>Click on <code>WebDAV</code> (if you already have some repositories, click the plus icon first)</li>
<li>Enter the URL, username and password</li>
</ul>
<p>
Optionally, if the server is using a self-signed certificate for
example, you could add it here.
</p>
</div>
</div>
<div id="outline-container-sync-repo-directory" class="outline-4">
<h4 id="sync-repo-directory">Directory (local storage)</h4>
<div class="outline-text-4" id="text-sync-repo-directory">
<p>
Notebooks can be synced with one or more directories on your device.
</p>
<ul class="org-ul">
<li>Go to <code>Settings</code></li>
<li>Click on <code>Sync</code></li>
<li>Click on <code>Repositories</code></li>
<li>Click on <code>Directory</code> (if you already have some repositories, click the plus icon first)</li>
<li>Click <code>Browse</code> and select (or create new) directory</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-9a103af" class="outline-3">
<h3 id="9a103af">Status Messages</h3>
<div class="outline-text-3" id="text-9a103af">
<p>
After syncing is done, every notebook will have its sync status
message updated.
</p>
</div>
<div id="outline-container-3a30eae" class="outline-4">
<h4 id="3a30eae">No change</h4>
<div class="outline-text-4" id="text-3a30eae">
<p>
Notebook is already synced. Nothing to do.
</p>
</div>
</div>
<div id="outline-container-c005876" class="outline-4">
<h4 id="c005876">Saved to URL</h4>
<div class="outline-text-4" id="text-c005876">
<p>
Notebook has been successfully synced by being saved to the repository
represented by URL.
</p>
</div>
</div>
<div id="outline-container-77c53bc" class="outline-4">
<h4 id="77c53bc">Loaded from URL</h4>
<div class="outline-text-4" id="text-77c53bc">
<p>
Notebook has been successfully synced by being loaded from the
notebook represented by URL.
</p>
</div>
</div>
<div id="outline-container-0eb6241" class="outline-4">
<h4 id="0eb6241">Notebook has no link and one or more remote notebooks with the same name exist</h4>
<div class="outline-text-4" id="text-0eb6241">
<p>
Orgzly doesn't know which remote notebook to use for syncing.
</p>
<p>
Each notebook must have a link to a remote notebook. Link is
usually set automatically after the first sync. However, there are
cases when this is not possible, or when the link is removed.
</p>
<p>
Link cannot be created after the first sync if:
</p>
<ul class="org-ul">
<li>Notebook was created in Orgzly, but there is already a remote
notebook with the same name in one of the repositories</li>
<li>Multiple repositories are used and there is a notebook with the same
name in them</li>
</ul>
<p>
Link is removed when:
</p>
<ul class="org-ul">
<li>Repository is renamed or deleted</li>
</ul>
<p>
Link can be set manually:
</p>
<ul class="org-ul">
<li>Open the list of notebooks ("Notebooks")</li>
<li>Long-click on a notebook</li>
<li>Click on <code>Set Link</code></li>
<li>Choose a repository</li>
<li>Click <code>Set</code></li>
</ul>
<p>
Link is set if you can see the URL next to the small link icon in
notebook's details.
</p>
</div>
</div>
<div id="outline-container-4268ee7" class="outline-4">
<h4 id="4268ee7">Notebook has no link and multiple repositories exist</h4>
<div class="outline-text-4" id="text-4268ee7">
<p>
See <a href="#0eb6241">Notebook has no link and one or more remote notebooks with the same name exist</a>.
</p>
</div>
</div>
<div id="outline-container-both-local-and-remote-notebook-have-been-modified" class="outline-4">
<h4 id="both-local-and-remote-notebook-have-been-modified">Both local and remote notebook have been modified</h4>
<div class="outline-text-4" id="text-both-local-and-remote-notebook-have-been-modified">
<p>
If you modify a notebook in Orgzly and at the same time (before
performing a sync) you modify its linked remote notebook, next sync
will leave the notebook in a conflicted state.
</p>
<p>
When notebook is not synced due to conflict, you have two options:
</p>
<ul class="org-ul">
<li><code>Force Load</code> to import remote notebook and overwrite the local version</li>
<li><code>Force Save</code> to export local notebook and overwrite the remote version</li>
</ul>
<p>
These actions are available in notebook's contextual menu:
</p>
<ul class="org-ul">
<li>Open the list of notebooks ("Notebooks")</li>
<li>Long-click on a notebook to open the menu</li>
</ul>
<p>
There is currently no other way to resolve a conflict within Orgzly itself.
</p>
</div>
<div id="outline-container-cd5aaec" class="outline-5">
<h5 id="cd5aaec">Manually merging the two, conflicting files when using Dropbox</h5>
<div class="outline-text-5" id="text-cd5aaec">
<p>
When the local and remote notebooks have been modified in a Dropbox
repository you can take advantage of the facts that Orgzly stores
information in text files (in the Org file format) and that Orgzly
will create a new copy of the file if you remove it from Dropbox.
</p>
<p>
For example, you might move the original, underlying .org file in
Dropbox to a different directory, then tell Orgzly to sync the files
again (which will cause Orgzly to create a new file (with the same
file name)). You can then use an external tool (such as a diff
program) to compare your original file and the file that Orgzly
created. You can then determine what changes were made, and which
ones you wish to keep.
</p>
<p>
Be sure to remember that the new file (the one created by Orgzly) is
where you want to put your final, merged version of the file.
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-org-mode" class="outline-3">
<h3 id="org-mode">Notes for Org mode users</h3>
<div class="outline-text-3" id="text-org-mode">
<p>
Notebooks are encoded in <a href="https://orgmode.org">Org mode</a> file format.
</p>
</div>
<div id="outline-container-d25f20c" class="outline-4">
<h4 id="d25f20c">Generated Org files</h4>
<div class="outline-text-4" id="text-d25f20c">
<p>
When compared to your original Org files, files generated by Orgzly
might differ in the amount of white space, outlined below. Any other
difference would be considered a serious bug.
</p>
<ul class="org-ul">
<li><i>By default, tags are separated from the title with a single space
character.</i> You will lose your tags' indentation as if you had
<code>org-tags-column</code> set to <code>0</code>.
<ul class="org-ul">
<li>You can set <code>Tags column</code> in the app's preferences (under
<code>Settings / Sync / Org file format / Tags indentation</code>), which
should behave just like <code>org-tags-column</code>.</li>
<li>There is also a preference to make <code>Tags column</code> output compatible
with <code>org-indent-mode</code>.</li>
</ul></li>
<li><i>Unsupported metadata below header is part of note's content.</i> As
soon as any unsupported metadata is encountered, lines from that point
until the next heading are considered part of note's content. You
might find an unexpected new line between supported and unsupported
metadata, because note's content is normally separated from heading
by a new line.</li>
</ul>
<p>
If any of this is not working for you, please <a href="#contact">contact</a> us.
</p>
</div>
</div>
</div>
<div id="outline-container-orgc553add" class="outline-3">
<h3 id="orgc553add">Ignoring files in a repository</h3>
<div class="outline-text-3" id="text-orgc553add">
<p>
(Supported on Android 8 and above.)
</p>
<p>
For users who have a large number of .org files in their repository, and only
want Orgzly to load some of them, a <code>.orgzlyignore</code> file can be
added to the repository on a remote device. The file uses the same syntax as
Git's <code>.gitignore</code> file, which lets you exclude or include files
based on glob patterns. See the <a
href="https://git-scm.com/docs/gitignore#_pattern_format">Git documentation</a>
for details on the syntax. If the repository contains a
<code>.orgzlyignore</code> file, it will be consulted in the following
situations:
</p>
<ol class="org-ol">
<li>When looking through the repository for .org files to load.</li>
<li>When renaming notebooks.</li>
<li>When linking a notebook to a repository (to ensure that the resulting file
name does not match an ignore rule).</li>
</ol>
<p>
Please note that the <code>.orgzlyignore</code> file is not consulted each time
a notebook is saved to a repository, for performance reasons.
</p>
<p>
If the ignore rules are updated such that an existing Orgzly notebook suddenly
matches an ignore rule, upon the next sync occasion, Orgzly will react as if
the file has been deleted from the repository. This means that the notebook's
repository link is removed, and a warning message is shown, but the notebook is
<b>not</b> deleted from Orgzly. However, you will not be able to link the
notebook to the same repository, unless you rename it to something which does
not match an ignore rule. (It would also be possible to link the notebook to a
different repository, with different or no ignore rules.)
</p>
</div>
</div>
</div>
<div id="outline-container-links" class="outline-2">
<h2 id="links">Links</h2>
<div class="outline-text-2" id="text-links">
<p>
Links can be used in note's title or content. Links can be enclosed in
brackets (e.g. <code>[[link]]</code>). You can specify a name which will be displayed
instead of the link (e.g. <code>[[link][name]]</code>).
</p>
</div>
<div id="outline-container-6874100" class="outline-3">
<h3 id="6874100">Web page</h3>
<div class="outline-text-3" id="text-6874100">
<p>
<code>https://www.orgzly.com</code>
</p>
</div>
</div>
<div id="outline-container-21a1d14" class="outline-3">
<h3 id="21a1d14">Email</h3>
<div class="outline-text-3" id="text-21a1d14">
<p>
<code>mailto:[email protected]</code>
</p>
</div>
</div>
<div id="outline-container-0630ac2" class="outline-3">
<h3 id="0630ac2">Telephone number</h3>
<div class="outline-text-3" id="text-0630ac2">
<p>
You can dial a phone number, compose SMS or MMS.
</p>
<ul class="org-ul">
<li><code>tel:1-800-555-0199</code></li>
<li><code>voicemail:1-800-555-0199</code></li>
<li><code>sms:1-800-555-0199</code></li>
<li><code>sms:1-800-555-0199?body=omw%20brt</code></li>
<li><code>smsto:1-800-555-0199</code></li>
<li><code>mms:1-800-555-0199</code></li>
<li><code>mmsto:1-800-555-0199</code></li>
</ul>
</div>
</div>
<div id="outline-container-93214ea" class="outline-3">
<h3 id="93214ea">Location</h3>
<div class="outline-text-3" id="text-93214ea">
<p>
To open a map you can specify the exact location or a search query.
</p>
<ul class="org-ul">
<li><code>geo:40.7128,-74.0060</code></li>
<li><code>geo:0,0?q=new+york+city</code></li>
<li><code>geo:40.7128,-74.0060?z=11</code></li>
</ul>
</div>
</div>
<div id="outline-container-a7a9f79" class="outline-3">
<h3 id="a7a9f79">File</h3>
<div class="outline-text-3" id="text-a7a9f79">
<p>
Links to external files are supported.
</p>
<p>
Files are <b>relative to the main storage directory</b> (e.g. <code>/sdcard</code>).
</p>
<ul class="org-ul">
<li><code>file:Download/document.txt</code></li>
<li><code>file:Music/song.mp3</code></li>
</ul>
<p>
In Settings, you can change the relative root to point to any directory on your
device. There is one setting to set the root for absolute links (e.g. <code>file:/readme.txt</code>),
and another setting to set the root for relative links (e.g. <code>file:readme.txt</code>).
</p>
</div>
</div>
<div id="outline-container-33542dd" class="outline-3">
<h3 id="33542dd">Note</h3>
<div class="outline-text-3" id="text-33542dd">
<p>
Linking to notes is done using properties. Two properties are supported – <code>ID</code> and
<code>CUSTOM_ID</code>.
</p>
<p>
If you set note's property <code>ID</code> to
<code>123e4567-e89b-12d3-a456-426655440000</code> you can link to the note using:
</p>
<p>
<code>id:123e4567-e89b-12d3-a456-426655440000</code>
</p>
<p>
Value can be anything, but <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> is recommended.
</p>
<p>
If you prefer a more user-friendly value, use <code>CUSTOM_ID</code>
property. This type of link starts with <code>#</code> character, followed by the
property value. It must be enclosed in brackets. If you set
<code>CUSTOM_ID</code> to <code>Meeting checklist</code>, linking to that note is done
using:
</p>
<p>
<code>[[#Meeting checklist]]</code>
</p>
</div>
</div>
<div id="outline-container-9d5f3b9" class="outline-3">
<h3 id="9d5f3b9">Notebook</h3>
<div class="outline-text-3" id="text-9d5f3b9">
<p>
Link to a notebook within the app looks like a link to an external file:
</p>
<p>
<code>file:gtd.org</code>
</p>
<p>
Only the name matters and it has to be the same as the notebook you
are linking to.
</p>
</div>
</div>
</div>
<div id="outline-container-search" class="outline-2">
<h2 id="search">Search</h2>
<div class="outline-text-2" id="text-search">
<p>
Search expressions are separated with space.
</p>
<p>
They are implicitly joined by logical <code>AND</code>. <code>OR</code> operator is also
supported. Both operators are case insensitive. <code>AND</code> has higher
precedence than <code>OR</code>.
</p>
</div>
<div id="outline-container-search-expressions" class="outline-3">
<h3 id="search-expressions">Search expressions</h3>
<div class="outline-text-3" id="text-search-expressions">
<p>
Following search expressions are supported.
</p>
<p>
Some of them support <code>.</code> (NOT) operator (see the last column).
</p>
<table class="table table-sm">
<colgroup>
<col class="org-left" />
<col class="org-left" />
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Expression</th>
<th scope="col" class="org-left">Finds notes</th>
<th scope="col" class="org-left">Example</th>
<th scope="col" class="org-left">.</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left"><code>s.PERIOD</code></td>
<td class="org-left">Scheduled within period</td>
<td class="org-left"><code>s.today</code></td>
<td class="org-left">N</td>
</tr>
<tr>
<td class="org-left"><code>d.PERIOD</code></td>
<td class="org-left">Deadline within period</td>
<td class="org-left"><code>d.le.2d</code></td>
<td class="org-left">N</td>
</tr>
<tr>
<td class="org-left"><code>e.PERIOD</code></td>
<td class="org-left">Event within period</td>
<td class="org-left"><code>e.ge.now</code></td>
<td class="org-left">N</td>
</tr>
<tr>
<td class="org-left"><code>c.PERIOD</code></td>
<td class="org-left">Closed within period</td>
<td class="org-left"><code>c.yesterday</code></td>
<td class="org-left">N</td>
</tr>
<tr>
<td class="org-left"><code>cr.PERIOD</code></td>
<td class="org-left">Created within period</td>
<td class="org-left"><code>cr.ge.yesterday</code></td>
<td class="org-left">N</td>
</tr>
<tr>
<td class="org-left"><code>i.STATE</code></td>
<td class="org-left">With state</td>
<td class="org-left"><code>i.todo</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>it.STATE-TYPE</code></td>
<td class="org-left">With state type</td>
<td class="org-left"><code>.it.done</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>b.NOTEBOOK</code></td>
<td class="org-left">From notebook</td>
<td class="org-left"><code>.b.Work</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>t.TAG</code></td>
<td class="org-left">With tag (inherited too)</td>
<td class="org-left"><code>t.errand</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>tn.TAG</code></td>
<td class="org-left">With tag (note's only)</td>
<td class="org-left"><code>tn.toRead</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>p.PRIORITY</code></td>
<td class="org-left">Having priority</td>
<td class="org-left"><code>.p.c</code></td>
<td class="org-left">Y</td>
</tr>
<tr>
<td class="org-left"><code>ps.PRIORITY</code></td>
<td class="org-left">Having set priority</td>
<td class="org-left"><code>ps.b</code></td>
<td class="org-left">Y</td>
</tr>
</tbody>
</table>
<p>
<code>PERIOD</code> can be:
</p>
<ul class="org-ul">
<li><code>OP.TIME</code> – matches time</li>
<li><code>none</code> (or <code>no</code>) – matches notes without the property</li>
</ul>
<p>
<code>OP</code> can be:
</p>
<ul class="org-ul">
<li><code>eq</code> – equal to <code>TIME</code></li>
<li><code>ne</code> – not equal to <code>TIME</code></li>
<li><code>lt</code> – less than <code>TIME</code></li>
<li><code>le</code> – less than or equal to <code>TIME</code></li>
<li><code>gt</code> – greater than <code>TIME</code></li>
<li><code>ge</code> – greater than or equal to <code>TIME</code></li>
</ul>
<p>
If <code>OP</code> is not specified:
</p>
<ul class="org-ul">
<li>Default value for <code>s</code>, <code>d</code> and <code>cr</code> is <code>le</code></li>
<li>Default value for <code>c</code> is <code>eq</code></li>
</ul>
<p>
<code>TIME</code> can be:
</p>
<ul class="org-ul">
<li><code>Nh</code> – <code>N</code> hours from now</li>
<li><code>Nd</code> – <code>N</code> days from now</li>
<li><code>Nw</code> – <code>N</code> weeks from now</li>
<li><code>Nm</code> – <code>N</code> months from now</li>
<li><code>Ny</code> – <code>N</code> years from now</li>
</ul>
<p>
<code>N</code> can be negative.
</p>
<p>
For example:
</p>
<ul class="org-ul">
<li><code>-2h</code> – two hours ago</li>
<li><code>5d</code> – five days from today</li>
<li><code>-2w</code> – two weeks ago</li>
<li><code>3m</code> – three months from today</li>
<li><code>1y</code> – one year from today</li>
</ul>
<p>
Few aliases for <code>TIME</code> are available:
</p>
<ul class="org-ul">
<li><code>tomorrow</code>, <code>tmrw</code> or <code>tom</code></li>
<li><code>today</code> or <code>tod</code></li>
<li><code>now</code></li>
<li><code>yesterday</code></li>
</ul>
<p>
<code>STATE</code> is a keyword like <code>TODO</code>, <code>DONE</code>, <code>NEW</code>, etc. Keywords are
case insensitive. Only states specified in Settings can be searched
by. Any keywords not included in the settings are not treated as
states - they become part of note's title.
</p>
<p>
<code>STATE-TYPE</code> can be <code>todo</code>, <code>done</code> or <code>none</code>.
</p>
<p>
<code>NOTEBOOK</code> is the name of notebook. It must be surrounded with double
quotes if it contains spaces.
</p>
<p>
<code>TAG</code> is searched as a substring. For example <code>t.bee</code> will find notes
which are tagged with <code>beeblebrox</code>.
</p>
<p>
<code>PRIORITY</code> is a priority starting from <code>A</code>.
</p>
</div>
</div>
<div id="outline-container-search-sorting" class="outline-3">
<h3 id="search-sorting">Sorting</h3>
<div class="outline-text-3" id="text-search-sorting">
<p>
Default ordering of notes is by notebook name then priority. If <code>s</code> or
<code>d</code> are used in the query, they are also sorted by scheduled or
deadline time. They are always sorted by position in the notebook
last.
</p>
<p>
You can change this behavior by using <code>o</code> operator.
</p>
<p>
Using <code>o.PROPERTY</code> will sort notes by property. <code>.o.PROPERTY</code> is also
supported which sorts notes by property in reverse order. You can
specify multiple operators and they will be used in order.
</p>
<p>
Following properties are supported:
</p>
<table class="table table-sm">
<colgroup>
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Property</th>
<th scope="col" class="org-left">Order by</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left"><code>b</code> <code>book</code> <code>notebook</code></td>
<td class="org-left">Notebook name</td>
</tr>
<tr>
<td class="org-left"><code>t</code> <code>title</code></td>
<td class="org-left">Title</td>
</tr>
<tr>
<td class="org-left"><code>s</code> <code>sched</code> <code>scheduled</code></td>
<td class="org-left">Scheduled time</td>
</tr>
<tr>
<td class="org-left"><code>d</code> <code>dead</code> <code>deadline</code></td>
<td class="org-left">Deadline time</td>
</tr>
<tr>
<td class="org-left"><code>e</code> <code>event</code></td>
<td class="org-left">Event time</td>
</tr>
<tr>
<td class="org-left"><code>c</code> <code>close</code> <code>closed</code></td>
<td class="org-left">Closed time</td>
</tr>
<tr>
<td class="org-left"><code>cr</code> <code>created</code></td>
<td class="org-left">Created-at time</td>
</tr>
<tr>
<td class="org-left"><code>p</code> <code>pri</code> <code>prio</code> <code>priority</code></td>
<td class="org-left">Priority</td>
</tr>
<tr>
<td class="org-left"><code>st</code> <code>state</code></td>
<td class="org-left">States as defined in Settings</td>
</tr>
</tbody>
</table>
<p>
When a note contains multiple events, only one of those events is
considered when sorting. With <code>o.event</code> the oldest event is used. With
<code>.o.event</code> most recent event is used.
</p>
</div>
</div>
<div id="outline-container-search-agenda" class="outline-3">
<h3 id="search-agenda">Agenda</h3>
<div class="outline-text-3" id="text-search-agenda">
<p>
You can add <code>ad.DAYS</code> to any query to display search results grouped by day.
</p>
<p>
<code>DAYS</code> is a number of days you want to display.
</p>
<p>
For example, <code>(t.gym or t.class) ad.3</code> will display notes tagged with
<code>gym</code> or <code>class</code> with any type of time set within next 3 days.
</p>
</div>
</div>
<div id="outline-container-search-examples" class="outline-3">
<h3 id="search-examples">Examples</h3>
<div class="outline-text-3" id="text-search-examples">
<ul class="org-ul">
<li><code>i.todo t.john</code> - Search for <code>TODO</code> notes which are tagged with <code>john</code></li>
<li><code>b.Work .i.done</code> - Search in notebook <code>Work</code> for notes without <code>DONE</code> state</li>
<li><code>(b.Home or b.Work) phone</code> - Search in notebooks <code>Home</code> and <code>Work</code> for notes which contain the string <code>phone</code> in their title, content or any of the tags</li>
<li><code>s.1d p.a</code> - Search for priority <code>A</code> notes scheduled for tomorrow or earlier (same as <code>p.a s.tom</code>)</li>
<li><code>s.ge.today o.book o.pri</code> - Search for notes scheduled for today or later, sorting them by notebook name then priority</li>
<li><code>o.book o.pri o.s</code> - Sort by notebook name then priority then scheduled time</li>
<li><code>p.b</code> - Search for notes with priority <code>B</code> (includes notes with no priority if default priority is <code>B</code>)</li>
<li><code>ps.b</code> - Search for notes with priority set to <code>B</code></li>
</ul>
</div>
</div>
<div id="outline-container-b0b0976" class="outline-3">
<h3 id="b0b0976">Search Results</h3>
<div class="outline-text-3" id="text-b0b0976">
<p>
For each note you can tap on it to edit the note immediately. For
each note you can also swipe right to display a menu of options that
allow you to assign a starting time, cycle through the <code>TODO</code> and
<code>DONE</code> states, or to simply mark the note as <code>DONE</code>. If you swipe
left you'll be given a single option: displaying the note in the
notebook that contains it.
</p>
</div>
</div>
</div>
<div id="outline-container-faq" class="outline-2">
<h2 id="faq">FAQ</h2>
<div class="outline-text-2" id="text-faq">
</div>
<div id="outline-container-cost" class="outline-3">
<h3 id="cost">How much does it cost?</h3>
<div class="outline-text-3" id="text-cost">
<p>
Orgzly is free.
</p>
</div>
</div>
<div id="outline-container-source-code" class="outline-3">
<h3 id="source-code">Is the source code available?</h3>
<div class="outline-text-3" id="text-source-code">
<p>
Yes, the source code is available on <a href="https://github.com/orgzly-revived/orgzly-android-revived">GitHub</a>.
</p>
</div>
</div>
<div id="outline-container-96f0fcb" class="outline-3">
<h3 id="96f0fcb">I don't use Google Play, any alternatives?</h3>
<div class="outline-text-3" id="text-96f0fcb">
<p>
Orgzly Revived is also available on <a href="https://f-droid.org/app/com.orgzlyrevived">F-Droid</a>. Or you can download APK files
directly from the <a href="https://github.com/orgzly-revived/orgzly-android-revived/releases">GitHub releases</a> page.
</p>
</div>
</div>
<div id="outline-container-f695589" class="outline-3">
<h3 id="f695589">Dropbox sync option is missing</h3>
<div class="outline-text-3" id="text-f695589">
<p>
Are you using F-Droid version? Dropbox is only available in Google
Play's version of the app.
</p>
</div>