From 96bdb056446a577822fa1a12ced074b94c066eae Mon Sep 17 00:00:00 2001 From: Angelos Orfanakos Date: Wed, 29 Dec 2021 01:48:38 +0200 Subject: [PATCH 1/4] Fix typos in doc file --- doc/wiki.txt | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/doc/wiki.txt b/doc/wiki.txt index 5f90a7dc..76b9ff6e 100644 --- a/doc/wiki.txt +++ b/doc/wiki.txt @@ -167,29 +167,27 @@ GUIDE *wiki-intro-guide* Executive summary~ * Speed is key - make sure you have a fast workflow. - * Use a global keyboard shortcut to open the wiki index, e.g. . + * Use a global keyboard shortcut to map |:WikiIndex| to open the wiki index, + e.g. . * Use |:WikiFzfPages| and `ripgrep` (with e.g. ctrlsf.vim) for searching. * Write short pages and use links between related pages. * Don't obsess about the wiki structure. - The following guide is more or less an essay on how I personally use `wiki.vim` for structuring and writing my notes. I take the liberty of writing in the first tense, as this is clearly a subjective matter. An initial version -of was posted as a comment in an issue thread [0] (note: the links are listed -at the bottom). I recommend anyone interested to read the entire thread +of this was posted as a comment in an issue thread [0] (note: the links are +listed at the bottom). I recommend anyone interested to read the entire thread (although it is quite long!). But first, a quote that I think captures the most important concept in a single sentence (by @mgoral [1]): > I think that the most important thing is to not overthink things and just > keep writing stuff down. - People write things down. Take notes. Why? Because people, or at least most of us, don't remember things for too long. From my point of view, taking notes is a way to extend my memory. And writing the notes is itself a useful -process, because it often helps both to learn and to remember things in -itself. +process, because it often helps both to learn and to remember things. I find the idea of keeping my notes linked and easily searchable in pure text to be extremely potent. With wiki.vim, I can very quickly locate relevant @@ -203,13 +201,13 @@ So, some context: My personal wiki consists per 2021-08-29 of 1714 pages with a total of 71474 lines, excluding my journal. I first started taking notes in 2007, so this is perhaps 14 years worth of writing. I use Syncthing [2] to keep my notes synchronized across my computers, phones, tablets. I've -previously also used Dropbox, and I think +previously also used Dropbox. With a lot of content, it is important to be able to find things fast. I use |:WikiFzfPages| to find a specific page, and it usually takes just a couple of -seconds from I think of something until I have opened the relevant note. A key -here is to use simple names for the pages. I prefer several short pages -instead of one long, if possible. +seconds from the moment I think of something until I have opened the relevant +note. A key here is to use simple names for the pages. I prefer several short +pages instead of one long, if possible. Sometimes I search for things within pages. For this, I rely on `ripgrep` [3]. I use `ctrlsf.vim` [4] (which uses `ripgrep` as a backend). This makes it easy @@ -222,7 +220,7 @@ and/or ":CtrlSF", and it typically goes very fast (both of the commands are properly mapped). How do I write my notes? I make sure to write down what I feel like at the -moment. I then clean it up and rince/repeat as something is developing. I add +moment. I then clean it up and rinse/repeat as something is developing. I add links to relevant external and internal pages/resources. I often add examples, for instance tools I discover or libraries I learn about. @@ -245,8 +243,8 @@ content, or I make a link to some new scratch buffer with the new content. With time, I work through this index (often slowly) and move content into more dedicated pages. For this workflow to work well, it is crucial that my index.wiki is extremely accessible. That is, it takes less than a second from -I have a thought until I can add it to my `index.wiki` for later processing. -This is what makes it important. +the moment I have a thought until I can add it to my `index.wiki` for later +processing. This is what makes it important. Although I do add a lot of text to my wiki, I've also realized that I should not add all data there. For instance, I've come to use Zotero [5] for managing @@ -273,7 +271,7 @@ everyone else. ------------------------------------------------------------------------------ ALTERNATIVES *wiki-intro-alternatives* -There exists a lot of alternatives to `wiki.vim`. Within the Vim ecosystem, +There exist a lot of alternatives to `wiki.vim`. Within the Vim ecosystem, the main alternative is vimwiki. But there are also a lot of other alternatives. The following list is probably not very comprehensive. It may be useful if only as an inspiration to read about alternative approaches. The @@ -322,8 +320,8 @@ top of a local folder of plain text Markdown files. ============================================================================== CONFIGURATION *wiki-config* -The following subsections presents a list of available options and events that -can be used to customize the behaviour of wiki.vim. +The following subsections present a list of available options and events that +can be used to customize the behavior of wiki.vim. ------------------------------------------------------------------------------ OPTIONS *wiki-config-options* @@ -598,7 +596,7 @@ OPTIONS *wiki-config-options* < This example maps `,wx` to |(wiki-reload)|. The other maps are kept at their default (unless |g:wiki_mappings_use_default| specifies otherwise). - Some mappings are defined in other mod s than normal mode. In this + Some mappings are defined in other modes than normal mode. In this case, one can use the following syntax: > let g:wiki_mappings_local = { @@ -1454,7 +1452,7 @@ Wiki pages may be tagged with keywords for organization. It is relatively easy to define and specify custom tag parsers with |g:wiki_tag_parsers|. wiki.vim ships a default parser that is automatically used, see |wiki-tags-default|. -The number of lines in which tags are recognized can be costumized by modifying +The number of lines in which tags are recognized can be customized by modifying the |g:wiki_tag_scan_num_lines| variable. Related commands: @@ -1550,7 +1548,7 @@ is a dictionary with the following values: `date` ISO date 2021-07-01 `time` Time (24h format) 19:30 -The origin link is a a dictionary that represents the link that was followed +The origin link is a dictionary that represents the link that was followed to create the page. One may expect it to have one or more of the following keys: From 5f386b4936120ac918b244bd3c42a74db61cde64 Mon Sep 17 00:00:00 2001 From: Angelos Orfanakos Date: Fri, 31 Dec 2021 22:47:04 +0200 Subject: [PATCH 2/4] fixup! Fix typos in doc file --- doc/wiki.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/wiki.txt b/doc/wiki.txt index 76b9ff6e..ffd68291 100644 --- a/doc/wiki.txt +++ b/doc/wiki.txt @@ -167,8 +167,7 @@ GUIDE *wiki-intro-guide* Executive summary~ * Speed is key - make sure you have a fast workflow. - * Use a global keyboard shortcut to map |:WikiIndex| to open the wiki index, - e.g. . + * Use a global keyboard shortcut to open the wiki index, e.g. . * Use |:WikiFzfPages| and `ripgrep` (with e.g. ctrlsf.vim) for searching. * Write short pages and use links between related pages. * Don't obsess about the wiki structure. From f0956a018c2d46dd5d47fb03b2a2f16fc6c122a0 Mon Sep 17 00:00:00 2001 From: Angelos Orfanakos Date: Fri, 31 Dec 2021 22:50:50 +0200 Subject: [PATCH 3/4] fixup! Fix typos in doc file --- doc/wiki.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/wiki.txt b/doc/wiki.txt index ffd68291..e4a988ee 100644 --- a/doc/wiki.txt +++ b/doc/wiki.txt @@ -320,7 +320,7 @@ top of a local folder of plain text Markdown files. CONFIGURATION *wiki-config* The following subsections present a list of available options and events that -can be used to customize the behavior of wiki.vim. +can be used to customize the behaviour of wiki.vim. ------------------------------------------------------------------------------ OPTIONS *wiki-config-options* From 9af22a3fa3694ce186bbcdb2b2017a4ff2fca956 Mon Sep 17 00:00:00 2001 From: Angelos Orfanakos Date: Fri, 31 Dec 2021 22:52:50 +0200 Subject: [PATCH 4/4] fixup! Fix typos in doc file --- doc/wiki.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/wiki.txt b/doc/wiki.txt index e4a988ee..84dcf252 100644 --- a/doc/wiki.txt +++ b/doc/wiki.txt @@ -172,6 +172,7 @@ Executive summary~ * Write short pages and use links between related pages. * Don't obsess about the wiki structure. + The following guide is more or less an essay on how I personally use `wiki.vim` for structuring and writing my notes. I take the liberty of writing in the first tense, as this is clearly a subjective matter. An initial version @@ -183,6 +184,7 @@ most important concept in a single sentence (by @mgoral [1]): > I think that the most important thing is to not overthink things and just > keep writing stuff down. + People write things down. Take notes. Why? Because people, or at least most of us, don't remember things for too long. From my point of view, taking notes is a way to extend my memory. And writing the notes is itself a useful