joplin - Joplin - Windows、macOS、Linux、Android、iOS の同期機能を備えたオープン ソースのメモ作成および ToDo アプリケーション。
(Joplin - an open source note taking and to-do application with synchronisation capabilities for Windows, macOS, Linux, Android and iOS.)
Joplin は2022 年 8 月 30 日に最初の Meetup を開催します。ロンドン橋の隣にあるオールド テムサイド インにぜひお越しください。
Joplinは、ノートブックに整理された多数のメモを処理できる、無料のオープン ソースのメモ作成および To Do アプリケーションです。メモは検索可能で、アプリケーションから直接、または独自のテキスト エディターからコピー、タグ付け、および変更できます。メモはMarkdown 形式です。
Evernote からエクスポートされたノートは、フォーマットされたコンテンツ (Markdown に変換される)、リソース (画像、添付ファイルなど)、完全なメタデータ (位置情報、更新時刻、作成時刻など) を含め、Joplin にインポートできます。プレーンな Markdown ファイルもインポートできます。
メモは、Nextcloud、Dropbox、OneDrive、 Joplin Cloudなどのさまざまなクラウド サービスとエンド ツー エンドの暗号化を使用して安全に同期できます。
全文検索はすべてのプラットフォームで利用でき、必要な情報をすばやく見つけることができます。アプリはプラグインとテーマを使用してカスタマイズでき、独自のアプリを簡単に作成することもできます.
このアプリケーションは、Windows、Linux、macOS、Android、および iOS で利用できます。ブラウザから Web ページとスクリーンショットを保存するためのWeb クリッパーは、 FirefoxとChromeでも利用できます。
インストール
デスクトップ用(Windows、macOS および Linux)、モバイル用(Android および iOS)、ターミナル用(Windows、macOS、Linux および FreeBSD)の 3 種類のアプリケーションが利用可能です。すべてのアプリケーションは同様のユーザー インターフェイスを備えており、相互に同期できます。
デスクトップ アプリケーション
| オペレーティング·システム | ダウンロード |
|---|---|
| Windows (32 および 64 ビット) |  |
| マックOS |  |
| Linux |  |
Windows では、 Portable バージョンも使用できます。ポータブル アプリケーションを使用すると、USB キーなどのポータブル デバイスにソフトウェアをインストールできます。その USB キーの任意のディレクトリにファイル JoplinPortable.exe をコピーするだけです。アプリケーションは、実行可能ファイルの隣に「JoplinProfile」というディレクトリを作成します。
Linuxでは、デスクトップ アイコンも処理するため、次のインストール スクリプトを使用することをお勧めします。
wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh | bash
モバイル アプリケーション
| オペレーティング·システム | ダウンロード | 代替。ダウンロード |
|---|---|---|
| アンドロイド |  |
または APK ファイルをダウンロードします: 64 ビット 32 ビット |
| iOS |  |
- |
端末アプリ
| オペレーティング·システム | 方法 |
|---|---|
| macOS、Linux、または Windows ( WSL経由) |
重要:まず、Node 12+ をインストールします。NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin デフォルトでは、アプリケーション バイナリは にインストールされ ~/.joplin-binます。必要に応じて、このディレクトリを変更できます。または、ここで説明されているように npm 権限が設定されている場合(オプション 2)、実行 npm -g install joplinするだけで機能します。 |
開始するには、 と入力し
joplinます。
使用方法については、完全なJoplin Terminal Application Documentationを参照してください。
ウェブクリッパー
Web クリッパーは、Web ページやスクリーンショットをブラウザーから保存できるようにするブラウザー拡張機能です。インストールと使用方法の詳細については、Web クリッパーのヘルプ ページを参照してください。
非公式の代替ディストリビューション
非公式の代替 Joplin ディストリビューションが多数あります。appimages やその他の公式にサポートされているリリースを使用したくない、または使用できない場合は、これらを検討することをお勧めします。
ただし、これらは公式にサポートされていないため、特定の問題がメイン プロジェクトでサポートされない可能性があるという注意事項があります。むしろ、サポート リクエスト、バグ レポート、および一般的なアドバイスは、これらのディストリビューションのメンテナに送信する必要があります。
これらのディストリビューションのコミュニティが管理するリストは、ここにあります: Unofficial Joplin distributions
スポンサー
目次
-
アプリケーション
-
サポート
-
ジョプリン・クラウド
-
Joplin API - はじめに
-
Joplin API - リファレンス
-
発達
-
Google Summer of Code 2022
-
約
特徴
- デスクトップ、モバイル、およびターミナル アプリケーション。
- Firefox および Chrome 用のWeb クリッパー。
- エンド ツー エンド暗号化 (E2EE)。
- 履歴（改訂）に注意してください。
- Nextcloud、Dropbox、WebDAV、OneDrive などのさまざまなサービスとの同期。
- 最初はオフラインであるため、インターネットに接続していなくても、デバイス上で常にデータ全体を利用できます。
- Enex ファイル (Evernote エクスポート形式) と Markdown ファイルをインポートします。
- JEX ファイル (Joplin Export 形式) と raw ファイルをエクスポートします。
- メモ、To Do、タグ、ノートブックをサポートします。
- タイトル、更新時間など、複数の基準でメモを並べ替えます。
- モバイルおよびデスクトップ アプリケーションでのアラーム (通知) のサポート。
- マークダウン ノート。デスクトップおよびモバイル アプリケーションで画像と書式設定を使用してレンダリングされます。数学表記やチェックボックスなどの追加機能のサポート。
- Markdown と Rich Text (WYSIWYG) エディターの両方の選択。
- ファイル添付のサポート - 画像が表示され、他のファイルがリンクされ、関連するアプリケーションで開くことができます。
- PDF、ビデオ、およびオーディオ ファイルのインライン表示。
- 何でも機能に移動します。
- 検索機能。
- ジオロケーションのサポート。
- 複数の言語をサポートします。
- 外部エディターのサポート - Joplin でワンクリックするだけで、お気に入りの外部エディターでメモを開くことができます。
- プラグインとデータ API による拡張可能な機能。
- レンダリングされたマークダウンと全体的なユーザー インターフェイスの両方をカスタマイズするためのカスタム CSS サポート。
- カスタマイズ可能なレイアウトにより、さまざまな要素の切り替え、移動、およびサイズ変更が可能です。
- キーボード ショートカットは編集可能で、ほとんどの Joplin コマンドをエクスポート/インポート機能にバインドできます。
- 複数のプロファイルのサポート。
輸入中
Evernote からのインポート
Joplin は Evernote の代替として設計されているため、完全な Evernote ノートブック、ノート、タグ、リソース (添付ファイル)、およびノート メタデータ (作成者、地理的位置など) を ENEX ファイル経由でインポートできます。データに関して、わずかに異なる可能性があるのは次の 2 つだけです。
-
認識データ - Evernote の画像、特にスキャン (または写真) されたドキュメントには、認識データが関連付けられています。これは、Evernote が文書内で認識できたテキストです。このデータは、メモが Joplin にインポートされるときに保持されません。ただし、検索ツールまたは Joplin の他の部分でサポートされるようになると、実際の画像がまだ利用できるため、この認識データを再生成できるはずです。
-
色、フォント サイズ、書体 - Evernote のテキストは HTML として保存され、インポート プロセス中に Markdown に変換されます。ほとんどがプレーン テキストまたは基本的な書式設定 (太字、イタリック、箇条書き、リンクなど) のメモの場合、これはロスレス変換であり、一度 HTML にレンダリングされたメモは非常に似ているはずです。テーブルもインポートされ、Markdown テーブルに変換されます。非常に複雑なメモの場合、一部の書式設定データが失われる可能性があります。特に、色、フォント サイズ、フォント フェイスがインポートされません。ただし、書式設定に関係なく、テキスト自体は常に完全にインポートされます。この余分なデータを保持することが不可欠な場合、Joplin では ENEX ファイルを HTML としてインポートすることもできます。
Evernote データをインポートするには、まずここで説明されているように、Evernote ノートブックを ENEX ファイルにエクスポートします。次に、次の手順に従います。
デスクトップ アプリケーションで、[ファイル] > [インポート] > [ENEX] を開き、ファイルを選択します。メモは新しい別のノートブックにインポートされます。必要に応じて、別のノートブックに移動したり、ノートブックの名前を変更したりできます。
ターミナル アプリケーションのコマンドライン モードで、と入力し
import /path/to/file.enexます。これにより、ファイル名にちなんで名付けられた新しいノートブックにメモがインポートされます。
Markdown ファイルからのインポート
Joplin は、プレーンな Markdown ファイルからメモをインポートできます。Markdown ファイルの完全なディレクトリまたは個々のファイルをインポートできます。
デスクトップ アプリケーションの場合:
- ファイルのインポート: [ファイル] > [インポート] > [MD - Markdown (ファイル)] に移動し、Markdown ファイルを選択します。このファイルは、現在選択されているノートブックにインポートされます。
- ディレクトリのインポート: [ファイル] > [インポート] > [MD - Markdown (ディレクトリ)] に移動し、インポートするディレクトリの最上位レベルを選択します。ディレクトリ (フォルダー) 構造は、Joplin 内の Notebook > Subnotebook > Note 構造に保持されます。
ターミナル アプリケーションのコマンドライン モードで、
import --format md /path/to/file.mdまたはと入力し
import --format md /path/to/directory/ます。
他のアプリケーションからのインポート
一般に、任意のアプリケーションからメモを Joplin にインポートする方法は、メモを ENEX ファイル (Evernote 形式) に変換し、上記の方法を使用してこれらの ENEX ファイルを Joplin にインポートすることです。ほとんどのメモ作成アプリケーションは ENEX ファイルをサポートしているため、比較的簡単です。特定のアプリケーションに関するヘルプについては、以下を参照してください。
- 標準的な注意事項:このチュートリアルを参照してください
- おてんば娘のメモ:たとえば、ここで説明されているようにメモを ENEX ファイルにエクスポートし、これらの ENEX ファイルを Joplin にインポートします。
- OneNote: まず、ノートを OneNote から Evernote にインポートします。次に、Evernote から ENEX ファイルをエクスポートし、Joplin にインポートします。
- NixNote: Evernote と同期し、ENEX ファイルをエクスポートして Joplin にインポートします。詳細については、このスレッドを参照してください。
エクスポート中
Joplin は、JEX 形式 (Joplin エクスポート ファイル) にエクスポートできます。これは、複数のメモ、ノートブックなどを含むことができる tar ファイルです。これは、すべてのメモだけでなく、地理的位置、更新時刻などのメタデータも含むロスレス形式です。 、タグなどは保存されます。この形式はバックアップ目的に便利で、Joplin に再インポートできます。「生」フォーマットも利用できます。これは、データがディレクトリに保存され、各項目が 1 つのファイルで表される点を除いて、JEX 形式と同じです。Joplin は、HTML や PDF を含む他の多くの形式にエクスポートすることもでき、単一のメモ、ノートブック、またはすべてに対して実行できます。
同期
Joplin の目標の 1 つは、特定の企業やサービス (Evernote、Google、Microsoft など) に縛られないようにすることです。そのため、同期は特定のサービスに強く依存しないように設計されています。同期プロセスのほとんどは抽象的なレベルで行われ、Nextcloud や Dropbox などの外部サービスへのアクセスは軽量ドライバーを介して行われます。ファイルシステムに似たインターフェイス、つまり項目の読み取り、書き込み、削除、一覧表示機能を提供する単純なドライバーを作成することで、新しいサービスを簡単にサポートできます。あるサービスから別のサービスに切り替えたり、一度に複数のサービスに同期することも簡単です. 各メモ、ノートブック、タグ、およびアイテム間の関係は、同期中にプレーン テキスト ファイルとして送信されます。つまり、データを別のアプリケーションに移動することもできます。
現在、Nextcloud、WebDAV、Dropbox、OneDrive、またはローカル ファイル システムとの同期が可能です。同期を有効にするには、以下の手順に従ってください。その後、アプリケーションは実行中はいつでもバックグラウンドで同期します。または、[同期] をクリックして手動で同期を開始することもできます。Joplin は、ローカル アプリケーションでコンテンツの変更が行われると、バックグラウンドで自動的に同期します。
ターミナル クライアントがインストールされている場合は、ターミナルから入力することで、ユーザー インターフェイスの外部でも同期することができます
joplin sync。これは、一定の間隔で同期するように cron スクリプトをセットアップするために使用できます。たとえば、これは 30 分ごとに実行されます。
*/30 * * * * /path/to/joplin sync
Nextcloud 同期
Nextcloudは、自己ホスト型のプライベート クラウド ソリューションです。ドキュメント、画像、ビデオだけでなく、カレンダー、パスワード、その他数え切れないほどのものを保存し、それらをラップトップや電話に同期できます. 独自の Nextcloud サーバーをホストできるため、デバイス上のデータと同期に使用されるインフラストラクチャの両方を所有できます。そのため、ジョプリンにぴったりです。プラットフォームも十分にサポートされており、強力なコミュニティがあるため、しばらくの間存在する可能性があります.とにかくオープンソースであるため、閉鎖できるサービスではなく、サーバー上に存在する限り.選択します。
デスクトップ アプリケーションまたはモバイル アプリケーションで、[構成] 画面に移動し、同期対象として [Nextcloud] を選択します。次に、WebDAV URL を入力します (これを取得するには、Nextcloud でページの左下隅にある [設定] をクリックします)。これは通常
https://example.com/nextcloud/remote.php/webdav/Joplin( Nextcloud で「Joplin」ディレクトリを作成することを確認してください)、ユーザー名とパスワードを設定します。うまくいかない場合は、こちらの説明をご覧ください。
ターミナル アプリケーションでは、
sync.targetconfig 変数とすべての
sync.5.path、
sync.5.usernameおよび
sync.5.passwordconfig 変数を、それぞれ Nextcloud WebDAV URL、ユーザー名、およびパスワードに設定する必要があります。これは、次を使用してコマンド ライン モードから実行できます。
:config sync.5.path https://example.com/nextcloud/remote.php/webdav/Joplin :config sync.5.username YOUR_USERNAME :config sync.5.password YOUR_PASSWORD :config sync.target 5
同期が機能しない場合は、アプリ プロファイル ディレクトリのログを参照してください。多くの場合、URL またはパスワードの設定が間違っていることが原因です。ログには、正確な問題が何であるかが示されているはずです。
WebDAV 同期
「WebDAV」同期ターゲットを選択し、上記の Nextcloud と同じ手順に従います (端末アプリケーションの場合、5 ではなく同期ターゲット 6 を選択する必要があります)。
Joplin で動作することが知られている WebDAV 互換サービス:
- Apache WebDAV モジュール
- ドライブHQ
- ファストメール
- ストラトのハイドライブ。セットアップのヘルプ
- Nginx WebDAV モジュール
- ネクストクラウド
- オウンクラウド
- シーファイル
- スタック
- Synology WebDAV サーバー
- WebDAV Nav、macOS サーバー。
- ジンブラ
ドロップボックスの同期
Dropbox と同期すると、Joplin は Dropbox にサブディレクトリを作成し、
/Apps/Joplinそこからメモやノートブックを読み書きします。アプリケーションは、このディレクトリ以外にはアクセスできません。
デスクトップアプリまたはモバイルアプリでは、設定画面で同期先として「Dropbox」を選択します（デフォルトで選択されています）。次に、同期プロセスを開始するには、サイドバーの [同期] ボタンをクリックし、指示に従います。
ターミナル アプリケーションで、同期プロセスを開始するには、 と入力します
:sync。リンクをたどってアプリケーションを承認するよう求められます。
OneDrive 同期
OneDrive と同期する場合、Joplin は OneDrive の /Apps/Joplin にサブディレクトリを作成し、そこからノートとノートブックを読み書きします。アプリケーションは、このディレクトリ以外にはアクセスできません。
デスクトップアプリまたはモバイルアプリの設定画面で、同期先として「OneDrive」を選択します。次に、同期プロセスを開始するには、サイドバーの [同期] ボタンをクリックし、指示に従います。
ターミナル アプリケーションで、同期プロセスを開始するには、 と入力します
:sync。リンクに従ってアプリケーションを承認するように求められます (Microsoft 資格情報を入力するだけで、OneDrive に登録する必要はありません)。
S3 同期
Joplin 2.xx の時点で、Joplin は複数の S3 プロバイダーをサポートしています。選択したプロバイダーに応じて構成する必要があるいくつかのオプションを公開します。UpCloud、AWS、Linode でテストしました。他の人も同様に機能するはずです。
デスクトップアプリまたはモバイルアプリの設定画面で、同期対象として「S3（ベータ版）」を選択します。
-
S3 バケット: 次のようなバケットの名前
joplin-bucket
-
S3 URL:完全修飾 URL。AWS の場合、これは
https://s3.amazonaws.com/
- S3 アクセス キーと S3 シークレット キー: ユーザーのプログラムによるアクセス キー。AWS で新しいキーとシークレットを作成するには、IAM Security Credentialsにアクセスしてください。他のプロバイダーについては、そのドキュメントに従ってください。
- S3 リージョン:一部のプロバイダーでは、バケットのリージョンを提供する必要があります。これは通常、地域によって「eu-west1」または同様の形式になります。地域を必要としないプロバイダーの場合は、空白のままにすることができます。
- Force Path Style : この設定により、Joplin は古いスタイルの S3 パスを使用して S3 プロバイダーと通信できます。プロバイダーによっては、これをオンまたはオフにして試す必要がある場合があります。
Joplin 用の新しいバケットを作成するときに、バケットのバージョン管理を無効にし、すべてのパブリック アクセスをブロックを有効にし、デフォルトの暗号化を有効にし
Amazon S3 key (SSE-S3)ます。一部のプロバイダーはこれらのオプションを公開していないため、同期の問題が発生する可能性があります。ドキュメントを適切に更新できるように、試して報告してください。
AWS S3 Web コンソールからバケット ポリシーを追加するには、[アクセス許可] タブに移動します。 Bucket ポリシーを編集するには、Block all public accessを一時的に無効にします。次のようになります。
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetBucketLocation",
"s3:GetObject",
"s3:DeleteObject",
"s3:DeleteObjectVersion",
"s3:PutObject"
],
"Resource": [
"arn:aws:s3:::joplin-bucket",
"arn:aws:s3:::joplin-bucket/*"
]
}
]
}
テスト済みプロバイダーの構成設定
すべてのプロバイダーには、バケット、アクセス キー、およびシークレット キーが必要です。
構成を提供し、「成功」を受け取った場合。「構成の確認」で、S3同期がプロバイダーで機能するはずです。成功しない場合は、設定を調整するか、設定を保存して、アプリを再起動し、同期を試みる必要があります。これにより、問題を推測するのに役立つ、より明確なエラー メッセージが明らかになる場合があります。
AWS
- URL: https://s3.amazonaws.com
- 地域: 必須
- フォース パス スタイル: オフ
Linode
- URL: https://.linodeobjects.com
- リージョン: 空
- フォース パス スタイル: オフ
アップクラウド
- URL: https://..upcloudobjects.com (複数の URL が提供されますが、このパターンに従う URL が機能するはずです。)
- 地域: 必須
- フォース パス スタイル: オフ
暗号化
Joplin は、すべてのアプリケーションでエンドツーエンドの暗号化 (E2EE) をサポートしています。E2EE は、メモ、ノート、タグ、またはリソースの所有者のみがそれらを読み取ることができるシステムです。これにより、潜在的な盗聴者 (通信プロバイダー、インターネット プロバイダー、さらには Joplin の開発者など) がデータにアクセスできなくなります。この機能の詳細と有効にする方法については、エンド ツー エンド暗号化のチュートリアルを参照してください。
主に開発に関連する、または使用されている方法を確認するための、より技術的な説明については、「暗号化の仕様」を参照してください。
ノート履歴
Joplin アプリケーションは、以前のバージョンのノートを定期的に自動的に保存します。これらのバージョンはデバイス間で同期され、デスクトップ アプリケーションから表示できます。これを行うには、メモの [情報] ボタンをクリックし、[このメモの以前のバージョン] をクリックします。この画面から、メモの以前のバージョンを表示したり、それらのいずれかを復元したりできます。
この機能は、[設定] 画面の [メモの履歴] セクションから無効にすることができます。また、メモの履歴を保存する期間を変更することもできます。
詳細については、メモの履歴ページをご覧ください。
外部テキスト エディタ
Joplin ノートは、選択した外部エディターを使用して開いて編集できます。Notepad++ や Sublime Text のような単純なテキスト エディターでも、Typora のような実際の Markdown エディターでもかまいません。その場合、画像もエディター内に表示されます。外部エディターでメモを開くには、ツールバーのアイコンをクリックするか、Ctrl+E (または Cmd+E) を押します。メモを開くには、デフォルトのテキスト エディタが使用されます。必要に応じて、[一般オプション] の [テキスト エディター コマンド] でエディターを直接指定することもできます。
付属品
メモにはあらゆる種類のファイルを添付できます。Markdown では、これらのファイルへのリンクは添付ファイルへの単純な ID として表されます。このリンクをクリックすると、デフォルトのアプリケーションでファイルが開きます。オーディオ、ビデオ、および PDF ファイルの場合、これらはメモと共にインラインで表示されるため、Joplin 内で表示または再生できます。
In the desktop application, files can be attached either by clicking the "Attach file" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation. You can also copy and paste images directly in the editor via Ctrl+V.
Resources that are not attached to any note will be automatically deleted in accordance to the Note History settings.
Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.
Downloading attachments
The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under "Attachment download behaviour". The default option ("Always") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option "Manual"), by clicking on it, or automatically (Option "Auto"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
Notifications
In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:
- Windows: >= 8. Make sure the Action Center is enabled on Windows. Task bar balloon for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
- macOS: >= 10.8 or Growl if earlier.
-
Linux:
notify-send
tool, delivered through packagesnotify-osd
,libnotify-bin
orlibnotify-tools
. GNOME should have this by default, but installlibnotify-tools
if using KDE Plasma.
See documentation and flow chart for reporter choice
On mobile, the alarms will be displayed using the built-in notification system.
If for any reason the notifications do not work, please open an issue.
Sub-notebooks
Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.
- In the desktop application, to create a subnotebook, drag and drop it onto another notebook. To move it back to the root, drag and drop it on the "Notebooks" header. Currently only the desktop app can be used to organise the notebooks.
- The mobile application supports displaying and collapsing/expanding the tree of notebooks, however it does not currently support moving the subnotebooks to different notebooks.
- The terminal app supports displaying the tree of subnotebooks but it does not support collapsing/expanding them or moving the subnotebooks around.
Markdown
Joplin uses and renders a Github-flavoured Markdown with a few variations and additions. In particular it adds math formula support, interactive checkboxes and support for note links. Joplin also supports Markdown plugins which allow enabling and disabling various advanced Markdown features. Have a look at the Markdown Guide for more information.
Custom CSS
Rendered markdown can be customized by placing a userstyle file in the profile directory
~/.config/joplin-desktop/userstyle.css(This path might be different on your device - check at the top of the
Generalpage of the Configuration screen for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
The whole UI can be customized by placing a custom editor style file in the profile directory
~/.config/joplin-desktop/userchrome.css.
Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.
Plugins
The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the
Pluginspage of the Configuration screen.
From this menu you can search for plugins uploaded to the Joplin plugins repository as well as manual installation of plugins using a 'Joplin Plugin Archive' (*.jpl) file.
Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
For more information see Plugins
Searching
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:
One caveat of SQLite FTS is that it does not support languages which do not use Latin word boundaries (spaces, tabs, punctuation). To solve this issue, Joplin has a custom search mode, that does not use FTS, but still has all of its features (multi term search, filters, etc.). One of its drawbacks is that it can get slow on larger note collections. Also, the sorting of the results will be less accurate, as the ranking algorithm (BM25) is, for now, only implemented for FTS. Finally, in this mode there are no restrictions on using the
*wildcard (
swim*,
*swimand
ast*rixall work). This search mode is currently enabled if one of the following languages are detected:
- Chinese
- Japanese
- Korean
- Thai
Supported queries
| Search type | Description | Example |
|---|---|---|
| Single word | Returns all the notes that contain this term. | For example, searching for catwill return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for "cat", notes that contain "cataclysmic" or "prevaricate" will not be returned. |
| Multiple word | Returns all the notes that contain all these words, but not necessarily next to each other. |
dog cat- will return any notes that contain the words "dog" and "cat" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain "dog" or "cat" only. |
| Phrase | Add double quotes to return the notes that contain exactly this phrase. |
"shopping list"- will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains "going shopping with my list". |
| Prefix | Add a wildcard to return all the notes that contain a term with a specified prefix. |
swim*- will return all the notes that contain eg. "swim", but also "swimming", "swimsuit", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix) |
| Switch to basic search | One drawback of Full Text Search is that it ignores most non-alphabetical characters. However in some cases you might want to search for this too. To do that, you can use basic search. You switch to this mode by prefixing your search with a slash /. This won't provide the benefits of FTS but it will allow searching exactly for what you need. Note that it can also be much slower, even extremely slow, depending on your query. |
/"- [ ]"- will return all the notes that contain unchecked checkboxes. |
Search filters
You can also use search filters to further restrict the search.
| Operator | Description | Example |
|---|---|---|
| - | If placed before a text term, it excludes the notes that contain that term. You can also place it before a filter to negate it. |
-spamsearches for all notes without the word spam. office -trashsearches for all notes with the word officeand without the word trash. |
| any: | Return notes that satisfy any/all of the required conditions. any:0is the default, which means all conditions must be satisfied. |
any:1 cat dogwill return notes that have the word cator dog. any:0 cat dogwill return notes with both the words catand dog. |
|
title: body: |
Restrict your search to just the title or the body field. |
title:"hello world"searches for notes whose title contains helloand world. title:hello -body:worldsearches for notes whose title contains helloand body does not contain world. |
| tag: | Restrict the search to the notes with the specified tags. |
tag:officeタグ office を持つすべてのメモを検索します。 tag:office tag:importantoffice タグと重要タグの両方を持つすべてのメモを検索します。tagを持たず、 tag を tag:office -tag:spam持つメモを検索します。tagまたは tagを持つメモを検索します。ワイルドカードで検索します。タグ付きのすべてのメモを返します。タグのないすべてのメモを返します。 office spam any:1 tag:office tag:spam office spam tag:be*ful tag:* -tag:* |
| ノート： | 指定したノートブックに検索を制限します。 |
notebook:books booksおよびそのすべてのサブノートブック内で検索範囲を制限します。 notebook:wheel*timeワイルドカード検索を行います。 |
|
作成: 更新: 期限: |
YYYYMMDD形式で指定した日付に作成・更新されたノートを検索します。現在の日、週、月、または年を基準にして検索することもできます。 |
created:20201218は、2020 年 12 月 18 日以降に作成されたノートを返します。 は、2020 年 -updated:2020121812 月 18 日より前に更新された created:20200118 -created:20201215ノート created:202001 -created:202003を返します。 2020. updated:1997 -updated:2020は、1997 年から 2019 年の間に更新されたすべてのメモを返します created:day-2。過去 2 日間に作成されたすべてのメモを検索します。 updated:year-0現在の年に更新されたすべてのメモを検索します。 -due:day+7は、期限が迫っている、または今後 7 日以内に期限が来るすべての Todo を返します。 -due:day-55 日以上延滞しているすべての仕事を検索します。 |
| タイプ： | 検索をノートまたは todo に制限します。 |
type:noteすべてのメモ type:todoを返す すべての仕事を返す |
| 完成されました： | 検索を完了済みまたは未完了の Todo に制限します。 |
iscompleted:1完了したすべての Todo iscompleted:0を返す 未完了の Todo をすべて返す |
|
緯度: 経度: 高度: |
場所でフィルタ |
latitude:40 -latitude:50緯度 >= 40 かつ < 50 のメモを返す |
| 資源： | 添付ファイルの MIME タイプでフィルタ |
resource:image/jpegjpeg を添付してメモを返します。 -resource:application/pdfPDF を添付せずにメモを返します。 resource:image/*画像付きのメモを返します。 |
| ソース URL: | ソース URL でフィルタ |
sourceurl:https://www.google.com sourceurl:*joplinapp.orgワイルドカード検索を実行します。 |
| ID: | メモ ID でフィルタ |
id:9cbc1b4f242043a9b8a50627508bccd5指定された ID のメモを返す |
注: CLI クライアントでは、
--否定されたフィルターを使用するときに使用してクエリをエスケープする必要があります。例えば。
:search -- "-tag:tag1".
フィルターは、次の規則に従って、 and/or 接続詞によって暗黙的に接続されます。
- デフォルトでは、すべてのフィルタが「AND」で接続されています。
- このデフォルトの動作をオーバーライドするには、
any
フィルタを使用します。この場合、検索用語は代わりに「OR」で接続されます。 notebook
「OR」で接続されているフィルターには例外があります。その理由は、一度に複数のノートブックにメモを入れることができないためです。
不適切な検索フィルタは、スペルミス
nootebook:Exampleや存在しないなどのフレーズ検索として解釈され
https://joplinapp.orgます。
検索順
メモは「関連性」によってソートされます。現在、要求された用語を最も多く含むメモが一番上に表示されることを意味します。複数の用語を含むクエリの場合、用語が互いにどれだけ近いかも重要です。これは少し実験的なものであるため、予期しない結果を返す検索クエリに気付いた場合は、フォーラムで報告し、問題を再現するためにできるだけ多くの詳細を提供してください。
なんでも行く
Ctrl+Pデスクトップ アプリケーションで、またはを押しCmd+Pてノートのタイトルまたはその内容の一部を入力すると、そこにジャンプします。または#、タグ名の@後に入力するか、ノートブック名の後に入力します。
複数のプロファイルのサポート
新しいプロファイルを作成するには、[ファイル] > [プロファイルの切り替え] を開き、[新しいプロファイルの作成] を選択し、プロファイル名を入力して [OK] を押します。アプリは、この新しいプロファイルに自動的に切り替わります。これを構成できるようになりました。
以前のプロファイルに戻すには、[ファイル] > [プロファイルの切り替え] を再度開き、[既定] を選択します。
プロファイルはすべて、言語、フォント サイズ、テーマなどの特定の設定を共有することに注意してください。これは、プロファイルを切り替えるときにすべての詳細を再構成する必要がないようにするためです。同期構成などのその他の設定はプロファイルごとです。
この機能は今のところデスクトップでのみ利用可能で、比較的近いうちにモバイルに移植される予定です。
寄付
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.
Please see the donation page for information on how to support the development of Joplin.
Community
| Name | Description |
|---|---|
| Support Forum | This is the main place for general discussion about Joplin, user support, software development questions, and to discuss new features. Also where the latest beta versions are released and discussed. |
| Twitter feed | Follow us on Twitter |
| Mastodon feed | Follow us on Mastodon |
| Patreon page | The latest news are often posted there |
| Discord server | Our chat server |
| Sub-reddit | Also a good place to get help |
Contributing
Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/dev/CONTRIBUTING.md
Localisation
Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:
- Download Poedit, the translation editor, and install it.
- Download the file to be translated.
- In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change "Country" and "Language" to your own country and language.
- From then you can translate the file.
- Once it is done, please open a pull request and add the file to it.
This translation will apply to the three applications - desktop, mobile and terminal.
To update a translation, follow the same steps as above but instead of getting the .pot file, get the .po file for your language from the table below.
Current translations:
| Language | Po File | Last translator | Percent done | |
|---|---|---|---|---|
 |
Arabic | ar | Whaell O | 89% |
 |
Basque | eu | juan.abasolo@ehu.eus | 25% |
 |
Bosnian (Bosna i Hercegovina) | bs_BA | Derviš T. | 64% |
 |
Bulgarian (България) | bg_BG | 50% | |
 |
Catalan | ca | Xavi Ivars | 98% |
 |
Croatian (Hrvatska) | hr_HR | Milo Ivir | 100% |
 |
Czech (Česká republika) | cs_CZ | Michal Stanke | 86% |
 |
Dansk (Danmark) | da_DK | ERYpTION | 98% |
 |
Deutsch (Deutschland) | de_DE | MrKanister | 100% |
 |
Eesti Keel (Eesti) | et_EE | 49% | |
 |
English (United Kingdom) | en_GB | 100% | |
 |
English (United States of America) | en_US | 100% | |
 |
Español (España) | es_ES | Francisco Mora | 98% |
 |
Esperanto | eo | Marton Paulo | 28% |
 |
Finnish (Suomi) | fi_FI | mrkaato0 | 98% |
 |
Français (France) | fr_FR | Laurent Cozic | 100% |
 |
Galician (España) | gl_ES | Marcos Lans | 32% |
 |
Indonesian (Indonesia) | id_ID | eresytter | 88% |
 |
Italiano (Italia) | it_IT | Albano Battistella | 86% |
 |
Magyar (Magyarország) | hu_HU | Magyari Balázs | 86% |
 |
Nederlands (België, Belgique, Belgien) | nl_BE | 88% | |
 |
Nederlands (Nederland) | nl_NL | MHolkamp | 98% |
 |
Norwegian (Norge, Noreg) | nb_NO | Mats Estensen | 98% |
 |
Persian | fa | Kourosh Firoozbakht | 62% |
 |
Polski (Polska) | pl_PL | konhi | 81% |
 |
Português (Brasil) | pt_BR | Renato Nunes Bastos | 98% |
 |
Português (Portugal) | pt_PT | Diogo Caveiro | 81% |
 |
Română | ro | Cristi Duluta | 57% |
 |
Slovenian (Slovenija) | sl_SI | Martin Korelič | 90% |
 |
Svenska | sv | Jonatan Nyberg | 98% |
 |
Thai (ประเทศไทย) | th_TH | 41% | |
 |
Tiếng Việt | vi | 87% | |
 |
Türkçe (Türkiye) | tr_TR | Arda Kılıçdağı | 96% |
 |
Ukrainian (Україна) | uk_UA | Vyacheslav Andreykiv | 80% |
 |
Ελληνικά (Ελλάδα) | el_GR | Harris Arvanitis | 98% |
 |
Русский (Россия) | ru_RU | Sergey Segeda | 89% |
 |
српски језик (Србија) | sr_RS | 72% | |
 |
中文 (简体) | zh_CN | horaceyoung | 98% |
 |
中文 (繁體) | zh_TW | SiderealArt | 87% |
 |
日本語 (日本) | ja_JP | genneko | 100% |
 |
한국어 | ko | Ji-Hyeon Gim | 86% |
Contributors
Thank you to everyone who've contributed to Joplin's source code!
