You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-19Lines changed: 12 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,43 +15,39 @@ Allows you to search by an ID that varies from API to API. Concrete information
15
15
#### Templates
16
16
17
17
The plugin allows you to set a template note that gets added to the end of any note created by this plugin.
18
-
The plugin also offers simple "template tgs". E.g. if the template includes `{{ title }}`, it will be replaced by the title of the movie, show or game.
19
-
Note that "template tags" are surrounded with two curly braces and that the spaces inside the curly braces are important.
18
+
The plugin also offers simple template tags, for example `{{ title }}`, which will be replaced by the title of the media you are importing.
19
+
Note that template tags are surrounded with two curly braces and spaces. The spaces inside the curly braces are important!
20
20
21
-
For arrays there are two special ways of displaying them.
21
+
For arrays there are two special ways of displaying them:
22
22
23
-
- using `{{ LIST:variable_name }}` will result in
23
+
- using `{{ LIST:variable_name }}` will result in:
24
24
```
25
25
- element 1
26
26
- element 2
27
27
- element 3
28
28
- ...
29
29
```
30
-
- using `{{ ENUM:variable_name }}` will result in
30
+
- using `{{ ENUM:variable_name }}` will result in:
31
31
```
32
32
element 1, element 2, element 3, ...
33
33
```
34
34
35
-
Available variables that can be used in template tags are the same variables from the metadata of the note.
35
+
Available variables that can be used in template tags are any front-matter properties.
36
36
37
37
I also published my own templates [here](https://github.com/mProjectsCode/obsidian-media-db-templates).
38
38
39
39
#### Download poster images
40
40
41
-
Allows you to automatically download the poster images for a new media, ensuring offline access. The images are saved as `type_title (year)` e.g. `movie_The Perfect Storm (2000)` with a user chosen save location.
41
+
The plugin offers a setting to automatically download the poster images for a new media, ensuring offline access. The images are saved as `type_title (year)` e.g. `movie_The Perfect Storm (2000)` in a user chosen folder.
42
42
43
43
#### Metadata field customization
44
44
45
-
Allows you to rename the metadata fields this plugin generates through mappings.
45
+
Allows you to rename the metadata fields this plugin generates through mappings. The mappings can be set in the plugins settings.
46
+
The three options for mapping are:
46
47
47
-
A mapping has to follow this syntax `[origional property name] -> [new property name]`.
48
-
Multiple mappings are separated by a new line.
49
-
So e.g.:
50
-
51
-
```
52
-
title -> name
53
-
year -> releaseYear
54
-
```
48
+
- `default`: Keep the original name
49
+
- `remap`: Rename the property
50
+
- `remove`: Removes the property entirely
55
51
56
52
#### Bulk Import
57
53
@@ -95,8 +91,6 @@ The folder structure should look like this:
95
91
96
92
### How to use
97
93
98
-
(pictures are coming)
99
-
100
94
Once you have installed this plugin, you will find a database icon in the left ribbon.
101
95
When using this or the `Add new Media DB entry` command, a popup will open.
102
96
Here you can enter the title of what you want to search for and then select in which APIs to search.
@@ -193,4 +187,3 @@ Contributions are always welcome. If you have an idea, feel free to open a featu
193
187
Credits go to:
194
188
195
189
- https://github.com/anpigon/obsidian-book-search-plugin for some inspiration and the idea to make this plugin
196
-
- https://github.com/liamcain/obsidian-periodic-notes for 99% of `Suggest.ts` and `FolderSuggest.ts`
0 commit comments