Skip to content

Commit ec1fa9b

Browse files
vrtmrzvrtmrz
committed
Fixed: Fix mistake on merge
1 parent 3b08783 commit ec1fa9b

1 file changed

Lines changed: 276 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 276 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,294 @@
1-
## MyTagFolder
1+
## TagFolder
22

3-
This is my custom build of the Obsidian TagFolder plugin.
3+
This is the plugin that shows your tags like folders.
44

5-
Original project: https://github.com/vrtmrz/obsidian-tagfolder
5+
![screenshot](images/screenshot.png)
66

7-
My fork keeps the original plugin behavior and adds my changes on top of it.
7+
### How to use
88

9-
### What I changed
9+
Install this plugin, press `Ctrl+p`, and choose "Show Tag Folder".
1010

11-
- Added support for creating new notes from a configured template when using TagFolder.
12-
- When no template is selected, new notes are created with TagFolder's default behavior. If `Store tags in frontmatter for new notes` is enabled, those fallback notes store their tags in Properties/frontmatter; otherwise the tags are inserted as hashtags.
13-
- Added a TagFolder context-menu action for renaming tags through TagWrangler.
11+
### Behavior
1412

15-
### Install my build
13+
This plugin creates a tree by tags permutation.
1614

17-
Download the ready-to-install zip from the GitHub Release:
15+
Like this,
16+
### Simple case
1817

19-
https://github.com/boabab/obsidian-tagfolder/releases/download/mytagfolder-v0.18.13-20260430/mytagfolder-plugin.zip
18+
If you have docs,
19+
```
20+
Apple : #food #red #sweet
21+
Pear : #food #green #sweet
22+
Tuna : #food #red
23+
```
24+
![](./images/simplecase.png)
25+
26+
...and more are shown.
27+
28+
### Case of respecting nested tags
29+
30+
The nested tag works well for Tag Folder.
2031

21-
Unzip it into this folder in your Obsidian vault:
32+
Tag Folder respects nested tags and makes the dedicated hierarchy. The nested child doesn't leak out over the parent.
2233

