# TUTORIAL - How to use the Book of Styles knowledge base - [[#Introduction|Introduction]] - [[#Setup|Setup]] - [[#Adding content|Adding content]] - [[#Updating a note|Updating a note]] - [[#Content type|Content type]] - [[#Automatic Operations|Automatic Operations]] - [[#Common Errors|Common Errors]] ## Introduction > [!warning] - Section under construction --- ## Setup > [!warning] - Section under construction ### Plugin configuration To access template configuration menu, first access Settings by clicking the "cog" icon on the bottom left of Obsidian: ![[tuto-templater-1.png]] #### Templater 1. On the left side panel of Settings, click on "Templater" in the "Community Plugins" section: ![[tuto-templater-3.png]] 2. **In "Template folder location", enter "z_dev/0 - special notes/templates"** ![[tuto-templater-2.png]] --- ## Adding content ### Step 0 - Pull changes Before adding new content, make sure to **pull the latest changes from the server**. This will ensure that content added by other contributors will be synchronized to your local library. To do that: 1. **Press "CONTROL + P" (Command + P on Mac)**, and tap in the search bar "source control". Select "Obsidian Git: Open source control view" ![[tuto-source-control-1.png]] 2. **On the right side panel (source control), select "Pull" (Down arrow)** ![[tuto-source-control-2.png]] ### Step 1 - Create a new note #### 1.1) Press "CONTROL + N" (Command + N on Mac) to open the file creation menu #### 1.2) Select the type of content you want to add ("Add a ...."). For a complete list of all content types available, refer to the [[#Content type|Content type]] section ![[tuto-select-content.png]] > [!warning] warning > if you get a Templater Error message, checkout [[#Templater Error]] on how to solve it #### 1.3) **Click on middle section to rename your newly created note** (By default, a note title is "Untitled") . The name can be for example, the title of the youtube video if you are adding a battle, or the name of the dancer. ![[tuto-create-1.png]] > [!warning] Warnings > The following characters are forbidden and can't be used to name a note: > - **/** (forward slash) > - **\\** (back slash) > - **\*** (asterisk) > - **?** (question mark) > - **'** (single quote) #### 1.4) Add a title to your note The title is generally the same as the note name, but it can be anything. ![[tuto-create-2.png]] > [!warning] Warning > Make sure to keep a space between the "**#**" and your text, so it appears as a title. #### 1.5) Fill in the note metadata To add a link to another note, use double brackets **\[\[** then tap in the note name. To add multiple note references to a same metadata field, separate note names with a comma. See the following example: ![[tuto-fill-metadata.gif]] > [!info] Tip > For a full description of each metadata field, refer to [[#Content type]] #### 1.6) Checkout how your note looks like by entering "Reading" mode. Toggle between "Reading" and "Editing" mode by pressing "CONTROL + E" (Command + E on Mac). ### Step 2 - Push changes Once you've added all the content you wanted, make sure to backup your modifications by pushing them to the remote server. This will ensure every other contributor will get access to the newly added content. > [!info] Tip > You do not need to do this operation for each note added. Do it once, at the end of your session, to backup all your work. ![[tuto-gif-push.gif]] #### 2.1) Open the Source Control view (See [[#Step 0 - Pull changes]]) #### 2.2) Select all your modifications Click on the **+** sign at the right side of "Changes". > [!warning] Warning > Make sure not to click on the curved arrow, it will erase your changes ! #### 2.3) write a "Commit message" to describe the files you have added If you don't know what to put, just write down your nickname. #### 2.4) click on the "Commit" button "Checkbox" emoji #### 2.5) Click on the "Push" button "upper arrow" emoji ### Step 3 - Publish changes on the website Now that you have added new content and backed up your work, the last step is publishing your changes on the website for everybody to see ! #### 3.1) On obsidian left side panel, click on the Publish Icon ![[tuto-publish-1.png]] #### 3.2) Select the notes you want to publish Check the "Changed" section for publishing modified notes, or "New" section for newly created notes ![[tuto-publish-2.png]] #### 3.3) Click on Publish That's it. You can check that the changes have been correctly published by visiting the [Book of Styles website](https://publish.obsidian.md/book-of-styles/%C2%B0START+HERE%C2%B0) --- ## Content type > [!warning] - Section under construction #### metadata ### Battle #### metadata ### Crew #### metadata ### Dancer #### metadata #### inbox - Tutorial: ne rien écrire APRES "related Media" ### Documentary #### metadata ### Event #### metadata ### Interview #### metadata ### Location #### metadata ### Music Artist #### metadata ### Showcase #### metadata ### Song #### metadata ### Style #### metadata --- ## Automatic Operations > [!warning] - Section under construction --- ## Common Errors > [!warning] - Section under construction ### Templater Error ![[tuto-error-file-exists.png]] This error generally occurs when you try to add a new note, and there is already a note named "Untitled" in the target folder. Example: You create a new Battle note ("Add a Battle") --> the error arises. To solve this error: 1. checkout in which folder the content you are adding is stored (in [[#Content type|Content type]]). Example: battle notes are stored in "knowledge-base/battles" 2. delete the file named "Untitled" in that folder This is most likely due to the fact that a note named "Untitled" already exists ### Updates were rejected because the remote contains work that you do not have locally ![[tuto-error-fast-forward.png]] This error occurs when you **push** files before having **pulled** the latest version of the library. To solve it: click on pull first (down arrow), then push again.