1
0
Fork 0

Updates to verbiage, grammer, and similar in readme

This commit is contained in:
kemonine 2024-11-23 22:48:17 +00:00
parent e14fcddf48
commit cd10e16bb8

View file

@ -90,7 +90,7 @@ This can also be helpful for screenshots, downloads from the internet and more.
Syncing this notebook is pretty simple. However, if you use multiple Obsidian clients over the course of the day you can easily run into conflicts on the `.obsidian` folder which are a pain to reconcile.
This vault should sync *fast*. Like within 60 seconds fast. I recommend syncing prior to using any client with the vault, closing clients when you're switching to another client or "walking away" for awhile and syncing prior to opening the Obsidian app and syncing when you close the Obsidian app.
This vault should sync *fast*. Like within 60 seconds fast. I recommend syncing prior to using any client with the vault, closing clients when you're switching to another client or "walking away" for awhile and and syncing when you close the Obsidian app.
For me this looks like
@ -117,14 +117,14 @@ The `template` folder as a single template called `Shower Thought`. This vault i
Something important: ensure there is only one template and it's as minimal as possible. Doing otherwise will slow note creation enough to be a very real problem during regular use.
> [!danger]
> *A single template with unique file name makes creating notes fast and this is the most critical factor related to speed.*
> *A single template with unique output file name makes creating notes fast and this is the most critical factor related to speed.*
### Tweaking
The template is pretty simple and easy to work with. Since it's simple, see the below for the "why" of each item present in the template.
`tags`
: This is a single tag as a list for one specific reason: I move my shower thought notes into my main "2nd Brain" value or "Medical" vault or ["Digital Art Composition Book](https://git.kemonine.info/kemonine/digital-art-composition-book) vault every day. This lets me know which items originated as shower thoughts and makes it easy for me to add additional tags when I process my shower thoughts in other vaults.
: This is a single tag as a list for one specific reason: I move my shower thought notes into my main "2nd Brain" vault or "Medical" vault or ["Digital Art Composition Book](https://git.kemonine.info/kemonine/digital-art-composition-book) vault every day. This lets me know which items originated as shower thoughts and makes it easy for me to add additional tags when I process my shower thoughts in other vaults.
`created_ts`
: This is a timestamp for when the note was created. When I move notes to my other vaults I tend to rename them. This allows me to keep track of the actual creation timestamp long-term.
@ -133,14 +133,14 @@ The template is pretty simple and easy to work with. Since it's simple, see the
: If the note didn't originate "in my head"... it came from somewhere. It could be another human showing me something, a website, a book, whatever. This field tells me where this note came from. I consider this an optional field and a lot of my notes never use this field. I don't delete this field until I've pulled a shower thought out into another vault. It doesn't take up much screen or storage space and I can easily ignore it when not needed.
`table-of-contents`
: This is here because, well, I use headings A Lot. Even in "tiny notes" I tend to have headings. This lets me get a proper table of contents at the top of my note so I can "jump down" when processing my notes into other vaults. This also allows me to expand on a shower thought if I get any down time "on the go". Only about 30% of my shower thoughts could or would benefit from a table of contents up front and about 70% could use a table of contents once I start to expand on my initial thoughts or process the shower thought. If the standard Outline View built into Obsidian is enough for your needs, I'd recommend removing this block from the template.
: This is here because, well, I use headings A Lot. Even in "tiny notes" I tend to have headings. This lets me get a proper table of contents at the top of my note so I can "jump down" when processing my notes into other vaults. This also allows me to expand on a shower thought if I get any down time "on the go". Only about 30% of my shower thoughts could or would benefit from a table of contents up front and about 70% could use a table of contents once I start to expand on my initial thoughts or process the shower thought. If the standard Outline View built into Obsidian is enough for your needs, I'd recommend removing this block from the template and removing the related community plugin.
`Shower_Thought` text
: This is here so I can double click or long-press to get my text cursor to the point I want my text to start. This also helps me visually separate "the header" and "the note". If you find you don't need or want this text, feel free to remove it.
: This is here so I can double click or long-press to get my text cursor to the point where I want my text to start. This also helps me visually separate "the header" and "the note". If you find you don't need or want this text, feel free to remove it.
That's the whole template. It's very simple and designed to facilitate shifting data from this vault into my other vaults that I treat as my main data and knowledge storage zones.
You may also notice a lack of prompts. *This is intentional*. Originally I had the template setup to prompt and it always slowed me down and got in my way. In the end any and all prompts pissed me off because they get in the way. Especially given I very likely need to capture my thought *then* fill in properties. The inversion of a "standard" workflow proved and important consideration with regular use.
You may also notice a lack of prompts in the template. *This is intentional*. Originally I had the template setup to prompt and it always slowed me down and got in my way. In the end, any and all prompts pissed me off because they get in my way. Especially given I very likely need to capture my thought *first* and then, *later*, fill in any applicable properties. This inversion of the "standard workflow" proved an important consideration with regular use.
> [!danger]
> When tweaking the template, the most important thing to remember is: keep it *simple* and do *NOT* use any prompts.
@ -151,12 +151,12 @@ This vault should be considered a slip box, pit stop for thoughts, and similar.
Sync speed is directly tied to the amount of data stored within this vault. Particularly the number of files. In order for this vault to be useful the speed needs to remain *fast*.
I strongly recommend culling all notes into other, primary data vaults at least weekly, if not daily or every other day. I cull daily and it's proven critical to my use of this vault. I tend to note a lot of random down over the course of a day and this tiny, simple, efficient *super fast syncing* vault is indispensable for me. However it's only super fast for sync if I go through and pull out or delete the content stored within daily.
I strongly recommend culling all notes into other vaults or storage areas at least weekly, if not daily or every other day. I cull daily and it's proven critical to my use of this vault. I tend to note a lot of random information over the course of a day and this tiny, simple, efficient, *super fast syncing* vault is indispensable for me. However it's only super fast for sync if I go through and pull out or delete the content stored within daily.
When I cull, I look at each note, move it to a better spot like my 2nd Brain vault or another vault or my todo list or another location. There are times I outright delete the note. I also go through any attachments and move them into other locations or delete them as appropriate. Once a shower thought or attachment gets moved to a different vault for the long-term, I go ahead and rename the note, tag it as appropriate, add content and generally fold it into my data sets for use. Sometimes I'll move a shower thought into my 2nd Brain's inbox so I know that it deserves some focused attention and since it's in my main inbox, I won't lose track of the note and will ultimately come back to it.
When I cull, I look at each note, move it to a better spot like my 2nd Brain vault or another vault or my todo list or another location. There are times I outright delete the note. I also go through any attachments and move them into other locations or delete them as appropriate. Once a shower thought or attachment gets moved to a different location for the long-term, I go ahead and rename the note, tag it as appropriate, add content and generally fold it into my data sets for use. Sometimes I'll move a shower thought into my 2nd Brain's inbox so I know that it deserves some focused attention. Since it's in my main inbox, I won't lose track of the note and will ultimately come back to it.
> [!tip]
> Just remember: **the more data, the slower sync becomes**
> Just remember: **the more data, the more files: the slower sync becomes**
## The Finer Details
@ -184,11 +184,11 @@ The only standard plugins enabled are...
: This is needed to create notes quickly and easily. It's also a requirement of the Unique Note Creator plugin. The standard template plugin in Obsidian is not something considered "powerful" but it's just enough to be useful for shower thoughts. It also forces KISS principles. This is a good thing as it'll help ensure you can get to editing notes *fast*.
**Unique Note Creator**
: Useful as it is meant to create notes using a timestamp for the title and filename. It's even tunable for the date and time format used to create the note title. Be careful though: the date and time setup here is designed to be *properly sortable*. US dates, UK dates, am/pm times and other formats are notorious for not being able to be sorted reliably or easily. Please mind this fact before making adjustments to this plugin.
: This is useful as it is meant to create notes using a timestamp for the title and filename. It's even tunable for the date and time format used to create the note title. Be careful though: the date and time setup here is designed to be *properly sortable*. US dates, UK dates, am/pm times and other formats are notorious for not being able to be sorted reliably or easily. Please mind this fact before making adjustments to this plugin's configuration.
### Audio Recorder Plugin
Audio recording has been disabled due to the simple fact there are better option available and this vault is setup to have attachment support. You can simply attach audio notes from other apps as appropriate.
Audio recording has been disabled due to the simple fact there are better options available and this vault is setup to have attachment support. You can simply attach audio notes from other apps as appropriate.
However, if you use *simple* voice memo's heavily, it may be good to turn on this plugin to help ensure both textual and audio shower thoughts are captured in one location.
@ -197,13 +197,13 @@ However, if you use *simple* voice memo's heavily, it may be good to turn on thi
The only community plugins present are...
**Automatic table of contents**
: When you do end up with the rare "long note with headings" or if you're like me and use headings heavily, having a full table of contents at the top of a note can be super helpful, even if the standard outline feature is available. If the standard outline view is sufficient for your needs, this plugin can be removed and the shower thought not template adjusted to not use this plugin.
: When you do end up with the rare "long note with headings" or if you're like me and use headings heavily, having a full table of contents at the top of a note can be super helpful, even if the standard outline feature is available. If the standard outline view is sufficient for your needs, this plugin can be removed and the shower thought template adjusted to not use this plugin.
**Definition list**
: For whatever reason, Obsidian doesn't support definition list markdown syntax. This plugin fixes that fact. Note: these lists of plugins are definition lists.
**Trash explorer**
: Simply put: I don't like "use system trash" as data that you may want to restore (accidental deletes anyone?) is suddenly outside the scope of the vault. Add in the fact on mobile OS's, the `.trash` folder can be a right PITA to find/view... I just setup this plugin. You boop a button and can see the trash. It's also included in sync just in case. Keep this, it's a very useful safety net.
: Simply put: I don't like "use system trash". It causes any data that you may want to restore (accidental deletes anyone?) to be outside the scope of the vault. Add in the fact that on mobile OS's, the `.trash` folder can be a right PITA to find/view... I just setup this plugin. You boop a button and can see the trash. It's also included in sync just in case. Keep this, it's a very useful safety net.
### AI Integrations / Plugins
@ -234,7 +234,7 @@ I do recommend tuning some areas of the vault config based on need and/or prefer
### Default Editing Mode
This vault is setup to use `Source mode` instead of `Live Preview` as the editing mode. This is due to my preference to keep presentation and formatting independent of content. I also have the majority of the markdown spec memorized and tend to write pure markdown by default.
This vault is setup to use `Source mode` instead of `Live Preview` as the editing mode. This is due to my preference to keep presentation and formatting independent of content. I also have the majority of the markdown spec memorized and tend to write pure markdown by default. Unless you're comfortable writing markdown directly or want to learn markdown syntax, you probably want to change this setting.
> [!tip]
> If you aren't fond of editing markdown outright, don't know the markdown spec or any other reason to avoid `Source mode`, you *should* change the `Editor -> Default editing mode` setting to `Live Preview`.
@ -250,7 +250,7 @@ The command palette has the following commands pinned
- Trash Explorer: Show trash explorer
- File Recovery: Open saved snapshots
These are the only commands I've regularly used to date and I've been using this vault for a long period of time now. Sometimes I need additional commands but the command palette pop-up allows me to search for a command which has obviated the need for additional pins on the command palette.
These are the only commands I've regularly used to date and I've been using this vault for a long period of time now. Sometimes I need additional commands but the command palette pop-up allows me to search for a command. This search feature has obviated the need for additional pins on the command palette. Especially since I can start typing to search as soon as the command palette pops up on screen.
> [!tip]
> If you find yourself needing additional commands regularly or disliking the order of pinned commands, feel free to make adjustments. This is a very personal area of config and *should* be adapted to individual need.
@ -267,7 +267,7 @@ The mobile editing toolbar has been configured to have only the following items
- Paste
- Configure mobile toolbar
The standard mobile editing toolbar is a huge list of "stuff" and far more than my needs require. I also prefer writing markdown directly and have most of the spec memorized. Because of this I've reduced the mobile toolbar to a fundamental set of actions that are not "simply markdown syntax".
The standard mobile editing toolbar is a huge list of "stuff" and far more than my needs require. I also prefer writing markdown directly and have most of the spec memorized. Because of this I've reduced the mobile toolbar to a fundamental set of actions that are not "simply markdown syntax". I strongly recommend adjusting this to your individual preferences.
> [!tip]
> This is one area of the vault that *should* be evaluated and tweaked immediately, especially if you don't have the markdown spec memorized.