23-
```text
24-
<your-vault>/.obsidian/plugins/obsidian-tagfolder/
2534
```
35+
TagFolder Readme: #dev #readme #2021/12/10 #status/draft
36+
Technical information: #dev #note #2021/12/09 #status/draft
37+
SelfHosted LiveSync Readme : #dev #readme #2021/12/06 #status/proofread
38+
Old Note: #dev #readme #2021/12/10 #status/abandoned
39+
```
40+
#### Tag hierarchy of status
41+
42+
![](./images/respect-nestedtag-1.png)
43+
44+
#### Tag hierarchy of date
45+
46+
![](./images/respect-nestedtag-2.png)
47+
2648

27-
The folder should contain:
49+
#### Search tags
50+
You can search tags. like this:
2851

29-
```text
30-
main.js
31-
manifest.json
32-
styles.css
3352
```
53+
sweet -red | food -sweet
54+
```
55+
When using this filter, this plugin shows only "Pear" (Sweet but not red) and "Tuna" (food but not sweet).
56+
57+
### Settings
58+
59+
#### Behavior
60+
61+
##### Always Open
62+
63+
Place TagFolder on the left pane and activate it at every Obsidian launch.
64+
65+
##### Use pinning
66+
We can pin the tag if we enable this option.
67+
When this feature is enabled, the pin information is saved in the file set in the next configuration.
68+
Pinned tags are sorted according to `key` in the frontmatter of `taginfo.md`.
69+
70+
##### Pin information file
71+
We can change the name of the file in which pin information is saved.
72+
This can be configured also from the context-menu.
73+
74+
| Item | Meaning of the value |
75+
| -------- | ------------------------------------------------------------------------------------------------- |
76+
| key | If exists, the tag is pinned. |
77+
| mark | The label which is shown instead of `📌`. |
78+
| alt | The tag will be shown as this. But they will not be merged into the same one. No `#` is required. |
79+
| redirect | The tag will be redirected to the configured one and will be merged. No `#` is required. |
80+
81+
##### Disable narrowing down
82+
TagFolder creates the folder structure by collecting combinations of tags that are used in the same note, to make it easier for us to find notes.
83+
When this feature is enabled, collected combinations are no longer structured and show as we have organized them in a manner.
84+
85+
86+
#### Files
87+
88+
##### Display Method
89+
90+
You can configure how the entry shows.
91+
92+
##### Order method
93+
94+
You can order items by:
95+
- Displaying name
96+
- Filename
97+
- Modified time
98+
- Fullpath of the file
99+
100+
##### Use title
101+
102+
When you enable this option, the value in the frontmatter or first level one heading will be shown instead of `NAME`.
103+
104+
##### Frontmatter path
105+
Dotted path to retrieve title from frontmatter.
106+
107+
#### Tags
108+
109+
##### Order method
110+
111+
You can order tags by:
112+
- Filename
113+
- Count of items
114+
115+
##### Use virtual tags
116+
117+
When we enable this feature, our notes will be tagged as their freshness automatically.
118+
| Icon | Edited ... |
119+
| ---- | --------------------- |
120+
| 🕐 | Within an hour |
121+
| 📖 | Within 6 hours |
122+
| 📗 | Within 3 days |
123+
| 📚 | Within 7 days |
124+
| 🗄 | Older than 7 days ago |
125+
126+
##### Display folder as tag
127+
128+
When we enable this feature, the folder will be shown as a tag.
129+
130+
##### Store tags in frontmatter for new notes
131+
132+
This setting changes how tags are stored in new notes created by TagFolder. When disabled, tags are stored as #hashtags at the top of new notes. When enabled, tags are stored in the frontmatter and displayed in the note's Properties.
133+
134+
##### Template for new notes
135+
136+
When this setting is set to a valid markdown template path, TagFolder uses that template immediately when creating a new note from the tag tree. The `.md` extension is optional. If the setting is empty or invalid, TagFolder opens a template picker.
137+
138+
Templates can include these placeholders, which are replaced with the tags from the clicked location:
139+
140+
| Placeholder | Replacement |
141+
| ------------------ | ----------------------------------- |
142+
| `{{expandedTags}}` or `{{tags}}` | Tags as hashtags, e.g. `#tag1 #tag2` |
143+
| `{{tagList}}` | Tags as comma-separated text, e.g. `tag1, tag2` |
144+
| `{{tagPath}}` | Tags as a slash-separated path, e.g. `tag1/tag2` |
145+
| `{{tagName}}` | The last tag in the clicked context |
146+
| `{{tagsJson}}` | Tags as a JSON array |
147+
| `{{tagsYaml}}` | Tags as YAML list lines |
148+
149+
#### Actions
150+
151+
##### Search tags inside TagFolder when clicking tags
152+
We can search tags inside TagFolder when clicking tags instead of opening the default search pane.
153+
With control and shift keys, we can remove the tag from the search condition or add an exclusion of it to that.
154+
155+
##### List files in a separated pane
156+
When enabled, files will be shown in a separated pane.
157+
158+
#### Arrangements
159+
160+
##### Hide Items
161+
162+
Configure hiding items.
163+
- Hide nothing
164+
- Only intermediates of nested tags
165+
- All intermediates
166+
167+
If you have these items:
168+
```
169+
2021-11-01 : #daily/2021/11 #status/summarized
170+
2021-11-02 : #daily/2021/11 #status/summarized
171+
2021-11-03 : #daily/2021/11 #status/jot
172+
2021-12-01 : #daily/2021/12 #status/jot
173+
```
174+
175+
This setting affects as like below.
176+
- Hide nothing
177+
178+
```
179+
daily
180+
→ 2021
181+
→ 11
182+
status
183+
→ jot
184+
2021-11-03
185+
→ summarized
186+
2021-11-01
187+
2021-11-02
188+
2021-11-01
189+
2021-11-02
190+
2021-11-03
191+
2021-11-01
192+
2021-11-02
193+
2021-11-03
194+
2021-11-01
195+
2021-11-02
196+
2021-11-03
197+
2021-12-01
198+
→ 12
199+
:
200+
2021-11-01
201+
2021-11-02
202+
2021-11-03
203+
2021-12-01
204+
```
205+
206+
- Only intermediates of nested tags
207+
Hide only intermediates of nested tags, so show items only on the last or break of the nested tags.
208+
```
209+
daily
210+
→ 2021
211+
→ 11
212+
status
213+
→ jot
214+
2021-11-03
215+
→ summarized
216+
2021-11-01
217+
2021-11-02
218+
2021-11-01
219+
2021-11-02
220+
2021-11-03
221+
→ 12
222+
:
223+
```
224+
- All intermediates
225+
Hide all intermediates, so show items only deepest.
226+
```
227+
daily
228+
→ 2021
229+
→ 11
230+
status
231+
→ jot
232+
2021-11-03
233+
→ summarized
234+
2021-11-01
235+
2021-11-02
236+
→ 12
237+
:
238+
```
239+
240+
##### Merge redundant combinations
241+
When this feature is enabled, a/b and b/a are merged into a/b if there are no intermediates.
242+
243+
##### Do not simplify empty folders
244+
Keep empty folders, even if they can be simplified.
245+
246+
##### Do not treat nested tags as dedicated levels
247+
248+
If you enable this option, every nested tag is split into normal tags.
249+
250+
`#dev/TagFolder` will be treated like `#dev` and `#TagFolder`.
251+
252+
##### Reduce duplicated parents in nested tags
253+
254+
If we have the doc (e.g., `example note`) with nested tags which have the same parents, like `#topic/calculus`, `#topic/electromagnetics`:
255+
256+
- Disabled
257+
```
258+
topic
259+
- > calculus
260+
topic
261+
- > electromagnetics
262+
example note
263+
example note
264+
```
265+
- Enabled
266+
```
267+
topic
268+
- > calculus
269+
- > electromagnetics
270+
example note
271+
example note
272+
```
273+
274+
#### Filters
275+
276+
277+
##### Target Folders
278+
If we set this, the plugin will only target files in it.
279+
280+
281+
##### Ignore Folders
282+
283+
Ignore documents in specific folders.
284+
285+
286+
##### Ignore note Tag
34287

35-
Restart Obsidian, then open Settings -> Community plugins and enable `MyTagFolder`.
288+
If the note has the tag that is set in here, the note would be treated as there was not.
36289

37-
### Source branch
290+
##### Ignore Tag
38291

39-
The branch with both custom features is:
292+
Tags that were set here would be treated as there were not.
40293

41-
https://github.com/boabab/obsidian-tagfolder/tree/feature/all-my-features
294+
##### Archive tags

0 commit comments

Comments
 (0)