mirror of https://github.com/joplin/website.git
340 lines
13 KiB
HTML
340 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="/plugins/favicon.png" />
|
|
<link rel="stylesheet" href="/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="/plugins/bundle-main.js"></script>
|
|
<script src="/plugins/bundle-components.js"></script>
|
|
<title>Joplin Plugins - Joplin debug tool</title>
|
|
|
|
<meta property="og:title" content="Joplin Plugin: Joplin debug tool"/>
|
|
<meta property="og:description" content="A panel with information about the current note and an advanced search tool."/>
|
|
<meta property="og:image" content=""/>
|
|
|
|
<script src="/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="/plugins"><i class="fas fa-home"></i> Home</a>
|
|
</li>
|
|
<li class="breadcrumb-item"><a id="current-category-nav-link" href="/plugins/">All</a></li>
|
|
<li class="breadcrumb-item active" aria-current="page">Joplin debug tool</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">Joplin debug tool</h1>
|
|
<div class="card-title pb-2">
|
|
by
|
|
<a
|
|
href="./?search=author%3D%22Henry Heino%22%20max-results%3D20"
|
|
style="display: inline;"
|
|
>
|
|
Henry Heino
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categories">
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-developer tools">
|
|
<i class="fas fa-tag"></i> developer tools
|
|
</a>
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-productivity">
|
|
<i class="fas fa-tag"></i> productivity
|
|
</a>
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-search">
|
|
<i class="fas fa-tag"></i> search
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="download-link-container">
|
|
<a
|
|
href="/plugins/downloadPlugin.html?plugin=io.github.personalizedrefrigerator.joplin-plugin-debug-info"
|
|
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 panel with information about the current note and an advanced search tool.</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://github.com/personalizedrefrigerator/joplin-plugin-debug-info style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
|
|
<li><a href=https://github.com/personalizedrefrigerator/joplin-plugin-debug-info style="display: block;"><i class="fa-solid fa-link"></i> Homepage</a></li>
|
|
<li>
|
|
<a
|
|
id="view-plugin-source-link"
|
|
href="/plugins/view-source.html?plugin=io.github.personalizedrefrigerator.joplin-plugin-debug-info"
|
|
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%22personalizedrefrigerator%22%20max-results%3D20" class="maintainer-link">
|
|
personalizedrefrigerator
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr><th>Version:</th><td>0.2.0</td></tr>
|
|
<tr><th>Minimum app version:</th><td>2.14</td></tr>
|
|
<tr><th>Downloads: This version:</th><td>239</td></tr>
|
|
<tr><th>Last updated:</th><td class="process--format-as-local-time">2024-06-06T17:38:25Z</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="container section" id="readme" data--is-rendered-markdown>
|
|
|
|
<h1>Joplin debug tool</h1>
|
|
<p>This plugin adds a panel that shows information about the selected notes(s). At present, this information isn't very user-friendly — it's presented roughly as fetched from Joplin's data API.</p>
|
|
<p><img src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/98ef3280-b8d2-44a4-b8d3-99b061252fab" alt="screenshot: Shows a panel with note properties including deleted_time, updated_time, and actions including delete" /></p>
|
|
<p>This plugin supports both Joplin Desktop >= 2.14 and Joplin Mobile >= 3.0.</p>
|
|
<h1>Features</h1>
|
|
<h2>Note info panel</h2>
|
|
<p>This plugin adds a "note info" panel to Joplin's UI. The panel can be hidden with the "View" > "Show/Hide note info" menu item.</p>
|
|
<p>The fields shown in the plugin are a subset of the fields <a href="https://github.com/laurent22/joplin/blob/dev/packages/lib/services/database/types.ts">stored for different items in Joplin's database</a>.</p>
|
|
<h3>Showing information for a specific note, notebook, or resource</h3>
|
|
<p>To show the information for a specific note or resource ID, click on the text box to the right of the ID header:
|
|
<img src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/f877d10d-a280-4b39-ac96-b662fa97f3b4" alt="screenshot: Box to the right of "ID" in the table header is circled" /></p>
|
|
<p>Next, paste a new ID (or note link) into the ID box. Finally, click "GO":</p>
|
|
<img src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/118a7bfc-ea9c-486a-8142-6ec53b9da555" width="340" />
|
|
<h2>Regular expression search</h2>
|
|
<p>At the bottom of the info panel is a "search" dropdown:</p>
|
|
<p><img src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/a55dc295-5884-48e6-8f25-de05170ff6a3" alt="screenshot: Arrow points to the bottom of the input panel" /></p>
|
|
<p>By default, the search tool contained in the dropdown uses a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions">regular expression</a> to search through notes' <code>title</code> and <code>body</code> fields. The fields and type of item can be customized using the options in the "Advanced" dropdown.</p>
|
|
<p>A search scans Joplin's database and results are in the order returned by Joplin's <a href="https://joplinapp.org/help/api/references/rest_api/">data API</a>.</p>
|
|
<h3>Example searches</h3>
|
|
<ul>
|
|
<li>
|
|
<p><strong>All notes with an empty body</strong>:</p>
|
|
<ul>
|
|
<li>
|
|
<img alt="" width="400" src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/7dcb3d66-8d57-4609-ae4f-3d028a5532b2" />
|
|
</li>
|
|
<li>Search field content: <code>^$</code></li>
|
|
<li>Advanced settings: <code>Notes</code> and fields: <code>body</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>All SVG resources</strong>:</p>
|
|
<ul>
|
|
<li>
|
|
<img alt="screenshot" width="400" src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/b0d67218-2caa-47fe-9d58-31bc28503237" />
|
|
</li>
|
|
<li>Search field content: <code>image/svg</code></li>
|
|
<li>Advanced settings: <code>Resources</code> and fields: <code>mime</code> (for <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types">MIME type</a>).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>All notes with nonbreaking spaces</strong>:</p>
|
|
<ul>
|
|
<li>
|
|
<img alt="screenshot" width="400" src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/45b18601-5df1-49a5-b58b-80c1218bde1d" />
|
|
</li>
|
|
<li>Search field content: <code>\u00A0</code></li>
|
|
<li>Advanced settings: <code>Notes</code> and fields: <code>body</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>Shared and/or published notes</strong>:</p>
|
|
<ul>
|
|
<li>
|
|
<img alt="screenshot" width="400" src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/a58c694c-0f57-46c6-b4f9-d949df36391c" />
|
|
</li>
|
|
<li>Search field content: <code>1</code></li>
|
|
<li>Advanced settings: <code>Notes</code> and fields: <code>is_shared</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>Notes from Joplin's webclipper</strong>:</p>
|
|
<ul>
|
|
<li>
|
|
<img alt="screenshot" width="400" src="https://github.com/personalizedrefrigerator/joplin-plugin-debug-info/assets/46334387/3a5829f8-aeb6-48ed-961a-a167c0170532" />
|
|
</li>
|
|
<li>Search field content: <code>.</code></li>
|
|
<li>Advanced settings: <code>Notes</code> and fields: <code>source_url</code>.</li>
|
|
<li><strong>Explanation</strong>: Because a <code>.</code> means "any character", this query searches for all notes with a non-empty <code>source_url</code>. The Joplin webclipper associates a <code>source_url</code> with webclipped notes.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</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="/plugins/terms-and-conditions.html">Terms and conditions</a>
|
|
<a class="link privacy" href="/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>
|
|
|