website/docs/plugins/plugin/io.github.djsudduth.paragra.../index.html

316 lines
13 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 - Paragraph Extractor</title>
<meta property="og:title" content="Joplin Plugin: Paragraph Extractor"/>
<meta property="og:description" content="Extract specific paragraphs out of Joplin notes using keywords, hashtags or custom tags"/>
<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">Paragraph Extractor</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">Paragraph Extractor</h1>
<div class="card-title pb-2">
by
<a
href="./?search=author%3D%22djsudduth%22%20max-results%3D20"
style="display: inline;"
>
djsudduth
</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=io.github.djsudduth.paragraph-extractor"
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">Extract specific paragraphs out of Joplin notes using keywords, hashtags or custom tags</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;djsudduth&#x2F;joplin-plugin-paragraph-extractor style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
<li><a href=https:&#x2F;&#x2F;github.com&#x2F;djsudduth&#x2F;joplin-plugin-paragraph-extractor 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=io.github.djsudduth.paragraph-extractor"
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%22djsudduth%22%20max-results%3D20" class="maintainer-link">
djsudduth
</a>
</td>
</tr>
<tr><th>Version:</th><td>1.1.5</td></tr>
<tr><th>Minimum app version:</th><td>1.8.1</td></tr>
<tr><th>Downloads: This version:</th><td>101</td></tr>
<tr><th>Last updated:</th><td class="process--format-as-local-time">2024-09-27T21:39:19Z</td></tr>
</tbody>
</table>
</div>
<div class="container section" id="readme" data--is-rendered-markdown>
<h1>Joplin Extract Paragraphs</h1>
<p>Plugin to extract and combine paragraph blocks from any selected notes to a single new note based on a keyword, hashtag or custom tag contained within the paragraph. This is similar to block functionality in other note taking systems like Logseq.</p>
<p>Typical useage is to identify paragraphs with added hashtags (e.g., #mytag). Then, any paragraph with that tag in multiple notes can be copied and added to a single new note. However, keywords do not have to be hashtags and can just be a simple search word to identify and extract the paragraph.</p>
<p>Example screenshots can be found here: <a href="https://discourse.joplinapp.org/t/plugin-extract-paragraphs/35831">https://discourse.joplinapp.org/t/plugin-extract-paragraphs/35831</a></p>
<p>Bullet and sub-bullet lists are treated as single paragraphs in Joplin. Settings will allow for extracting single bullets (along with their sub-bullets) that contain the keyword rather than all the bullets in the paragraph.</p>
<p><strong>The full note can be extracted</strong> if the hashtagged keyword is by iteself in the last paragraph. This is useful if you do not wish to add the same hashtag to every paragraph if the entire note is useful.</p>
<p>Any Joplin tags in the source notes will be combined as Joplin tags in the extracted note. Selected notes are not changed at all.</p>
<h2>Installation</h2>
<h3>Automatic</h3>
<ul>
<li>Go to <code>Tools &gt; Options &gt; Plugins</code></li>
<li>Search for <code>Paragraph Extractor</code></li>
<li>Click Install plugin</li>
<li>Restart Joplin to enable the plugin</li>
</ul>
<h3>Manual</h3>
<ul>
<li>Download the latest released JPL package (<code>io.github.djsudduth.paragraph-extractor.jpl</code>) from <a href="https://github.com/djsudduth/joplin-plugin-paragraph-extractor/releases/latest">here</a></li>
<li>Close Joplin</li>
<li>Copy the downloaded JPL package in your profile <code>plugins</code> folder</li>
<li>Start Joplin</li>
</ul>
<h2>Usage</h2>
<ul>
<li>Select multiple notes to extract sections based on keyword into a single note</li>
<li>Click on <code>Tools &gt; Extract paragraphs from notes</code> or use the command <code>Extract paragraphs from notes</code> from the context menu</li>
</ul>
<p>Complete Video Tutorial:<br />
<a href="https://youtu.be/tyk66PUjSCE">https://youtu.be/tyk66PUjSCE</a></p>
<h2>Options</h2>
<p>Go to <code>Tools &gt; Options &gt; Paragraph Extractor</code></p>
<ul>
<li><code>Preserve source note titles with backlinks</code>: Titles of source notes will be embedded at the top in new note with links back to the original source notes. Default <code>true</code>.</li>
<li><code>Embed source note titles at end of each extracted paragraph</code>: Titles of source notes will be embedded at the end of each extracted paragraph rather than at the top with a link back to the original source notes. Default <code>false</code>.</li>
<li><code>Extract content at the bulleted list item level</code>: Bullets will be extracted at the top bullet level (including sub-bullets) vs all bullets within a paragraph. Default <code>false</code></li>
<li><code>Ignore the keyword case</code>: Any case for the keyword or hashtag keyword will be used for extraction. Default <code>false</code></li>
<li><code>Include the header of the section extracted</code>: Any H1-H6 header will be included with the extracted paragraph or bullet (this is ignored for keywords embedded within the header which are always extracted). Default <code>false</code></li>
<li><code>Default or Last Used Tag Prefix character</code>: Either the common hashtag # character (preferred) or $, %. Default <code>#</code></li>
<li><code>Default or Last Used Paragraph Tag or Keyword</code>: The entered keyword to search in notes to extract the paragraph. If the prefix hashtag field is set, then the tag is added to the keyword for finding paragraph blocks.</li>
<li><code>Remove extracted paragraph keyword and add end tag</code>: Any tagged/hashtagged keyword will be removed from the paragraph and an endtag will be added in the new extraction note. Removal assumes the keyword has a hashtag prefix character - otherwise the setting is ignored. The end tag is always appended when this is selected. Default <code>false</code></li>
<li><code>Title of the combined note</code>: New title of the combined note. Default <code>Extracted paragraphs</code>.</li>
<li><code>Custom note title</code>: New note title with possible variables <code>{{FIRSTTITLE}}</code>, <code>{{LASTTITLE}}</code>, <code>{{ALLTITLE}}</code> and <code>{{DATE}}</code>.</li>
</ul>
<h2>Keyboard Shortcuts</h2>
<p>Under <code>Options &gt; Keyboard Shortcuts</code> you can assign a keyboard shortcut for the following commands:</p>
<ul>
<li><code>Extract paragraphs from notes</code></li>
</ul>
<h2>Build</h2>
<p>See <a href="https://raw.githubusercontent.com/djsudduth/joplin-plugin-paragraph-extractor/HEAD/BUILD.md">BUILD</a></p>
<h2>Changelog</h2>
<p>See <a href="https://raw.githubusercontent.com/djsudduth/joplin-plugin-paragraph-extractor/HEAD/CHANGELOG.md">Changelog</a></p>
<h2>Thanks</h2>
<p>Special thanks to <a href="https://github.com/JackGruber">Jack Gruber</a> for the inspiration and excellent code to help bootstrap this plugin!</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>