website/docs/plugins/plugin/com.DanteCoder.NoteVariables/index.html

292 lines
10 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<!-- Common page configuration that goes in the <head></head> tag -->
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,viewport-fit=cover"/>
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; img-src * data: ; style-src 'self' 'unsafe-inline' ; child-src 'none' ; connect-src 'self' raw.githubusercontent.com ;"/>
<link rel="icon" type="image/x-icon" href="&#x2F;plugins/favicon.png" />
<link rel="stylesheet" href="&#x2F;plugins/fontawesome-6.4.2/css/all.min.css" type="text/css"/>
<!-- Allow included JavaScipt files to determine the root directory of this site. -->
<script id="site-root" type="text/plain">/plugins</script>
<!-- Scripts used by all pages -->
<script src="&#x2F;plugins/bundle-main.js"></script>
<script src="&#x2F;plugins/bundle-components.js"></script>
<title>Joplin Plugins - Note Variables</title>
<meta property="og:title" content="Joplin Plugin: Note Variables"/>
<meta property="og:description" content="A plugin to create variables that can be accesed through all the notes."/>
<meta property="og:image" content=""/>
<script src="&#x2F;plugins/bundle-pluginPage.js"></script>
</head>
<body>
<nav class="navbar navbar-expand-lg bg-body-tertiary sticky-top">
<div class="container">
<a class="navbar-brand" href="https://joplinapp.org/">
<img src="/plugins/joplin-logo.png" alt="Home"/>
</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav ms-auto me-2 mb-2 mb-lg-0">
<li class="nav-item">
<a class="nav-link active" aria-current="page" href="/plugins">Plugins</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://joplinapp.org/news/">News</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://joplinapp.org/help/">Help</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://discourse.joplinapp.org/">Forum</a>
</li>
</ul>
<div class="search-field col-12 col-lg-3 mb-3 mb-lg-0 me-lg-3">
<i class="fa-solid fa-magnifying-glass search-icon" alt=""></i>
<input
type="search"
class="form-control search-input"
placeholder="Search..."
id="search-input"/>
<div class="search-results" id="search-results-container" aria-live="polite"></div>
</div>
</div>
</div>
</nav>
<main class="plugin-details">
<nav aria-label="breadcrumb" class="container breadcrumb-container">
<ol class="breadcrumb">
<li class="breadcrumb-item">
<a href="&#x2F;plugins"><i class="fas fa-home"></i> Home</a>
</li>
<li class="breadcrumb-item"><a id="current-category-nav-link" href="&#x2F;plugins/">All</a></li>
<li class="breadcrumb-item active" aria-current="page">Note Variables</li>
</ol>
</nav>
<div class="plugin-overview">
<div class="spacer">
</div>
<div class="plugin-page-header">
<div class="title plugin-page-title">
<img
class="icon plugin-icon -missing"
src=""
alt="Plugin icon"
/>
<div>
<h1 class="card-title">Note Variables</h1>
<div class="card-title pb-2">
by
<a
href="./?search=author%3D%22Dante G. Barboza%22%20max-results%3D20"
style="display: inline;"
>
Dante G. Barboza
</a>
</div>
</div>
</div>
<div class="categories">
<a class="plugin-category me-2 badge" href="&#x2F;plugins/#tab-productivity">
<i class="fas fa-tag"></i> productivity
</a>
</div>
</div>
<div class="download-link-container">
<a
href="/plugins/downloadPlugin.html?plugin=com.DanteCoder.NoteVariables"
class="btn btn-primary process--append-parent-tab-to-href"
>
Install Plugin
</a>
</div>
</div>
<div class="plugin-content">
<div class="secondary-section">
<div class="content" id="screenshots-container">
<div id="raw-screenshots">
</div>
<!-- See https://getbootstrap.com/docs/5.3/components/carousel/ -->
<div id="screenshots-carousel" class="carousel slide">
<button
class="carousel-control-prev"
type="button"
data-bs-target="#screenshots-carousel"
data-bs-slide="prev"
>
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button
class="carousel-control-next"
type="button"
data-bs-target="#screenshots-carousel"
data-bs-slide="next"
>
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
</div>
</div>
<div class="container section">
<h3>Description</h3>
<p class="card-text pb-4">A plugin to create variables that can be accesed through all the notes.</p>
</div>
<div class="container section">
<h3>Additional Information</h3>
<table class="additional-information-table">
<tbody>
<tr>
<th>Links:</th>
<td>
<ul class="list-group list-group-flush text-break">
<li><a href=https:&#x2F;&#x2F;github.com&#x2F;DanteCoder&#x2F;JoplinPluginNoteVariables style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
<li><a href=https:&#x2F;&#x2F;github.com&#x2F;DanteCoder&#x2F;JoplinPluginNoteVariables#readme style="display: block;"><i class="fa-solid fa-link"></i> Homepage</a></li>
<li>
<a
id="view-plugin-source-link"
href="&#x2F;plugins/view-source.html?plugin=com.DanteCoder.NoteVariables"
class="process--append-parent-tab-to-href"
>
<i class="fa-solid fa-code"></i> View source
</a>
</li>
</ul>
</td>
</tr>
<tr>
<th>Maintainers:</th>
<td>
<a href="./?search=maintainer%3D%22dantecoder%22%20max-results%3D20" class="maintainer-link">
dantecoder
</a>
</td>
</tr>
<tr><th>Version:</th><td>2.0.0</td></tr>
<tr><th>Minimum app version:</th><td>2.2</td></tr>
<tr><th>Downloads: This version:</th><td>1101</td></tr>
<tr><th>Last updated:</th><td class="process--format-as-local-time">2022-07-24T23:35:53Z</td></tr>
</tbody>
</table>
</div>
<div class="container section" id="readme" data--is-rendered-markdown>
<h1>Note Variables Plugin</h1>
<p>With this plugin you can create string variables that can be used across all your notes.</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/90792603/180668302-44c487ac-a647-4124-9f34-dd0758d9f9c7.png" />
</p>
<h2>Usage</h2>
<p>To begin you need to create a new Variables Note, you can do that by clicking on Note &gt; "Create variables note":</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/90792603/180668392-64da24d1-b952-4a22-8f75-babb0df10577.png" />
</p>
<p>Inside the Variables Note you can add as many string variables as you need inside the created table:</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/90792603/180668652-a1804fff-d493-45f3-b950-543343c5fb38.png" />
</p>
<p>To use the variables in a note you have to write an inline code like <code>import Variables1 AnotherVariables</code>. The rendered text will turn green if the import was succesful, and red if the plugin could not find the Variables Note:</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/90792603/180669121-73cb43c0-8a87-427e-9cb5-a08986f5687c.png" />
</p>
<h2>Usage notes</h2>
<ul>
<li>Every Variables Note must have a different name and without spaces. If two Variable Notes have the same name the plugin will use the first one it finds.</li>
<li>Every variable in a Variable Note must have a different name, otherwise just the first of the same name will be used.</li>
<li>You can import multiple Note Variables in a single note, but if they have variables with the same name the variables from the rightmost import will take priority.</li>
<li>Sometimes after starting Joplin, you have to switch notes to see the variables replaced on the note.</li>
</ul>
<h2>Download</h2>
<p>You can install it directly from Options &gt; Plugins &gt; Search for "Note Variables".</p>
<h2>Bugs, feature requests or contributions</h2>
<p>Please report any bugs you find, or any feature request you have on the <a href="https://github.com/DanteCoder/JoplinPluginNoteVariables/issues">GitHub Issues page</a>
Feel free to contribute to the plugin making a pull request to the <a href="https://github.com/DanteCoder/JoplinPluginNoteVariables/tree/Dev">Dev branch</a>.</p>
</div>
</div>
</main>
<footer class="page-footer">
<div class="plugin-documentation-section">
<div class="heading">
Would you like to submit or develop a plugin? Consult our documentation:
</div>
<a class="btn btn-outline-primary" href="https://joplinapp.org/help/api/get_started/plugins">
See documentation
</a>
</div>
<div class="links legal-and-about-links">
<div class="copyright">© Joplin 2023 - 2024</div>
<a class="link terms-and-conditions" href="&#x2F;plugins/terms-and-conditions.html">Terms and conditions</a>
<a class="link privacy" href="&#x2F;plugins/privacy-policy.html">Privacy policy</a>
</div>
<div class="site-links">
<a
class="a-github"
href="https://github.com/joplin/website-plugin-discovery"
aria-label="GitHub"
title="GitHub"
>
<i class="fab fa-github"></i>
</a>
<a
class="a-discord"
href="https://discord.com/invite/VSj7AFHvpq"
aria-label="Discord"
title="Discord"
>
<i class="fab fa-discord"></i>
</a>
<a
class="a-linkedin"
href="https://www.linkedin.com/company/joplin"
aria-label="LinkedIn"
title="LinkedIn"
>
<i class="fab fa-linkedin"></i>
</a>
<a
class="a-twitter"
href="https://twitter.com/joplinapp"
aria-label="Twitter"
title="Twitter"
>
<i class="fab fa-twitter"></i>
</a>
<a
class="a-mastodon"
href="https://mastodon.social/@joplinapp"
aria-label="Mastodon"
title="Mastodon"
>
<i class="fab fa-mastodon"></i>
</a>
<a
class="a-patreon"
href="https://www.patreon.com/joplin"
aria-label="Patreon"
title="Patreon"
>
<i class="fab fa-patreon"></i>
</a>
</div>
</footer>
</body>
</html>