Skip to content

Commit 5d13a67

Browse files
committed
update readme
1 parent 75166ec commit 5d13a67

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,39 @@ Allows you to search by an ID that varies from API to API. Concrete information
1515
#### Templates
1616

1717
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!
2020

21-
For arrays there are two special ways of displaying them.
21+
For arrays there are two special ways of displaying them:
2222

23-
- using `{{ LIST:variable_name }}` will result in
23+
- using `{{ LIST:variable_name }}` will result in:
2424
```
2525
- element 1
2626
- element 2
2727
- element 3
2828
- ...
2929
```
30-
- using `{{ ENUM:variable_name }}` will result in
30+
- using `{{ ENUM:variable_name }}` will result in:
3131
```
3232
element 1, element 2, element 3, ...
3333
```
3434
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.
3636
3737
I also published my own templates [here](https://github.com/mProjectsCode/obsidian-media-db-templates).
3838
3939
#### Download poster images
4040
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.
4242
4343
#### Metadata field customization
4444
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:
4647
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
5551
5652
#### Bulk Import
5753
@@ -95,8 +91,6 @@ The folder structure should look like this:
9591
9692
### How to use
9793
98-
(pictures are coming)
99-
10094
Once you have installed this plugin, you will find a database icon in the left ribbon.
10195
When using this or the `Add new Media DB entry` command, a popup will open.
10296
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
193187
Credits go to:
194188
195189
- 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

Comments
 (0)