Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/execution-command.html b/commands/execution-command.html
new file mode 100644
index 00000000..9af948e3
--- /dev/null
+++ b/commands/execution-command.html
@@ -0,0 +1,219 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dynamic Commands
+With this command utility, you can declare a command as "dynamic", which means that this command will be resolved when entering preview mode.
+To declare a dynamic command add a plus + sign after the command opening tag: <%+
That's it, your command will now be executed only in preview mode.
+This is useful for internal functions like tp.file.last_modified_date for example:
Last modified date: <%+ tp.file.last_modified_date() %>
+Note: Dynamic commands have known issues, and will likely not be maintained going forward (see this issue for more details). In most cases the Dataview plugin is the suggested alternative.
+Refresh problems
+One "downside" of the preview mode is that it puts the rendered note in cache, to speed things up.
+This means that your dynamic command will be rendered only once, when you open the note, but won't be refreshed after.
+If you want to refresh it, you must close the note to clear the cache and open it again.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/overview.html b/commands/overview.html
new file mode 100644
index 00000000..53210020
--- /dev/null
+++ b/commands/overview.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Javascript Execution Command
+This type of command allows us to execute JavaScript code.
+With a JavaScript Execution command, we can pretty much do everything that JavaScript allows us to do. Some examples are given below.
+We can still access the tp object and all the internal variables / functions from this type of command.
JavaScript Execution commands let you access global namespace variables. This means you can access things like app or moment.
Asynchronous functions
+Some internal functions are asynchronous. When calling such functions inside a JavaScript execution command, don't forget to use the await keyword if necessary.
How to output a value from a JavaScript Execution Command ?
+Sometimes, you may want to output something when using a JS execution command.
+When our templating engine generates a replacement string using all of our commands results, it is stored in a variable named tR. This is the string that will contain the processed file content. You are allowed to access that variable from a JS execution command.
This means that, to output something from a JS execution command, you just need to append what you want to output to that tR string variable.
For example, the following command: <%* tR += "test" %> will output test.
Suggesters and Prompts
+It is important to note that the tp.system.prompt() and tp.system.suggester() both require a await statement to save the value to a variable
Examples
+Here are some examples of things you can do using JavaScript Execution Commands:
+<%* if (tp.file.title.startsWith("Hello")) { %>
+This is a hello file !
+<%* } else { %>
+This is a normal file !
+<%* } %>
+
+<%* if (tp.frontmatter.type === "seedling") { %>
+This is a seedling file !
+<%* } else { %>
+This is a normal file !
+<%* } %>
+
+<%* if (tp.file.tags.contains("#todo")) { %>
+This is a todo file !
+<%* } else { %>
+This is a finished file !
+<%* } %>
+
+<%*
+function log(msg) {
+ console.log(msg);
+}
+%>
+<%* log("Title: " + tp.file.title) %>
+
+<%* tR += tp.file.content.replace(/stuff/, "things"); %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/whitespace-control.html b/commands/whitespace-control.html
new file mode 100644
index 00000000..ca03da53
--- /dev/null
+++ b/commands/whitespace-control.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Commands
+Command Types
+Templater defines 2 types of opening tags, that defines 2 types of commands:
+-
+
<%: Interpolation command. It will output the result of the expression that's inside.
+<%*: JavaScript execution command. It will execute the JavaScript code that's inside. It does not output anything by default.
+
The closing tag for a command is always the same: %>
Command utilities
+In addition to the different types of commands, you can also use command utilities. They are also declared in the opening tag of the command. All command utilities work with all command types. The available command utilities are:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 00000000..21c08b93
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,495 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+::-webkit-scrollbar {
+ background: var(--bg);
+}
+::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-bottom-color: var(--bg);
+ border-bottom-width: 1px;
+ border-bottom-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-bottom-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-top: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+.previous {
+ float: left;
+}
+
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+@media only screen and (max-width: 1380px) {
+ .sidebar-visible .nav-wide-wrapper { display: none; }
+ .sidebar-visible .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 5px;
+ top: 5px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+}
+pre > .buttons i {
+ margin-left: 8px;
+}
+pre > .buttons button {
+ color: inherit;
+ background: transparent;
+ border: none;
+ cursor: inherit;
+}
+pre > .result {
+ margin-top: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding: 0 3px 1px 3px;
+ margin: 0 -3px -1px -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin: 5px auto 0px auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding: 18px 0 0 5px;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+ border-bottom: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-left: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin: 5px 0 0 20px;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: 0;
+ top: 0;
+ bottom: 0;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: 5px;
+}
+.sidebar-hidden .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+.sidebar-visible .page-wrapper {
+ transform: translateX(var(--sidebar-width));
+}
+@media only screen and (min-width: 620px) {
+ .sidebar-visible .page-wrapper {
+ transform: none;
+ margin-left: var(--sidebar-width);
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-left: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-left: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-top: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-left: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+}
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 10px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: left;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+.theme-popup .theme:hover:first-child,
+.theme-popup .theme:hover:last-child {
+ border-top-left-radius: inherit;
+ border-top-right-radius: inherit;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 00000000..ef2ba504
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,182 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
+ font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-top: 2.5em; }
+h4, h5 { margin-top: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-top: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-left: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-top: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+}
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 15px;
+ padding-bottom: 50px;
+}
+.content main {
+ margin-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-top: .1em solid var(--quote-border);
+ border-bottom: .1em solid var(--quote-border);
+}
+
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-top: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 00000000..5e690f75
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,54 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none;
+ margin-left: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ background-color: #666666;
+ border-radius: 5px;
+
+ /* Force background to be printed in Chrome */
+ -webkit-print-color-adjust: exact;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 00000000..56b634bc
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,253 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 00000000..94b20dd2
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Whitespace Control
+By default, commands in Templater are not removing any newlines. Commands are replaced with their values and that's it.
+It can sometimes be useful to have some whitespace control after commands are inserted, which is exactly what this command utility offers.
+Let's have an example. The following template:
+<%* if (tp.file.title == "MyFile" ) { %>
+This is my file!
+<%* } else { %>
+This isn't my file!
+<%* } %>
+Some content ...
+Will produce the following output if the condition is false (the same happens when it's true), notice the blank lines:
+
+This isn't my file!
+
+Some content ...
+You may want to remove the blank lines produced by the execution commands, that do not produce any output.
+A specific syntax exists for whitespace control:
+-
+
- An underscore
_at the beginning of a tag (<%_) will trim all whitespace before the command
+ - An underscore
_at the end of a tag (_%>) will trim all whitespace after the command
+ - A dash
-at the beginning of a tag (<%-) will trim one newline before the command
+ - A dash
-at the end of a tag (-%>) will trim one newline after the command.
+
In our example, to fix our template to remove the blank lines, we would use the following template (notice the dashes - at the end of the tags), to remove the blank newlines after the execution commands:
<%* if (tp.file.title == "MyFile" ) { -%>
+This is my file!
+<%* } else { -%>
+This isn't my file!
+<%* } -%>
+Some content ...
+Which would produce the following output:
+This isn't my file!
+Some content ...
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/favicon.png b/favicon.png
new file mode 100644
index 00000000..a5b1aa16
Binary files /dev/null and b/favicon.png differ
diff --git a/favicon.svg b/favicon.svg
new file mode 100644
index 00000000..90e0ea58
--- /dev/null
+++ b/favicon.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/fonts/OPEN-SANS-LICENSE.txt b/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 00000000..d6456956
--- /dev/null
+++ b/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/fonts/SOURCE-CODE-PRO-LICENSE.txt b/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 00000000..366206f5
--- /dev/null
+++ b/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/fonts/fonts.css b/fonts/fonts.css
new file mode 100644
index 00000000..858efa59
--- /dev/null
+++ b/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/fonts/open-sans-v17-all-charsets-300.woff2 b/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 00000000..9f51be37
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-300italic.woff2 b/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 00000000..2f545448
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600.woff2 b/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 00000000..f503d558
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600italic.woff2 b/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 00000000..c99aabe8
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700.woff2 b/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 00000000..421a1ab2
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700italic.woff2 b/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 00000000..12ce3d20
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800.woff2 b/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 00000000..c94a223b
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800italic.woff2 b/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 00000000..eed7d3c6
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-italic.woff2 b/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 00000000..398b68a0
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-regular.woff2 b/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 00000000..8383e94c
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/fonts/source-code-pro-v11-all-charsets-500.woff2 b/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 00000000..72224568
Binary files /dev/null and b/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 00000000..c2343227
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,83 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+ padding: 0.5em;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 00000000..180385b7
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,6 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Frequently Asked Questions
+Unicode characters (emojis, ...) are not working on Windows ?
+cmd.exe and powershell on Windows are known to have problems with unicode characters.
You can check https://github.com/SilentVoid13/Templater/issues/15#issuecomment-824067020 for a solution.
+Another good solution (probably the best) is to use Windows Terminal and set it as the default shell in Templater's setting.
+Another resource containing solutions that could work for you: https://stackoverflow.com/questions/49476326/displaying-unicode-in-powershell
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation.html b/installation.html
new file mode 100644
index 00000000..46ab3805
--- /dev/null
+++ b/installation.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+Templater is a template language that lets you insert variables and functions results into your notes. It will also let you execute JavaScript code manipulating those variables and functions.
+With Templater, you will be able to create powerful templates to automate manual tasks.
+Quick Example
+The following template file, that is using Templater syntax:
+---
+creation date: <% tp.file.creation_date() %>
+modification date: <% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm:ss") %>
+---
+
+<< [[<% tp.date.now("YYYY-MM-DD", -1) %>]] | [[<% tp.date.now("YYYY-MM-DD", 1) %>]] >>
+
+# <% tp.file.title %>
+
+<% tp.web.daily_quote() %>
+Will produce the following result when inserted:
+---
+creation date: 2021-01-07 17:20
+modification date: Thursday 7th January 2021 17:20:43
+---
+
+<< [[2021-04-08]] | [[2021-04-10]] >>
+
+# Test Test
+
+> Do the best you can until you know better. Then when you know better, do better.
+> — <cite>Maya Angelou</cite>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/contribute.html b/internal-functions/contribute.html
new file mode 100644
index 00000000..d2cb6169
--- /dev/null
+++ b/internal-functions/contribute.html
@@ -0,0 +1,243 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+You can install this plugin via the Community Plugins tab within Obsidian. Search for "Templater".
+It's a good practice to restart the Obsidian app after the installation of Templater, to make sure everything is working properly.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/app-module.html b/internal-functions/internal-modules/app-module.html
new file mode 100644
index 00000000..8b9810d6
--- /dev/null
+++ b/internal-functions/internal-modules/app-module.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contributing
+You can contribute to Templater by developing a new internal function / variable.
+The process to develop a new one is really easy.
+Keep in mind that only pertinent submissions will be accepted, don't submit a very specific internal variable / function that you'll be the only one using.
+Layout
+Internal variables / functions are sorted by modules. Each module has a dedicated folder under src/InternalTemplates.
+Let's take the date module as an example.
+It contains an InternalModuleDate file where all our internal date's related variables and functions are defined and registered:
+export class InternalModuleDate extends InternalModule {
+ name = "date";
+
+ async createStaticTemplates() {
+ this.static_templates.set("now", this.generate_now());
+ this.static_templates.set("tomorrow", this.generate_tomorrow());
+ this.static_templates.set("yesterday", this.generate_yesterday());
+ }
+
+ async updateTemplates() {}
+
+ generate_now() {
+ return (format: string = "YYYY-MM-DD", offset?: number, reference?: string, reference_format?: string) => {
+ if (reference && !window.moment(reference, reference_format).isValid()) {
+ throw new Error("Invalid title date format, try specifying one with the argument 'reference'");
+ }
+ return get_date_string(format, offset, reference, reference_format);
+ }
+ }
+
+ generate_tomorrow() {
+ return (format: string = "YYYY-MM-DD") => {
+ return get_date_string(format, 1);
+ }
+ }
+
+ generate_yesterday() {
+ return (format: string = "YYYY-MM-DD") => {
+ return get_date_string(format, -1);
+ }
+ }
+}
+Every module extends the InternalModule abstract class, which means they contain the following attributes and methods:
+-
+
this.appattribute: the Obsidian APIAppobject.
+this.fileattribute: The destination file where the template will be inserted.
+this.pluginattribute: The Templater plugin object.
+this.static_templatesattribute: A map containing all (name; variable/function) that are static. A static variable / function means that it doesn't depend on the file when executed. These type of variables / functions won't be updated each time we insert a new template, to save some overhead.
+this.dynamic_templatesattribute: Same asstatic_templatesexcept that it contains variables / functions dependent on the file when executed.
+this.createStaticTemplates()method: Registers all static internal variable / function for that module.
+this.updateTemplates()method: Registers every dynamic internal variable / function for that module.
+
You can use these attributes in your new internal variable / function if you need them.
+Registering a new internal variable / function
+Here are the different steps you need to follow, in order to register a new internal variable / function in a module.
+1st step: Create a method inside the module called generate_<internal_variable_or_function_name>() that will generate your internal variable / function, that means it will return either a lambda function (representing the internal function) or directly the internal variable you want to expose.
All generation methods are ordered by alphabetical order based on the internal variable / function name.
+Try to give a good, self-explanatory name for your variable / function.
+2nd step: Register your internal variable / function in the static_templates or dynamic_templates map depending on whether your internal variable / function on the file when executed. The registration happens either in createStaticTemplates or updateTemplates.
To register your variable / function, use your this.generate_<internal_variable_or_function_name>() method you defined earlier:
this.static_templates.set(<internal_variable_or_function_name>, this.generate_<internal_variable_or_function_name>());
+OR
+this.dynamic_templates.set(<internal_variable_or_function_name>, this.generate_<internal_variable_or_function_name>());
+Internal variable / function registrations are also ordered by alphabetical order based on the variable / function name.
+3rd step: Add your internal variable / function documentation to Templater's documentation.
+And you are done ! Thanks for contributing to Templater !
+Now, just submit a pull request on Github, I'll try to be as reactive as possible.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/config-module.html b/internal-functions/internal-modules/config-module.html
new file mode 100644
index 00000000..dfe3a0ec
--- /dev/null
+++ b/internal-functions/internal-modules/config-module.html
@@ -0,0 +1,198 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ App Module
+This module exposes the app instance. Prefer to use this over the global app instance.
+This is mostly useful when writing scripts.
+Refer to the Obsidian developer documentation for more information.
+Examples
+// Get all folders
+<%
+tp.app.vault.getAllLoadedFiles()
+ .filter(x => x instanceof tp.obsidian.TFolder)
+ .map(x => x.name)
+%>
+
+// Update frontmatter of existing file
+<%*
+const file = tp.file.find_tfile("path/to/file");
+await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
+ frontmatter["key"] = "value";
+});
+%>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/date-module.html b/internal-functions/internal-modules/date-module.html
new file mode 100644
index 00000000..cc02de19
--- /dev/null
+++ b/internal-functions/internal-modules/date-module.html
@@ -0,0 +1,326 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Config Module
+This module exposes Templater's running configuration.
+This is mostly useful when writing scripts requiring some context information.
+-
+
- Documentation + + +
Documentation
+tp.config.active_file?
+The active file (if existing) when launching Templater.
+tp.config.run_mode
+The RunMode, representing the way Templater was launched (Create new from template, Append to active file, ...).
tp.config.target_file
+The TFile object representing the target file where the template will be inserted.
tp.config.template_file
+The TFile object representing the template file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/file-module.html b/internal-functions/internal-modules/file-module.html
new file mode 100644
index 00000000..b7cf71e9
--- /dev/null
+++ b/internal-functions/internal-modules/file-module.html
@@ -0,0 +1,487 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Date Module
+This module contains every internal function related to dates.
+-
+
- Documentation
+
-
+
tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)
+tp.date.tomorrow(format: string = "YYYY-MM-DD")
+tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)
+tp.date.yesterday(format: string = "YYYY-MM-DD")
+
+ - Moment.js +
- Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)
+Retrieves the date.
+Arguments
+-
+
-
+
+format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+ -
+
+offset: Duration to offset the date from. If a number is provided, duration will be added to the date in days. You can also specify the offset as a string using the ISO 8601 format.
+ -
+
+reference: The date referential, e.g. set this to the note's title.
+ -
+
+reference_format: The format for the reference date. Refer to format reference.
+
Examples
+// Date now
+<% tp.date.now() %>
+// Date now with format
+<% tp.date.now("Do MMMM YYYY") %>
+// Last week
+<% tp.date.now("YYYY-MM-DD", -7) %>
+// Next week
+<% tp.date.now("YYYY-MM-DD", 7) %>
+// Last month
+<% tp.date.now("YYYY-MM-DD", "P-1M") %>
+// Next year
+<% tp.date.now("YYYY-MM-DD", "P1Y") %>
+// File's title date + 1 day (tomorrow)
+<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>
+// File's title date - 1 day (yesterday)
+<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>
+tp.date.tomorrow(format: string = "YYYY-MM-DD")
+Retrieves tomorrow's date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+
Examples
+// Date tomorrow
+<% tp.date.tomorrow() %>
+// Date tomorrow with format
+<% tp.date.tomorrow("Do MMMM YYYY") %>
+tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)
+Arguments
+-
+
-
+
+format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+ -
+
+weekday: Week day number. If the locale assigns Monday as the first day of the week,0will be Monday,-7will be last week's day.
+ -
+
+reference: The date referential, e.g. set this to the note's title.
+ -
+
+reference_format: The format for the reference date. Refer to format reference.
+
Examples
+// This week's Monday
+<% tp.date.weekday("YYYY-MM-DD", 0) %>
+// Next Monday
+<% tp.date.weekday("YYYY-MM-DD", 7) %>
+// File's title Monday
+<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-DD") %>
+// File's title previous Monday
+<% tp.date.weekday("YYYY-MM-DD", -7, tp.file.title, "YYYY-MM-DD") %>
+tp.date.yesterday(format: string = "YYYY-MM-DD")
+Retrieves yesterday's date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+
Examples
+// Date yesterday
+<% tp.date.yesterday() %>
+// Date yesterday with format
+<% tp.date.yesterday("Do MMMM YYYY") %>
+Moment.js
+Templater gives you access to the moment object, with all of its functionalities.
More information on moment.js here.
+Examples
+// Date now
+<% moment(tp.file.title, "YYYY-MM-DD").format("YYYY-MM-DD") %>
+// Get start of month from note title
+<% moment(tp.file.title, "YYYY-MM-DD").startOf("month").format("YYYY-MM-DD") %>
+// Get end of month from note title
+<% moment(tp.file.title, "YYYY-MM-DD").endOf("month").format("YYYY-MM-DD") %>
+Examples
+// Date now
+<% tp.date.now() %>
+// Date now with format
+<% tp.date.now("Do MMMM YYYY") %>
+// Last week
+<% tp.date.now("YYYY-MM-DD", -7) %>
+// Next week
+<% tp.date.now("YYYY-MM-DD", 7) %>
+// Last month
+<% tp.date.now("YYYY-MM-DD", "P-1M") %>
+// Next year
+<% tp.date.now("YYYY-MM-DD", "P1Y") %>
+// File's title date + 1 day (tomorrow)
+<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>
+// File's title date - 1 day (yesterday)
+<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>
+
+// Date tomorrow
+<% tp.date.tomorrow() %>
+// Date tomorrow with format
+<% tp.date.tomorrow("Do MMMM YYYY") %>
+
+// This week's Monday
+<% tp.date.weekday("YYYY-MM-DD", 0) %>
+// Next Monday
+<% tp.date.weekday("YYYY-MM-DD", 7) %>
+// File's title Monday
+<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-DD") %>
+// File's title previous Monday
+<% tp.date.weekday("YYYY-MM-DD", -7, tp.file.title, "YYYY-MM-DD") %>
+
+// Date yesterday
+<% tp.date.yesterday() %>
+// Date yesterday with format
+<% tp.date.yesterday("Do MMMM YYYY") %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/frontmatter-module.html b/internal-functions/internal-modules/frontmatter-module.html
new file mode 100644
index 00000000..8f0074d0
--- /dev/null
+++ b/internal-functions/internal-modules/frontmatter-module.html
@@ -0,0 +1,214 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File Module
+This module contains every internal function related to files.
+-
+
- Documentation
+
-
+
tp.file.content
+tp.file.create_new(template: TFile ⎮ string, filename?: string, open_new: boolean = false, folder?: TFolder | string)
+tp.file.creation_date(format: string = "YYYY-MM-DD HH:mm")
+tp.file.cursor(order?: number)
+tp.file.cursor_append(content: string)
+tp.file.exists(filepath: string)
+tp.file.find_tfile(filename: string)
+tp.file.folder(absolute: boolean = false)
+tp.file.include(include_link: string ⎮ TFile)
+tp.file.last_modified_date(format: string = "YYYY-MM-DD HH:mm")
+tp.file.move(new_path: string, file_to_move?: TFile)
+tp.file.path(relative: boolean = false)
+tp.file.rename(new_title: string)
+tp.file.selection()
+tp.file.tags
+tp.file.title
+
+ - Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.file.content
+The string contents of the file at the time that Templater was executed. Manipulating this string will not update the current file.
+Examples
+// Retrieve file content
+<% tp.file.content %>
+tp.file.create_new(template: TFile ⎮ string, filename?: string, open_new: boolean = false, folder?: TFolder | string)
+Creates a new file using a specified template or with a specified content.
+Arguments
+-
+
-
+
+template: Either the template used for the new file content, or the file content as a string. If it is the template to use, you retrieve it withtp.file.find_tfile(TEMPLATENAME).
+ -
+
+filename: The filename of the new file, defaults to "Untitled".
+ -
+
+open_new: Whether to open or not the newly created file. Warning: if you use this option, since commands are executed asynchronously, the file can be opened first and then other commands are appended to that new file and not the previous file.
+ -
+
+folder: The folder to put the new file in, defaults to Obsidian's default location. If you want the file to appear in a different folder, specify it with"PATH/TO/FOLDERNAME"orapp.vault.getAbstractFileByPath("PATH/TO/FOLDERNAME").
+
Examples
+// File creation
+<%* await tp.file.create_new("MyFileContent", "MyFilename") %>
+// File creation with template
+<%* await tp.file.create_new(tp.file.find_tfile("MyTemplate"), "MyFilename") %>
+// File creation and open created note
+<%* await tp.file.create_new("MyFileContent", "MyFilename", true) %>
+// File creation in current folder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, tp.file.folder(true)) %>
+// File creation in specified folder with string path
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, "Path/To/MyFolder") %>
+// File creation in specified folder with TFolder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, app.vault.getAbstractFileByPath("MyFolder")) %>
+// File creation and append link to current note
+[[<% (await tp.file.create_new("MyFileContent", "MyFilename")).basename %>]]
+tp.file.creation_date(format: string = "YYYY-MM-DD HH:mm")
+Retrieves the file's creation date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD HH:mm". Refer to format reference.
+
Examples
+// File creation date
+<% tp.file.creation_date() %>
+// File creation date with format
+<% tp.file.creation_date("dddd Do MMMM YYYY HH:mm") %>
+tp.file.cursor(order?: number)
+Sets the cursor to this location after the template has been inserted.
+You can navigate between the different cursors using the configured hotkey in Obsidian settings.
+Arguments
+-
+
order: The order of the different cursors jump, e.g. it will jump from 1 to 2 to 3, and so on. +If you specify multiple tp.file.cursor with the same order, the editor will switch to multi-cursor.
+
Examples
+// File cursor
+<% tp.file.cursor() %>
+// File multi-cursor
+<% tp.file.cursor(1) %>Content<% tp.file.cursor(1) %>
+tp.file.cursor_append(content: string)
+Appends some content after the active cursor in the file.
+Arguments
+-
+
content: The content to append after the active cursor.
+
Examples
+// File cursor append
+<% tp.file.cursor_append("Some text") %>
+tp.file.exists(filepath: string)
+Check to see if a file exists by it's file path. The full path to the file, relative to the Vault and containing the extension, must be provided.
+Arguments
+-
+
filepath: The full file path of the file we want to check existence for.
+
Examples
+// File existence
+<% await tp.file.exists("MyFolder/MyFile.md") %>
+// File existence of current file
+<% await tp.file.exists(tp.file.folder(true) + "/" + tp.file.title + ".md") %>
+tp.file.find_tfile(filename: string)
+Search for a file and returns its TFile instance.
Arguments
+-
+
filename: The filename we want to search and resolve as aTFile.
+
Examples
+// File find TFile
+<% tp.file.find_tfile("MyFile").basename %>
+tp.file.folder(absolute: boolean = false)
+Retrieves the file's folder name.
+Arguments
+-
+
absolute: If set totrue, returns the vault-absolute path of the folder. Iffalse, only returns the basename of the folder (the last part). Defaults tofalse.
+
Examples
+// File folder (Folder)
+<% tp.file.folder() %>
+// File folder with vault-absolute path (Path/To/Folder)
+<% tp.file.folder(true) %>
+tp.file.include(include_link: string ⎮ TFile)
+Includes the file's link content. Templates in the included content will be resolved.
+Arguments
+-
+
include_link: The link to the file to include, e.g."[[MyFile]]", or a TFile object. Also supports sections or blocks inclusions.
+
Examples
+// File include
+<% tp.file.include("[[Template1]]") %>
+// File include TFile
+<% tp.file.include(tp.file.find_tfile("MyFile")) %>
+// File include section
+<% tp.file.include("[[MyFile#Section1]]") %>
+// File include block
+<% tp.file.include("[[MyFile#^block1]]") %>
+tp.file.last_modified_date(format: string = "YYYY-MM-DD HH:mm")
+Retrieves the file's last modification date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD HH:mm". Refer to format reference.
+
Examples
+// File last modified date
+<% tp.file.last_modified_date() %>
+// File last modified date with format
+<% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm") %>
+tp.file.move(new_path: string, file_to_move?: TFile)
+Moves the file to the desired vault location.
+Arguments
+-
+
-
+
+new_path: The new vault relative path of the file, without the file extension. Note: the new path needs to include the folder and the filename, e.g."/Notes/MyNote".
+ -
+
+file_to_move: The file to move, defaults to the current file.
+
Examples
+// File move
+<% await tp.file.move("/A/B/" + tp.file.title) %>
+// File move and rename
+<% await tp.file.move("/A/B/NewTitle") %>
+tp.file.path(relative: boolean = false)
+Retrieves the file's absolute path on the system.
+Arguments
+-
+
relative: If set totrue, only retrieves the vault's relative path.
+
Examples
+// File path
+<% tp.file.path() %>
+// File relative path (relative to vault root)
+<% tp.file.path(true) %>
+tp.file.rename(new_title: string)
+Renames the file (keeps the same file extension).
+Arguments
+-
+
new_title: The new file title.
+
Examples
+// File rename
+<% await tp.file.rename("MyNewName") %>
+// File append a 2 to the file name
+<% await tp.file.rename(tp.file.title + "2") %>
+tp.file.selection()
+Retrieves the active file's text selection.
+Examples
+// File selection
+<% tp.file.selection() %>
+tp.file.tags
+Retrieves the file's tags (array of string).
+Examples
+// File tags
+<% tp.file.tags %>
+tp.file.title
+Retrieves the file's title.
+Examples
+// File title
+<% tp.file.title %>
+// Strip the Zettelkasten ID of title (if space separated)
+<% tp.file.title.split(" ")[1] %>
+Examples
+// Retrieve file content
+<% tp.file.content %>
+
+// File creation
+<%* await tp.file.create_new("MyFileContent", "MyFilename") %>
+// File creation with template
+<%* await tp.file.create_new(tp.file.find_tfile("MyTemplate"), "MyFilename") %>
+// File creation and open created note
+<%* await tp.file.create_new("MyFileContent", "MyFilename", true) %>
+// File creation in current folder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, tp.file.folder(true)) %>
+// File creation in specified folder with string path
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, "Path/To/MyFolder") %>
+// File creation in specified folder with TFolder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, app.vault.getAbstractFileByPath("MyFolder")) %>
+// File creation and append link to current note
+[[<% (await tp.file.create_new("MyFileContent", "MyFilename")).basename %>]]
+
+// File creation date
+<% tp.file.creation_date() %>
+// File creation date with format
+<% tp.file.creation_date("dddd Do MMMM YYYY HH:mm") %>
+
+// File cursor
+<% tp.file.cursor() %>
+// File multi-cursor
+<% tp.file.cursor(1) %>Content<% tp.file.cursor(1) %>
+
+// File cursor append
+<% tp.file.cursor_append("Some text") %>
+
+// File existence
+<% await tp.file.exists("MyFolder/MyFile.md") %>
+// File existence of current file
+<% await tp.file.exists(tp.file.folder(true) + "/" + tp.file.title + ".md") %>
+
+// File find TFile
+<% tp.file.find_tfile("MyFile").basename %>
+
+// File folder (Folder)
+<% tp.file.folder() %>
+// File folder with vault-absolute path (Path/To/Folder)
+<% tp.file.folder(true) %>
+
+// File include
+<% tp.file.include("[[Template1]]") %>
+// File include TFile
+<% tp.file.include(tp.file.find_tfile("MyFile")) %>
+// File include section
+<% tp.file.include("[[MyFile#Section1]]") %>
+// File include block
+<% tp.file.include("[[MyFile#^block1]]") %>
+
+// File last modified date
+<% tp.file.last_modified_date() %>
+// File last modified date with format
+<% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm") %>
+
+// File move
+<% await tp.file.move("/A/B/" + tp.file.title) %>
+// File move and rename
+<% await tp.file.move("/A/B/NewTitle") %>
+
+// File path
+<% tp.file.path() %>
+// File relative path (relative to vault root)
+<% tp.file.path(true) %>
+
+// File rename
+<% await tp.file.rename("MyNewName") %>
+// File append a 2 to the file name
+<% await tp.file.rename(tp.file.title + "2") %>
+
+// File selection
+<% tp.file.selection() %>
+
+// File tags
+<% tp.file.tags %>
+
+// File title
+<% tp.file.title %>
+// Strip the Zettelkasten ID of title (if space separated)
+<% tp.file.title.split(" ")[1] %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/hooks-module.html b/internal-functions/internal-modules/hooks-module.html
new file mode 100644
index 00000000..fda3657e
--- /dev/null
+++ b/internal-functions/internal-modules/hooks-module.html
@@ -0,0 +1,212 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Frontmatter Module
+This modules exposes all the frontmatter variables of a file as variables.
+ +Documentation
+tp.frontmatter.<frontmatter_variable_name>
+Retrieves the file's frontmatter variable value.
+If your frontmatter variable name contains spaces, you can reference it using the bracket notation like so:
+<% tp.frontmatter["variable name with spaces"] %>
+Examples
+Let's say you have the following file:
+---
+alias: myfile
+note type: seedling
+---
+
+file content
+Then you can use the following template:
+File's metadata alias: <% tp.frontmatter.alias %>
+Note's type: <% tp.frontmatter["note type"] %>
+For lists in frontmatter, you can use JavaScript array prototype methods to manipulate how the data is displayed.
+---
+categories:
+ - book
+ - movie
+---
+<% tp.frontmatter.categories.map(prop => ` - "${prop}"`).join("\n") %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/obsidian-module.html b/internal-functions/internal-modules/obsidian-module.html
new file mode 100644
index 00000000..2c7d405d
--- /dev/null
+++ b/internal-functions/internal-modules/obsidian-module.html
@@ -0,0 +1,200 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hooks Module
+This module exposes hooks that allow you to execute code when a Templater event occurs.
+ +Documentation
+Function documentation is using a specific syntax. More information here.
+tp.hooks.on_all_templates_executed(callback_function: () => any)
+Hooks into when all actively running templates have finished executing. Most of the time this will be a single template, unless you are using tp.file.include or tp.file.create_new.
Multiple invokations of this method will have their callback functions run in parallel.
+Arguments
+-
+
callback_function: Callback function that will be executed when all actively running templates have finished executing.
+
Examples
+// Update frontmatter after template finishes executing
+<%*
+tp.hooks.on_all_templates_executed(async () => {
+ const file = tp.file.find_tfile(tp.file.path(true));
+ await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
+ frontmatter["key"] = "value";
+ });
+});
+%>
+// Run a command from another plugin that modifies the current file, after Templater has updated the file
+<%*
+tp.hooks.on_all_templates_executed(() => {
+ tp.app.commands.executeCommandById("obsidian-linter:lint-file");
+});
+-%>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/system-module.html b/internal-functions/internal-modules/system-module.html
new file mode 100644
index 00000000..a6483058
--- /dev/null
+++ b/internal-functions/internal-modules/system-module.html
@@ -0,0 +1,272 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Obsidian Module
+This module exposes all the functions and classes from the Obsidian API.
+This is mostly useful when writing scripts.
+Refer to the Obsidian API declaration file for more information.
+Examples
+// Get all folders
+<%
+tp.app.vault.getAllLoadedFiles()
+ .filter(x => x instanceof tp.obsidian.TFolder)
+ .map(x => x.name)
+%>
+
+// Normalize path
+<% tp.obsidian.normalizePath("Path/to/file.md") %>
+
+// Html to markdown
+<% tp.obsidian.htmlToMarkdown("\<h1>Heading\</h1>\<p>Paragraph\</p>") %>
+
+// HTTP request
+<%*
+const response = await tp.obsidian.requestUrl("https://jsonplaceholder.typicode.com/todos/1");
+tR += response.json.title;
+%>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/internal-modules/web-module.html b/internal-functions/internal-modules/web-module.html
new file mode 100644
index 00000000..3cd5de88
--- /dev/null
+++ b/internal-functions/internal-modules/web-module.html
@@ -0,0 +1,252 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ System Module
+This module contains system related functions.
+-
+
- Documentation
+
-
+
tp.system.clipboard()
+tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)
+tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = "", limit?: number = undefined)
+
+ - Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.system.clipboard()
+Retrieves the clipboard's content.
+Examples
+// Clipboard
+<% tp.system.clipboard() %>
+tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)
+Spawns a prompt modal and returns the user's input.
+Arguments
+-
+
-
+
+prompt_text: Text placed above the input field.
+ -
+
+default_value: A default value for the input field.
+ -
+
+throw_on_cancel: Throws an error if the prompt is canceled, instead of returning anullvalue.
+ -
+
+multiline: If set totrue, the input field will be a multiline textarea. Defaults tofalse.
+
Examples
+// Prompt
+<% tp.system.prompt("Please enter a value") %>
+// Prompt with default value
+<% tp.system.prompt("What is your mood today?", "happy") %>
+// Multiline prompt
+<% tp.system.prompt("What is your mood today?", null, false, true) %>
+tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = "", limit?: number = undefined)
+Spawns a suggester prompt and returns the user's chosen item.
+Arguments
+-
+
-
+
+text_items: Array of strings representing the text that will be displayed for each item in the suggester prompt. This can also be a function that maps an item to its text representation.
+ -
+
+items: Array containing the values of each item in the correct order.
+ -
+
+throw_on_cancel: Throws an error if the prompt is canceled, instead of returning anullvalue.
+ -
+
+placeholder: Placeholder string of the prompt.
+ -
+
+limit: Limit the number of items rendered at once (useful to improve performance when displaying large lists).
+
Examples
+// Suggester
+<% tp.system.suggester(["Happy", "Sad", "Confused"], ["Happy", "Sad", "Confused"]) %>
+// Suggester with mapping function (same as above example)
+<% tp.system.suggester((item) => item, ["Happy", "Sad", "Confused"]) %>
+// Suggester for files
+[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]
+// Suggester for tags
+<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace("#", ""))) %>
+Examples
+// Clipboard
+<% tp.system.clipboard() %>
+
+// Prompt
+<% tp.system.prompt("Please enter a value") %>
+// Prompt with default value
+<% tp.system.prompt("What is your mood today?", "happy") %>
+// Multiline prompt
+<% tp.system.prompt("What is your mood today?", null, false, true) %>
+
+// Suggester
+<% tp.system.suggester(["Happy", "Sad", "Confused"], ["Happy", "Sad", "Confused"]) %>
+// Suggester with mapping function (same as above example)
+<% tp.system.suggester((item) => item, ["Happy", "Sad", "Confused"]) %>
+// Suggester for files
+[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]
+// Suggester for tags
+<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace("#", ""))) %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/internal-functions/overview.html b/internal-functions/overview.html
new file mode 100644
index 00000000..76565f15
--- /dev/null
+++ b/internal-functions/overview.html
@@ -0,0 +1,192 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Web Module
+This modules contains every internal function related to the web (making web requests).
+-
+
- Documentation + + +
- Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.web.daily_quote()
+Retrieves and parses the daily quote from https://github.com/Zachatoo/quotes-database as a callout.
Examples
+// Daily quote
+<% tp.web.daily_quote() %>
+tp.web.random_picture(size?: string, query?: string, include_size?: boolean)
+Gets a random image from https://unsplash.com/.
Arguments
+-
+
-
+
+size: Image size in the format<width>x<height>.
+ -
+
+query: Limits selection to photos matching a search term. Multiple search terms can be passed separated by a comma.
+ -
+
+include_size: Optional argument to include the specified size in the image link markdown. Defaults to false.
+
Examples
+// Random picture
+<% tp.web.random_picture() %>
+// Random picture with size
+<% tp.web.random_picture("200x200") %>
+// Random picture with size and query
+<% tp.web.random_picture("200x200", "landscape,water") %>
+tp.web.request(url: string, path?: string)
+Makes a HTTP request to the specified URL. Optionally, you can specify a path to extract specific data from the response.
+Arguments
+-
+
-
+
+url: The URL to which the HTTP request will be made.
+ -
+
+path: A path within the response JSON to extract specific data.
+
Examples
+// Simple request
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos/1") %>
+// Request with path
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos", "0.title") %>
+Examples
+// Daily quote
+<% tp.web.daily_quote() %>
+
+// Random picture
+<% tp.web.random_picture() %>
+// Random picture with size
+<% tp.web.random_picture("200x200") %>
+// Random picture with size and query
+<% tp.web.random_picture("200x200", "landscape,water") %>
+
+// Simple request
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos/1") %>
+// Request with path
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos", "0.title") %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/introduction.html b/introduction.html
new file mode 100644
index 00000000..2b4f4564
--- /dev/null
+++ b/introduction.html
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal Functions
+The different internal variables and functions offered by Templater are available under different modules, to sort them. The existing internal modules are:
+-
+
- App module:
tp.app
+ - Config module:
tp.config
+ - Date module:
tp.date
+ - File module:
tp.file
+ - Frontmatter module:
tp.frontmatter
+ - Hooks module:
tp.hooks
+ - Obsidian module:
tp.obsidian
+ - System module:
tp.system
+ - Web module:
tp.web
+
If you understood the object hierarchy correctly, this means that a typical internal function call looks like this: <% tp.<module_name>.<internal_function_name> %>
Contribution
+I invite everyone to contribute to this plugin development by adding new internal functions. More information here.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 00000000..16362318
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+Templater is a template language that lets you insert variables and functions results into your notes. It will also let you execute JavaScript code manipulating those variables and functions.
+With Templater, you will be able to create powerful templates to automate manual tasks.
+Quick Example
+The following template file, that is using Templater syntax:
+---
+creation date: <% tp.file.creation_date() %>
+modification date: <% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm:ss") %>
+---
+
+<< [[<% tp.date.now("YYYY-MM-DD", -1) %>]] | [[<% tp.date.now("YYYY-MM-DD", 1) %>]] >>
+
+# <% tp.file.title %>
+
+<% tp.web.daily_quote() %>
+Will produce the following result when inserted:
+---
+creation date: 2021-01-07 17:20
+modification date: Thursday 7th January 2021 17:20:43
+---
+
+<< [[2021-04-08]] | [[2021-04-10]] >>
+
+# Test Test
+
+> Do the best you can until you know better. Then when you know better, do better.
+> — <cite>Maya Angelou</cite>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 00000000..d2b0aeed
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+Templater is a template language that lets you insert variables and functions results into your notes. It will also let you execute JavaScript code manipulating those variables and functions.
+With Templater, you will be able to create powerful templates to automate manual tasks.
+Quick Example
+The following template file, that is using Templater syntax:
+---
+creation date: <% tp.file.creation_date() %>
+modification date: <% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm:ss") %>
+---
+
+<< [[<% tp.date.now("YYYY-MM-DD", -1) %>]] | [[<% tp.date.now("YYYY-MM-DD", 1) %>]] >>
+
+# <% tp.file.title %>
+
+<% tp.web.daily_quote() %>
+Will produce the following result when inserted:
+---
+creation date: 2021-01-07 17:20
+modification date: Thursday 7th January 2021 17:20:43
+---
+
+<< [[2021-04-08]] | [[2021-04-10]] >>
+
+# Test Test
+
+> Do the best you can until you know better. Then when you know better, do better.
+> — <cite>Maya Angelou</cite>
+Installation
+You can install this plugin via the Community Plugins tab within Obsidian. Search for "Templater".
+It's a good practice to restart the Obsidian app after the installation of Templater, to make sure everything is working properly.
+Terminology
+To understand how Templater works, let's define a few terms:
+-
+
- A template is a file that contains commands. +
- A text snippet that starts with an opening tag
<%, ends with a closing tag%>is what we will call a command.
+ - A function is an object that we can invoke inside a command and that returns a value (the replacement string) +
There are two types of functions you can use:
+-
+
- Internal functions. They are predefined functions that are built within the plugin. As an example,
tp.date.nowis an internal function that will return the current date.
+ - User functions. Users can define their own functions. They are either system command or user scripts. +
Example
+The following template contains 2 commands, calling 2 different internal functions:
+Yesterday: <% tp.date.yesterday("YYYY-MM-DD") %>
+Tomorrow: <% tp.date.tomorrow("YYYY-MM-DD") %>
+We'll see in the next part the syntax required to write some commands.
+Syntax
+Templater uses a custom templating engine (rusty_engine) syntax to declare a command. You may need a bit of time to get used to it, but once you get the idea, the syntax is not that hard.
+All of Templater's functions are JavaScript objects that are invoked using a command.
+Command syntax
+A command must have both an opening tag <% and a closing tag %>.
A complete command using the tp.date.now internal function would be: <% tp.date.now() %>
Function syntax
+Objects hierarchy
+All of Templater's functions, whether it's an internal function or a user function, are available under the tp object. You could say that all our functions are children of the tp object. To access the "child" of an object, we have to use the dot notation .
This means that a Templater function invocation will always start with tp.<something>
Function invocation
+To invoke a function, we need to use a syntax specific to functions calls: appending an opening and a closing parenthesis after the function name.
+As an example, we would use tp.date.now() to invoke the tp.date.now internal function.
A function can have arguments and optional arguments. They are placed between the opening and the closing parenthesis, like so:
+tp.date.now(arg1_value, arg2_value, arg3_value, ...)
+All arguments must be passed in the correct order.
+The arguments of a function can have different types. Here is a non-exhaustive list of the possible types of a function:
+-
+
- A
stringtype means the value must be placed within simple or double quotes ("value"or'value')
+ - A
numbertype means the value must be an integer (15,-5, ...)
+ - A
booleantype means the value must be eithertrueorfalse(completely lower case), and nothing else.
+
The type of an argument must be respected when calling a function, or it won't work.
+Function documentation syntax
+The documentation for the internal functions of Templater are using the following syntax:
+tp.<my_function>(arg1_name: type, arg2_name?: type, arg3_name: type = <default_value>, arg4_name: type1|type2, ...)
+Where:
+-
+
arg_namerepresents a symbolic name for the argument, to understand what it is.
+typerepresents the expected type for the argument. This type must be respected when calling the internal function, or it will throw an error.
+
If an argument is optional, it will be appended with a question mark ?, e.g. arg2_name?: type
If an argument has a default value, it will be specified using an equal sign =, e.g. arg3_name: type = <default_value>.
If an argument can have different types, it will be specified using a pipe |, e.g. arg4_name: type1|type2
Syntax warning
+Please note that this syntax is for documentation purposes only, to be able to understand what arguments the function expects.
+You mustn't specify the name nor the type nor the default value of an argument when calling a function. Only the value of the arguments are required, as explained here
+Example
+Let's take the tp.date.now internal function documentation as an example:
tp.date.now(format: string = "YYYY-MM-DD", offset?: number|string, reference?: string, reference_format?: string)
+This internal function has 4 optional arguments:
+-
+
- a format of type
string, with a default value of"YYYY-MM-DD".
+ - an offset of type
numberor of typestring.
+ - a reference of type
string.
+ - a reference_format of type
string.
+
That means that valid invocations for this internal function are:
+-
+
<% tp.date.now() %>
+<% tp.date.now("YYYY-MM-DD", 7) %>
+<% tp.date.now("YYYY-MM-DD", 7, "2021-04-09", "YYYY-MM-DD") %>
+<% tp.date.now("dddd, MMMM Do YYYY", 0, tp.file.title, "YYYY-MM-DD") %>*Assuming the file name is of the format: "YYYY-MM-DD"
+
On the other hand, invalid invocations are:
+-
+
tp.date.now(format: string = "YYYY-MM-DD")
+tp.date.now(format: string = "YYYY-MM-DD", offset?: 0)
+
Settings
+General Settings
+-
+
Template folder location: Files in this folder will be available as templates.
+Syntax Highlighting on Desktopadds syntax highlighting for Templater commands in edit mode.
+Syntax Highlighting on Mobileadds syntax highlighting for Templater commands in edit mode on mobile. Use with caution: this may break live preview on mobile platforms."
+Automatic jump to cursorautomatically triggerstp.file.cursorafter inserting a template. You can also set a hotkey to manually triggertp.file.cursor.
+Trigger Templater on new file creation: Templater will listen for the new file creation event, and, if it matches a rule you've set, replace every command it finds in the new file's content. This makes Templater compatible with other plugins like the Daily note core plugin, Calendar plugin, Review plugin, Note refactor plugin, etc. +-
+
- Make sure to set up rules under either Folder Templates or File Regex Template below. +
- Warning: This can be dangerous if you create new files with unknown / unsafe content on creation. Make sure that every new file's content is safe on creation." +
+
Template Hotkeys
+Template Hotkeys allows you to bind a template to a hotkey.
+Folder Templates
+Note: This setting is hidden by default. To view it first enable the Trigger Template on new file creation setting. And since it's mutually exclusive with File Regex Templates, enabling one will disable the other.
You can specify a template that will automatically be used on a selected folder and children using the Folder Templates functionality. The deepest match will be used, so the order of the rules is irrelevant.
Add a rule for "/" if you need a catch-all.
File Regex Templates
+Note: This setting is hidden by default. To view it first enable the Trigger Template on new file creation setting. And since it's mutually exclusive with Folder Templates, enabling one will disable the other.
You can specify regex declarations that a new file's path will be tested against. If a regex matches, the associated template will automatically be used. Rules are tested top-to-bottom, and the first match will be used.
+End with a rule for ".*" if you need a catch-all.
Use a tool like Regex101 to verify your regexes.
+Startup Templates
+Startup Templates are templates that will get executed once when Templater starts.
+These templates won't output anything.
+This can be useful to set up templates adding hooks to obsidian events for example.
+User Script Functions
+All JavaScript files in this folder will be loaded as CommonJS modules, to import custom user functions.
+The folder needs to be accessible from the vault.
+Check the documentation for more information.
+User System Command Functions
+Allows you to create user functions linked to system commands.
+Check the documentation for more information.
+Warning: It can be dangerous to execute arbitrary system commands from untrusted sources. Only run system commands that you understand, from trusted sources.
+Frequently Asked Questions
+Unicode characters (emojis, ...) are not working on Windows ?
+cmd.exe and powershell on Windows are known to have problems with unicode characters.
You can check https://github.com/SilentVoid13/Templater/issues/15#issuecomment-824067020 for a solution.
+Another good solution (probably the best) is to use Windows Terminal and set it as the default shell in Templater's setting.
+Another resource containing solutions that could work for you: https://stackoverflow.com/questions/49476326/displaying-unicode-in-powershell
+Internal Functions
+The different internal variables and functions offered by Templater are available under different modules, to sort them. The existing internal modules are:
+-
+
- App module:
tp.app
+ - Config module:
tp.config
+ - Date module:
tp.date
+ - File module:
tp.file
+ - Frontmatter module:
tp.frontmatter
+ - Hooks module:
tp.hooks
+ - Obsidian module:
tp.obsidian
+ - System module:
tp.system
+ - Web module:
tp.web
+
If you understood the object hierarchy correctly, this means that a typical internal function call looks like this: <% tp.<module_name>.<internal_function_name> %>
Contribution
+I invite everyone to contribute to this plugin development by adding new internal functions. More information here.
+App Module
+This module exposes the app instance. Prefer to use this over the global app instance.
+This is mostly useful when writing scripts.
+Refer to the Obsidian developer documentation for more information.
+Examples
+// Get all folders
+<%
+tp.app.vault.getAllLoadedFiles()
+ .filter(x => x instanceof tp.obsidian.TFolder)
+ .map(x => x.name)
+%>
+
+// Update frontmatter of existing file
+<%*
+const file = tp.file.find_tfile("path/to/file");
+await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
+ frontmatter["key"] = "value";
+});
+%>
+Config Module
+This module exposes Templater's running configuration.
+This is mostly useful when writing scripts requiring some context information.
+-
+
- Documentation + + +
Documentation
+tp.config.active_file?
+The active file (if existing) when launching Templater.
+tp.config.run_mode
+The RunMode, representing the way Templater was launched (Create new from template, Append to active file, ...).
tp.config.target_file
+The TFile object representing the target file where the template will be inserted.
tp.config.template_file
+The TFile object representing the template file.
Date Module
+This module contains every internal function related to dates.
+-
+
- Documentation
+
-
+
tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)
+tp.date.tomorrow(format: string = "YYYY-MM-DD")
+tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)
+tp.date.yesterday(format: string = "YYYY-MM-DD")
+
+ - Moment.js +
- Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.date.now(format: string = "YYYY-MM-DD", offset?: number⎮string, reference?: string, reference_format?: string)
+Retrieves the date.
+Arguments
+-
+
-
+
+format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+ -
+
+offset: Duration to offset the date from. If a number is provided, duration will be added to the date in days. You can also specify the offset as a string using the ISO 8601 format.
+ -
+
+reference: The date referential, e.g. set this to the note's title.
+ -
+
+reference_format: The format for the reference date. Refer to format reference.
+
Examples
+// Date now
+<% tp.date.now() %>
+// Date now with format
+<% tp.date.now("Do MMMM YYYY") %>
+// Last week
+<% tp.date.now("YYYY-MM-DD", -7) %>
+// Next week
+<% tp.date.now("YYYY-MM-DD", 7) %>
+// Last month
+<% tp.date.now("YYYY-MM-DD", "P-1M") %>
+// Next year
+<% tp.date.now("YYYY-MM-DD", "P1Y") %>
+// File's title date + 1 day (tomorrow)
+<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>
+// File's title date - 1 day (yesterday)
+<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>
+tp.date.tomorrow(format: string = "YYYY-MM-DD")
+Retrieves tomorrow's date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+
Examples
+// Date tomorrow
+<% tp.date.tomorrow() %>
+// Date tomorrow with format
+<% tp.date.tomorrow("Do MMMM YYYY") %>
+tp.date.weekday(format: string = "YYYY-MM-DD", weekday: number, reference?: string, reference_format?: string)
+Arguments
+-
+
-
+
+format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+ -
+
+weekday: Week day number. If the locale assigns Monday as the first day of the week,0will be Monday,-7will be last week's day.
+ -
+
+reference: The date referential, e.g. set this to the note's title.
+ -
+
+reference_format: The format for the reference date. Refer to format reference.
+
Examples
+// This week's Monday
+<% tp.date.weekday("YYYY-MM-DD", 0) %>
+// Next Monday
+<% tp.date.weekday("YYYY-MM-DD", 7) %>
+// File's title Monday
+<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-DD") %>
+// File's title previous Monday
+<% tp.date.weekday("YYYY-MM-DD", -7, tp.file.title, "YYYY-MM-DD") %>
+tp.date.yesterday(format: string = "YYYY-MM-DD")
+Retrieves yesterday's date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD". Refer to format reference.
+
Examples
+// Date yesterday
+<% tp.date.yesterday() %>
+// Date yesterday with format
+<% tp.date.yesterday("Do MMMM YYYY") %>
+Moment.js
+Templater gives you access to the moment object, with all of its functionalities.
More information on moment.js here.
+Examples
+// Date now
+<% moment(tp.file.title, "YYYY-MM-DD").format("YYYY-MM-DD") %>
+// Get start of month from note title
+<% moment(tp.file.title, "YYYY-MM-DD").startOf("month").format("YYYY-MM-DD") %>
+// Get end of month from note title
+<% moment(tp.file.title, "YYYY-MM-DD").endOf("month").format("YYYY-MM-DD") %>
+Examples
+// Date now
+<% tp.date.now() %>
+// Date now with format
+<% tp.date.now("Do MMMM YYYY") %>
+// Last week
+<% tp.date.now("YYYY-MM-DD", -7) %>
+// Next week
+<% tp.date.now("YYYY-MM-DD", 7) %>
+// Last month
+<% tp.date.now("YYYY-MM-DD", "P-1M") %>
+// Next year
+<% tp.date.now("YYYY-MM-DD", "P1Y") %>
+// File's title date + 1 day (tomorrow)
+<% tp.date.now("YYYY-MM-DD", 1, tp.file.title, "YYYY-MM-DD") %>
+// File's title date - 1 day (yesterday)
+<% tp.date.now("YYYY-MM-DD", -1, tp.file.title, "YYYY-MM-DD") %>
+
+// Date tomorrow
+<% tp.date.tomorrow() %>
+// Date tomorrow with format
+<% tp.date.tomorrow("Do MMMM YYYY") %>
+
+// This week's Monday
+<% tp.date.weekday("YYYY-MM-DD", 0) %>
+// Next Monday
+<% tp.date.weekday("YYYY-MM-DD", 7) %>
+// File's title Monday
+<% tp.date.weekday("YYYY-MM-DD", 0, tp.file.title, "YYYY-MM-DD") %>
+// File's title previous Monday
+<% tp.date.weekday("YYYY-MM-DD", -7, tp.file.title, "YYYY-MM-DD") %>
+
+// Date yesterday
+<% tp.date.yesterday() %>
+// Date yesterday with format
+<% tp.date.yesterday("Do MMMM YYYY") %>
+
+File Module
+This module contains every internal function related to files.
+-
+
- Documentation
+
-
+
tp.file.content
+tp.file.create_new(template: TFile ⎮ string, filename?: string, open_new: boolean = false, folder?: TFolder | string)
+tp.file.creation_date(format: string = "YYYY-MM-DD HH:mm")
+tp.file.cursor(order?: number)
+tp.file.cursor_append(content: string)
+tp.file.exists(filepath: string)
+tp.file.find_tfile(filename: string)
+tp.file.folder(absolute: boolean = false)
+tp.file.include(include_link: string ⎮ TFile)
+tp.file.last_modified_date(format: string = "YYYY-MM-DD HH:mm")
+tp.file.move(new_path: string, file_to_move?: TFile)
+tp.file.path(relative: boolean = false)
+tp.file.rename(new_title: string)
+tp.file.selection()
+tp.file.tags
+tp.file.title
+
+ - Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.file.content
+The string contents of the file at the time that Templater was executed. Manipulating this string will not update the current file.
+Examples
+// Retrieve file content
+<% tp.file.content %>
+tp.file.create_new(template: TFile ⎮ string, filename?: string, open_new: boolean = false, folder?: TFolder | string)
+Creates a new file using a specified template or with a specified content.
+Arguments
+-
+
-
+
+template: Either the template used for the new file content, or the file content as a string. If it is the template to use, you retrieve it withtp.file.find_tfile(TEMPLATENAME).
+ -
+
+filename: The filename of the new file, defaults to "Untitled".
+ -
+
+open_new: Whether to open or not the newly created file. Warning: if you use this option, since commands are executed asynchronously, the file can be opened first and then other commands are appended to that new file and not the previous file.
+ -
+
+folder: The folder to put the new file in, defaults to Obsidian's default location. If you want the file to appear in a different folder, specify it with"PATH/TO/FOLDERNAME"orapp.vault.getAbstractFileByPath("PATH/TO/FOLDERNAME").
+
Examples
+// File creation
+<%* await tp.file.create_new("MyFileContent", "MyFilename") %>
+// File creation with template
+<%* await tp.file.create_new(tp.file.find_tfile("MyTemplate"), "MyFilename") %>
+// File creation and open created note
+<%* await tp.file.create_new("MyFileContent", "MyFilename", true) %>
+// File creation in current folder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, tp.file.folder(true)) %>
+// File creation in specified folder with string path
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, "Path/To/MyFolder") %>
+// File creation in specified folder with TFolder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, app.vault.getAbstractFileByPath("MyFolder")) %>
+// File creation and append link to current note
+[[<% (await tp.file.create_new("MyFileContent", "MyFilename")).basename %>]]
+tp.file.creation_date(format: string = "YYYY-MM-DD HH:mm")
+Retrieves the file's creation date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD HH:mm". Refer to format reference.
+
Examples
+// File creation date
+<% tp.file.creation_date() %>
+// File creation date with format
+<% tp.file.creation_date("dddd Do MMMM YYYY HH:mm") %>
+tp.file.cursor(order?: number)
+Sets the cursor to this location after the template has been inserted.
+You can navigate between the different cursors using the configured hotkey in Obsidian settings.
+Arguments
+-
+
order: The order of the different cursors jump, e.g. it will jump from 1 to 2 to 3, and so on. +If you specify multiple tp.file.cursor with the same order, the editor will switch to multi-cursor.
+
Examples
+// File cursor
+<% tp.file.cursor() %>
+// File multi-cursor
+<% tp.file.cursor(1) %>Content<% tp.file.cursor(1) %>
+tp.file.cursor_append(content: string)
+Appends some content after the active cursor in the file.
+Arguments
+-
+
content: The content to append after the active cursor.
+
Examples
+// File cursor append
+<% tp.file.cursor_append("Some text") %>
+tp.file.exists(filepath: string)
+Check to see if a file exists by it's file path. The full path to the file, relative to the Vault and containing the extension, must be provided.
+Arguments
+-
+
filepath: The full file path of the file we want to check existence for.
+
Examples
+// File existence
+<% await tp.file.exists("MyFolder/MyFile.md") %>
+// File existence of current file
+<% await tp.file.exists(tp.file.folder(true) + "/" + tp.file.title + ".md") %>
+tp.file.find_tfile(filename: string)
+Search for a file and returns its TFile instance.
Arguments
+-
+
filename: The filename we want to search and resolve as aTFile.
+
Examples
+// File find TFile
+<% tp.file.find_tfile("MyFile").basename %>
+tp.file.folder(absolute: boolean = false)
+Retrieves the file's folder name.
+Arguments
+-
+
absolute: If set totrue, returns the vault-absolute path of the folder. Iffalse, only returns the basename of the folder (the last part). Defaults tofalse.
+
Examples
+// File folder (Folder)
+<% tp.file.folder() %>
+// File folder with vault-absolute path (Path/To/Folder)
+<% tp.file.folder(true) %>
+tp.file.include(include_link: string ⎮ TFile)
+Includes the file's link content. Templates in the included content will be resolved.
+Arguments
+-
+
include_link: The link to the file to include, e.g."[[MyFile]]", or a TFile object. Also supports sections or blocks inclusions.
+
Examples
+// File include
+<% tp.file.include("[[Template1]]") %>
+// File include TFile
+<% tp.file.include(tp.file.find_tfile("MyFile")) %>
+// File include section
+<% tp.file.include("[[MyFile#Section1]]") %>
+// File include block
+<% tp.file.include("[[MyFile#^block1]]") %>
+tp.file.last_modified_date(format: string = "YYYY-MM-DD HH:mm")
+Retrieves the file's last modification date.
+Arguments
+-
+
format: The format for the date. Defaults to"YYYY-MM-DD HH:mm". Refer to format reference.
+
Examples
+// File last modified date
+<% tp.file.last_modified_date() %>
+// File last modified date with format
+<% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm") %>
+tp.file.move(new_path: string, file_to_move?: TFile)
+Moves the file to the desired vault location.
+Arguments
+-
+
-
+
+new_path: The new vault relative path of the file, without the file extension. Note: the new path needs to include the folder and the filename, e.g."/Notes/MyNote".
+ -
+
+file_to_move: The file to move, defaults to the current file.
+
Examples
+// File move
+<% await tp.file.move("/A/B/" + tp.file.title) %>
+// File move and rename
+<% await tp.file.move("/A/B/NewTitle") %>
+tp.file.path(relative: boolean = false)
+Retrieves the file's absolute path on the system.
+Arguments
+-
+
relative: If set totrue, only retrieves the vault's relative path.
+
Examples
+// File path
+<% tp.file.path() %>
+// File relative path (relative to vault root)
+<% tp.file.path(true) %>
+tp.file.rename(new_title: string)
+Renames the file (keeps the same file extension).
+Arguments
+-
+
new_title: The new file title.
+
Examples
+// File rename
+<% await tp.file.rename("MyNewName") %>
+// File append a 2 to the file name
+<% await tp.file.rename(tp.file.title + "2") %>
+tp.file.selection()
+Retrieves the active file's text selection.
+Examples
+// File selection
+<% tp.file.selection() %>
+tp.file.tags
+Retrieves the file's tags (array of string).
+Examples
+// File tags
+<% tp.file.tags %>
+tp.file.title
+Retrieves the file's title.
+Examples
+// File title
+<% tp.file.title %>
+// Strip the Zettelkasten ID of title (if space separated)
+<% tp.file.title.split(" ")[1] %>
+Examples
+// Retrieve file content
+<% tp.file.content %>
+
+// File creation
+<%* await tp.file.create_new("MyFileContent", "MyFilename") %>
+// File creation with template
+<%* await tp.file.create_new(tp.file.find_tfile("MyTemplate"), "MyFilename") %>
+// File creation and open created note
+<%* await tp.file.create_new("MyFileContent", "MyFilename", true) %>
+// File creation in current folder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, tp.file.folder(true)) %>
+// File creation in specified folder with string path
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, "Path/To/MyFolder") %>
+// File creation in specified folder with TFolder
+<%* await tp.file.create_new("MyFileContent", "MyFilename", false, app.vault.getAbstractFileByPath("MyFolder")) %>
+// File creation and append link to current note
+[[<% (await tp.file.create_new("MyFileContent", "MyFilename")).basename %>]]
+
+// File creation date
+<% tp.file.creation_date() %>
+// File creation date with format
+<% tp.file.creation_date("dddd Do MMMM YYYY HH:mm") %>
+
+// File cursor
+<% tp.file.cursor() %>
+// File multi-cursor
+<% tp.file.cursor(1) %>Content<% tp.file.cursor(1) %>
+
+// File cursor append
+<% tp.file.cursor_append("Some text") %>
+
+// File existence
+<% await tp.file.exists("MyFolder/MyFile.md") %>
+// File existence of current file
+<% await tp.file.exists(tp.file.folder(true) + "/" + tp.file.title + ".md") %>
+
+// File find TFile
+<% tp.file.find_tfile("MyFile").basename %>
+
+// File folder (Folder)
+<% tp.file.folder() %>
+// File folder with vault-absolute path (Path/To/Folder)
+<% tp.file.folder(true) %>
+
+// File include
+<% tp.file.include("[[Template1]]") %>
+// File include TFile
+<% tp.file.include(tp.file.find_tfile("MyFile")) %>
+// File include section
+<% tp.file.include("[[MyFile#Section1]]") %>
+// File include block
+<% tp.file.include("[[MyFile#^block1]]") %>
+
+// File last modified date
+<% tp.file.last_modified_date() %>
+// File last modified date with format
+<% tp.file.last_modified_date("dddd Do MMMM YYYY HH:mm") %>
+
+// File move
+<% await tp.file.move("/A/B/" + tp.file.title) %>
+// File move and rename
+<% await tp.file.move("/A/B/NewTitle") %>
+
+// File path
+<% tp.file.path() %>
+// File relative path (relative to vault root)
+<% tp.file.path(true) %>
+
+// File rename
+<% await tp.file.rename("MyNewName") %>
+// File append a 2 to the file name
+<% await tp.file.rename(tp.file.title + "2") %>
+
+// File selection
+<% tp.file.selection() %>
+
+// File tags
+<% tp.file.tags %>
+
+// File title
+<% tp.file.title %>
+// Strip the Zettelkasten ID of title (if space separated)
+<% tp.file.title.split(" ")[1] %>
+
+Frontmatter Module
+This modules exposes all the frontmatter variables of a file as variables.
+ +Documentation
+tp.frontmatter.<frontmatter_variable_name>
+Retrieves the file's frontmatter variable value.
+If your frontmatter variable name contains spaces, you can reference it using the bracket notation like so:
+<% tp.frontmatter["variable name with spaces"] %>
+Examples
+Let's say you have the following file:
+---
+alias: myfile
+note type: seedling
+---
+
+file content
+Then you can use the following template:
+File's metadata alias: <% tp.frontmatter.alias %>
+Note's type: <% tp.frontmatter["note type"] %>
+For lists in frontmatter, you can use JavaScript array prototype methods to manipulate how the data is displayed.
+---
+categories:
+ - book
+ - movie
+---
+<% tp.frontmatter.categories.map(prop => ` - "${prop}"`).join("\n") %>
+Hooks Module
+This module exposes hooks that allow you to execute code when a Templater event occurs.
+ +Documentation
+Function documentation is using a specific syntax. More information here.
+tp.hooks.on_all_templates_executed(callback_function: () => any)
+Hooks into when all actively running templates have finished executing. Most of the time this will be a single template, unless you are using tp.file.include or tp.file.create_new.
Multiple invokations of this method will have their callback functions run in parallel.
+Arguments
+-
+
callback_function: Callback function that will be executed when all actively running templates have finished executing.
+
Examples
+// Update frontmatter after template finishes executing
+<%*
+tp.hooks.on_all_templates_executed(async () => {
+ const file = tp.file.find_tfile(tp.file.path(true));
+ await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
+ frontmatter["key"] = "value";
+ });
+});
+%>
+// Run a command from another plugin that modifies the current file, after Templater has updated the file
+<%*
+tp.hooks.on_all_templates_executed(() => {
+ tp.app.commands.executeCommandById("obsidian-linter:lint-file");
+});
+-%>
+Obsidian Module
+This module exposes all the functions and classes from the Obsidian API.
+This is mostly useful when writing scripts.
+Refer to the Obsidian API declaration file for more information.
+Examples
+// Get all folders
+<%
+tp.app.vault.getAllLoadedFiles()
+ .filter(x => x instanceof tp.obsidian.TFolder)
+ .map(x => x.name)
+%>
+
+// Normalize path
+<% tp.obsidian.normalizePath("Path/to/file.md") %>
+
+// Html to markdown
+<% tp.obsidian.htmlToMarkdown("\<h1>Heading\</h1>\<p>Paragraph\</p>") %>
+
+// HTTP request
+<%*
+const response = await tp.obsidian.requestUrl("https://jsonplaceholder.typicode.com/todos/1");
+tR += response.json.title;
+%>
+System Module
+This module contains system related functions.
+-
+
- Documentation
+
-
+
tp.system.clipboard()
+tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)
+tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = "", limit?: number = undefined)
+
+ - Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.system.clipboard()
+Retrieves the clipboard's content.
+Examples
+// Clipboard
+<% tp.system.clipboard() %>
+tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)
+Spawns a prompt modal and returns the user's input.
+Arguments
+-
+
-
+
+prompt_text: Text placed above the input field.
+ -
+
+default_value: A default value for the input field.
+ -
+
+throw_on_cancel: Throws an error if the prompt is canceled, instead of returning anullvalue.
+ -
+
+multiline: If set totrue, the input field will be a multiline textarea. Defaults tofalse.
+
Examples
+// Prompt
+<% tp.system.prompt("Please enter a value") %>
+// Prompt with default value
+<% tp.system.prompt("What is your mood today?", "happy") %>
+// Multiline prompt
+<% tp.system.prompt("What is your mood today?", null, false, true) %>
+tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = "", limit?: number = undefined)
+Spawns a suggester prompt and returns the user's chosen item.
+Arguments
+-
+
-
+
+text_items: Array of strings representing the text that will be displayed for each item in the suggester prompt. This can also be a function that maps an item to its text representation.
+ -
+
+items: Array containing the values of each item in the correct order.
+ -
+
+throw_on_cancel: Throws an error if the prompt is canceled, instead of returning anullvalue.
+ -
+
+placeholder: Placeholder string of the prompt.
+ -
+
+limit: Limit the number of items rendered at once (useful to improve performance when displaying large lists).
+
Examples
+// Suggester
+<% tp.system.suggester(["Happy", "Sad", "Confused"], ["Happy", "Sad", "Confused"]) %>
+// Suggester with mapping function (same as above example)
+<% tp.system.suggester((item) => item, ["Happy", "Sad", "Confused"]) %>
+// Suggester for files
+[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]
+// Suggester for tags
+<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace("#", ""))) %>
+Examples
+// Clipboard
+<% tp.system.clipboard() %>
+
+// Prompt
+<% tp.system.prompt("Please enter a value") %>
+// Prompt with default value
+<% tp.system.prompt("What is your mood today?", "happy") %>
+// Multiline prompt
+<% tp.system.prompt("What is your mood today?", null, false, true) %>
+
+// Suggester
+<% tp.system.suggester(["Happy", "Sad", "Confused"], ["Happy", "Sad", "Confused"]) %>
+// Suggester with mapping function (same as above example)
+<% tp.system.suggester((item) => item, ["Happy", "Sad", "Confused"]) %>
+// Suggester for files
+[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]
+// Suggester for tags
+<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace("#", ""))) %>
+
+Web Module
+This modules contains every internal function related to the web (making web requests).
+-
+
- Documentation + + +
- Examples +
Documentation
+Function documentation is using a specific syntax. More information here.
+tp.web.daily_quote()
+Retrieves and parses the daily quote from https://github.com/Zachatoo/quotes-database as a callout.
Examples
+// Daily quote
+<% tp.web.daily_quote() %>
+tp.web.random_picture(size?: string, query?: string, include_size?: boolean)
+Gets a random image from https://unsplash.com/.
Arguments
+-
+
-
+
+size: Image size in the format<width>x<height>.
+ -
+
+query: Limits selection to photos matching a search term. Multiple search terms can be passed separated by a comma.
+ -
+
+include_size: Optional argument to include the specified size in the image link markdown. Defaults to false.
+
Examples
+// Random picture
+<% tp.web.random_picture() %>
+// Random picture with size
+<% tp.web.random_picture("200x200") %>
+// Random picture with size and query
+<% tp.web.random_picture("200x200", "landscape,water") %>
+tp.web.request(url: string, path?: string)
+Makes a HTTP request to the specified URL. Optionally, you can specify a path to extract specific data from the response.
+Arguments
+-
+
-
+
+url: The URL to which the HTTP request will be made.
+ -
+
+path: A path within the response JSON to extract specific data.
+
Examples
+// Simple request
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos/1") %>
+// Request with path
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos", "0.title") %>
+Examples
+// Daily quote
+<% tp.web.daily_quote() %>
+
+// Random picture
+<% tp.web.random_picture() %>
+// Random picture with size
+<% tp.web.random_picture("200x200") %>
+// Random picture with size and query
+<% tp.web.random_picture("200x200", "landscape,water") %>
+
+// Simple request
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos/1") %>
+// Request with path
+<% tp.web.request("https://jsonplaceholder.typicode.com/todos", "0.title") %>
+
+Contributing
+You can contribute to Templater by developing a new internal function / variable.
+The process to develop a new one is really easy.
+Keep in mind that only pertinent submissions will be accepted, don't submit a very specific internal variable / function that you'll be the only one using.
+Layout
+Internal variables / functions are sorted by modules. Each module has a dedicated folder under src/InternalTemplates.
+Let's take the date module as an example.
+It contains an InternalModuleDate file where all our internal date's related variables and functions are defined and registered:
+export class InternalModuleDate extends InternalModule {
+ name = "date";
+
+ async createStaticTemplates() {
+ this.static_templates.set("now", this.generate_now());
+ this.static_templates.set("tomorrow", this.generate_tomorrow());
+ this.static_templates.set("yesterday", this.generate_yesterday());
+ }
+
+ async updateTemplates() {}
+
+ generate_now() {
+ return (format: string = "YYYY-MM-DD", offset?: number, reference?: string, reference_format?: string) => {
+ if (reference && !window.moment(reference, reference_format).isValid()) {
+ throw new Error("Invalid title date format, try specifying one with the argument 'reference'");
+ }
+ return get_date_string(format, offset, reference, reference_format);
+ }
+ }
+
+ generate_tomorrow() {
+ return (format: string = "YYYY-MM-DD") => {
+ return get_date_string(format, 1);
+ }
+ }
+
+ generate_yesterday() {
+ return (format: string = "YYYY-MM-DD") => {
+ return get_date_string(format, -1);
+ }
+ }
+}
+Every module extends the InternalModule abstract class, which means they contain the following attributes and methods:
+-
+
this.appattribute: the Obsidian APIAppobject.
+this.fileattribute: The destination file where the template will be inserted.
+this.pluginattribute: The Templater plugin object.
+this.static_templatesattribute: A map containing all (name; variable/function) that are static. A static variable / function means that it doesn't depend on the file when executed. These type of variables / functions won't be updated each time we insert a new template, to save some overhead.
+this.dynamic_templatesattribute: Same asstatic_templatesexcept that it contains variables / functions dependent on the file when executed.
+this.createStaticTemplates()method: Registers all static internal variable / function for that module.
+this.updateTemplates()method: Registers every dynamic internal variable / function for that module.
+
You can use these attributes in your new internal variable / function if you need them.
+Registering a new internal variable / function
+Here are the different steps you need to follow, in order to register a new internal variable / function in a module.
+1st step: Create a method inside the module called generate_<internal_variable_or_function_name>() that will generate your internal variable / function, that means it will return either a lambda function (representing the internal function) or directly the internal variable you want to expose.
All generation methods are ordered by alphabetical order based on the internal variable / function name.
+Try to give a good, self-explanatory name for your variable / function.
+2nd step: Register your internal variable / function in the static_templates or dynamic_templates map depending on whether your internal variable / function on the file when executed. The registration happens either in createStaticTemplates or updateTemplates.
To register your variable / function, use your this.generate_<internal_variable_or_function_name>() method you defined earlier:
this.static_templates.set(<internal_variable_or_function_name>, this.generate_<internal_variable_or_function_name>());
+OR
+this.dynamic_templates.set(<internal_variable_or_function_name>, this.generate_<internal_variable_or_function_name>());
+Internal variable / function registrations are also ordered by alphabetical order based on the variable / function name.
+3rd step: Add your internal variable / function documentation to Templater's documentation.
+And you are done ! Thanks for contributing to Templater !
+Now, just submit a pull request on Github, I'll try to be as reactive as possible.
+User Functions
+You can define your own functions in Templater.
+There are two types of user functions you can use:
+ +Invoking User Functions
+You can call a user function using the usual function call syntax: tp.user.<user_function_name>(), where <user_function_name> is the function name you defined.
For example, if you defined a system command user function named echo, a complete command invocation would look like this:
<% tp.user.echo() %>
+No mobile support
+Currently user functions are unavailable on Obsidian for mobile.
+Script User Functions
+This type of user functions allows you to call JavaScript functions from JavaScript files and retrieve their output.
+To use script user functions, you need to specify a script folder in Templater's settings. This folder needs to be accessible from your vault.
+Define a Script User Function
+Let's say you specified the Scripts folder as your script folder in Templater's settings.
Templater will load all JavaScript (.js files) scripts in the Scripts folder.
You can then create your script named Scripts/my_script.js (the .js extension is required) for example. You will likely have to create the file outside of Obsidian, as Obsidian only creates markdown files.
You will then be able to call your scripts as user functions. The function name corresponds to the script file name.
+Scripts should follow the CommonJS module specification, and export a single function.
+function my_function (msg) {
+ return `Message from my script: ${msg}`;
+}
+module.exports = my_function;
+In this example, a complete command invocation would look like this:
+<% tp.user.my_script("Hello World!") %>
+Which would output Message from my script: Hello World!.
Global namespace
+In script user functions, you can still access global namespace variables like app or moment.
However, you can't access the template engine scoped variables like tp or tR. If you want to use them, you must pass them as arguments for your function.
Functions Arguments
+You can pass as many arguments as you want to your function, depending on how you defined it.
+You can for example pass the tp object to your function, to be able to use all of the internal variables / functions of Templater: <% tp.user.<user_function_name>(tp) %>
System Command User Functions
+This type of user functions allows you to execute system commands and retrieve their output.
+System command user functions need to be enabled in Templater's settings.
+Define a System Command User Function
+To define a new system command user function, you need to define a function name, associated with a system command.
+To do that, go to the plugin's settings and click Add User Function.
Once this is done, Templater will create a user function named after what you defined, that will execute your system command and return its output.
+Just like internal functions, user functions are available under the tp JavaScript object, and more specifically under the tp.user object.
Functions Arguments
+You can pass optional arguments to user functions. They must be passed as a single JavaScript object containing properties and their corresponding values: {arg1: value1, arg2: value2, ...}.
These arguments will be made available for your programs / scripts in the form of environment variables.
+In our previous example, this would give the following command declaration: <% tp.user.echo({a: "value 1", b: "value 2"}).
If our system command was calling a bash script, we would be able to access variables a and b using $a and $b.
Internal functions in system commands
+You can use internal functions inside your system command. The internal functions will be replaced before your system command gets executed.
+For example, if you configured the system command cat <% tp.file.path() %>, it would be replaced with cat /path/to/file before the system command gets executed.
Commands
+Command Types
+Templater defines 2 types of opening tags, that defines 2 types of commands:
+-
+
<%: Interpolation command. It will output the result of the expression that's inside.
+<%*: JavaScript execution command. It will execute the JavaScript code that's inside. It does not output anything by default.
+
The closing tag for a command is always the same: %>
Command utilities
+In addition to the different types of commands, you can also use command utilities. They are also declared in the opening tag of the command. All command utilities work with all command types. The available command utilities are:
+ +Dynamic Commands
+With this command utility, you can declare a command as "dynamic", which means that this command will be resolved when entering preview mode.
+To declare a dynamic command add a plus + sign after the command opening tag: <%+
That's it, your command will now be executed only in preview mode.
+This is useful for internal functions like tp.file.last_modified_date for example:
Last modified date: <%+ tp.file.last_modified_date() %>
+Note: Dynamic commands have known issues, and will likely not be maintained going forward (see this issue for more details). In most cases the Dataview plugin is the suggested alternative.
+Refresh problems
+One "downside" of the preview mode is that it puts the rendered note in cache, to speed things up.
+This means that your dynamic command will be rendered only once, when you open the note, but won't be refreshed after.
+If you want to refresh it, you must close the note to clear the cache and open it again.
+Javascript Execution Command
+This type of command allows us to execute JavaScript code.
+With a JavaScript Execution command, we can pretty much do everything that JavaScript allows us to do. Some examples are given below.
+We can still access the tp object and all the internal variables / functions from this type of command.
JavaScript Execution commands let you access global namespace variables. This means you can access things like app or moment.
Asynchronous functions
+Some internal functions are asynchronous. When calling such functions inside a JavaScript execution command, don't forget to use the await keyword if necessary.
How to output a value from a JavaScript Execution Command ?
+Sometimes, you may want to output something when using a JS execution command.
+When our templating engine generates a replacement string using all of our commands results, it is stored in a variable named tR. This is the string that will contain the processed file content. You are allowed to access that variable from a JS execution command.
This means that, to output something from a JS execution command, you just need to append what you want to output to that tR string variable.
For example, the following command: <%* tR += "test" %> will output test.
Suggesters and Prompts
+It is important to note that the tp.system.prompt() and tp.system.suggester() both require a await statement to save the value to a variable
Examples
+Here are some examples of things you can do using JavaScript Execution Commands:
+<%* if (tp.file.title.startsWith("Hello")) { %>
+This is a hello file !
+<%* } else { %>
+This is a normal file !
+<%* } %>
+
+<%* if (tp.frontmatter.type === "seedling") { %>
+This is a seedling file !
+<%* } else { %>
+This is a normal file !
+<%* } %>
+
+<%* if (tp.file.tags.contains("#todo")) { %>
+This is a todo file !
+<%* } else { %>
+This is a finished file !
+<%* } %>
+
+<%*
+function log(msg) {
+ console.log(msg);
+}
+%>
+<%* log("Title: " + tp.file.title) %>
+
+<%* tR += tp.file.content.replace(/stuff/, "things"); %>
+Whitespace Control
+By default, commands in Templater are not removing any newlines. Commands are replaced with their values and that's it.
+It can sometimes be useful to have some whitespace control after commands are inserted, which is exactly what this command utility offers.
+Let's have an example. The following template:
+<%* if (tp.file.title == "MyFile" ) { %>
+This is my file!
+<%* } else { %>
+This isn't my file!
+<%* } %>
+Some content ...
+Will produce the following output if the condition is false (the same happens when it's true), notice the blank lines:
+
+This isn't my file!
+
+Some content ...
+You may want to remove the blank lines produced by the execution commands, that do not produce any output.
+A specific syntax exists for whitespace control:
+-
+
- An underscore
_at the beginning of a tag (<%_) will trim all whitespace before the command
+ - An underscore
_at the end of a tag (_%>) will trim all whitespace after the command
+ - A dash
-at the beginning of a tag (<%-) will trim one newline before the command
+ - A dash
-at the end of a tag (-%>) will trim one newline after the command.
+
In our example, to fix our template to remove the blank lines, we would use the following template (notice the dashes - at the end of the tags), to remove the blank newlines after the execution commands:
<%* if (tp.file.title == "MyFile" ) { -%>
+This is my file!
+<%* } else { -%>
+This isn't my file!
+<%* } -%>
+Some content ...
+Which would produce the following output:
+This isn't my file!
+Some content ...
+Heading\\
\\Paragraph\\
\") %> // HTTP request\n<%*\nconst response = await tp.obsidian.requestUrl(\"https://jsonplaceholder.typicode.com/todos/1\");\ntR += response.json.title;\n%>","breadcrumbs":"Internal Functions » tp.obsidian » Examples","id":"66","title":"Examples"},"67":{"body":"This module contains system related functions. Documentation tp.system.clipboard() tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false) tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined) Examples","breadcrumbs":"Internal Functions » tp.system » System Module","id":"67","title":"System Module"},"68":{"body":"Function documentation is using a specific syntax. More information here .","breadcrumbs":"Internal Functions » tp.system » Documentation","id":"68","title":"Documentation"},"69":{"body":"Retrieves the clipboard's content. Examples // Clipboard\n<% tp.system.clipboard() %>","breadcrumbs":"Internal Functions » tp.system » tp.system.clipboard()","id":"69","title":"tp.system.clipboard()"},"7":{"body":"","breadcrumbs":"Introduction » Syntax » Function syntax","id":"7","title":"Function syntax"},"70":{"body":"Spawns a prompt modal and returns the user's input. Arguments prompt_text: Text placed above the input field. default_value: A default value for the input field. throw_on_cancel: Throws an error if the prompt is canceled, instead of returning a null value. multiline: If set to true, the input field will be a multiline textarea. Defaults to false. Examples // Prompt\n<% tp.system.prompt(\"Please enter a value\") %>\n// Prompt with default value\n<% tp.system.prompt(\"What is your mood today?\", \"happy\") %>\n// Multiline prompt\n<% tp.system.prompt(\"What is your mood today?\", null, false, true) %>","breadcrumbs":"Internal Functions » tp.system » tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)","id":"70","title":"tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)"},"71":{"body":"Spawns a suggester prompt and returns the user's chosen item. Arguments text_items: Array of strings representing the text that will be displayed for each item in the suggester prompt. This can also be a function that maps an item to its text representation. items: Array containing the values of each item in the correct order. throw_on_cancel: Throws an error if the prompt is canceled, instead of returning a null value. placeholder: Placeholder string of the prompt. limit: Limit the number of items rendered at once (useful to improve performance when displaying large lists). Examples // Suggester\n<% tp.system.suggester([\"Happy\", \"Sad\", \"Confused\"], [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester with mapping function (same as above example)\n<% tp.system.suggester((item) => item, [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester for files\n[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]\n// Suggester for tags\n<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace(\"#\", \"\"))) %>","breadcrumbs":"Internal Functions » tp.system » tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined)","id":"71","title":"tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined)"},"72":{"body":"// Clipboard\n<% tp.system.clipboard() %> // Prompt\n<% tp.system.prompt(\"Please enter a value\") %>\n// Prompt with default value\n<% tp.system.prompt(\"What is your mood today?\", \"happy\") %>\n// Multiline prompt\n<% tp.system.prompt(\"What is your mood today?\", null, false, true) %> // Suggester\n<% tp.system.suggester([\"Happy\", \"Sad\", \"Confused\"], [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester with mapping function (same as above example)\n<% tp.system.suggester((item) => item, [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester for files\n[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]\n// Suggester for tags\n<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace(\"#\", \"\"))) %>","breadcrumbs":"Internal Functions » tp.system » Examples","id":"72","title":"Examples"},"73":{"body":"This modules contains every internal function related to the web (making web requests). Documentation tp.web.daily_quote() tp.web.random_picture(size?: string, query?: string, include_size?: boolean) tp.web.request(url: string, path?: string) Examples","breadcrumbs":"Internal Functions » tp.web » Web Module","id":"73","title":"Web Module"},"74":{"body":"Function documentation is using a specific syntax. More information here .","breadcrumbs":"Internal Functions » tp.web » Documentation","id":"74","title":"Documentation"},"75":{"body":"Retrieves and parses the daily quote from https://github.com/Zachatoo/quotes-database as a callout. Examples // Daily quote\n<% tp.web.daily_quote() %>","breadcrumbs":"Internal Functions » tp.web » tp.web.daily_quote()","id":"75","title":"tp.web.daily_quote()"},"76":{"body":"Gets a random image from https://unsplash.com/. Arguments size: Image size in the formatHeading\\
\\Paragraph\\
\") %> // HTTP request\n<%*\nconst response = await tp.obsidian.requestUrl(\"https://jsonplaceholder.typicode.com/todos/1\");\ntR += response.json.title;\n%>","breadcrumbs":"Internal Functions » tp.obsidian » Examples","id":"66","title":"Examples"},"67":{"body":"This module contains system related functions. Documentation tp.system.clipboard() tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false) tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined) Examples","breadcrumbs":"Internal Functions » tp.system » System Module","id":"67","title":"System Module"},"68":{"body":"Function documentation is using a specific syntax. More information here .","breadcrumbs":"Internal Functions » tp.system » Documentation","id":"68","title":"Documentation"},"69":{"body":"Retrieves the clipboard's content. Examples // Clipboard\n<% tp.system.clipboard() %>","breadcrumbs":"Internal Functions » tp.system » tp.system.clipboard()","id":"69","title":"tp.system.clipboard()"},"7":{"body":"","breadcrumbs":"Introduction » Syntax » Function syntax","id":"7","title":"Function syntax"},"70":{"body":"Spawns a prompt modal and returns the user's input. Arguments prompt_text: Text placed above the input field. default_value: A default value for the input field. throw_on_cancel: Throws an error if the prompt is canceled, instead of returning a null value. multiline: If set to true, the input field will be a multiline textarea. Defaults to false. Examples // Prompt\n<% tp.system.prompt(\"Please enter a value\") %>\n// Prompt with default value\n<% tp.system.prompt(\"What is your mood today?\", \"happy\") %>\n// Multiline prompt\n<% tp.system.prompt(\"What is your mood today?\", null, false, true) %>","breadcrumbs":"Internal Functions » tp.system » tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)","id":"70","title":"tp.system.prompt(prompt_text?: string, default_value?: string, throw_on_cancel: boolean = false, multiline?: boolean = false)"},"71":{"body":"Spawns a suggester prompt and returns the user's chosen item. Arguments text_items: Array of strings representing the text that will be displayed for each item in the suggester prompt. This can also be a function that maps an item to its text representation. items: Array containing the values of each item in the correct order. throw_on_cancel: Throws an error if the prompt is canceled, instead of returning a null value. placeholder: Placeholder string of the prompt. limit: Limit the number of items rendered at once (useful to improve performance when displaying large lists). Examples // Suggester\n<% tp.system.suggester([\"Happy\", \"Sad\", \"Confused\"], [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester with mapping function (same as above example)\n<% tp.system.suggester((item) => item, [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester for files\n[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]\n// Suggester for tags\n<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace(\"#\", \"\"))) %>","breadcrumbs":"Internal Functions » tp.system » tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined)","id":"71","title":"tp.system.suggester(text_items: string[] ⎮ ((item: T) => string), items: T[], throw_on_cancel: boolean = false, placeholder: string = \"\", limit?: number = undefined)"},"72":{"body":"// Clipboard\n<% tp.system.clipboard() %> // Prompt\n<% tp.system.prompt(\"Please enter a value\") %>\n// Prompt with default value\n<% tp.system.prompt(\"What is your mood today?\", \"happy\") %>\n// Multiline prompt\n<% tp.system.prompt(\"What is your mood today?\", null, false, true) %> // Suggester\n<% tp.system.suggester([\"Happy\", \"Sad\", \"Confused\"], [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester with mapping function (same as above example)\n<% tp.system.suggester((item) => item, [\"Happy\", \"Sad\", \"Confused\"]) %>\n// Suggester for files\n[[<% (await tp.system.suggester((item) => item.basename, app.vault.getMarkdownFiles())).basename %>]]\n// Suggester for tags\n<% tp.system.suggester(item => item, Object.keys(app.metadataCache.getTags()).map(x => x.replace(\"#\", \"\"))) %>","breadcrumbs":"Internal Functions » tp.system » Examples","id":"72","title":"Examples"},"73":{"body":"This modules contains every internal function related to the web (making web requests). Documentation tp.web.daily_quote() tp.web.random_picture(size?: string, query?: string, include_size?: boolean) tp.web.request(url: string, path?: string) Examples","breadcrumbs":"Internal Functions » tp.web » Web Module","id":"73","title":"Web Module"},"74":{"body":"Function documentation is using a specific syntax. More information here .","breadcrumbs":"Internal Functions » tp.web » Documentation","id":"74","title":"Documentation"},"75":{"body":"Retrieves and parses the daily quote from https://github.com/Zachatoo/quotes-database as a callout. Examples // Daily quote\n<% tp.web.daily_quote() %>","breadcrumbs":"Internal Functions » tp.web » tp.web.daily_quote()","id":"75","title":"tp.web.daily_quote()"},"76":{"body":"Gets a random image from https://unsplash.com/. Arguments size: Image size in the format
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/syntax.html b/syntax.html
new file mode 100644
index 00000000..63defa23
--- /dev/null
+++ b/syntax.html
@@ -0,0 +1,238 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Settings
+General Settings
+-
+
Template folder location: Files in this folder will be available as templates.
+Syntax Highlighting on Desktopadds syntax highlighting for Templater commands in edit mode.
+Syntax Highlighting on Mobileadds syntax highlighting for Templater commands in edit mode on mobile. Use with caution: this may break live preview on mobile platforms."
+Automatic jump to cursorautomatically triggerstp.file.cursorafter inserting a template. You can also set a hotkey to manually triggertp.file.cursor.
+Trigger Templater on new file creation: Templater will listen for the new file creation event, and, if it matches a rule you've set, replace every command it finds in the new file's content. This makes Templater compatible with other plugins like the Daily note core plugin, Calendar plugin, Review plugin, Note refactor plugin, etc. +-
+
- Make sure to set up rules under either Folder Templates or File Regex Template below. +
- Warning: This can be dangerous if you create new files with unknown / unsafe content on creation. Make sure that every new file's content is safe on creation." +
+
Template Hotkeys
+Template Hotkeys allows you to bind a template to a hotkey.
+Folder Templates
+Note: This setting is hidden by default. To view it first enable the Trigger Template on new file creation setting. And since it's mutually exclusive with File Regex Templates, enabling one will disable the other.
You can specify a template that will automatically be used on a selected folder and children using the Folder Templates functionality. The deepest match will be used, so the order of the rules is irrelevant.
Add a rule for "/" if you need a catch-all.
File Regex Templates
+Note: This setting is hidden by default. To view it first enable the Trigger Template on new file creation setting. And since it's mutually exclusive with Folder Templates, enabling one will disable the other.
You can specify regex declarations that a new file's path will be tested against. If a regex matches, the associated template will automatically be used. Rules are tested top-to-bottom, and the first match will be used.
+End with a rule for ".*" if you need a catch-all.
Use a tool like Regex101 to verify your regexes.
+Startup Templates
+Startup Templates are templates that will get executed once when Templater starts.
+These templates won't output anything.
+This can be useful to set up templates adding hooks to obsidian events for example.
+User Script Functions
+All JavaScript files in this folder will be loaded as CommonJS modules, to import custom user functions.
+The folder needs to be accessible from the vault.
+Check the documentation for more information.
+User System Command Functions
+Allows you to create user functions linked to system commands.
+Check the documentation for more information.
+Warning: It can be dangerous to execute arbitrary system commands from untrusted sources. Only run system commands that you understand, from trusted sources.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/terminology.html b/terminology.html
new file mode 100644
index 00000000..8639d677
--- /dev/null
+++ b/terminology.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Syntax
+Templater uses a custom templating engine (rusty_engine) syntax to declare a command. You may need a bit of time to get used to it, but once you get the idea, the syntax is not that hard.
+All of Templater's functions are JavaScript objects that are invoked using a command.
+Command syntax
+A command must have both an opening tag <% and a closing tag %>.
A complete command using the tp.date.now internal function would be: <% tp.date.now() %>
Function syntax
+Objects hierarchy
+All of Templater's functions, whether it's an internal function or a user function, are available under the tp object. You could say that all our functions are children of the tp object. To access the "child" of an object, we have to use the dot notation .
This means that a Templater function invocation will always start with tp.<something>
Function invocation
+To invoke a function, we need to use a syntax specific to functions calls: appending an opening and a closing parenthesis after the function name.
+As an example, we would use tp.date.now() to invoke the tp.date.now internal function.
A function can have arguments and optional arguments. They are placed between the opening and the closing parenthesis, like so:
+tp.date.now(arg1_value, arg2_value, arg3_value, ...)
+All arguments must be passed in the correct order.
+The arguments of a function can have different types. Here is a non-exhaustive list of the possible types of a function:
+-
+
- A
stringtype means the value must be placed within simple or double quotes ("value"or'value')
+ - A
numbertype means the value must be an integer (15,-5, ...)
+ - A
booleantype means the value must be eithertrueorfalse(completely lower case), and nothing else.
+
The type of an argument must be respected when calling a function, or it won't work.
+Function documentation syntax
+The documentation for the internal functions of Templater are using the following syntax:
+tp.<my_function>(arg1_name: type, arg2_name?: type, arg3_name: type = <default_value>, arg4_name: type1|type2, ...)
+Where:
+-
+
arg_namerepresents a symbolic name for the argument, to understand what it is.
+typerepresents the expected type for the argument. This type must be respected when calling the internal function, or it will throw an error.
+
If an argument is optional, it will be appended with a question mark ?, e.g. arg2_name?: type
If an argument has a default value, it will be specified using an equal sign =, e.g. arg3_name: type = <default_value>.
If an argument can have different types, it will be specified using a pipe |, e.g. arg4_name: type1|type2
Syntax warning
+Please note that this syntax is for documentation purposes only, to be able to understand what arguments the function expects.
+You mustn't specify the name nor the type nor the default value of an argument when calling a function. Only the value of the arguments are required, as explained here
+Example
+Let's take the tp.date.now internal function documentation as an example:
tp.date.now(format: string = "YYYY-MM-DD", offset?: number|string, reference?: string, reference_format?: string)
+This internal function has 4 optional arguments:
+-
+
- a format of type
string, with a default value of"YYYY-MM-DD".
+ - an offset of type
numberor of typestring.
+ - a reference of type
string.
+ - a reference_format of type
string.
+
That means that valid invocations for this internal function are:
+-
+
<% tp.date.now() %>
+<% tp.date.now("YYYY-MM-DD", 7) %>
+<% tp.date.now("YYYY-MM-DD", 7, "2021-04-09", "YYYY-MM-DD") %>
+<% tp.date.now("dddd, MMMM Do YYYY", 0, tp.file.title, "YYYY-MM-DD") %>*Assuming the file name is of the format: "YYYY-MM-DD"
+
On the other hand, invalid invocations are:
+-
+
tp.date.now(format: string = "YYYY-MM-DD")
+tp.date.now(format: string = "YYYY-MM-DD", offset?: 0)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tomorrow-night.css b/tomorrow-night.css
new file mode 100644
index 00000000..f7197925
--- /dev/null
+++ b/tomorrow-night.css
@@ -0,0 +1,104 @@
+/* Tomorrow Night Theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+ padding: 0.5em;
+ -webkit-text-size-adjust: none;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
diff --git a/user-functions/overview.html b/user-functions/overview.html
new file mode 100644
index 00000000..ea2534f9
--- /dev/null
+++ b/user-functions/overview.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Terminology
+To understand how Templater works, let's define a few terms:
+-
+
- A template is a file that contains commands. +
- A text snippet that starts with an opening tag
<%, ends with a closing tag%>is what we will call a command.
+ - A function is an object that we can invoke inside a command and that returns a value (the replacement string) +
There are two types of functions you can use:
+-
+
- Internal functions. They are predefined functions that are built within the plugin. As an example,
tp.date.nowis an internal function that will return the current date.
+ - User functions. Users can define their own functions. They are either system command or user scripts. +
Example
+The following template contains 2 commands, calling 2 different internal functions:
+Yesterday: <% tp.date.yesterday("YYYY-MM-DD") %>
+Tomorrow: <% tp.date.tomorrow("YYYY-MM-DD") %>
+We'll see in the next part the syntax required to write some commands.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/user-functions/script-user-functions.html b/user-functions/script-user-functions.html
new file mode 100644
index 00000000..f68023af
--- /dev/null
+++ b/user-functions/script-user-functions.html
@@ -0,0 +1,200 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ User Functions
+You can define your own functions in Templater.
+There are two types of user functions you can use:
+ +Invoking User Functions
+You can call a user function using the usual function call syntax: tp.user.<user_function_name>(), where <user_function_name> is the function name you defined.
For example, if you defined a system command user function named echo, a complete command invocation would look like this:
<% tp.user.echo() %>
+No mobile support
+Currently user functions are unavailable on Obsidian for mobile.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/user-functions/system-user-functions.html b/user-functions/system-user-functions.html
new file mode 100644
index 00000000..85431230
--- /dev/null
+++ b/user-functions/system-user-functions.html
@@ -0,0 +1,193 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Script User Functions
+This type of user functions allows you to call JavaScript functions from JavaScript files and retrieve their output.
+To use script user functions, you need to specify a script folder in Templater's settings. This folder needs to be accessible from your vault.
+Define a Script User Function
+Let's say you specified the Scripts folder as your script folder in Templater's settings.
Templater will load all JavaScript (.js files) scripts in the Scripts folder.
You can then create your script named Scripts/my_script.js (the .js extension is required) for example. You will likely have to create the file outside of Obsidian, as Obsidian only creates markdown files.
You will then be able to call your scripts as user functions. The function name corresponds to the script file name.
+Scripts should follow the CommonJS module specification, and export a single function.
+function my_function (msg) {
+ return `Message from my script: ${msg}`;
+}
+module.exports = my_function;
+In this example, a complete command invocation would look like this:
+<% tp.user.my_script("Hello World!") %>
+Which would output Message from my script: Hello World!.
Global namespace
+In script user functions, you can still access global namespace variables like app or moment.
However, you can't access the template engine scoped variables like tp or tR. If you want to use them, you must pass them as arguments for your function.
Functions Arguments
+You can pass as many arguments as you want to your function, depending on how you defined it.
+You can for example pass the tp object to your function, to be able to use all of the internal variables / functions of Templater: <% tp.user.<user_function_name>(tp) %>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ System Command User Functions
+This type of user functions allows you to execute system commands and retrieve their output.
+System command user functions need to be enabled in Templater's settings.
+Define a System Command User Function
+To define a new system command user function, you need to define a function name, associated with a system command.
+To do that, go to the plugin's settings and click Add User Function.
Once this is done, Templater will create a user function named after what you defined, that will execute your system command and return its output.
+Just like internal functions, user functions are available under the tp JavaScript object, and more specifically under the tp.user object.
Functions Arguments
+You can pass optional arguments to user functions. They must be passed as a single JavaScript object containing properties and their corresponding values: {arg1: value1, arg2: value2, ...}.
These arguments will be made available for your programs / scripts in the form of environment variables.
+In our previous example, this would give the following command declaration: <% tp.user.echo({a: "value 1", b: "value 2"}).
If our system command was calling a bash script, we would be able to access variables a and b using $a and $b.
Internal functions in system commands
+You can use internal functions inside your system command. The internal functions will be replaced before your system command gets executed.
+For example, if you configured the system command cat <% tp.file.path() %>, it would be replaced with cat /path/to/file before the system command gets executed.