Merge a50566472f
into 4d84c491f1
108
docs/ja/advanced.md
Normal file
|
@ -0,0 +1,108 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 高度な使用方法
|
||||||
|
|
||||||
|
## 設定ファイル
|
||||||
|
|
||||||
|
`jrnl`には、テンプレート、フォーマット、複数のジャーナルなど、設定ファイルを通
|
||||||
|
してカスタマイズできる多様なオプションがあります。詳細については[設定ファイルリ
|
||||||
|
ファレンス](./reference-config-file.md)を参照するか、以下の一般的な使用例をお読
|
||||||
|
みください。
|
||||||
|
|
||||||
|
### 複数のジャーナルファイル
|
||||||
|
|
||||||
|
[設定ファイル](./reference-config-file.md)でより多くのジャーナルを定義することで、`jrnl`を複数のジャーナル(例:`private`と`work`)で使用するように設定できます。例えば:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work: ~/work.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
`default`ジャーナルは`jrnl`を初めて起動したときに作成されます。
|
||||||
|
これで、`jrnl`の代わりに`jrnl work`を使用して`work`ジャーナルにアクセスできます。例えば:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl work at 10am: @Steveとのミーティング
|
||||||
|
jrnl work -n 3
|
||||||
|
```
|
||||||
|
|
||||||
|
これらはどちらも`~/work.txt`を使用しますが、`jrnl -n 3`は`~/journal.txt`から最後の3つのエントリーを表示します(`jrnl default -n 3`も同様です)。
|
||||||
|
|
||||||
|
各ジャーナルのデフォルトオプションを個別にオーバーライドすることもできます。
|
||||||
|
`jrnl.yaml`が以下のようになっている場合:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
encrypt: false
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
food: ~/my_recipes.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
`default`と`food`ジャーナルは暗号化されませんが、`work`ジャーナルは暗号化されます!
|
||||||
|
|
||||||
|
`jrnl.yaml`のトップレベルにあるすべてのオプションをオーバーライドできますが、少なくともそのジャーナルのジャーナルファイルを指す`journal: ...`キーを指定してください。
|
||||||
|
|
||||||
|
以下の設定例を考えてみましょう:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: vi -c startinsert
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
display_format: json
|
||||||
|
editor: code -rw
|
||||||
|
food:
|
||||||
|
display_format: markdown
|
||||||
|
journal: ~/recipes.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
`work`ジャーナルは暗号化され、デフォルトで`json`形式で出力され、VSCodeの既存のウィンドウで編集されます。同様に、`food`ジャーナルはデフォルトでmarkdown形式で出力されますが、他のすべてのデフォルト設定を使用します。
|
||||||
|
|
||||||
|
### コマンドラインから設定を変更する
|
||||||
|
|
||||||
|
現在の`jrnl`インスタンスの設定フィールドを`--config-override CONFIG_KEY CONFIG_VALUE`を使用してオーバーライドできます。ここで、`CONFIG_KEY`は有効な設定フィールドをドット表記で指定し、`CONFIG_VALUE`は希望する(有効な)オーバーライド値です。ドット表記を使用して、`colors.title`のような他のキー内のキーを変更することもできます。
|
||||||
|
|
||||||
|
複数のオーバーライドを指定するには、`--config-override`を複数回呼び出します。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
これらのオーバーライドにより、jrnl設定の**_任意の_**フィールドを変更できます。自己責任で使用してください。
|
||||||
|
|
||||||
|
#### 例
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# 高速ログ記録のために`stdin`プロンプトを使用してエントリーを作成する
|
||||||
|
jrnl --config-override editor ""
|
||||||
|
|
||||||
|
# プロジェクトのログを記録する
|
||||||
|
jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo タオルを見つける
|
||||||
|
|
||||||
|
# 複数のオーバーライドを渡す
|
||||||
|
jrnl --config-override display_format fancy --config-override linewrap 20 \
|
||||||
|
--config-override colors.title green
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代替設定の使用
|
||||||
|
|
||||||
|
現在の`jrnl`インスタンスに対して、`--config-file CONFIG_FILE_PATH`を使用して代替設定ファイルを指定できます。ここで`CONFIG_FILE_PATH`は代替`jrnl`設定ファイルへのパスです。
|
||||||
|
|
||||||
|
#### 例
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# 個人的なジャーナルエントリーに個人用設定ファイルを使用する
|
||||||
|
jrnl --config-file ~/foo/jrnl/personal-config.yaml
|
||||||
|
|
||||||
|
# 仕事関連のエントリーに代替設定ファイルを使用する
|
||||||
|
jrnl --config-file ~/foo/jrnl/work-config.yaml
|
||||||
|
|
||||||
|
# デフォルトの設定ファイルを使用する(初回実行時に作成される)
|
||||||
|
jrnl
|
||||||
|
```
|
132
docs/ja/contributing.md
Normal file
|
@ -0,0 +1,132 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# jrnlへの貢献
|
||||||
|
|
||||||
|
jrnlへの貢献を歓迎します。バグの報告、ドキュメントの改善、リリースのテスト、機能やバグに関する議論への参加、コードの作成など、さまざまな形での貢献が可能です。
|
||||||
|
|
||||||
|
## 目次
|
||||||
|
|
||||||
|
- [行動規範](#行動規範)
|
||||||
|
- [バグの報告](#バグの報告)
|
||||||
|
- [ドキュメントの編集](#ドキュメントの編集)
|
||||||
|
- [テスト](#テスト)
|
||||||
|
- [機能リクエストとアイデアの提出](#機能リクエストとアイデアの提出)
|
||||||
|
- [jrnlの開発](#開発)
|
||||||
|
|
||||||
|
## 行動規範
|
||||||
|
|
||||||
|
まず始めに、[行動規範](https://github.com/jrnl-org/jrnl/blob/develop/CODE_OF_CONDUCT.md)をお読みください。
|
||||||
|
|
||||||
|
## バグの報告
|
||||||
|
|
||||||
|
バグは[新しい問題を開く](https://github.com/jrnl-org/jrnl/issues/new/choose)ことで報告してください。できるだけ詳細に説明してください。多くのバグは特定のオペレーティングシステムやPythonのバージョンに固有のものなので、その情報も含めてください!
|
||||||
|
|
||||||
|
## ドキュメントの編集
|
||||||
|
|
||||||
|
ドキュメントにタイプミスや間違いを見つけた場合は、すぐに修正してプルリクエストを送ってください。何を変更すべきか不確かだが問題を見つけた場合は、「ドキュメントの変更」タイプで[新しい問題を開く](https://github.com/jrnl-org/jrnl/issues/new/choose)ことができます。
|
||||||
|
|
||||||
|
ドキュメントを編集するには、**develop**ブランチの`docs/*.md`ファイルを編集します。プロジェクトのルートディレクトリで`poe docs-run`を実行し、ブラウザで[localhost:8000](http://localhost:8000)にアクセスすることで結果を確認できます。
|
||||||
|
|
||||||
|
### 外部エディタとヒントとコツ
|
||||||
|
|
||||||
|
便利だと思うjrnlのコマンドラインテクニックを共有したい場合は、["ヒントとコツ"セクション](tips-and-tricks.md)に追加するとよいでしょう。特定の外部エディタとの統合に関するアドバイスは、["外部エディタ"セクション](external-editors.md)に追加できます。
|
||||||
|
|
||||||
|
## テスト
|
||||||
|
|
||||||
|
jrnlの保守作業の多くは、コーディングよりもテストに関わるものです。
|
||||||
|
|
||||||
|
jrnlの性質上、非常に機密性の高いデータを扱うため、データ損失のリスクを冒すことはできません。jrnlには包括的な自動テストスイートがありますが、ユーザーテストはこのリスクを軽減する上で極めて重要です。
|
||||||
|
|
||||||
|
### プレリリース
|
||||||
|
|
||||||
|
[プレリリースは通常のリリースと同様にPyPiを通じてデプロイされます](https://pypi.org/project/jrnl/#history)。[pipx](https://pypi.org/project/pipx/)を使用してそれらを取得し、テストすることができます。各リリースで変更された内容については[チェンジログ](https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md)を参照してください。
|
||||||
|
|
||||||
|
### プルリクエスト
|
||||||
|
|
||||||
|
gitに慣れている場合は、特定の[プルリクエスト](https://github.com/jrnl-org/jrnl/pulls)をフェッチし、自分でテストして、結果を報告してください。新機能の動作をスクリーンキャストで示すとなおよいでしょう。
|
||||||
|
|
||||||
|
### バグ報告の確認
|
||||||
|
|
||||||
|
[GitHubの問題](https://github.com/jrnl-org/jrnl/issues?q=is%3Aissue+is%3Aopen+label%3Abug)には常にオープンなバグがあり、多くは特定のOS、Pythonバージョン、またはjrnlバージョンに固有のものです。「jrnl v2.2、MacOS 10.15、Python 3.8.1で確認」といった簡単なコメントでも、バグの追跡に非常に役立ちます。
|
||||||
|
|
||||||
|
### 自動テスト
|
||||||
|
|
||||||
|
新しい自動テストの追加方法については、以下の開発セクションを参照してください。
|
||||||
|
|
||||||
|
## 機能リクエストとアイデアの提出
|
||||||
|
|
||||||
|
jrnlに対する機能リクエストやアイデアがある場合は、[新しい問題を開いて](https://github.com/jrnl-org/jrnl/issues/new/choose)機能の目的と関連するユースケースを説明してください。私たちはあなたと議論し、それがプロジェクトに適しているかどうかを決定します。
|
||||||
|
|
||||||
|
新機能について議論する際は、私たちの設計目標を念頭に置いてください。jrnlは[一つのことをうまく行う](https://en.wikipedia.org/wiki/Unix_philosophy)ことを目指しています。私たちにとって、それは以下を意味します:
|
||||||
|
|
||||||
|
- *機敏*であること
|
||||||
|
- シンプルなインターフェースを持つこと
|
||||||
|
- 機能の重複を避けること
|
||||||
|
|
||||||
|
## 開発
|
||||||
|
|
||||||
|
### 環境のセットアップ
|
||||||
|
|
||||||
|
jrnlを開発するには[poetry](https://python-poetry.org/)をインストールする必要があります。poetryがプロジェクトの他のすべての依存関係を管理します。
|
||||||
|
|
||||||
|
### ブランチの理解
|
||||||
|
|
||||||
|
jrnlは主に2つのブランチを使用します:
|
||||||
|
|
||||||
|
- `develop` - 継続的な開発用
|
||||||
|
- `release` - リリース用
|
||||||
|
|
||||||
|
一般的に、プルリクエストは`develop`ブランチに対して行われるべきです。
|
||||||
|
|
||||||
|
### 一般的な開発コマンド
|
||||||
|
|
||||||
|
`pyproject.toml`にコマンドの一覧があります。ユーザーは`poe`の後にコマンド名を入力することでコマンドを実行できます([Poe the Poet](https://github.com/nat-n/poethepoet)は単独で、または`poetry install`の一部としてインストールできます)。
|
||||||
|
|
||||||
|
典型的な開発ワークフローには以下が含まれます:
|
||||||
|
|
||||||
|
- 依存関係のインストール:
|
||||||
|
- `poetry install`
|
||||||
|
- 仮想環境の有効化:
|
||||||
|
- `poetry shell`
|
||||||
|
- 仮想環境でソースを実行:
|
||||||
|
- `jrnl`(必要に応じて引数を付けて)
|
||||||
|
- テストの実行:
|
||||||
|
- `poe test`
|
||||||
|
- コードのフォーマットをスタイルに標準化:
|
||||||
|
- `poe format`
|
||||||
|
|
||||||
|
### 自動テストの更新
|
||||||
|
|
||||||
|
バグの解決や新機能の追加時には、将来その機能が壊れるのを防ぐためにテストを追加してください。テストでカバーされていない機能に気づいた場合は、テストのみのプルリクエストを提出することもできます。
|
||||||
|
|
||||||
|
テストには、ユニットテスト用に[pytest](https://docs.pytest.org)を、統合テスト用に[pytest-bdd](https://pytest-bdd.readthedocs.io/)を使用しています。すべてのテストは`tests`フォルダーにあります。
|
||||||
|
|
||||||
|
多くのテストは、他のテストと同じフォーマットの`*.feature`ファイルを編集するだけで作成できます。より複雑な機能については、`tests/lib/`にステップを実装し、それを`feature`ファイルのテストで実行する必要があるかもしれません。
|
||||||
|
|
||||||
|
### プルリクエストの提出
|
||||||
|
|
||||||
|
準備ができたら、プルリクエスト(PR)を提出してください。jrnlのメンテナーは通常2週間ごとにプルリクエストをレビューしますが、継続的統合パイプラインは数分以内にあなたのコードに対して自動テストを実行し、さまざまな環境で見つかった問題を報告します。
|
||||||
|
|
||||||
|
プルリクエストのテンプレートにはハウスキーピング項目のチェックリストが含まれています。提出時に必要に応じてそれらを記入してください。
|
||||||
|
|
||||||
|
プルリクエストにテスト失敗が含まれている場合、おそらくレビューされず、確実に承認されません。ただし、テスト失敗の解決に助けが必要な場合は、PRでその旨を言及してください。
|
||||||
|
|
||||||
|
### 作業対象を見つける
|
||||||
|
|
||||||
|
[jrnlのGitHub Issues](https://github.com/jrnl-org/jrnl/issues)を[ラベル](https://github.com/jrnl-org/jrnl/labels)で検索して、作業対象を見つけることができます。以下は検索する価値のあるラベルです:
|
||||||
|
|
||||||
|
- [critical](https://github.com/jrnl-org/jrnl/labels/critical)
|
||||||
|
- [help wanted](https://github.com/jrnl-org/jrnl/labels/help%20wanted)
|
||||||
|
- [bug](https://github.com/jrnl-org/jrnl/labels/bug)
|
||||||
|
- [enhancement](https://github.com/jrnl-org/jrnl/labels/enhancement)
|
||||||
|
|
||||||
|
[マイルストーン](https://github.com/jrnl-org/jrnl/milestones)をレビューして、プロジェクトの優先事項を把握することもできます。
|
||||||
|
|
||||||
|
### 新しいプログラマーとPythonを初めて使うプログラマーへの注意
|
||||||
|
|
||||||
|
jrnlは発足以来かなり成長しましたが、全体的な複雑さ(エンドユーザープログラムとしては)は比較的低く、コードを理解しやすいと思います。
|
||||||
|
|
||||||
|
質問がある場合は、遠慮なく聞いてください!Pythonは初心者プログラマーを歓迎し、オープンなコミュニティとして知られています。コードをフォークして自由に試してみてください!私たちと共有したいものを作成した場合は、プルリクエストを作成してください。プルリクエストが完璧で、慣用的で、すぐにマージできるコードであることは期待していません。一緒に取り組んでいきましょう!
|
150
docs/ja/encryption.md
Normal file
|
@ -0,0 +1,150 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 暗号化
|
||||||
|
|
||||||
|
## セキュリティに関する注意
|
||||||
|
|
||||||
|
`jrnl`はベストプラクティスに従っていますが、現実世界で完全なセキュリティを実現することは不可能です。あなたの`jrnl`データを少なくとも部分的に侵害する方法はいくつかあります。詳細については、[プライバシーとセキュリティ](./privacy-and-security.md)のページを参照してください。
|
||||||
|
|
||||||
|
## 暗号化と復号化
|
||||||
|
|
||||||
|
既存のプレーンテキストのジャーナルファイルは、`--encrypt`コマンドを使用して暗号化できます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --encrypt [ファイル名]
|
||||||
|
```
|
||||||
|
|
||||||
|
その後、新しいパスワードを入力すると、暗号化されていないファイルが新しい暗号化されたファイルに置き換えられます。
|
||||||
|
|
||||||
|
このコマンドは、既に暗号化されているジャーナルファイルのパスワードを変更する際にも機能します。`jrnl`は現在のパスワードと新しいパスワードの入力を求めます。
|
||||||
|
|
||||||
|
逆に、
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --decrypt [ファイル名]
|
||||||
|
```
|
||||||
|
|
||||||
|
は暗号化されたジャーナルファイルをプレーンテキストファイルに置き換えます。また、ファイル名を指定することもできます(例:`jrnl --decrypt plain_text_copy.txt`)。これにより、元の暗号化されたファイルはそのままで、その隣に新しいプレーンテキストファイルが作成されます。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
[設定ファイル](./reference-config-file.md)の`encrypt`を別の値に変更しても、
|
||||||
|
ジャーナルファイルの暗号化や復号化は行われません。それはただ、あなたの
|
||||||
|
ジャーナルが暗号化されているかどうかを示すだけです。したがって、この
|
||||||
|
オプションを手動で変更すると、ほとんどの場合、ジャーナルファイルを
|
||||||
|
ロードできなくなります。そのため、上記のコマンドが必要になります。
|
||||||
|
|
||||||
|
## パスワードをキーチェーンに保存する
|
||||||
|
|
||||||
|
誰も`jrnl`のパスワードを回復またはリセットすることはできません。パスワードを失うと、
|
||||||
|
あなたのデータに永久にアクセスできなくなります。
|
||||||
|
|
||||||
|
このため、ジャーナルを暗号化する際、`jrnl`はパスワードをシステムのキーチェーンに
|
||||||
|
保存するかどうかを尋ねます。追加の利点として、ジャーナルファイルとやり取りする際に
|
||||||
|
パスワードを入力する必要がなくなります。
|
||||||
|
|
||||||
|
最初にパスワードをキーチェーンに保存しなかったが、後で保存することにした場合
|
||||||
|
(または、あるコンピューターのキーチェーンには保存したいが、別のコンピューターでは
|
||||||
|
保存したくない場合)、暗号化されたジャーナルに対して`jrnl --encrypt`を実行し、
|
||||||
|
同じパスワードを再度使用することができます。これによりキーチェーン保存のプロンプトが
|
||||||
|
トリガーされます。
|
||||||
|
|
||||||
|
## 手動復号化
|
||||||
|
|
||||||
|
ジャーナルを復号化する最も簡単な方法は`jrnl --decrypt`を使用することですが、
|
||||||
|
必要に応じてジャーナルを手動で復号化することもできます。これを行うには、
|
||||||
|
AESアルゴリズム(特にAES-CBC)をサポートする任意のプログラムを使用できます。
|
||||||
|
復号化には以下の関連情報が必要です:
|
||||||
|
|
||||||
|
- **キー:** 暗号化に使用されるキーは、パスワードの
|
||||||
|
[SHA-256](https://en.wikipedia.org/wiki/SHA-2)ハッシュです。
|
||||||
|
- **初期化ベクトル(IV):** IVは暗号化されたジャーナルファイルの最初の16バイトに
|
||||||
|
保存されています。
|
||||||
|
- **ジャーナルの実際のテキスト**(暗号化されたジャーナルファイルの最初の16バイト
|
||||||
|
以降のすべて)は[UTF-8](https://en.wikipedia.org/wiki/UTF-8)でエンコードされ、
|
||||||
|
暗号化される前に[PKCS#7](https://en.wikipedia.org/wiki/PKCS_7)に従って
|
||||||
|
パディングされます。
|
||||||
|
|
||||||
|
スクリプト形式でどのように見えるかの例が必要な場合は、以下にジャーナルを手動で
|
||||||
|
復号化するのに使用できるPythonスクリプトの例をいくつか示します。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
これらは単なる例であり、`jrnl`が存在しなくなっても、ジャーナルファイルが
|
||||||
|
まだ復元可能であることを示すためにここにあります。可能な場合は
|
||||||
|
`jrnl --decrypt`を使用してください。
|
||||||
|
|
||||||
|
**jrnl v2ファイルの例**:
|
||||||
|
|
||||||
|
```python
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
jrnl v2の暗号化されたジャーナルを復号化します。
|
||||||
|
|
||||||
|
注意:`cryptography`モジュールがインストールされている必要があります
|
||||||
|
(`pip3 install crytography`のようなコマンドでインストールできます)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import getpass
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from cryptography.fernet import Fernet
|
||||||
|
from cryptography.hazmat.backends import default_backend
|
||||||
|
from cryptography.hazmat.primitives import hashes
|
||||||
|
from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
|
||||||
|
|
||||||
|
filepath = input("ジャーナルファイルのパス: ")
|
||||||
|
password = getpass.getpass("パスワード: ")
|
||||||
|
|
||||||
|
with open(Path(filepath), "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
password = password.encode("utf-8")
|
||||||
|
kdf = PBKDF2HMAC(
|
||||||
|
algorithm=hashes.SHA256(),
|
||||||
|
length=32,
|
||||||
|
salt=b"\xf2\xd5q\x0e\xc1\x8d.\xde\xdc\x8e6t\x89\x04\xce\xf8",
|
||||||
|
iterations=100_000,
|
||||||
|
backend=default_backend(),
|
||||||
|
)
|
||||||
|
|
||||||
|
key = base64.urlsafe_b64encode(kdf.derive(password))
|
||||||
|
|
||||||
|
print(Fernet(key).decrypt(ciphertext).decode("utf-8"))
|
||||||
|
```
|
||||||
|
|
||||||
|
**jrnl v1ファイルの例**:
|
||||||
|
|
||||||
|
```python
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
jrnl v1の暗号化されたジャーナルを復号化します。
|
||||||
|
|
||||||
|
注意:`pycrypto`モジュールがインストールされている必要があります
|
||||||
|
(`pip3 install pycrypto`のようなコマンドでインストールできます)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import getpass
|
||||||
|
import hashlib
|
||||||
|
|
||||||
|
from Crypto.Cipher import AES
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument("filepath", help="復号化するジャーナルファイル")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
pwd = getpass.getpass()
|
||||||
|
key = hashlib.sha256(pwd.encode("utf-8")).digest()
|
||||||
|
|
||||||
|
with open(args.filepath, "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
|
||||||
|
plain = crypto.decrypt(ciphertext[16:])
|
||||||
|
plain = plain.strip(plain[-1:])
|
||||||
|
plain = plain.decode("utf-8")
|
||||||
|
print(plain)
|
||||||
|
```
|
113
docs/ja/external-editors.md
Normal file
|
@ -0,0 +1,113 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 外部エディタ
|
||||||
|
|
||||||
|
お好みの外部エディタを設定するには、[設定ファイル](./reference-config-file.md#editor)の`editor`オプションを更新してください。エディタがオペレーティングシステムの`PATH`環境変数に含まれていない場合は、エディタのフルパスを入力する必要があります。
|
||||||
|
|
||||||
|
設定が完了したら、`jrnl`コマンドを単独で使用して、エディタで新しいドキュメントとしてエントリーを作成できます:
|
||||||
|
|
||||||
|
```text
|
||||||
|
jrnl
|
||||||
|
```
|
||||||
|
|
||||||
|
ドキュメントの最初の行に、通常通りエントリーの時間とタイトルを指定できます。
|
||||||
|
|
||||||
|
クイックエントリーを含めることで、エディタをスキップすることもできます:
|
||||||
|
|
||||||
|
```text
|
||||||
|
jrnl yesterday: All my troubles seemed so far away.
|
||||||
|
```
|
||||||
|
|
||||||
|
コマンドラインでエントリーを開始し、選択したエディタで書き続けたい場合は、`--edit`フラグを使用します。例:
|
||||||
|
|
||||||
|
```text
|
||||||
|
jrnl yesterday: All my troubles seemed so far away. --edit
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
エントリーの編集を保存してログに記録するには、ファイルを保存して閉じてください。
|
||||||
|
|
||||||
|
jrnlで動作するには、すべてのエディタが[ブロッキングプロセス](<https://en.wikipedia.org/wiki/Blocking_(computing)>)である必要があります。[micro](https://micro-editor.github.io/)のような一部のエディタはデフォルトでブロッキングですが、他のエディタは以下に記載されているような追加の引数でブロッキングにすることができます。jrnlがエディタを開いても即座に実行が終了する場合、そのエディタはブロッキングプロセスではありません。以下の提案のいずれかで修正できる可能性があります。
|
||||||
|
|
||||||
|
エディタが機密情報を漏洩する可能性とそのリスクを軽減する方法については、[このセクション](./privacy-and-security.md#editor-history)を参照してください。
|
||||||
|
|
||||||
|
## Sublime Text
|
||||||
|
|
||||||
|
[Sublime Text](https://www.sublimetext.com/)を使用するには、Sublime Textのコマンドラインツールをインストールし、`jrnl.yaml`を以下のように設定します:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "subl -w"
|
||||||
|
```
|
||||||
|
|
||||||
|
`-w`フラグは、jrnlがSublime Textがファイルを閉じるのを待ってからジャーナルに書き込むようにするためのものです。
|
||||||
|
|
||||||
|
## Visual Studio Code
|
||||||
|
|
||||||
|
[Visual Studio Code](https://code.visualstudio.com)も、プロセスがファイルを閉じるまで待機するように指示するフラグが必要です:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "code --wait"
|
||||||
|
```
|
||||||
|
|
||||||
|
Windowsでは、`code`はデフォルトでパスに追加されていないので、`code.exe`ファイルのフルパスを入力するか、`PATH`変数に追加する必要があります。
|
||||||
|
|
||||||
|
## MacVim
|
||||||
|
|
||||||
|
Sublime Textと同様に、MacVimもプロセスがファイルを閉じるまで待機してからジャーナルに制御を戻すように指示するフラグで起動する必要があります。MacVimの場合、このフラグは`-f`です:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "mvim -f"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Vim/Neovim
|
||||||
|
|
||||||
|
Linuxでエディタとしてvimの派生版を使用するには、単純に`editor`を実行ファイルに設定します:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "vim"
|
||||||
|
# または
|
||||||
|
editor: "nvim"
|
||||||
|
```
|
||||||
|
|
||||||
|
## iA Writer
|
||||||
|
|
||||||
|
OS Xでは、素晴らしい[iA Writer](http://www.iawriter.com/mac)を使用してエントリーを書くことができます。`jrnl.yaml`を以下のように設定してください:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "open -b pro.writer.mac -Wn"
|
||||||
|
```
|
||||||
|
|
||||||
|
これは何をしているのでしょうか?`open -b ...`は、バンドル識別子(すべてのアプリに固有の文字列)で識別されるアプリケーションを使用してファイルを開きます。`-Wn`は、制御を戻す前にアプリケーションが閉じるまで待つこと、およびアプリケーションの新しいインスタンスを使用することをアプリケーションに指示します。
|
||||||
|
|
||||||
|
システムで`pro.writer.mac`バンドル識別子が見つからない場合は、シェルでiA Writerの`Info.plist`ファイルを調べることで、使用する正しい文字列を見つけることができます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
|
||||||
|
```
|
||||||
|
|
||||||
|
## Windows上のNotepad++
|
||||||
|
|
||||||
|
[Notepad++](http://notepad-plus-plus.org/)をエディタとして設定するには、`jrnl`の設定ファイル(`jrnl.yaml`)を以下のように編集します:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession"
|
||||||
|
```
|
||||||
|
|
||||||
|
二重のバックスラッシュは、`jrnl`がファイルパスを正しく読み取るために必要です。`-multiInst -nosession`オプションにより、`jrnl`は独自のNotepad++ウィンドウを開きます。
|
||||||
|
|
||||||
|
## emacs
|
||||||
|
|
||||||
|
`emacs`をエディタとして使用するには、`jrnl`の設定ファイル(`jrnl.yaml`)を以下のように編集します:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: emacsclient -a "" -c
|
||||||
|
```
|
||||||
|
|
||||||
|
メッセージの編集が終わったら、保存して`C-x #`でバッファを閉じ、emacsclientプロセスを停止します。
|
||||||
|
|
||||||
|
## その他のエディタ
|
||||||
|
|
||||||
|
他のエディタを使用していて、共有したい場合は、[ドキュメントの貢献](./contributing.md#editing-documentation)を自由に行ってください。
|
328
docs/ja/formats.md
Normal file
|
@ -0,0 +1,328 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# フォーマット
|
||||||
|
|
||||||
|
`jrnl`は様々な代替フォーマットをサポートしています。これらは、ジャーナルを`jrnl`のデフォルトとは異なる方法で表示したり、ジャーナルからのデータを他のプログラムにパイプして報告書を作成したり、`jrnl`のデータを好きなように使用したりするのに利用できます。
|
||||||
|
|
||||||
|
これらのフォーマットはいずれも検索と組み合わせて使用でき(例:`jrnl -contains "lorem ipsum" --format json`)、検索結果を指定されたフォーマットで表示したり、単独で使用して(例:`jrnl --format json`)選択されたジャーナルのすべてのエントリーを表示したりできます。
|
||||||
|
|
||||||
|
このページでは、すべての組み込みフォーマットの例を示していますが、`jrnl`はプラグインを通じてさらにフォーマットを追加することをサポートしているため、システムによってはさらに多くのフォーマットが利用可能な場合があります。システムで利用可能なフォーマットのリストについては、`jrnl --help`を参照してください。
|
||||||
|
|
||||||
|
これらのフォーマットはどれも互換性があり、以下では便宜上「表示」、「データ」、「レポート」フォーマットにグループ分けしているだけです。
|
||||||
|
|
||||||
|
## 表示フォーマット
|
||||||
|
|
||||||
|
これらのフォーマットは主にターミナルでジャーナルを表示することを目的としています。それでも、他のフォーマットと同じように使用できます(選択すればファイルに書き込むこともできます)。
|
||||||
|
|
||||||
|
### Pretty
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format pretty
|
||||||
|
# または
|
||||||
|
jrnl -1 # 任意の検索
|
||||||
|
```
|
||||||
|
|
||||||
|
これは`jrnl`のデフォルトフォーマットです。`--format`が指定されていない場合、`pretty`が使用されます。
|
||||||
|
|
||||||
|
各エントリーのタイムスタンプをユーザー設定に従ってフォーマットし、同じ行にタイトルを表示します。その後、エントリーの本文が下に表示されます。
|
||||||
|
|
||||||
|
このフォーマットは、設定ファイルの以下の値を通じて設定可能です(詳細は[Advanced Usage](./advanced.md)を参照):
|
||||||
|
|
||||||
|
- `colors`
|
||||||
|
- `body`
|
||||||
|
- `date`
|
||||||
|
- `tags`
|
||||||
|
- `title`
|
||||||
|
- `indent_character`
|
||||||
|
- `linewrap`
|
||||||
|
- `timeformat`
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
| これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
| これは2番目のサンプルエントリーの本文テキストですが、
|
||||||
|
| これには@tagがあります。
|
||||||
|
|
||||||
|
2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
| これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
```
|
||||||
|
|
||||||
|
### Short
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format short
|
||||||
|
# または
|
||||||
|
jrnl --short
|
||||||
|
```
|
||||||
|
|
||||||
|
これはエントリーを短縮して、日付とタイトルのみを表示します。本質的には`pretty`フォーマットから各エントリーの本文を除いたものです。長いジャーナルエントリーがあり、検索に一致するエントリーのリストのみを表示したい場合に便利です。
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
```
|
||||||
|
|
||||||
|
### Fancy (または Boxed)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format fancy
|
||||||
|
# または
|
||||||
|
jrnl --format boxed
|
||||||
|
```
|
||||||
|
|
||||||
|
このフォーマットは各エントリーを枠線で囲みます。これにより、各エントリーの開始と終了がわかりやすくなります。フォーマットがいかに自由形式であるかを示す例であり、また、そういったものが好きな人にとっては~_~ファンシー~_~に見えるかもしれません。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
日本語の場合、文字幅の問題でボックスが崩れてしまうようです。
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-06-28 18:22
|
||||||
|
┃ これは最初のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは最初のサンプルエントリーの本文テキストです。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-01 20:00
|
||||||
|
┃ これは2番目のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-02 09:00
|
||||||
|
┃ これは3番目のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは3番目のサンプルエントリーの本文テキストです。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## データフォーマット
|
||||||
|
|
||||||
|
これらのフォーマットは主に、ジャーナルを他のプログラムにパイプしたりエクスポートしたりすることを目的としています。それでも、他のフォーマットと同じように使用できます(必要に応じてファイルに書き込んだり、ターミナルに表示したりできます)。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
これらのフォーマットを使用する際に「2つのエントリーが見つかりました」のようなメッセージボックスが表示されることがありますが、これらのメッセージは`stdout`ではなく`stderr`に書き込まれるため、`|`演算子を使用してパイプする際には含まれません。
|
||||||
|
|
||||||
|
### JSON
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format json
|
||||||
|
```
|
||||||
|
|
||||||
|
JSONは多くのプログラムで使用される非常に便利なフォーマットで、ほぼすべてのプログラミング言語でサポートされています。JSONデータでできることは多岐にわたります。例えば、`jq`([プロジェクトページ](https://github.com/stedolan/jq))を使用してジャーナルのフィールドをフィルタリングすることができます。
|
||||||
|
以下のように:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ j -3 --format json | jq '.entries[].date' jrnl-GFqVlfgP-py3.8
|
||||||
|
"2020-06-28"
|
||||||
|
"2020-07-01"
|
||||||
|
"2020-07-02"
|
||||||
|
```
|
||||||
|
|
||||||
|
あるいは、ジャーナルの[美しいタイムライン](http://timeline.knightlab.com/)を作成するのはどうでしょうか?
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"tags": {
|
||||||
|
"@tag": 1
|
||||||
|
},
|
||||||
|
"entries": [
|
||||||
|
{
|
||||||
|
"title": "これは最初のサンプルエントリーです",
|
||||||
|
"body": "これは最初のサンプルエントリーの本文テキストです。",
|
||||||
|
"date": "2020-06-28",
|
||||||
|
"time": "18:22",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "これは2番目のサンプルエントリーです",
|
||||||
|
"body": "これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。",
|
||||||
|
"date": "2020-07-01",
|
||||||
|
"time": "20:00",
|
||||||
|
"tags": ["@tag"],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "これは3番目のサンプルエントリーです",
|
||||||
|
"body": "これは3番目のサンプルエントリーの本文テキストです。",
|
||||||
|
"date": "2020-07-02",
|
||||||
|
"time": "09:00",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Markdown
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format markdown
|
||||||
|
# または
|
||||||
|
jrnl --format md
|
||||||
|
```
|
||||||
|
|
||||||
|
Markdownは人間が読みやすく、他のフォーマット(html、pdf)にレンダリングできるシンプルなマークアップ言語です。例えば、`jrnl`の[README](https://github.com/jrnl-org/jrnl/blob/develop/README.md)はmarkdownでフォーマットされており、Githubが一部のフォーマットを追加して見栄えを良くしています。
|
||||||
|
|
||||||
|
markdownフォーマットはエントリーを日付でグループ化し(まず年、次に月)、必要に応じてヘッダーマーキング(例:`#`、`##`など)を追加します。すでにジャーナルにmarkdownのヘッダーマーキングがある場合、これらの新しいヘッダーの下に適合するように必要に応じて増加します(つまり、`#`は`##`になります)。
|
||||||
|
|
||||||
|
このフォーマットは、例えば、ジャーナルをmarkdownからhtmlに変換するプログラムにエクスポートして、ジャーナルからウェブサイトやブログを作成するのに非常に便利です。
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# 2020
|
||||||
|
|
||||||
|
## 6月
|
||||||
|
|
||||||
|
### 2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
|
||||||
|
これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
## 7月
|
||||||
|
|
||||||
|
### 2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
|
||||||
|
### 2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
|
||||||
|
これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
```
|
||||||
|
|
||||||
|
### プレーンテキスト
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format text
|
||||||
|
# または
|
||||||
|
jrnl --format txt
|
||||||
|
```
|
||||||
|
|
||||||
|
これは、`jrnl`がジャーナルをディスクに保存するのに使用するのと同じプレーンテキストフォーマットでジャーナルを出力します。このフォーマットは特に`jrnl`内でのジャーナルのインポートとエクスポートに便利です。
|
||||||
|
|
||||||
|
例えば、あるジャーナルから別のジャーナルにエントリーを移動したり、別のジャーナルからの検索結果で新しいジャーナルを作成したりするのに使用できます。
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
[2020-06-28 18:22] これは最初のサンプルエントリーです
|
||||||
|
これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
[2020-07-01 20:00] これは2番目のサンプルエントリーです
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
|
||||||
|
[2020-07-02 09:00] これは3番目のサンプルエントリーです
|
||||||
|
これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
```
|
||||||
|
|
||||||
|
### XML
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format xml
|
||||||
|
```
|
||||||
|
|
||||||
|
これはジャーナルをXML形式で出力します。XMLは一般的に使用されるデータ形式で、多くのプログラムやプログラミング言語でサポートされています。
|
||||||
|
|
||||||
|
**出力例**:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<?xml version="1.0" ?>
|
||||||
|
<journal>
|
||||||
|
<entries>
|
||||||
|
<entry date="2020-06-28T18:22:00" starred="">これは最初のサンプルエントリーです これは最初のサンプルエントリーの本文テキストです。</entry>
|
||||||
|
<entry date="2020-07-01T20:00:00" starred="">これは2番目のサンプルエントリーです これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。</entry>
|
||||||
|
<entry date="2020-07-02T09:00:00" starred="">これは3番目のサンプルエントリーです これは3番目のサンプルエントリーの本文テキストです。</entry>
|
||||||
|
</entries>
|
||||||
|
<tags>
|
||||||
|
<tag name="@tag">1</tag>
|
||||||
|
</tags>
|
||||||
|
</journal>
|
||||||
|
```
|
||||||
|
|
||||||
|
### YAML
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format yaml --file 'my_directory/'
|
||||||
|
```
|
||||||
|
|
||||||
|
これはジャーナルをYAML形式で出力します。YAMLは一般的に使用されるデータ形式で、多くのプログラムやプログラミング言語でサポートされています。[ディレクトリへのエクスポート](#ディレクトリへのエクスポート)は唯一サポートされているYAMLエクスポートオプションであり、各エントリーは別々のファイルに書き込まれます。
|
||||||
|
|
||||||
|
**ファイル例**:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
title: これは2番目のサンプルエントリーです
|
||||||
|
date: 2020-07-01 20:00
|
||||||
|
starred: False
|
||||||
|
tags: tag
|
||||||
|
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
```
|
||||||
|
|
||||||
|
## レポートフォーマット
|
||||||
|
|
||||||
|
フォーマットはジャーナルデータを使用して異なる方法で表示するため、レポートの作成にも使用できます。
|
||||||
|
|
||||||
|
### タグ
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format tags
|
||||||
|
# または
|
||||||
|
jrnl --tags
|
||||||
|
```
|
||||||
|
|
||||||
|
このフォーマットは、フォーマットがどのようにレポート作成に使用できるかの簡単な例です。ジャーナル内(または検索結果内)の各タグと、そのタグが出現するエントリーの数を表示し、頻度順にソートします。
|
||||||
|
|
||||||
|
出力例:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
@one : 32
|
||||||
|
@two : 17
|
||||||
|
@three : 4
|
||||||
|
```
|
||||||
|
|
||||||
|
## オプション
|
||||||
|
|
||||||
|
### `--file`を使用したエクスポート
|
||||||
|
|
||||||
|
例: `jrnl --format json --file /some/path/to/a/file.txt`
|
||||||
|
|
||||||
|
デフォルトでは、`jrnl`はエントリーをターミナルに出力します。しかし、`--file`とファイル名を一緒に指定すると、ターミナルに出力されるはずだった同じ出力がファイルに書き込まれます。これは出力をファイルにパイプするのと同じです。
|
||||||
|
|
||||||
|
したがって、bashの場合、以下の2つの文は同等です:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format json --file myjournal.json
|
||||||
|
```
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format json > myjournal.json
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ディレクトリへのエクスポート
|
||||||
|
|
||||||
|
`--file`引数がディレクトリの場合、jrnlは各エントリーを個別のファイルにエクスポートします:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --format yaml --file my_entries/
|
||||||
|
```
|
||||||
|
|
||||||
|
`my_entries/`の内容は次のようになります:
|
||||||
|
|
||||||
|
```output
|
||||||
|
my_entries/
|
||||||
|
|- 2013_06_03_a-beautiful-day.yaml
|
||||||
|
|- 2013_06_07_dinner-with-gabriel.yaml
|
||||||
|
|- ...
|
||||||
|
```
|
37
docs/ja/installation.md
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# はじめに
|
||||||
|
|
||||||
|
## インストール
|
||||||
|
|
||||||
|
`jrnl`をインストールする最も簡単な方法は、[Python](https://www.python.org/) 3.10以上で[pipx](https://pipx.pypa.io/stable/installation/)を使用することです:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pipx install jrnl
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! tip
|
||||||
|
`jrnl`のインストール時に`sudo`を使用しないでください。パスの問題が発生する可能性があります。
|
||||||
|
|
||||||
|
`jrnl`を初めて実行すると、ジャーナルファイルをどこに作成するか、そして暗号化するかどうかを尋ねられます。
|
||||||
|
|
||||||
|
## クイックスタート
|
||||||
|
|
||||||
|
新しいエントリーを作成するには、以下のように入力します
|
||||||
|
|
||||||
|
```text
|
||||||
|
jrnl yesterday: 病欠した。時間を使って掃除をし、本の執筆に4時間費やした。
|
||||||
|
```
|
||||||
|
|
||||||
|
そしてリターンキーを押します。`yesterday:`はタイムスタンプとして解釈されます。
|
||||||
|
最初の文章の区切り(`.?!:`)までがタイトルとして、残りが本文として解釈されます。ジャーナルファイルでは、結果は次のようになります:
|
||||||
|
|
||||||
|
```output
|
||||||
|
2012-03-29 09:00 病欠した。
|
||||||
|
時間を使って家の掃除をし、本の執筆に4時間費やした。
|
||||||
|
```
|
||||||
|
|
||||||
|
単に`jrnl`と入力すると、エントリーの作成を促されますが、外部エディタを使用するように*jrnl*を[設定する](advanced.md)こともできます。
|
68
docs/ja/journal-types.md
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# ジャーナルタイプ
|
||||||
|
|
||||||
|
`jrnl`はいくつかの異なる方法でジャーナルを保存できます:
|
||||||
|
|
||||||
|
- 単一のテキストファイル(暗号化されているかどうかにかかわらず)
|
||||||
|
- 日付ごとに整理された暗号化されていないテキストファイルを含むフォルダ構造
|
||||||
|
- DayOne Classicフォーマット
|
||||||
|
|
||||||
|
使用したいジャーナルタイプを指定する必要はありません。代わりに、
|
||||||
|
`jrnl`は[設定ファイル](advanced.md)でファイルを参照しているかフォルダを参照しているか、
|
||||||
|
そしてそれがフォルダの場合、DayOne Classicのコンテンツがそこに存在するかどうかに基づいて、
|
||||||
|
自動的にジャーナルタイプを検出します。
|
||||||
|
|
||||||
|
## 単一ファイル
|
||||||
|
|
||||||
|
単一ファイルフォーマットは最も柔軟で、[暗号化](encryption.md)することができます。
|
||||||
|
使用するには、ファイルへのパス、または既に存在しないパスを入力します。任意の拡張子を
|
||||||
|
使用できます。最初のエントリーを保存すると、`jrnl`は自動的にファイルを作成します。
|
||||||
|
|
||||||
|
## フォルダ
|
||||||
|
|
||||||
|
フォルダジャーナルフォーマットは、エントリーを年と月のサブフォルダ、そして各日の`.txt`ファイルに
|
||||||
|
整理します。1日に複数のエントリーがある場合、それらはすべて同じ`.txt`ファイルに表示されます。
|
||||||
|
|
||||||
|
ディレクトリツリー構造は以下の形式です:`YYYY/MM/DD.txt`。例えば、
|
||||||
|
`~/folderjournal`にあるフォルダジャーナルに2021年5月5日のエントリーがある場合、
|
||||||
|
次の場所に配置されます:`~/folderjournal/2021/05/05.txt`
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
新しいフォルダジャーナルの作成は2つの方法で行えます:
|
||||||
|
|
||||||
|
- `jrnl`を実行する前に、ジャーナルの名前でフォルダを作成します。そうしないと、`jrnl`を初めて実行したとき、単一ファイルジャーナルを作成していると見なされ、そのパスにファイルが作成されます。
|
||||||
|
- [設定ファイル](advanced.md)で新しいジャーナルを作成し、パスの最後に`/`(POSIXシステムのLinuxやMacOSXの場合)または`\`(Windowsシステムの場合)を付けます。フォルダが存在しない場合は自動的に作成されます。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
フォルダジャーナルは暗号化できません。
|
||||||
|
|
||||||
|
## Day One Classic
|
||||||
|
|
||||||
|
`jrnl`はDayOneで使用されていた元のデータフォーマットをサポートしています。これはフォルダ
|
||||||
|
ジャーナルフォーマットに似ていますが、以下の特徴のいずれかで識別されます:
|
||||||
|
|
||||||
|
- フォルダに`.dayone`拡張子がある
|
||||||
|
- フォルダに`entries`という名前のサブフォルダがある
|
||||||
|
|
||||||
|
これはDayOne 2.0フォーマットとは混同しないでください。[それは非常に異なります](https://help.dayoneapp.com/en/articles/1187337-day-one-classic-is-retired)。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
DayOne Classicジャーナルは暗号化できません。
|
||||||
|
|
||||||
|
## ジャーナルタイプの変更
|
||||||
|
|
||||||
|
ジャーナルの設定を単に変更してタイプを変更することはできません。代わりに、
|
||||||
|
希望するタイプの新しいジャーナルを定義し、
|
||||||
|
[パイピング](<https://en.wikipedia.org/wiki/Redirection_(computing)#Piping>)
|
||||||
|
を使用して古いジャーナルを`txt`としてエクスポートし、新しいジャーナルにインポートコマンドを実行します。
|
||||||
|
|
||||||
|
例えば、`projects`ジャーナルを`new`ジャーナルにインポートしたい場合、
|
||||||
|
`new`ジャーナルの設定を行った後、次のように実行します:
|
||||||
|
|
||||||
|
```
|
||||||
|
jrnl projects --format txt | jrnl new --import
|
||||||
|
```
|
44
docs/ja/overview.md
Normal file
|
@ -0,0 +1,44 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 概要
|
||||||
|
|
||||||
|
`jrnl`はコマンドライン用のシンプルな日記アプリケーションです。
|
||||||
|
|
||||||
|
簡単に日記エントリーの作成、検索、閲覧ができます。日記は人間が読める形式のプレーンテキストで保存され、[AES暗号化](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard)を使用して暗号化することもできます。
|
||||||
|
|
||||||
|
`jrnl`には必要な機能のほとんどが備わっており、不要な機能はほとんどありません。
|
||||||
|
|
||||||
|
## プレーンテキスト
|
||||||
|
|
||||||
|
`jrnl`は各日記をプレーンテキストで保存します。`jrnl`ファイルは任意の場所に保存でき、共有フォルダに保存してデバイス間で同期することもできます。日記ファイルはコンパクトで(数千のエントリーでも1MiB未満)、現在そして近い将来にわたってほぼすべての電子デバイスで読むことができます。
|
||||||
|
|
||||||
|
## タグ
|
||||||
|
|
||||||
|
後でエントリーを見つけやすくするために、`jrnl`はインラインタグをサポートしています(デフォルトのタグ記号は`@`です)。タグを他の検索条件と組み合わせて、エントリーを検索およびフィルタリングできます。
|
||||||
|
|
||||||
|
## 複数の日記のサポート
|
||||||
|
|
||||||
|
`jrnl`は複数の日記の作成をサポートしており、各日記は単一のファイルまたは一連のファイルとして保存できます。エントリーは人間が読める形式で自動的にタイムスタンプが付けられ、複数のエントリーを一度に簡単に閲覧できます。`jrnl`は必要なエントリーを簡単に見つけ出し、読んだり編集したりすることができます。
|
||||||
|
|
||||||
|
## 外部エディタのサポート
|
||||||
|
|
||||||
|
`jrnl`はお気に入りのテキストエディタと上手く連携します。エディタで日記エントリーを書くことを好む場合や、より包括的なアプリケーションを必要とする変更を加えたい場合があるかもしれません。`jrnl`は特定のエントリーをフィルタリングし、選択した[外部エディタ](./external-editors.md)に渡すことができます。
|
||||||
|
|
||||||
|
## 暗号化
|
||||||
|
|
||||||
|
`jrnl`は[AES暗号化](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard)をサポートしています。詳細については[暗号化ページ](./encryption.md)をご覧ください。
|
||||||
|
|
||||||
|
## インポートとエクスポート
|
||||||
|
|
||||||
|
`jrnl`は他のソースからエントリーを簡単にインポートできます。既存のエントリーは様々な[フォーマット](./formats.md)でエクスポートできます。
|
||||||
|
|
||||||
|
## マルチプラットフォームサポート
|
||||||
|
|
||||||
|
`jrnl`はほとんどのオペレーティングシステムと互換性があります。様々なパッケージマネージャーを使用して[ダウンロード](./installation.md)するか、ソースからビルドすることができます。
|
||||||
|
|
||||||
|
## オープンソース
|
||||||
|
|
||||||
|
`jrnl`は[Python](https://www.python.org)で書かれており、オープンソースソフトウェア愛好家の[フレンドリーなコミュニティ](https://github.com/jrnl-org/jrnl)によって維持されています。
|
223
docs/ja/privacy-and-security.md
Normal file
|
@ -0,0 +1,223 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# プライバシーとセキュリティ
|
||||||
|
|
||||||
|
`jrnl`はプライバシーとセキュリティを念頭に置いて設計されていますが、他のプログラムと同様に、
|
||||||
|
注意すべきいくつかの制限があります。
|
||||||
|
|
||||||
|
## パスワードの強度
|
||||||
|
|
||||||
|
`jrnl`はパスワードの強度要件を強制しません。短いまたは一般的に使用されるパスワードは、
|
||||||
|
基本的なセキュリティスキルを持つ人が暗号化された`jrnl`ファイルにアクセスするのを
|
||||||
|
簡単に回避できてしまいます。
|
||||||
|
|
||||||
|
## 合理的否認
|
||||||
|
|
||||||
|
ジャーナルの内容を暗号化の層の背後に隠すことはできますが、誰かがあなたの設定ファイルに
|
||||||
|
アクセスできる場合、ジャーナルの存在、そのジャーナルファイルの場所、最後に編集した
|
||||||
|
時期を知ることができます。十分な力の不均衡がある場合、誰かが非技術的な手段を通じて
|
||||||
|
あなたに暗号化を解除させることができるかもしれません。
|
||||||
|
|
||||||
|
## スパイ行為
|
||||||
|
|
||||||
|
`jrnl`は開かれていない間のジャーナルエントリーへの不正アクセスから保護できますが、
|
||||||
|
安全でないコンピューター/場所からは保護できません。例えば:
|
||||||
|
|
||||||
|
- 誰かがキーロガーをインストールし、ジャーナルに入力する内容を追跡する。
|
||||||
|
- 誰かがエントリーを書いている間にあなたの画面を見ている。
|
||||||
|
- 誰かが`jrnl`にバックドアをインストールしたり、ジャーナルを毒して
|
||||||
|
エントリーを明らかにするよう仕向けたりする。
|
||||||
|
|
||||||
|
## 保存されたパスワード
|
||||||
|
|
||||||
|
暗号化されたジャーナルを作成する際、「パスワードをキーチェーンに保存するか」と
|
||||||
|
尋ねられます。このキーチェーンは[Python keyringライブラリ](https://pypi.org/project/keyring/)を
|
||||||
|
使用してアクセスされ、オペレーティングシステムによって動作が異なります。
|
||||||
|
|
||||||
|
Windowsでは、キーチェーンはWindows Credential Manager(WCM)で、ロックできず、
|
||||||
|
あなたのユーザー名で実行されている他のアプリケーションからアクセスできます。
|
||||||
|
これが心配な場合は、パスワードを保存しないほうがよいかもしれません。
|
||||||
|
|
||||||
|
## シェル履歴
|
||||||
|
|
||||||
|
コマンドラインからエントリーを入力できるため、コマンドライン操作をログに記録する
|
||||||
|
ツールは潜在的なセキュリティリスクとなります。以下に、様々なシェルでこの問題に
|
||||||
|
対処する方法を示します。
|
||||||
|
|
||||||
|
### bash
|
||||||
|
|
||||||
|
`~/.bashrc`ファイルに以下の行を追加することで、jrnlの履歴ログを無効にできます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
HISTIGNORE="$HISTIGNORE:jrnl *"
|
||||||
|
```
|
||||||
|
|
||||||
|
`bash`履歴から既存の`jrnl`コマンドを削除するには、bashの履歴ファイルから
|
||||||
|
単純に削除します。このファイルのデフォルトの場所は`~/.bash_history`ですが、
|
||||||
|
必要に応じて`echo "$HISTFILE"`を実行して見つけることができます。また、
|
||||||
|
`history -c`を実行して履歴からすべてのコマンドを削除することもできます。
|
||||||
|
|
||||||
|
### zsh
|
||||||
|
|
||||||
|
`~/.zshrc`ファイルに以下を追加することで、jrnlの履歴ログを無効にできます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
setopt HIST_IGNORE_SPACE
|
||||||
|
alias jrnl=" jrnl"
|
||||||
|
```
|
||||||
|
|
||||||
|
`zsh`履歴から既存の`jrnl`コマンドを削除するには、zshの履歴ファイルから
|
||||||
|
単純に削除します。このファイルのデフォルトの場所は`~/.zsh_history`ですが、
|
||||||
|
必要に応じて`echo "$HISTFILE"`を実行して見つけることができます。また、
|
||||||
|
`history -c`を実行して履歴からすべてのコマンドを削除することもできます。
|
||||||
|
|
||||||
|
### fish
|
||||||
|
|
||||||
|
デフォルトでは、`fish`はスペースで始まるコマンドをログに記録しません。
|
||||||
|
常にjrnlの前にスペースを付けて実行したい場合は、`~/.config/fish/config.fish`
|
||||||
|
ファイルに以下を追加できます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
abbr --add jrnl " jrnl"
|
||||||
|
```
|
||||||
|
|
||||||
|
`fish`履歴から既存のjrnlコマンドを削除するには、`history delete --prefix 'jrnl '`を実行します。
|
||||||
|
|
||||||
|
### Windowsコマンドプロンプト
|
||||||
|
|
||||||
|
Windowsは履歴をディスクにログ記録しませんが、コマンドプロンプトセッションには
|
||||||
|
保持されます。ジャーナリング後、コマンドプロンプトを閉じるか`Alt`+`F7`を
|
||||||
|
押して履歴をクリアしてください。
|
||||||
|
|
||||||
|
## エディターからjrnlへの転送中のファイル
|
||||||
|
|
||||||
|
エントリーの作成や編集時、`jrnl`はエディターがジャーナルにアクセスできるよう
|
||||||
|
ディスク上に暗号化されていない一時ファイルを使用します。エディターを閉じた後、
|
||||||
|
`jrnl`はこの一時ファイルを削除します。
|
||||||
|
|
||||||
|
つまり、ジャーナルエントリーを保存したがまだエディターを閉じていない場合、
|
||||||
|
暗号化されていない一時ファイルがディスク上に残ります。この間にコンピューターが
|
||||||
|
シャットダウンしたり、`jrnl`プロセスが予期せず終了したりすると、暗号化されて
|
||||||
|
いない一時ファイルがディスク上に残ります。この問題を軽減するには、エディターを
|
||||||
|
閉じる直前にのみ保存するようにしてください。また、一時フォルダからこれらの
|
||||||
|
ファイルを手動で削除することもできます。デフォルトでは、これらは`jrnl*.jrnl`
|
||||||
|
という名前ですが、[テンプレート](reference-config-file.md#template)を使用して
|
||||||
|
いる場合は、テンプレートと同じ拡張子になります。
|
||||||
|
|
||||||
|
## エディター履歴
|
||||||
|
|
||||||
|
一部のエディターは、将来の使用のためにディスク上に使用履歴を保存します。
|
||||||
|
これは、最近の検索パターンやエディターコマンドを通じて機密情報が漏洩する
|
||||||
|
可能性があるという意味でセキュリティリスクとなる可能性があります。
|
||||||
|
|
||||||
|
### Visual Studio Code
|
||||||
|
|
||||||
|
Visual Studio Codeは、後でコンテンツを復元またはレビューできるように、
|
||||||
|
保存されたファイルの内容を保存します。すべてのファイルに対してこの機能を
|
||||||
|
無効にするには、[設定エディター](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor)で
|
||||||
|
`workbench.localHistory.enabled`設定のチェックを外します。
|
||||||
|
|
||||||
|
または、`workbench.localHistory.exclude`設定で[パターン](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options)を
|
||||||
|
設定することで、特定のファイルに対してこの機能を無効にできます。`jrnl`によって
|
||||||
|
生成される暗号化されていない一時ファイルを除外するには、[設定エディター](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor)で
|
||||||
|
`workbench.localHistory.exclude`設定に`**/jrnl*.jrnl`パターンを設定できます
|
||||||
|
([テンプレート](reference-config-file.md#template)を使用していない場合)。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
Windowsでは、履歴の場所は通常`%APPDATA%\Code\User\History`にあります。
|
||||||
|
|
||||||
|
Visual Studio Codeは、開いているすべての未保存ファイルのコピーも作成します。
|
||||||
|
これらのコピーはバックアップ場所に保存され、ファイルを保存すると自動的に
|
||||||
|
クリーンアップされます。ただし、ファイルを保存する前にコンピューターが
|
||||||
|
シャットダウンしたり、Visual Studio Codeプロセスが予期せず停止したりすると、
|
||||||
|
暗号化されていない一時ファイルがディスク上に残る可能性があります。これらの
|
||||||
|
ファイルはバックアップ場所から手動で削除できます。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
Windowsでは、バックアップ場所は通常`%APPDATA%\Code\Backups`にあります。
|
||||||
|
|
||||||
|
### Vim
|
||||||
|
|
||||||
|
Vimは`~/.viminfo`にある所謂Viminfoファイルに進捗データを保存します。
|
||||||
|
これにはコマンドライン履歴、検索文字列履歴、検索/置換パターン、レジスタの
|
||||||
|
内容など、あらゆる種類のユーザーデータが含まれています。また、予期せぬ
|
||||||
|
アプリケーションの終了後に開いていたファイルを復元できるよう、Vimはスワップ
|
||||||
|
ファイルを使用します。
|
||||||
|
|
||||||
|
これらのオプションや他の情報漏洩の可能性のある機能は、Jrnl設定の`editor`キーを
|
||||||
|
以下のように設定することで無効にできます:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "vim -c 'set viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
```
|
||||||
|
|
||||||
|
すべてのプラグインとカスタム設定を無効にし、デフォルト設定でVimを起動するには、
|
||||||
|
コマンドラインで`-u NONE`を渡すこともできます。これにより、悪意のあるプラグインや
|
||||||
|
その他の検出が困難な情報漏洩が確実に排除されます。ただし、これによりエディター
|
||||||
|
の使用感が大幅に低下します。
|
||||||
|
|
||||||
|
代わりに、Jrnlファイルが編集されているときに自動的に検出するようVimに設定するには、
|
||||||
|
autocommandを使用できます。これを`~/.vimrc`に配置します:
|
||||||
|
|
||||||
|
```vim
|
||||||
|
autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
[テンプレート](reference-config-file.md#template)を使用している場合は、
|
||||||
|
`.jrnl`の代わりにテンプレートのファイル拡張子を使用する必要があります。
|
||||||
|
|
||||||
|
言及したオプションの詳細については、Vimで`:h <option>`を参照してください。
|
||||||
|
|
||||||
|
### Neovim
|
||||||
|
|
||||||
|
Neovimは主にVimと互換性があるよう努めており、そのためVimと同様の機能を
|
||||||
|
持っています。Neovimの1つの違いは、Viminfoファイルの代わりにShaDa
|
||||||
|
("shared data")ファイルと呼ばれるものが`~/.local/state/nvim`
|
||||||
|
(Neovim v0.8.0以前は`~/.local/share/nvim`)にあることです。ShaDaファイルは
|
||||||
|
Vimと同じ方法で無効にできます。
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: "nvim -c 'set shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
```
|
||||||
|
|
||||||
|
ここでも`-u NONE`を渡して、デフォルト設定でセッションを開始できます。
|
||||||
|
|
||||||
|
上記のVimと同様に、Vimscriptでautocommandを作成できます:
|
||||||
|
|
||||||
|
```vim
|
||||||
|
autocmd BufNewFile,BufReadPre *.jrnl setlocal shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
```
|
||||||
|
|
||||||
|
または、同じことをLuaで:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
vim.api.nvim_create_autocmd( {"BufNewFile","BufReadPre" }, {
|
||||||
|
group = vim.api.nvim_create_augroup("PrivateJrnl", {}),
|
||||||
|
pattern = "*.jrnl",
|
||||||
|
callback = function()
|
||||||
|
vim.o.shada = ""
|
||||||
|
vim.o.swapfile = false
|
||||||
|
vim.o.undofile = false
|
||||||
|
vim.o.backup = false
|
||||||
|
vim.o.writebackup = false
|
||||||
|
vim.o.shelltemp = false
|
||||||
|
vim.o.history = 0
|
||||||
|
vim.o.modeline = false
|
||||||
|
vim.o.secure = true
|
||||||
|
end,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
[テンプレート](reference-config-file.md#template)を使用している場合は、
|
||||||
|
`.jrnl`の代わりにテンプレートのファイル拡張子を使用する必要があります。
|
||||||
|
|
||||||
|
言及したオプションの詳細については、Neovimで`:h <option>`を参照してください。
|
||||||
|
|
||||||
|
## 他のリスクに気づいた場合
|
||||||
|
|
||||||
|
[GitHubで問題を提出](https://github.com/jrnl-org/jrnl/issues)して、メンテナーに知らせてください。
|
162
docs/ja/reference-command-line.md
Normal file
|
@ -0,0 +1,162 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# コマンドライン参照
|
||||||
|
|
||||||
|
## 概要
|
||||||
|
|
||||||
|
```
|
||||||
|
使用法: jrnl [--debug] [--help] [--version] [--list] [--encrypt] [--decrypt]
|
||||||
|
[--import] [-on DATE] [-today-in-history] [-month DATE]
|
||||||
|
[-day DATE] [-year DATE] [-from DATE] [-to DATE] [-contains TEXT]
|
||||||
|
[-and] [-starred] [-n [NUMBER]] [-not [TAG]] [--edit] [--delete]
|
||||||
|
[--format TYPE] [--tags] [--short]
|
||||||
|
[--config-override CONFIG_KEY CONFIG_VALUE]
|
||||||
|
[--config-file CONFIG_FILE_PATH]
|
||||||
|
[[...]]
|
||||||
|
```
|
||||||
|
|
||||||
|
## スタンドアロンコマンド
|
||||||
|
|
||||||
|
これらのコマンドは完了後に終了します。一度に1つだけ実行できます。
|
||||||
|
|
||||||
|
### --help
|
||||||
|
|
||||||
|
ヘルプメッセージを表示します。
|
||||||
|
|
||||||
|
### --version
|
||||||
|
|
||||||
|
バージョンとライセンス情報を表示します。
|
||||||
|
|
||||||
|
### --list
|
||||||
|
|
||||||
|
設定ファイルの場所、設定されているすべてのジャーナル、およびそれらの場所を一覧表示します。
|
||||||
|
|
||||||
|
### --encrypt
|
||||||
|
|
||||||
|
ジャーナルを暗号化します。詳細は[暗号化](encryption.md)を参照してください。
|
||||||
|
|
||||||
|
### --decrypt
|
||||||
|
|
||||||
|
ジャーナルを復号化します。詳細は[暗号化](encryption.md)を参照してください。
|
||||||
|
|
||||||
|
### --import
|
||||||
|
|
||||||
|
他のジャーナルからエントリーをインポートします。同じ内容とタイムスタンプを持つエントリーがある場合、重複は排除されます。
|
||||||
|
|
||||||
|
オプションパラメータ:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
--file FILENAME
|
||||||
|
```
|
||||||
|
|
||||||
|
インポートするファイルを指定します。指定されない場合、`jrnl`はSTDINをデータソースとして使用します。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
--format TYPE
|
||||||
|
```
|
||||||
|
|
||||||
|
インポートされるファイルのフォーマットを指定します。デフォルトはjrnlが使用するのと同じデータ保存方法です。詳細は[フォーマット](formats.md)を参照してください。
|
||||||
|
|
||||||
|
## 新しいエントリーの書き込み
|
||||||
|
|
||||||
|
[基本的な使用方法](usage.md)を参照してください。
|
||||||
|
|
||||||
|
## 検索
|
||||||
|
|
||||||
|
ジャーナルからエントリーを見つけるには、以下のフィルターの任意の組み合わせを使用します。
|
||||||
|
すべてのフィルターに一致するエントリーのみが表示されます。
|
||||||
|
|
||||||
|
日付を指定する際は、新しいエントリーで使用するのと同じ種類の日付を使用できます。
|
||||||
|
例えば、`yesterday`、`today`、`Tuesday`、または`2021-08-01`などです。
|
||||||
|
|
||||||
|
| 検索引数 | 説明 |
|
||||||
|
| ----------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| -on DATE | この日付のエントリーを表示 |
|
||||||
|
| -today-in-history | 年をまたいで今日の日付のエントリーを表示 |
|
||||||
|
| -month DATE | 任意の年のこの月のエントリーを表示 |
|
||||||
|
| -day DATE | 任意の月のこの日のエントリーを表示 |
|
||||||
|
| -year DATE | 特定の年のエントリーを表示 |
|
||||||
|
| -from DATE | この日付以降(この日を含む)のエントリーを表示 |
|
||||||
|
| -to DATE | この日付以前(この日を含む)のエントリーを表示(別名: -until) |
|
||||||
|
| -contains TEXT | 特定のテキストを含むエントリーを表示(スペースを含むテキストは引用符で囲む) |
|
||||||
|
| -and | すべての条件に一致するエントリーのみを表示、"x AND y"と言うのと同じ(デフォルト: OR) |
|
||||||
|
| -starred | スター付きのエントリーのみを表示(\*でマークされたもの) |
|
||||||
|
| -tagged | タグ付きのエントリーのみを表示([設定されたtagsymbols](reference-config-file.md#tagsymbols)でマークされたもの) |
|
||||||
|
| -n [NUMBER] | 最大NUMBER個のエントリーを表示(注: '-n 3'と'-3'は同じ効果) |
|
||||||
|
| -not [TAG] | このタグを持つエントリーを除外 |
|
||||||
|
| -not -starred | スター付きのエントリーを除外 |
|
||||||
|
| -not -tagged | タグ付きのエントリーを除外 |
|
||||||
|
|
||||||
|
## 検索オプション
|
||||||
|
|
||||||
|
これらは検索で選択されたエントリーでさまざまなタスクを実行するのに役立ちます。
|
||||||
|
単独で使用した場合(検索なし)、ジャーナル全体に対して動作します。
|
||||||
|
|
||||||
|
### --edit
|
||||||
|
|
||||||
|
選択されたエントリーを設定されたエディタで開きます。設定ファイルに`editor`キーが
|
||||||
|
設定されていない場合は失敗します。
|
||||||
|
|
||||||
|
編集を開始すると、エディタでテキストを修正することで複数のエントリーを追加したり
|
||||||
|
削除したりできます。エディタを閉じると、jrnlは編集していた一時ファイルを読み取り、
|
||||||
|
ジャーナルに変更を加えます。
|
||||||
|
|
||||||
|
### --delete
|
||||||
|
|
||||||
|
選択されたエントリーを対話的に削除します。各エントリーの削除を確認するよう求められます。
|
||||||
|
|
||||||
|
### --change-time DATE
|
||||||
|
|
||||||
|
選択されたエントリーの時間を指定された日付に、または日付が指定されていない場合は
|
||||||
|
現在の時刻に対話的に変更します。各エントリーの確認を求められますが、単一のエントリーに
|
||||||
|
対して`--edit`と一緒に使用している場合は除きます。
|
||||||
|
|
||||||
|
### --format TYPE
|
||||||
|
|
||||||
|
選択されたエントリーを別のフォーマットで表示します。[フォーマット](formats.md)を参照してください。
|
||||||
|
|
||||||
|
#### オプションパラメータ
|
||||||
|
|
||||||
|
```sh
|
||||||
|
--file FILENAME
|
||||||
|
```
|
||||||
|
|
||||||
|
出力をSTDOUTの代わりにファイルに書き込みます。ほとんどのシェルでは、
|
||||||
|
`>`を使用して同じ効果を得ることができます。
|
||||||
|
|
||||||
|
### --tags
|
||||||
|
|
||||||
|
'--format tags'のエイリアスです。検索されたエントリー内のすべてのタグとその出現回数の
|
||||||
|
リストを返します。タグが見つからない場合、`jrnl`はその旨のメッセージを出力します。
|
||||||
|
|
||||||
|
### --short
|
||||||
|
|
||||||
|
検索されたエントリーの日付とタイトルのみを表示します。
|
||||||
|
|
||||||
|
## 設定引数
|
||||||
|
|
||||||
|
### --config-override CONFIG_KEY CONFIG_VALUE
|
||||||
|
|
||||||
|
このコマンド呼び出しのみ、設定されたキーと値のペアをCONFIG_KV_PAIRで上書きします。
|
||||||
|
トップレベルにないconfig keyにアクセスするには、キーをドットで区切ります。
|
||||||
|
例えば、`colors`キー内の`title`キーにアクセスするには`colors.title`を使用します。
|
||||||
|
例については[高度な使用方法](./advanced.md)を参照してください。
|
||||||
|
|
||||||
|
### --config-file CONFIG_FILE_PATH
|
||||||
|
|
||||||
|
このコマンド呼び出しのみ、CONFIG_FILE_PATHにある設定ファイルを使用します。
|
||||||
|
例については[高度な使用方法](./advanced.md)を参照してください。
|
||||||
|
|
||||||
|
## その他の引数
|
||||||
|
|
||||||
|
### --debug
|
||||||
|
|
||||||
|
`jrnl`の実行中にトラブルシューティングに役立つ情報を出力します。
|
||||||
|
|
||||||
|
### --diagnostic
|
||||||
|
|
||||||
|
[問題を報告する](https://github.com/jrnl-org/jrnl/issues)際に役立つ診断情報を出力します。
|
||||||
|
|
127
docs/ja/reference-config-file.md
Normal file
|
@ -0,0 +1,127 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 設定ファイル参照
|
||||||
|
|
||||||
|
`jrnl`はYAML形式の設定ファイルに情報を保存します。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
編集前にジャーナルと設定ファイルをバックアップしてください。設定ファイルの
|
||||||
|
変更はジャーナルに破壊的な影響を与える可能性があります!
|
||||||
|
|
||||||
|
## 設定ファイルの場所
|
||||||
|
|
||||||
|
以下のコマンドを実行すると、設定ファイルの場所を確認できます:
|
||||||
|
`jrnl --list`
|
||||||
|
|
||||||
|
デフォルトでは、設定ファイルは`~/.config/jrnl/jrnl.yaml`にあります。
|
||||||
|
`XDG_CONFIG_HOME`変数が設定されている場合、設定ファイルは
|
||||||
|
`$XDG_CONFIG_HOME/jrnl/jrnl.yaml`として保存されます。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
Windowsでは、設定ファイルは通常
|
||||||
|
`%USERPROFILE%\.config\jrnl\jrnl.yaml`にあります。
|
||||||
|
|
||||||
|
## 設定フォーマット
|
||||||
|
|
||||||
|
設定ファイルは[YAML](https://yaml.org/)形式で、テキストエディタで編集できます。
|
||||||
|
|
||||||
|
## 設定キー
|
||||||
|
|
||||||
|
### journals
|
||||||
|
|
||||||
|
`jrnl`が使用する各ジャーナルを記述します。このキーの後の各インデントされたキーは
|
||||||
|
ジャーナルの名前です。
|
||||||
|
|
||||||
|
ジャーナルキーに値がある場合、その値はジャーナルへのパスとして解釈されます。
|
||||||
|
そうでない場合、ジャーナルはパスを指定するための追加のインデントされた
|
||||||
|
`journal`キーが必要です。
|
||||||
|
|
||||||
|
以下のすべてのキーは、`journal`キーと同じレベルで各ジャーナルに対して指定できます。
|
||||||
|
キーがトップレベルのキーと競合する場合、ジャーナル固有のキーが代わりに使用されます。
|
||||||
|
|
||||||
|
### editor
|
||||||
|
|
||||||
|
設定されている場合、このコマンドを実行して外部エディタを起動し、
|
||||||
|
エントリーの作成と編集を行います。一時ファイルへのパスがその後に
|
||||||
|
渡され、エディタが制御を`jrnl`に戻すと、`jrnl`がファイルを処理します。
|
||||||
|
|
||||||
|
一部のエディタは`jrnl`で動作するためにブロッキングプロセスである必要があるため、
|
||||||
|
特別なオプションが必要です。詳細は[外部エディタ](external-editors.md)を参照してください。
|
||||||
|
|
||||||
|
### encrypt
|
||||||
|
|
||||||
|
`true`の場合、AESを使用してジャーナルを暗号化します。既にデータがある
|
||||||
|
ジャーナルでは、この値を変更しないでください。
|
||||||
|
|
||||||
|
### template
|
||||||
|
|
||||||
|
新しいエントリーのテンプレートとして使用するテキストファイルへのパス。`editor`フィールドが
|
||||||
|
設定されている場合のみ機能します。テンプレートを使用する場合、エディタの
|
||||||
|
[一時ファイル](privacy-and-security.md#files-in-transit-from-editor-to-jrnl)は
|
||||||
|
テンプレートと同じ拡張子を持ちます。
|
||||||
|
|
||||||
|
### tagsymbols
|
||||||
|
|
||||||
|
タグとして解釈されるシンボル。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
タグに`#`文字を使用するのが直感的に思えますが、欠点があります:ほとんどの
|
||||||
|
シェルでは、これはコメントを開始するメタ文字として解釈されます。つまり、
|
||||||
|
以下のように入力すると:
|
||||||
|
|
||||||
|
> `jrnl Implemented endless scrolling on the #frontend of our website.`
|
||||||
|
|
||||||
|
bashは`#`以降をすべて切り捨てて`jrnl`に渡します。これを避けるには、
|
||||||
|
入力を次のように引用符で囲みます:
|
||||||
|
|
||||||
|
> `jrnl "Implemented endless scrolling on the #frontend of our website."`
|
||||||
|
|
||||||
|
または、組み込みのプロンプトや外部エディタを使用してエントリーを
|
||||||
|
作成してください。
|
||||||
|
|
||||||
|
### default_hour と default_minute
|
||||||
|
|
||||||
|
日付を指定しても具体的な時間を指定しない場合(例:`last thursday`)、エントリーはこの時間に作成されます。
|
||||||
|
|
||||||
|
### timeformat
|
||||||
|
|
||||||
|
ジャーナルに保存されるタイムスタンプの形式を定義します。
|
||||||
|
参照は[pythonドキュメント](http://docs.python.org/library/time.html#time.strftime)を確認してください。
|
||||||
|
|
||||||
|
既存のジャーナルでは変更しないでください。データ損失につながる可能性があります。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
`jrnl`は`%z`または`%Z`タイムゾーン識別子をサポートしていません。
|
||||||
|
|
||||||
|
### highlight
|
||||||
|
|
||||||
|
`true`の場合、タグはシアン色で強調表示されます。
|
||||||
|
|
||||||
|
### linewrap
|
||||||
|
|
||||||
|
出力の幅を制御します。長い行を折り返したくない場合は`false`に設定します。
|
||||||
|
`jrnl`に自動的に端末幅を決定させる場合は`auto`に設定します。
|
||||||
|
|
||||||
|
### colors
|
||||||
|
|
||||||
|
ジャーナルエントリーの表示に使用される色を制御する辞書です。
|
||||||
|
4つのサブキーがあります:`body`、`date`、`tags`、`title`。
|
||||||
|
|
||||||
|
現在有効な値は:`BLACK`、`RED`、`GREEN`、`YELLOW`、`BLUE`、
|
||||||
|
`MAGENTA`、`CYAN`、`WHITE`、`NONE`です。
|
||||||
|
|
||||||
|
色付けには`colorama.Fore`が使用され、[ドキュメントはこちら](https://github.com/tartley/colorama#colored-output)で確認できます。
|
||||||
|
|
||||||
|
色付き出力を無効にするには、値を`NONE`に設定します。
|
||||||
|
|
||||||
|
### display_format
|
||||||
|
|
||||||
|
デフォルトで使用するフォーマッタを指定します。[フォーマット](formats.md)を参照してください。
|
||||||
|
|
||||||
|
### version
|
||||||
|
|
||||||
|
`jrnl`は自動的にこのフィールドを実行中のバージョンに更新します。
|
||||||
|
このフィールドを手動で変更する必要はありません。
|
214
docs/ja/tips-and-tricks.md
Normal file
|
@ -0,0 +1,214 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# ヒントとコツ
|
||||||
|
|
||||||
|
このページでは、他のツールや外部エディタと組み合わせて
|
||||||
|
jrnlを使用するためのヒントとコツを紹介します。
|
||||||
|
|
||||||
|
## Co-occurrence of tags
|
||||||
|
|
||||||
|
ルームメイトの AlbertoとMeloを同じエントリーでどれくらい一緒に言及したか調べたい場合、
|
||||||
|
次のコマンドを使います。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl @alberto --tags | grep @melo
|
||||||
|
```
|
||||||
|
|
||||||
|
これにより、`@melo: 9`と言った結果が表示されます。これは`@alberto`と
|
||||||
|
`@melo`の両方がタグ付けされたエントリーが9件あることを意味しています。
|
||||||
|
仕組みを説明すると、まず`jrnl @alberto` が`@alberto`タグの有るエントリーだけを
|
||||||
|
抽出します。次に `--tags`オプションを使うと、その抽出されたエントリー内で
|
||||||
|
各タグがどれくらい使われているかが表示されます。最後に、`grep`で`@melo`を
|
||||||
|
含み行だけを示しています。
|
||||||
|
|
||||||
|
## フィルターの組み合わせ
|
||||||
|
|
||||||
|
次のようにコマンドを使うことが出来ます。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl @fixed -starred -n 10 -to "jan 2013" --short
|
||||||
|
```
|
||||||
|
|
||||||
|
これで2013年1月1日以前に`@fixed`タグが付けられた最近のお気に入りの10件の
|
||||||
|
エントリーの要約を取得できます。
|
||||||
|
|
||||||
|
## 統計
|
||||||
|
|
||||||
|
昨年どれくらい書いたか知りたい場合は?
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -from "jan 1 2013" -to "dec 31 2013" | wc -w
|
||||||
|
```
|
||||||
|
|
||||||
|
このコマンドを実行すると、2013年に書いた単語数が表示されます。
|
||||||
|
|
||||||
|
エントリーの平均の長さを知りたい場合は?
|
||||||
|
|
||||||
|
```sh
|
||||||
|
expr $(jrnl --export text | wc -w) / $(jrnl --short | wc -l)
|
||||||
|
```
|
||||||
|
|
||||||
|
このコマンドは、まずジャーナル全体の単語数を取得し、それをエントリーの数で
|
||||||
|
割ります(`jrnl --short`は各エントリーごとに1行だけ出力するため、この方法が機能
|
||||||
|
します)。
|
||||||
|
|
||||||
|
## 古いファイルのインポート
|
||||||
|
|
||||||
|
ファイルを `jrnl` のエントリとしてインポートしたい場合は、
|
||||||
|
単に `jrnl < entry.ext` と実行するだけです。
|
||||||
|
しかし、ファイルの最終更新日時を `jrnl` のエントリの日付として設定したい場合はどうでしょうか?
|
||||||
|
|
||||||
|
次のコマンドを試してみてください。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' entry.txt` `cat entry.txt` | jrnl
|
||||||
|
```
|
||||||
|
|
||||||
|
このコマンドの前半部分は `entry.txt` の最終更新日時をフォーマットし、ファイルの内容と結合してからそれを `jrnl` にパイプします。これを頻繁に行う場合は、`.bashrc` や `.bash_profile` に関数を作成することを検討してください。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnlimport () {
|
||||||
|
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' $1` `cat $1` | jrnl
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## テンプレートの使用
|
||||||
|
|
||||||
|
!!! 注意
|
||||||
|
テンプレートを使用するには、[外部エディタ](./advanced.md) の設定が必要です。
|
||||||
|
|
||||||
|
テンプレートは、構造化されたジャーナルを作成するために使うテキストファイルです。テンプレートを使用する方法は3つあります。
|
||||||
|
|
||||||
|
### 1. `--template` コマンドライン引数とデフォルトの `$XDG_DATA_HOME/jrnl/templates` ディレクトリを使用
|
||||||
|
|
||||||
|
`$XDG_DATA_HOME/jrnl/templates` は、テンプレートを保存するためにデフォルトで作成されます!このディレクトリにテンプレート(例えば `default.md`)を作成し、`--template FILE_IN_DIR` として指定します。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --template default.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. `--template` コマンドライン引数とローカル/絶対パスを使用
|
||||||
|
|
||||||
|
任意のテキストでテンプレートファイルを作成できます。例は以下の通りです:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# /tmp/template.txt
|
||||||
|
私の個人ジャーナル
|
||||||
|
タイトル:
|
||||||
|
|
||||||
|
本文:
|
||||||
|
```
|
||||||
|
|
||||||
|
その後、テンプレートファイルの絶対パスまたは相対パスを引数として指定すると、外部エディタが開き、テンプレートが事前に入力された状態になります。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --template /tmp/template.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. `jrnl.yaml` にデフォルトのテンプレートファイルを設定
|
||||||
|
|
||||||
|
デフォルトでテンプレートを使用したい場合は、[設定ファイル](./reference-config-file.md) 内の `template` の値を `false` からダブルクオーテーションで囲まれたテンプレートファイルのパスに変更します。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
...
|
||||||
|
template: "/path/to/template.txt"
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! ヒント
|
||||||
|
ジャーナルエントリを確認したり、保存されたエントリを確認したい場合は、以下のコマンドを使用します:`jrnl -n 1` (他のオプションについては[フォーマット](./formats.md) を確認してください)。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -n 1
|
||||||
|
```
|
||||||
|
|
||||||
|
## シェルのリロード時にプロンプトを表示
|
||||||
|
|
||||||
|
シェルをリフレッシュするたびにプロンプトを表示させたい場合は、以下を `.bash_profile` に追加できます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
function log_question()
|
||||||
|
{
|
||||||
|
echo $1
|
||||||
|
read
|
||||||
|
jrnl today: ${1}. $REPLY
|
||||||
|
}
|
||||||
|
log_question '今日達成したことは何ですか?'
|
||||||
|
log_question 'どんな進展がありましたか?'
|
||||||
|
```
|
||||||
|
|
||||||
|
シェルがリロードされるたびに、上記の質問に回答するように促されます。各回答は、`jrnl.yaml` の `default_hour` および `default_minute` にリストされている時刻で別々のジャーナルエントリとして記録されます。
|
||||||
|
|
||||||
|
## ランダムエントリの表示
|
||||||
|
|
||||||
|
ランダムに1つのタイトルを選択し、エントリ全体を表示することができます。タイムスタンプのフォーマットに合わせて `cut` の呼び出しを調整します。日時要素の間にスペースがあるタイムスタンプでは、以下のようにフィールド1と2を選択します。スペースがないタイムスタンプの場合は、フィールド1のみを選択します。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -on "$(jrnl --short | shuf -n 1 | cut -d' ' -f1,2)"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 高速記録用の端末を起動
|
||||||
|
|
||||||
|
`jrnl` の stdin プロンプトを持つ端末を起動し、すぐに入力を開始できるようにすることができます。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
jrnl --config-override editor ""
|
||||||
|
```
|
||||||
|
|
||||||
|
これをキーボードショートカットに割り当てます。
|
||||||
|
|
||||||
|
`Super+Alt+J` に `jrnl` プロンプトを持つ端末を起動するようにマップする
|
||||||
|
|
||||||
|
- **xbindkeys**
|
||||||
|
あなたの `.xbindkeysrc` に以下を追加します
|
||||||
|
|
||||||
|
```ini
|
||||||
|
Mod4+Mod1+j
|
||||||
|
alacritty -t floating-jrnl -e jrnl --config-override editor "",
|
||||||
|
```
|
||||||
|
|
||||||
|
- **I3 WM** `jrnl` プロンプトを持つフローティング端末を起動します
|
||||||
|
|
||||||
|
```ini
|
||||||
|
bindsym Mod4+Mod1+j exec --no-startup-id alacritty -t floating-jrnl -e jrnl --config-override editor ""
|
||||||
|
for_window[title="floating *"] floating enable
|
||||||
|
```
|
||||||
|
|
||||||
|
## CLI でフォーマットされた Markdown を視覚化
|
||||||
|
|
||||||
|
`jrnl` はデフォルトでジャーナルエントリをMarkdown形式で出力できます。これを視覚化するには、[mdless](https://github.com/ttscoff/mdless) にパイプします。`mdless` は、Markdownテキストをフォーマットおよびシンタックスハイライト付きでCLIで表示できる、[less](<https://en.wikipedia.org/wiki/Less_(Unix)>) のようなツールです。この機能は、パイプをサポートする任意のシェルで使用できます。
|
||||||
|
|
||||||
|
Markdown出力を `mdless` で視覚化する最も簡単な方法は次の通りです:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --export md | mdless
|
||||||
|
```
|
||||||
|
|
||||||
|
これにより、画面全体にMarkdown出力がレンダリングされます。
|
||||||
|
|
||||||
|
幸いなことに、`mdless` には画面幅を調整するための `-w` オプションがあります。以下のように使用します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --export md | mdless -w 70
|
||||||
|
```
|
||||||
|
|
||||||
|
Markdownをデフォルトの表示形式にしたい場合は、設定ファイルで次のように定義できます:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
display_format: md
|
||||||
|
# または
|
||||||
|
display_format: markdown
|
||||||
|
```
|
||||||
|
|
||||||
|
`jrnl` がエントリをMarkdown形式で出力する方法についての詳細は、[フォーマット](./formats.md) セクションを参照してください。
|
||||||
|
|
||||||
|
## バッファの末尾にジャンプ(vi使用時)
|
||||||
|
|
||||||
|
viを使用して編集する際に、エントリの最後の行にジャンプさせるには、設定ファイルで次のように設定します:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
editor: vi + -c "call cursor('.',strwidth(getline('.')))"
|
||||||
|
```
|
254
docs/ja/usage.md
Normal file
|
@ -0,0 +1,254 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 基本的な使い方
|
||||||
|
|
||||||
|
`jrnl`には2つのモードがあります:**作成モード**と**閲覧モード**です。ダッシュ(`-`)
|
||||||
|
やダブルダッシュ(`--`)で始まる引数を入力しない場合は作成モードになり、
|
||||||
|
コマンドラインでエントリーを書くことができます。
|
||||||
|
|
||||||
|
私たちは意図的にコマンドライン引数の慣例を破っています:_一重のダッシュ_(`-`)で
|
||||||
|
始まるすべての引数は、閲覧前にジャーナルを*フィルタリング*します。フィルタ引数は
|
||||||
|
任意に組み合わせることができます。_二重のダッシュ_(`--`)で始まる引数は、
|
||||||
|
ジャーナルの表示やエクスポートの方法を*制御*します。制御引数は相互に排他的です
|
||||||
|
(つまり、一度に一つの方法でのみジャーナルの表示やエクスポートを指定できます)。
|
||||||
|
|
||||||
|
コマンドのリストを表示するには、`jrnl --help`と入力してください。
|
||||||
|
|
||||||
|
## エントリーの作成
|
||||||
|
|
||||||
|
作成モードは、引数なしで`jrnl`を起動する(外部エディタが起動します)か、
|
||||||
|
コマンドラインに直接エントリーを書くことで入ります:
|
||||||
|
|
||||||
|
```text
|
||||||
|
jrnl today at 3am: バーでスティーブ・ブシェミに会った!とても良い人だった。
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
ほとんどのシェルには`#`や`*`などの予約文字があります。これらの文字や、
|
||||||
|
バランスの取れていない単一または二重引用符、括弧などは、おそらく問題を
|
||||||
|
引き起こします。予約文字は`\`を使ってエスケープできますが、長文の
|
||||||
|
書き込みには理想的ではありません。解決策:まず`jrnl`と入力してリターンキーを
|
||||||
|
押します。その後、ジャーナルエントリーのテキストを入力できます。
|
||||||
|
または、[外部エディタを使用する](./advanced.md)こともできます。
|
||||||
|
|
||||||
|
ファイルから直接エントリーをインポートすることもできます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl < my_entry.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### 日付と時間の指定
|
||||||
|
|
||||||
|
日付と時間を指定しない場合(例:`jrnl 弟への手紙を書き終えた`)、`jrnl`は現在の日付と時間を使用してエントリーを作成します。過去のエントリーの場合、タイムスタンプを使用して`jrnl`にエントリーの配置場所を指示できます。タイムスタンプは様々な形式で入力できます。以下は機能する例です:
|
||||||
|
|
||||||
|
- at 6am
|
||||||
|
- yesterday
|
||||||
|
- last monday
|
||||||
|
- sunday at noon
|
||||||
|
- 2 march 2012
|
||||||
|
- 7 apr
|
||||||
|
- 5/20/1998 at 23:42
|
||||||
|
- 2020-05-22T15:55-04:00
|
||||||
|
|
||||||
|
タイムスタンプを使用しない場合、`jrnl`は現在の時刻を使用してエントリーを作成します。
|
||||||
|
日付のみを使用する場合(時刻なし)、`jrnl`は[設定ファイル](./reference-config-file.md#default_hour-and-default_minute)で
|
||||||
|
指定されたデフォルトの時刻を使用します。
|
||||||
|
内部的には、`jrnl`はエントリーを年代順に並べ替えます。
|
||||||
|
|
||||||
|
### タグの使用
|
||||||
|
|
||||||
|
`jrnl`はタグをサポートしています。デフォルトのタグシンボルは`@`です(主に`#`が
|
||||||
|
予約文字であるため)。[設定ファイル](./reference-config-file.md#tagsymbols)で
|
||||||
|
独自のタグシンボルを指定できます。タグを使用するには、目的のタグの前にシンボルを
|
||||||
|
付けます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl @ビーチで@トムと@アンナと素晴らしい一日を過ごした。
|
||||||
|
```
|
||||||
|
|
||||||
|
エントリーにタグを付ける際に大文字を使用できますが、タグによる検索は
|
||||||
|
大文字小文字を区別しません。
|
||||||
|
|
||||||
|
1つのエントリーで使用できるタグの数に制限はありません。
|
||||||
|
|
||||||
|
### エントリーにスターを付ける
|
||||||
|
|
||||||
|
エントリーをお気に入りとしてマークするには、単にアスタリスク(`*`)を使って
|
||||||
|
「スター」を付けます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl last sunday *: 人生最高の日。
|
||||||
|
```
|
||||||
|
|
||||||
|
日付を追加したくない場合(つまり、日付を*now*として入力したい場合)、
|
||||||
|
以下のオプションは同等です:
|
||||||
|
|
||||||
|
- `jrnl *: 人生最高の日。`
|
||||||
|
- `jrnl *人生最高の日。`
|
||||||
|
- `jrnl 人生最高の日。*`
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
アスタリスク(`*`)の前後に空白がないことを確認してください。
|
||||||
|
`jrnl 人生最高の日! *`は機能しません。なぜなら、`*`文字はほとんどの
|
||||||
|
シェルで特別な意味を持つからです。
|
||||||
|
|
||||||
|
## エントリーの閲覧と検索
|
||||||
|
|
||||||
|
`jrnl`は様々な方法でエントリーを表示できます。
|
||||||
|
|
||||||
|
すべてのエントリーを表示するには、次のように入力します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -to today
|
||||||
|
```
|
||||||
|
|
||||||
|
`jrnl`はいくつかのフィルタリングコマンドを提供しており、一重のダッシュ(`-`)で
|
||||||
|
始まり、より具体的な範囲のエントリーを見つけることができます。例えば、
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -n 10
|
||||||
|
```
|
||||||
|
|
||||||
|
は最新の10件のエントリーを表示します。`jrnl -10`はさらに簡潔で、同じように機能します。
|
||||||
|
昨年の初めから今年の3月末までに書いたすべてのエントリーを見たい場合は、
|
||||||
|
次のように入力します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -from "last year" -to march
|
||||||
|
```
|
||||||
|
|
||||||
|
複数の単語を使用するフィルタ条件は、引用符(`""`)で囲む必要があります。
|
||||||
|
|
||||||
|
特定の日のエントリーを見るには、`-on`を使用します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -on yesterday
|
||||||
|
```
|
||||||
|
|
||||||
|
### テキスト検索
|
||||||
|
|
||||||
|
`-contains`コマンドは、その後に入力したテキストを含むすべてのエントリーを表示します。
|
||||||
|
これは、エントリーを検索する際に、書いた時にタグを付けたかどうか覚えていない場合に
|
||||||
|
役立つかもしれません。
|
||||||
|
|
||||||
|
ある単語をよく使っていることに気づき、過去のすべてのエントリーでそれをタグに
|
||||||
|
変えたいと思うかもしれません。
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -contains "犬" --edit
|
||||||
|
```
|
||||||
|
|
||||||
|
外部エディタを開き、"犬"という単語のすべてのインスタンスにタグシンボル
|
||||||
|
(デフォルトでは`@`)を追加できます。
|
||||||
|
|
||||||
|
### タグによるフィルタリング
|
||||||
|
|
||||||
|
ジャーナルエントリーをタグでフィルタリングできます。例えば、
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl @ピンキー @世界征服
|
||||||
|
```
|
||||||
|
|
||||||
|
は`@ピンキー`または`@世界征服`のいずれかが出現するすべてのエントリーを表示します。
|
||||||
|
タグフィルタは他のフィルタと組み合わせることができます:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -n 5 @ピンキー -and @世界征服
|
||||||
|
```
|
||||||
|
|
||||||
|
は`@ピンキー`_と_`@世界征服`の*両方*を含む最新の5つのエントリーを表示します。
|
||||||
|
[設定ファイル](./reference-config-file.md#tagsymbols)でタグに使用したいシンボルを
|
||||||
|
変更できます。
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
`jrnl @ピンキー @世界征服`と入力すると、両方のタグが存在するエントリーが
|
||||||
|
表示されます。これは、コマンドライン引数が与えられていないにもかかわらず、
|
||||||
|
すべての入力文字列がタグのように見えるためです。`jrnl`は、タグのみで
|
||||||
|
構成される新しいエントリーを作成するのではなく、タグでフィルタリング
|
||||||
|
したいと想定します。
|
||||||
|
|
||||||
|
ジャーナル内のすべてのタグのリストを表示するには、次のように入力します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --tags
|
||||||
|
```
|
||||||
|
|
||||||
|
### スター付きエントリーの表示
|
||||||
|
|
||||||
|
お気に入り(スター付き)のエントリーのみを表示するには、次のように入力します:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -starred
|
||||||
|
```
|
||||||
|
|
||||||
|
## エントリーの編集
|
||||||
|
|
||||||
|
エントリーを書いた後で編集することができます。これは特に、ジャーナルファイルが
|
||||||
|
暗号化されている場合に便利です。この機能を使用するには、[設定ファイル](./reference-config-file.md#editor)で
|
||||||
|
外部エディタを設定する必要があります。また、特定の検索条件に一致するエントリー
|
||||||
|
のみを編集することもできます。例えば、
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -to 1950 @テキサス -and @歴史 --edit
|
||||||
|
```
|
||||||
|
|
||||||
|
は外部エディタを開き、1950年以前に書かれた`@テキサス`と`@歴史`のタグが付いた
|
||||||
|
すべてのエントリーを表示します。変更を加えてファイルを保存して閉じると、
|
||||||
|
それらのエントリーのみが変更されます(該当する場合は暗号化されます)。
|
||||||
|
|
||||||
|
複数のジャーナルを使用している場合、特定のジャーナルから特定のエントリーを
|
||||||
|
簡単に編集できます。フィルタ文字列の前にジャーナルの名前を付けるだけです。
|
||||||
|
例えば、
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl work -n 1 --edit
|
||||||
|
```
|
||||||
|
|
||||||
|
は'work'ジャーナルの最新のエントリーを外部エディタで開きます。
|
||||||
|
|
||||||
|
## エントリーの削除
|
||||||
|
|
||||||
|
`--delete`コマンドは、エントリーを削除するための対話型インターフェースを開きます。
|
||||||
|
ジャーナル内の各エントリーの日付とタイトルが一つずつ表示され、各エントリーを
|
||||||
|
保持するか削除するかを選択できます。
|
||||||
|
|
||||||
|
フィルタが指定されていない場合、`jrnl`はジャーナル全体の各エントリーを一つずつ
|
||||||
|
保持するか削除するかを尋ねます。ジャーナルに多くのエントリーがある場合は、
|
||||||
|
`--delete`コマンドを渡す前にエントリーをフィルタリングする方が効率的かもしれません。
|
||||||
|
|
||||||
|
例を挙げます。過去12年間のブログ投稿をインポートしたジャーナルがあるとします。
|
||||||
|
`@本`タグを頻繁に使用しており、何らかの理由で、そのタグを使用したエントリーの
|
||||||
|
一部(全部ではない)を削除したいのですが、2004年以前に書いたものだけです。
|
||||||
|
どのエントリーを保持したいかわからず、決定する前に確認したいとします。
|
||||||
|
次のように入力するかもしれません:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -to 2004 @本 --delete
|
||||||
|
```
|
||||||
|
|
||||||
|
`jrnl`は関連するエントリーのみを表示し、削除したいものを選択できます。
|
||||||
|
|
||||||
|
2004年以前に書いた`@本`を含むすべてのエントリーを削除したい場合もあるでしょう。
|
||||||
|
数十または数百ある場合、最も簡単な方法は外部エディタを使用することです。
|
||||||
|
削除したいエントリーをエディタで開きます...
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl -to 2004 @本 --edit
|
||||||
|
```
|
||||||
|
|
||||||
|
...すべてを選択し、削除して保存して閉じると、それらのエントリーすべてが
|
||||||
|
ジャーナルから削除されます。
|
||||||
|
|
||||||
|
## ジャーナルのリスト表示
|
||||||
|
|
||||||
|
すべてのジャーナルをリスト表示するには:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jrnl --list
|
||||||
|
```
|
||||||
|
|
||||||
|
表示されるジャーナルは、`jrnl`の[設定ファイル](./reference-config-file.md#journals)で
|
||||||
|
指定されたものに対応します。
|
23
docs_theme/laungae_selector.html
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
{% if config.theme.language %}
|
||||||
|
<div
|
||||||
|
class="rst-versions"
|
||||||
|
data-toggle="rst-versions"
|
||||||
|
role="note"
|
||||||
|
aria-label="versions"
|
||||||
|
>
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
<span class="fa fa-book"> Language </span>
|
||||||
|
{{ config.theme.language }}
|
||||||
|
<span class="fa fa-caret-down"></span>
|
||||||
|
</span>
|
||||||
|
<div class="rst-other-versions">
|
||||||
|
{% for lang in config.extra.alternate %} {% if lang.lang !=
|
||||||
|
config.theme.language %}
|
||||||
|
<dl>
|
||||||
|
<dt>{{ lang.name }}</dt>
|
||||||
|
<dd><a href="{{ lang.link }}">{{ lang.name }}</a></dd>
|
||||||
|
</dl>
|
||||||
|
{% endif %} {% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
96
mkdocs.yml
|
@ -4,36 +4,92 @@ theme:
|
||||||
name: readthedocs
|
name: readthedocs
|
||||||
custom_dir: docs_theme
|
custom_dir: docs_theme
|
||||||
static_templates:
|
static_templates:
|
||||||
- index.html
|
- index.html
|
||||||
|
language: en
|
||||||
|
features:
|
||||||
|
- language-selector
|
||||||
watch:
|
watch:
|
||||||
- docs
|
- docs
|
||||||
- docs_theme
|
- docs_theme
|
||||||
extra_css:
|
extra_css:
|
||||||
- https://fonts.googleapis.com/css?family=Open+Sans:300,600
|
- https://fonts.googleapis.com/css?family=Open+Sans:300,600
|
||||||
- assets/colors.css
|
- assets/colors.css
|
||||||
- assets/theme.css
|
- assets/theme.css
|
||||||
- assets/highlight.css
|
- assets/highlight.css
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
repo_url: https://github.com/jrnl-org/jrnl/
|
repo_url: https://github.com/jrnl-org/jrnl/
|
||||||
edit_uri: edit/develop/docs/
|
edit_uri: edit/develop/docs/
|
||||||
site_author: jrnl contributors
|
site_author: jrnl contributors
|
||||||
site_description: Collect your thoughts and notes without leaving the command line.
|
site_description: Collect your thoughts and notes without leaving the command line.
|
||||||
|
|
||||||
|
extra:
|
||||||
|
alternate:
|
||||||
|
- name: English
|
||||||
|
link: /
|
||||||
|
lang: en
|
||||||
|
- name: 日本語
|
||||||
|
link: /ja/
|
||||||
|
lang: ja
|
||||||
|
language: en
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Overview: overview.md
|
- Overview: overview.md
|
||||||
- 'User Guide':
|
- "User Guide":
|
||||||
- Quickstart: installation.md
|
- Quickstart: installation.md
|
||||||
- Basic Usage: usage.md
|
- Basic Usage: usage.md
|
||||||
- Encryption: encryption.md
|
- Encryption: encryption.md
|
||||||
- Journal Types: journal-types.md
|
- Journal Types: journal-types.md
|
||||||
- Privacy and Security: privacy-and-security.md
|
- Privacy and Security: privacy-and-security.md
|
||||||
- Formats: formats.md
|
- Formats: formats.md
|
||||||
- Advanced Usage: advanced.md
|
- Advanced Usage: advanced.md
|
||||||
- 'External Editors': external-editors.md
|
- "External Editors": external-editors.md
|
||||||
- 'Tips and Tricks': tips-and-tricks.md
|
- "Tips and Tricks": tips-and-tricks.md
|
||||||
- 'Reference':
|
- "Reference":
|
||||||
- Command Line: reference-command-line.md
|
- Command Line: reference-command-line.md
|
||||||
- Configuration File: reference-config-file.md
|
- Configuration File: reference-config-file.md
|
||||||
- 'Contributing':
|
- "Contributing":
|
||||||
- Contributing to jrnl: contributing.md
|
- Contributing to jrnl: contributing.md
|
||||||
|
- ja:
|
||||||
|
- 概要: ja/overview.md
|
||||||
|
- "ユーザーガイド":
|
||||||
|
- クイックスタート: ja/installation.md
|
||||||
|
- 基本的な使い方: ja/usage.md
|
||||||
|
- 暗号化: ja/encryption.md
|
||||||
|
- ジャーナルの種類: ja/journal-types.md
|
||||||
|
- プライバシーとセキュリティ: ja/privacy-and-security.md
|
||||||
|
- フォーマット: ja/formats.md
|
||||||
|
- 高度な使い方: ja/advanced.md
|
||||||
|
- "外部エディタ": ja/external-editors.md
|
||||||
|
- "ヒントとコツ": ja/tips-and-tricks.md
|
||||||
|
- "リファレンス":
|
||||||
|
- コマンドライン: ja/reference-command-line.md
|
||||||
|
- 設定ファイル: ja/reference-config-file.md
|
||||||
|
- "貢献":
|
||||||
|
- jrnlへの貢献: ja/contributing.md
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- i18n:
|
||||||
|
default_language: en
|
||||||
|
languages:
|
||||||
|
en: English
|
||||||
|
ja: 日本語
|
||||||
|
nav_translations:
|
||||||
|
ja:
|
||||||
|
Overview: 概要
|
||||||
|
"User Guide": "ユーザーガイド"
|
||||||
|
Quickstart: クイックスタート
|
||||||
|
"Basic Usage": "基本的な使い方"
|
||||||
|
Encryption: 暗号化
|
||||||
|
"Journal Types": "ジャーナルの種類"
|
||||||
|
"Privacy and Security": "プライバシーとセキュリティ"
|
||||||
|
Formats: フォーマット
|
||||||
|
"Advanced Usage": "高度な使い方"
|
||||||
|
"External Editors": "外部エディタ"
|
||||||
|
"Tips and Tricks": "ヒントとコツ"
|
||||||
|
"Reference": "リファレンス"
|
||||||
|
"Command Line": "コマンドライン"
|
||||||
|
"Configuration File": "設定ファイル"
|
||||||
|
"Contributing": "貢献"
|
||||||
|
"Contributing to jrnl": "jrnlへの貢献"
|
||||||
|
|
1455
poetry.lock
generated
|
@ -3,22 +3,20 @@ name = "jrnl"
|
||||||
version = "v4.1"
|
version = "v4.1"
|
||||||
description = "Collect your thoughts and notes without leaving the command line."
|
description = "Collect your thoughts and notes without leaving the command line."
|
||||||
authors = [
|
authors = [
|
||||||
"jrnl contributors <maintainers@jrnl.sh>",
|
"jrnl contributors <maintainers@jrnl.sh>",
|
||||||
"Manuel Ebert <manuel@1450.me>",
|
"Manuel Ebert <manuel@1450.me>",
|
||||||
"Jonathan Wren <jonathan@nowandwren.com>",
|
"Jonathan Wren <jonathan@nowandwren.com>",
|
||||||
"Micah Ellison <micahellison@gmail.com>"
|
"Micah Ellison <micahellison@gmail.com>",
|
||||||
]
|
|
||||||
maintainers = [
|
|
||||||
"Jonathan Wren and Micah Ellison <maintainers@jrnl.sh>",
|
|
||||||
]
|
]
|
||||||
|
maintainers = ["Jonathan Wren and Micah Ellison <maintainers@jrnl.sh>"]
|
||||||
license = "GPL-3.0-only"
|
license = "GPL-3.0-only"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
homepage = "https://jrnl.sh"
|
homepage = "https://jrnl.sh"
|
||||||
repository = "https://github.com/jrnl-org/jrnl"
|
repository = "https://github.com/jrnl-org/jrnl"
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Topic :: Office/Business :: News/Diary",
|
"Topic :: Office/Business :: News/Diary",
|
||||||
"Environment :: Console",
|
"Environment :: Console",
|
||||||
"Operating System :: OS Independent"
|
"Operating System :: OS Independent",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.poetry.urls]
|
[tool.poetry.urls]
|
||||||
|
@ -29,17 +27,19 @@ classifiers = [
|
||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
python = ">=3.10.0, <3.13"
|
python = ">=3.10.0, <3.13"
|
||||||
|
|
||||||
colorama = ">=0.4" # https://github.com/tartley/colorama/blob/master/CHANGELOG.rst
|
colorama = ">=0.4" # https://github.com/tartley/colorama/blob/master/CHANGELOG.rst
|
||||||
cryptography = ">=3.0" # https://cryptography.io/en/latest/api-stability.html
|
cryptography = ">=3.0" # https://cryptography.io/en/latest/api-stability.html
|
||||||
keyring = ">=21.0" # https://github.com/jaraco/keyring#integration
|
keyring = ">=21.0" # https://github.com/jaraco/keyring#integration
|
||||||
parsedatetime = ">=2.6"
|
parsedatetime = ">=2.6"
|
||||||
python-dateutil = "^2.8" # https://github.com/dateutil/dateutil/blob/master/RELEASING
|
python-dateutil = "^2.8" # https://github.com/dateutil/dateutil/blob/master/RELEASING
|
||||||
pyxdg = ">=0.27.0"
|
pyxdg = ">=0.27.0"
|
||||||
"ruamel.yaml" = ">=0.17.22"
|
"ruamel.yaml" = ">=0.17.22"
|
||||||
rich = ">=12.2.0, <14.0.0"
|
rich = ">=12.2.0, <14.0.0"
|
||||||
|
|
||||||
|
|
||||||
# dayone-only deps
|
# dayone-only deps
|
||||||
tzlocal = ">=4.0" # https://github.com/regebro/tzlocal/blob/master/CHANGES.txt
|
tzlocal = ">=4.0" # https://github.com/regebro/tzlocal/blob/master/CHANGES.txt
|
||||||
|
mkdocs-i18n = "^0.4.6"
|
||||||
|
|
||||||
[tool.poetry.dev-dependencies]
|
[tool.poetry.dev-dependencies]
|
||||||
black = { version = ">=21.5b2", allow-prereleases = true }
|
black = { version = ">=21.5b2", allow-prereleases = true }
|
||||||
|
@ -56,6 +56,10 @@ ruff = ">=0.0.276"
|
||||||
toml = ">=0.10"
|
toml = ">=0.10"
|
||||||
tox = "*"
|
tox = "*"
|
||||||
xmltodict = "*"
|
xmltodict = "*"
|
||||||
|
mkdocs-i18n = "^0.4.6"
|
||||||
|
|
||||||
|
#[tool.poetry.plugins."mkdocs.plugins"]
|
||||||
|
#i18n = "mkdocs_i18n.plugin:I18nPlugin"
|
||||||
|
|
||||||
[tool.poetry.scripts]
|
[tool.poetry.scripts]
|
||||||
jrnl = 'jrnl.main:run'
|
jrnl = 'jrnl.main:run'
|
||||||
|
@ -71,13 +75,9 @@ docs-check.sequence = [
|
||||||
"tasks:run_shell('npx pa11y-ci -c config.json')",
|
"tasks:run_shell('npx pa11y-ci -c config.json')",
|
||||||
"tasks:delete_files(['sitemap.xml', 'config.json'])",
|
"tasks:delete_files(['sitemap.xml', 'config.json'])",
|
||||||
]
|
]
|
||||||
docs-run = [
|
docs-run = [{ cmd = "mkdocs serve" }]
|
||||||
{cmd = "mkdocs serve"},
|
|
||||||
]
|
|
||||||
|
|
||||||
test-run = [
|
test-run = [{ cmd = "tox -q -e py --" }]
|
||||||
{cmd = "tox -q -e py --"},
|
|
||||||
]
|
|
||||||
|
|
||||||
# Groups of tasks
|
# Groups of tasks
|
||||||
format.default_item_type = "cmd"
|
format.default_item_type = "cmd"
|
||||||
|
@ -93,36 +93,21 @@ lint.sequence = [
|
||||||
"ruff --version",
|
"ruff --version",
|
||||||
"ruff .",
|
"ruff .",
|
||||||
"black --version",
|
"black --version",
|
||||||
"black --check ."
|
"black --check .",
|
||||||
]
|
]
|
||||||
|
|
||||||
test = [
|
test = ["lint", "test-run"]
|
||||||
"lint",
|
|
||||||
"test-run",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
minversion = "6.0"
|
minversion = "6.0"
|
||||||
required_plugins = [
|
required_plugins = ["pytest-bdd"]
|
||||||
"pytest-bdd"
|
markers = ["todo", "skip_win", "skip_posix", "on_win", "on_posix"]
|
||||||
]
|
addopts = ["--pdbcls=IPython.terminal.debugger:Pdb", "--tb=native", "-n=auto"]
|
||||||
markers = [
|
|
||||||
"todo",
|
|
||||||
"skip_win",
|
|
||||||
"skip_posix",
|
|
||||||
"on_win",
|
|
||||||
"on_posix",
|
|
||||||
]
|
|
||||||
addopts = [
|
|
||||||
"--pdbcls=IPython.terminal.debugger:Pdb",
|
|
||||||
"--tb=native",
|
|
||||||
"-n=auto",
|
|
||||||
]
|
|
||||||
|
|
||||||
filterwarnings = [
|
filterwarnings = [
|
||||||
"ignore::DeprecationWarning",
|
"ignore::DeprecationWarning",
|
||||||
"ignore:[WinError 32].*",
|
"ignore:[WinError 32].*",
|
||||||
"ignore:[WinError 5].*"
|
"ignore:[WinError 5].*",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
|
@ -130,7 +115,7 @@ line-length = 88
|
||||||
target-version = "py310"
|
target-version = "py310"
|
||||||
|
|
||||||
# https://beta.ruff.rs/docs/rules/
|
# https://beta.ruff.rs/docs/rules/
|
||||||
select = [
|
select = [
|
||||||
'F', # Pyflakes
|
'F', # Pyflakes
|
||||||
'E', # pycodestyle errors
|
'E', # pycodestyle errors
|
||||||
'W', # pycodestyle warnings
|
'W', # pycodestyle warnings
|
||||||
|
@ -145,7 +130,7 @@ select = [
|
||||||
'TID', # flake8-tidy-imports
|
'TID', # flake8-tidy-imports
|
||||||
'TCH', # flake8-type-checking
|
'TCH', # flake8-type-checking
|
||||||
'T100', # debugger, don't allow break points
|
'T100', # debugger, don't allow break points
|
||||||
'ICN' # flake8-import-conventions
|
'ICN', # flake8-import-conventions
|
||||||
]
|
]
|
||||||
exclude = [".git", ".tox", ".venv", "node_modules"]
|
exclude = [".git", ".tox", ".venv", "node_modules"]
|
||||||
|
|
||||||
|
|
192
site/404.html
Normal file
|
@ -0,0 +1,192 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" />
|
||||||
|
<link rel="shortcut icon" href="/img/favicon.ico" />
|
||||||
|
<title>jrnl</title>
|
||||||
|
<link rel="stylesheet" href="/css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="/css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="/assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="/assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="/assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="/." class="icon icon-home"> jrnl
|
||||||
|
</a><div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="/ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="/ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="/.">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="/." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="404-page-not-found">404</h1>
|
||||||
|
|
||||||
|
<p><strong>Page not found</strong></p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="/js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "/";</script>
|
||||||
|
<script src="/js/theme_extra.js"></script>
|
||||||
|
<script src="/js/theme.js"></script>
|
||||||
|
<script src="/search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
322
site/advanced/index.html
Normal file
|
@ -0,0 +1,322 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/advanced/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Advanced Usage - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Advanced Usage";
|
||||||
|
var mkdocs_page_input_path = "advanced.md";
|
||||||
|
var mkdocs_page_url = "/advanced/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Advanced Usage</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#configuration-file">Configuration File</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#multiple-journal-files">Multiple journal files</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#modifying-configurations-from-the-command-line">Modifying Configurations from the Command line</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#examples">Examples:</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#using-an-alternate-config">Using an alternate config</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#examples_1">Examples:</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Advanced Usage</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/advanced.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="advanced-usage">Advanced Usage</h1>
|
||||||
|
<h2 id="configuration-file">Configuration File</h2>
|
||||||
|
<p><code>jrnl</code> has a wide variety of options that can be customized through the config file,
|
||||||
|
including templates, formats, multiple journals, and more. See
|
||||||
|
the <a href="../reference-config-file/">configuration file reference</a> for details
|
||||||
|
or read on for some common use cases.</p>
|
||||||
|
<h3 id="multiple-journal-files">Multiple journal files</h3>
|
||||||
|
<p>You can configure <code>jrnl</code>to use with multiple journals (eg.
|
||||||
|
<code>private</code> and <code>work</code>) by defining more journals in your <a href="../reference-config-file/">config file</a>,
|
||||||
|
for example:</p>
|
||||||
|
<pre><code class="language-yaml">journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work: ~/work.txt
|
||||||
|
</code></pre>
|
||||||
|
<p>The <code>default</code> journal gets created the first time you start <code>jrnl</code>
|
||||||
|
Now you can access the <code>work</code> journal by using <code>jrnl work</code> instead of
|
||||||
|
<code>jrnl</code>, eg.</p>
|
||||||
|
<pre><code class="language-sh">jrnl work at 10am: Meeting with @Steve
|
||||||
|
jrnl work -n 3
|
||||||
|
</code></pre>
|
||||||
|
<p>will both use <code>~/work.txt</code>, while <code>jrnl -n 3</code> will display the last
|
||||||
|
three entries from <code>~/journal.txt</code> (and so does <code>jrnl default -n 3</code>).</p>
|
||||||
|
<p>You can also override the default options for each individual journal.
|
||||||
|
If your <code>jrnl.yaml</code> looks like this:</p>
|
||||||
|
<pre><code class="language-yaml">encrypt: false
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
food: ~/my_recipes.txt
|
||||||
|
</code></pre>
|
||||||
|
<p>Your <code>default</code> and your <code>food</code> journals won't be encrypted, however your
|
||||||
|
<code>work</code> journal will!</p>
|
||||||
|
<p>You can override all options that are present at
|
||||||
|
the top level of <code>jrnl.yaml</code>, just make sure that at the very least
|
||||||
|
you specify a <code>journal: ...</code> key that points to the journal file of
|
||||||
|
that journal.</p>
|
||||||
|
<p>Consider the following example configuration</p>
|
||||||
|
<pre><code class="language-yaml">editor: vi -c startinsert
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
display_format: json
|
||||||
|
editor: code -rw
|
||||||
|
food:
|
||||||
|
display_format: markdown
|
||||||
|
journal: ~/recipes.txt
|
||||||
|
</code></pre>
|
||||||
|
<p>The <code>work</code> journal is encrypted, prints to <code>json</code> by default, and is edited using an existing window of VSCode. Similarly, the <code>food</code> journal prints to markdown by default, but uses all the other defaults.</p>
|
||||||
|
<h3 id="modifying-configurations-from-the-command-line">Modifying Configurations from the Command line</h3>
|
||||||
|
<p>You can override a configuration field for the current instance of <code>jrnl</code> using <code>--config-override CONFIG_KEY CONFIG_VALUE</code> where <code>CONFIG_KEY</code> is a valid configuration field, specified in dot notation and <code>CONFIG_VALUE</code> is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as <code>colors.title</code> for the <code>title</code> key within the <code>colors</code> key.</p>
|
||||||
|
<p>You can specify multiple overrides as multiple calls to <code>--config-override</code>.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>These overrides allow you to modify <strong><em>any</em></strong> field of your jrnl configuration. We trust that you know what you are doing. </p>
|
||||||
|
</div>
|
||||||
|
<h4 id="examples">Examples:</h4>
|
||||||
|
<pre><code class="language-sh"># Create an entry using the `stdin` prompt, for rapid logging
|
||||||
|
jrnl --config-override editor ""
|
||||||
|
|
||||||
|
# Populate a project's log
|
||||||
|
jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel
|
||||||
|
|
||||||
|
# Pass multiple overrides
|
||||||
|
jrnl --config-override display_format fancy --config-override linewrap 20 \
|
||||||
|
--config-override colors.title green
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="using-an-alternate-config">Using an alternate config</h3>
|
||||||
|
<p>You can specify an alternate configuration file for the current instance of <code>jrnl</code> using <code>--config-file CONFIG_FILE_PATH</code> where
|
||||||
|
<code>CONFIG_FILE_PATH</code> is a path to an alternate <code>jrnl</code> configuration file. </p>
|
||||||
|
<h4 id="examples_1">Examples:</h4>
|
||||||
|
<pre><code class="language-sh"># Use personalised configuration file for personal journal entries
|
||||||
|
jrnl --config-file ~/foo/jrnl/personal-config.yaml
|
||||||
|
|
||||||
|
# Use alternate configuration file for work-related entries
|
||||||
|
jrnl --config-file ~/foo/jrnl/work-config.yaml
|
||||||
|
|
||||||
|
# Use default configuration file (created on first run)
|
||||||
|
jrnl
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../formats/" class="btn btn-neutral float-left" title="Formats"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../external-editors/" class="btn btn-neutral float-right" title="External Editors">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../formats/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../external-editors/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
34
site/assets/colors.css
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
/*
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
*/
|
||||||
|
|
||||||
|
:root {
|
||||||
|
/* For dark bg */
|
||||||
|
--white: #fcfcfc;
|
||||||
|
--off-white: #f4f0ff;
|
||||||
|
--purple: #7e57c2;
|
||||||
|
--light-purple: #cf93e6;
|
||||||
|
--blue: #61aeee;
|
||||||
|
--green: #a6e22e;
|
||||||
|
--orange: #fd971f;
|
||||||
|
--red: #eb5567;
|
||||||
|
--pink: #d57699;
|
||||||
|
--yellow: #e2b93d;
|
||||||
|
|
||||||
|
/* For light bg */
|
||||||
|
--black: #404040;
|
||||||
|
--teal: #2a8068;
|
||||||
|
--dark-blue: #356eb7;
|
||||||
|
--mid-purple: #846392;
|
||||||
|
--bright-purple: #af27ad;
|
||||||
|
--dark-purple: #604385;
|
||||||
|
--darkest-purple: #251A32;
|
||||||
|
--grey: #3b3b4a;
|
||||||
|
|
||||||
|
--black-shadow: #0000001A;
|
||||||
|
--blacker-shadow: #00000059;
|
||||||
|
|
||||||
|
/* Special cases */
|
||||||
|
--terminal: #1b1c2e;
|
||||||
|
}
|
141
site/assets/highlight.css
Normal file
|
@ -0,0 +1,141 @@
|
||||||
|
/*
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
|
||||||
|
Atom One Dark With support for ReasonML by Gidi Morris, based off work by
|
||||||
|
Daniel Gamage
|
||||||
|
|
||||||
|
Original One Dark Syntax theme from https://github.com/atom/one-dark-syntax
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: 0.5em;
|
||||||
|
line-height: 1.3em;
|
||||||
|
color: var(--off-white);
|
||||||
|
background: #383e49;
|
||||||
|
border-radius: 5px;
|
||||||
|
font-size: 0.9rem;
|
||||||
|
line-height: 1.3rem;
|
||||||
|
}
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-operator {
|
||||||
|
color: var(--pink);
|
||||||
|
}
|
||||||
|
.hljs-pattern-match {
|
||||||
|
color: var(--pink);
|
||||||
|
}
|
||||||
|
.hljs-pattern-match .hljs-constructor {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
.hljs-function {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
.hljs-function .hljs-params {
|
||||||
|
color: var(--green);
|
||||||
|
}
|
||||||
|
.hljs-function .hljs-params .hljs-typing {
|
||||||
|
color: var(--orange);
|
||||||
|
}
|
||||||
|
.hljs-module-access .hljs-module {
|
||||||
|
color: var(--purple);
|
||||||
|
}
|
||||||
|
.hljs-constructor {
|
||||||
|
color: var(--yellow);
|
||||||
|
}
|
||||||
|
.hljs-constructor .hljs-string {
|
||||||
|
color: var(--green);
|
||||||
|
}
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: var(--light-purple);
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.hljs-doctag,
|
||||||
|
.hljs-formula {
|
||||||
|
color: var(--purple);
|
||||||
|
}
|
||||||
|
.hljs-section,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-selector-tag,
|
||||||
|
.hljs-deletion,
|
||||||
|
.hljs-subst {
|
||||||
|
color: var(--yellow);
|
||||||
|
}
|
||||||
|
.hljs-literal {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-addition,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-meta-string {
|
||||||
|
color: var(--green);
|
||||||
|
}
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-class .hljs-title {
|
||||||
|
color: var(--orange);
|
||||||
|
}
|
||||||
|
.hljs-attr,
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-selector-class,
|
||||||
|
.hljs-selector-attr,
|
||||||
|
.hljs-selector-pseudo,
|
||||||
|
.hljs-number {
|
||||||
|
color: var(--orange);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content a tt,
|
||||||
|
.rst-content a tt,
|
||||||
|
.rst-content a code {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-tag .hljs-attr {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-tag {
|
||||||
|
color: var(--pink)
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-symbol,
|
||||||
|
.hljs-bullet,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-title {
|
||||||
|
color: var(--blue);
|
||||||
|
}
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
.hljs-link {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content .note .admonition-title {
|
||||||
|
background: var(--dark-blue);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content .note.admonition {
|
||||||
|
background: var(--light-blue);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content .tip .admonition-title {
|
||||||
|
background: var(--teal);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content .tip .admonition {
|
||||||
|
background: var(--light-blue);
|
||||||
|
}
|
325
site/assets/index.css
Normal file
|
@ -0,0 +1,325 @@
|
||||||
|
/*
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* reset */article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block}audio:not([controls]){display:none;height:0}[hidden]{display:none}html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{font-size:2em;margin:.67em 0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}mark{background:#ff0;color:#000}code,kbd,pre,samp{font-family:monospace,serif;font-size:1em}pre{white-space:pre-wrap}q{quotes:"\201C" "\201D" "\2018" "\2019"}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:0}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0}
|
||||||
|
|
||||||
|
body {
|
||||||
|
background-color: var(--white);
|
||||||
|
font-family: "Open Sans", "Helvetica Neue", sans-serif;
|
||||||
|
font-weight: 300;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon {
|
||||||
|
background-image: url("../img/sprites.svg");
|
||||||
|
width: 32px;
|
||||||
|
height: 32px;
|
||||||
|
display: inline-block;
|
||||||
|
font-size: 40px;
|
||||||
|
background-size: 200px 80px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
font-weight: 400;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.secure {
|
||||||
|
background-position: 0em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.future {
|
||||||
|
background-position: -1em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.search {
|
||||||
|
background-position: -2em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.nli {
|
||||||
|
background-position: -3em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.share {
|
||||||
|
background-position: 0em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.sync {
|
||||||
|
background-position: 0 -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.dayone {
|
||||||
|
background-position: -1em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.github {
|
||||||
|
background-position: -2em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.search {
|
||||||
|
background-position: -2em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.folders {
|
||||||
|
background-position: -3em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon.twitter {
|
||||||
|
background-position: -4em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
header {
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
background-image: linear-gradient(211deg, var(--mid-purple) 0%, var(--dark-purple) 100%);
|
||||||
|
color: var(--white);
|
||||||
|
border: 0px solid transparent;
|
||||||
|
display: relative;
|
||||||
|
padding-top: 150px;
|
||||||
|
overflow: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
#terminal {
|
||||||
|
background: var(--terminal);
|
||||||
|
max-width: 520px;
|
||||||
|
box-shadow: 0 -2px 16px 0 var(--black-shadow);
|
||||||
|
border-radius: 6px;
|
||||||
|
min-height: 120px;
|
||||||
|
margin: 0px auto;
|
||||||
|
position: relative;
|
||||||
|
transform: translateY(75px);
|
||||||
|
color: var(--off-white);
|
||||||
|
font-family: "Monaco", "Courier New";
|
||||||
|
font-size: 18px;
|
||||||
|
padding: 45px 20px 0px 20px;
|
||||||
|
line-height: 165%;
|
||||||
|
}
|
||||||
|
|
||||||
|
#terminal b {
|
||||||
|
font-weight: normal;
|
||||||
|
color: var(--off-white);
|
||||||
|
}
|
||||||
|
|
||||||
|
#terminal i {
|
||||||
|
font-style: normal;
|
||||||
|
color: var(--light-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
#terminal:before {
|
||||||
|
content: "";
|
||||||
|
position: absolute;
|
||||||
|
top: 15px;
|
||||||
|
left: 15px;
|
||||||
|
display: inline-block;
|
||||||
|
width: 15px;
|
||||||
|
height: 15px;
|
||||||
|
border-radius: 50%;
|
||||||
|
background: var(--grey);
|
||||||
|
box-shadow: 25px 0 0 var(--grey), 50px 0 0 var(--grey);
|
||||||
|
}
|
||||||
|
|
||||||
|
#typed:before {
|
||||||
|
content: "$ ";
|
||||||
|
color: var(--mid-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
#twitter {
|
||||||
|
display: block;
|
||||||
|
position: absolute;
|
||||||
|
text-decoration: none;
|
||||||
|
top: 20px;
|
||||||
|
right: 20px;
|
||||||
|
border: 1px solid var(--white);
|
||||||
|
padding: 5px 10px;
|
||||||
|
color: var(--white);
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#twitter .icon {
|
||||||
|
transform: scale(0.5);
|
||||||
|
vertical-align: -18%;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#twitter:hover,
|
||||||
|
#twitter:active {
|
||||||
|
text-decoration: none;
|
||||||
|
box-shadow: 0 2px 25px 0 var(--blacker-shadow);
|
||||||
|
transition: all .5s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
#title {
|
||||||
|
max-width: 630px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 0px 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#prompt {
|
||||||
|
max-width: 700px;
|
||||||
|
margin: 25px auto 100px auto;
|
||||||
|
padding: 0px 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
header img {
|
||||||
|
float: left;
|
||||||
|
margin-right: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
color: var(--white);
|
||||||
|
font-weight: 300;
|
||||||
|
}
|
||||||
|
|
||||||
|
a,
|
||||||
|
a:visited {
|
||||||
|
color: var(--dark-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
color: var(--bright-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
nav {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a#twitter-nav {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a, nav a:visited {
|
||||||
|
color: var(--dark-purple);
|
||||||
|
font-size: 20px;
|
||||||
|
line-height: 2.5em;
|
||||||
|
margin: 0 40px;
|
||||||
|
font-weight: 400;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a:hover,
|
||||||
|
nav a:visited:hover {
|
||||||
|
color: var(--bright-purple);
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
nav a.cta {
|
||||||
|
display: inline-block;
|
||||||
|
color: var(--white);
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
background-image: linear-gradient(259deg, var(--mid-purple) 0%, var(--dark-purple) 100%);
|
||||||
|
box-shadow: 0 2px 8px 0 var(--blacker-shadow);
|
||||||
|
border-radius: 50px;
|
||||||
|
padding: 0 2em;
|
||||||
|
white-space: nowrap;
|
||||||
|
transition: all 0.1s ease;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a.cta:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
background-image: linear-gradient(259deg, var(--bright-purple) 0%, var(--dark-purple) 100%);
|
||||||
|
box-shadow: 0 4px 16px 0 var(--black-shadow);
|
||||||
|
color: var(--off-white);
|
||||||
|
}
|
||||||
|
|
||||||
|
main {
|
||||||
|
padding: 60px 0 0 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex {
|
||||||
|
display: flex;
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 920px;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
padding: 20px 20px;
|
||||||
|
padding-top: 30px;
|
||||||
|
justify-content: space-between;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex section {
|
||||||
|
/*margin: 20px;*/
|
||||||
|
margin-top: 40px;
|
||||||
|
width: 32%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex section:first-child {
|
||||||
|
margin-left: 0px;
|
||||||
|
}
|
||||||
|
.flex section:last-child {
|
||||||
|
margin-right: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex section i {
|
||||||
|
float: left;
|
||||||
|
left: 0;
|
||||||
|
display: block;
|
||||||
|
margin: 0px auto 10px auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex section h3 {
|
||||||
|
margin-top: 0;
|
||||||
|
font-size: 18px;
|
||||||
|
color: var(--dark-purple);
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
font-weight: 300;
|
||||||
|
margin-left: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex section p {
|
||||||
|
padding-left: 40px;
|
||||||
|
color: var(--grey);
|
||||||
|
font-size: 16px;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
footer {
|
||||||
|
color: var(--grey);
|
||||||
|
max-width: 700px;
|
||||||
|
margin: 70px auto 20px;
|
||||||
|
padding: 0 20px 20px 20px;
|
||||||
|
font-size: 16px;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 680px) {
|
||||||
|
.flex {
|
||||||
|
display: block;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
.flex section {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
main {
|
||||||
|
padding: 20px;
|
||||||
|
margin: 0;
|
||||||
|
width: calc(100% - 40px);
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a,
|
||||||
|
nav a#twitter-nav {
|
||||||
|
display: inline-block;
|
||||||
|
margin: 0px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav a.cta {
|
||||||
|
display: block;
|
||||||
|
margin: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
header #twitter {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
header #logo {
|
||||||
|
display: block;
|
||||||
|
float: none;
|
||||||
|
margin: 0px auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
header #title br {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
378
site/assets/theme.css
Normal file
|
@ -0,0 +1,378 @@
|
||||||
|
/*
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
/* Overrides for jrnl theme */
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
|
||||||
|
body.wy-body-for-nav,
|
||||||
|
section.wy-nav-content-wrap {
|
||||||
|
background-color: var(--white);
|
||||||
|
color: var(--black);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content pre {
|
||||||
|
background-color: transparent;
|
||||||
|
border: none;
|
||||||
|
margin: 1em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content code {
|
||||||
|
color: var(--darkest-purple);
|
||||||
|
background-color: var(--off-white);
|
||||||
|
font-size: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content pre code {
|
||||||
|
color: var(--off-white);
|
||||||
|
background: var(--darkest-purple);
|
||||||
|
padding: 1em 1.5em;
|
||||||
|
border-radius: 15px;
|
||||||
|
border: none;
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 1.5em;
|
||||||
|
font-weight: 200 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1,
|
||||||
|
h2,
|
||||||
|
h3,
|
||||||
|
h4,
|
||||||
|
h5,
|
||||||
|
h6 {
|
||||||
|
font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif;
|
||||||
|
font-weight: 600;
|
||||||
|
margin-top: 2rem;
|
||||||
|
margin-bottom: 0.2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
font-size: 1.2em;
|
||||||
|
margin-top: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
font-size: 1.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h4 {
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
p,
|
||||||
|
td,
|
||||||
|
tr,
|
||||||
|
div,
|
||||||
|
li {
|
||||||
|
font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif;
|
||||||
|
font-weight: 00;
|
||||||
|
font-size: 18px;
|
||||||
|
line-height: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 1em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* No-one likes lines that are 400 characters long. */
|
||||||
|
div.rst-content {
|
||||||
|
max-width: 54em;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
.wy-side-nav-search,
|
||||||
|
.wy-menu-vertical li.current,
|
||||||
|
.wy-menu-vertical li.toctree-l1.current > a,
|
||||||
|
.wy-menu-vertical li.toctree-l2.current > a,
|
||||||
|
.wy-menu-vertical li.toctree-l3.current > a {
|
||||||
|
background-color: transparent;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.toctree-l2.current li.toctree-l3,
|
||||||
|
.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a {
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.toctree-l4,
|
||||||
|
.wy-menu-vertical li.toctree-l5,
|
||||||
|
.wy-menu-vertical li.toctree-l6,
|
||||||
|
.wy-menu-vertical li.toctree-l7 {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-nav-top {
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
background-image: linear-gradient(-211deg, var(--mid-purple) 0%, var(--dark-purple) 100%);
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-nav-top .fa-bars {
|
||||||
|
line-height: 50px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search a.icon-home {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 250px;
|
||||||
|
background-size: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search a.icon-home:before {
|
||||||
|
display: block;
|
||||||
|
width: 84px;
|
||||||
|
height: 70px;
|
||||||
|
content: "";
|
||||||
|
background: url(../img/logo_white.svg) center center no-repeat;
|
||||||
|
margin: 10px auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical a,
|
||||||
|
.wy-menu-vertical li ul li a {
|
||||||
|
font-size: 16px;
|
||||||
|
color: var(--white);
|
||||||
|
line-height: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical a:hover,
|
||||||
|
.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover,
|
||||||
|
.wy-menu-vertical li.current a:hover {
|
||||||
|
background-color: var(--black-shadow);
|
||||||
|
color: var(--white);
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.on a {
|
||||||
|
transition: all .25s ease;
|
||||||
|
background: var(--dark-purple);
|
||||||
|
color: var(--white);
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.toctree-l1.current > a {
|
||||||
|
background: var(--darkest-purple);
|
||||||
|
border: none !important;
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.on a,
|
||||||
|
.wy-menu-vertical li.current a {
|
||||||
|
border-right: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.on a,
|
||||||
|
.wy-menu-vertical li > a.current:after {
|
||||||
|
position: absolute;
|
||||||
|
right: 0em;
|
||||||
|
z-index: 999;
|
||||||
|
content: "";
|
||||||
|
width: 0;
|
||||||
|
height: 0;
|
||||||
|
border-top: 1em solid transparent;
|
||||||
|
border-bottom: 1em solid transparent;
|
||||||
|
border-right: 1em solid var(--white);
|
||||||
|
}
|
||||||
|
|
||||||
|
.toctree-expand:before {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-versions,
|
||||||
|
.rst-versions .rst-current-version {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical p.caption {
|
||||||
|
margin-top: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical span {
|
||||||
|
color: var(--white);
|
||||||
|
font-size: 1.2em;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li a {
|
||||||
|
color: var(--white) !important;
|
||||||
|
font-weight: 300;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
.wy-nav-side {
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
font-weight: 300;
|
||||||
|
height: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
footer {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search input[type=text],
|
||||||
|
.mkdocs-search input[type=text],
|
||||||
|
form .search-query {
|
||||||
|
background-color: var(--off-white);
|
||||||
|
border: none;
|
||||||
|
margin-bottom: 1em;
|
||||||
|
color: var(--black);
|
||||||
|
font-weight: 500;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search input[type=text]::placeholder,
|
||||||
|
.mkdocs-search input[type=text]::placeholder,
|
||||||
|
form .search-query::placeholder {
|
||||||
|
color: var(--dark-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search > a:hover {
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-menu-vertical li.current ul {
|
||||||
|
background-color: var(--mid-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
/* Logo: ; */
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
|
||||||
|
.logo {
|
||||||
|
width: 128px;
|
||||||
|
height: 128px;
|
||||||
|
vertical-align: middle;
|
||||||
|
margin-right: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
/* Code blocks in callouts */
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
|
||||||
|
div.admonition {
|
||||||
|
border-radius: 5px;
|
||||||
|
margin: 1em -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition p.admonition-title {
|
||||||
|
border-top-left-radius: 5px;
|
||||||
|
border-top-right-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition>p {
|
||||||
|
padding: 0em .5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
div.admonition div.highlight {
|
||||||
|
background: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
/* Fancy ordered lists. */
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
|
||||||
|
ol {
|
||||||
|
counter-reset: li;
|
||||||
|
margin-left: 0px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol li {
|
||||||
|
list-style: none !important;
|
||||||
|
margin-bottom: 1.5em;
|
||||||
|
margin-left: 3em !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol>li:before {
|
||||||
|
content: counter(li);
|
||||||
|
counter-increment: li;
|
||||||
|
background-color: var(--sidebar);
|
||||||
|
border-radius: 50%;
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
margin-left: -3em;
|
||||||
|
margin-top: -.3em;
|
||||||
|
width: 2em;
|
||||||
|
height: 2em;
|
||||||
|
color: var(--dark-purple);
|
||||||
|
text-align: center;
|
||||||
|
line-height: 2em;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
/* Accessibility-related changes */
|
||||||
|
/* ------------------------------------------------------------ */
|
||||||
|
.rst-content div[role="main"] a,
|
||||||
|
.rst-content div[role="main"] a:visited {
|
||||||
|
color: var(--mid-purple);
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content div[role="main"] a:hover {
|
||||||
|
color: var(--bright-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content div[role="navigation"] a,
|
||||||
|
.rst-content div[role="navigation"] a:visited {
|
||||||
|
color: var(--mid-purple);
|
||||||
|
}
|
||||||
|
|
||||||
|
.mkdocs-search {
|
||||||
|
display: flex;
|
||||||
|
margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.wy-side-nav-search input[type="text"],
|
||||||
|
.mkdocs-search input[type=text] {
|
||||||
|
border-radius: 50px 0 0 50px;
|
||||||
|
height: 32px;
|
||||||
|
border-right: none;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mkdocs-search button {
|
||||||
|
background-color: var(--off-white);
|
||||||
|
border: none;
|
||||||
|
box-shadow: none;
|
||||||
|
color: var(--mid-purple);
|
||||||
|
border-radius: 0 50px 50px 0;
|
||||||
|
height: 32px;
|
||||||
|
width: 2.5em;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mkdocs-search {
|
||||||
|
border-radius: 50px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mkdocs-search:focus-within {
|
||||||
|
box-shadow: 0 2px 25px 0 var(--blacker-shadow);
|
||||||
|
transition: all .5s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content div[role="main"] .mkdocs-search input[type="text"] {
|
||||||
|
border-right: none;
|
||||||
|
font-size: 100%;
|
||||||
|
height: 48px;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content div[role="main"] .mkdocs-search button {
|
||||||
|
border-left: none;
|
||||||
|
font-size: 100%;
|
||||||
|
height: 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content div[role="main"] .mkdocs-search button:before {
|
||||||
|
font-size: 140%;
|
||||||
|
position: relative;
|
||||||
|
left: -7px;
|
||||||
|
top: -1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-results {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
360
site/contributing/index.html
Normal file
|
@ -0,0 +1,360 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/contributing/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Contributing to jrnl - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Contributing to jrnl";
|
||||||
|
var mkdocs_page_input_path = "contributing.md";
|
||||||
|
var mkdocs_page_url = "/contributing/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Contributing to jrnl</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#table-of-contents">Table of Contents</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#code-of-conduct">Code of Conduct</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#reporting-bugs">Reporting Bugs</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#editing-documentation">Editing Documentation</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#external-editors-and-tips-and-tricks">External editors and tips and tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#testing">Testing</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#prereleases">Prereleases</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#pull-requests">Pull requests</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#confirm-bug-reports">Confirm bug reports</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#automate-tests">Automate tests</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#submitting-feature-requests-and-ideas">Submitting feature requests and ideas</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#developing">Developing</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#getting-your-environment-set-up">Getting your environment set up</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#understanding-the-branches">Understanding the branches</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#common-development-commands">Common development commands</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#updating-automated-tests">Updating automated tests</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#submitting-pull-requests">Submitting pull requests</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#finding-things-to-work-on">Finding things to work on</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#a-note-for-new-programmers-and-programmers-new-to-python">A note for new programmers and programmers new to python</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>Contributing »</li>
|
||||||
|
<li>Contributing to jrnl</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/contributing.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="contributing-to-jrnl">Contributing to jrnl</h1>
|
||||||
|
<p>We welcome contributions to jrnl, whether it's through reporting bugs, improving the documentation, testing releases, engaging in discussion on features and bugs, or writing code.</p>
|
||||||
|
<h2 id="table-of-contents">Table of Contents</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#code-of-conduct">Code of Conduct</a></li>
|
||||||
|
<li><a href="#reporting-bugs">Reporting Bugs</a></li>
|
||||||
|
<li><a href="#editing-documentation">Editing Documentation</a></li>
|
||||||
|
<li><a href="#testing">Testing</a></li>
|
||||||
|
<li><a href="#submitting-feature-requests-and-ideas">Submitting feature requests and ideas</a></li>
|
||||||
|
<li><a href="#developing">Developing jrnl</a></li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="code-of-conduct">Code of Conduct</h2>
|
||||||
|
<p>Before starting, please read the <a href="https://github.com/jrnl-org/jrnl/blob/develop/CODE_OF_CONDUCT.md">Code of Conduct</a>.</p>
|
||||||
|
<h2 id="reporting-bugs">Reporting Bugs</h2>
|
||||||
|
<p>Please report bugs by <a href="https://github.com/jrnl-org/jrnl/issues/new/choose">opening a new issue</a> and describing it as well as possible. Many bugs are specific to a particular operating system and Python version, so please include that information!</p>
|
||||||
|
<h2 id="editing-documentation">Editing Documentation</h2>
|
||||||
|
<p>If you find a typo or a mistake in the docs, please fix it right away and send a pull request. If you're unsure what to change but still see a problem, you can <a href="https://github.com/jrnl-org/jrnl/issues/new/choose">open a new issue</a> with the "Documentation change" type.</p>
|
||||||
|
<p>To edit the documentation, edit the <code>docs/*.md</code> files on the <strong>develop</strong> branch. You can see the result by running <code>poe docs-run</code> inside the project's root directory, then navigating your browser to <a href="http://localhost:8000">localhost:8000</a>.</p>
|
||||||
|
<h3 id="external-editors-and-tips-and-tricks">External editors and tips and tricks</h3>
|
||||||
|
<p>If you'd like to share a jrnl command line trick that you find useful, you may find it worthwhile to add it to the <a href="../tips-and-tricks/">"Tips and Tricks" section</a>. For advice on how to integrate a particular external editor, you can add to the <a href="../external-editors/">"External Editors" section</a>.</p>
|
||||||
|
<h2 id="testing">Testing</h2>
|
||||||
|
<p>Much of the work of maintaining jrnl involves testing rather than coding.</p>
|
||||||
|
<p>The nature of jrnl means we deal with extremely sensitive data, and can't risk data loss. While jrnl does have a comprehensive automated testing suite, user testing is crucial to mitigating this risk.</p>
|
||||||
|
<h3 id="prereleases">Prereleases</h3>
|
||||||
|
<p><a href="https://pypi.org/project/jrnl/#history">Prereleases are deployed through PyPi much like normal releases</a>. You can use <a href="https://pypi.org/project/pipx/">pipx</a> to fetch them and test them. See the <a href="https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md">changelog</a> for information on what has changed with each release.</p>
|
||||||
|
<h3 id="pull-requests">Pull requests</h3>
|
||||||
|
<p>If you are comfortable enough with git, feel free to fetch particular <a href="https://github.com/jrnl-org/jrnl/pulls">pull requests</a>, test them yourself, and report back your findings. Bonus points if you can add a screencast of how the new feature works.</p>
|
||||||
|
<h3 id="confirm-bug-reports">Confirm bug reports</h3>
|
||||||
|
<p>There are always <a href="https://github.com/jrnl-org/jrnl/issues?q=is%3Aissue+is%3Aopen+label%3Abug">open bugs among our GitHub issues</a> and many are specific to a particular OS, Python version, or jrnl version. A simple comment like "Confirmed on jrnl v2.2, MacOS 10.15, Python 3.8.1" would be extremely helpful in tracking down bugs.</p>
|
||||||
|
<h3 id="automate-tests">Automate tests</h3>
|
||||||
|
<p>See the develop section below for information on how to contribute new automated tests.</p>
|
||||||
|
<h2 id="submitting-feature-requests-and-ideas">Submitting feature requests and ideas</h2>
|
||||||
|
<p>If you have a feature request or idea for jrnl, please <a href="https://github.com/jrnl-org/jrnl/issues/new/choose">open a new issue</a> and describe the goal of the feature, and any relevant use cases. We'll discuss the issue with you, and decide if it's a good fit for the project.</p>
|
||||||
|
<p>When discussing new features, please keep in mind our design goals. jrnl strives to
|
||||||
|
<a href="https://en.wikipedia.org/wiki/Unix_philosophy">do one thing well</a>. To us, that means:</p>
|
||||||
|
<ul>
|
||||||
|
<li>being <em>nimble</em></li>
|
||||||
|
<li>having a simple interface</li>
|
||||||
|
<li>avoiding duplicating functionality</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="developing">Developing</h2>
|
||||||
|
<h3 id="getting-your-environment-set-up">Getting your environment set up</h3>
|
||||||
|
<p>You will need to install <a href="https://python-poetry.org/">poetry</a> to develop jrnl. It will take care of all of the project's other dependencies.</p>
|
||||||
|
<h3 id="understanding-the-branches">Understanding the branches</h3>
|
||||||
|
<p>jrnl uses two primary branches:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>develop</code> - for ongoing development</li>
|
||||||
|
<li><code>release</code> - for releases</li>
|
||||||
|
</ul>
|
||||||
|
<p>In general, pull requests should be made on the <code>develop</code> branch.</p>
|
||||||
|
<h3 id="common-development-commands">Common development commands</h3>
|
||||||
|
<p>You can find an inventory of commands in the <code>pyproject.toml</code>. Users can run the commands by typing <code>poe</code> followed by the name of the command (<a href="https://github.com/nat-n/poethepoet">Poe the Poet</a> can be installed on its own, or as part of <code>poetry install</code>).</p>
|
||||||
|
<p>A typical development workflow includes:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Installing dependencies:<ul>
|
||||||
|
<li><code>poetry install</code></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Activate virtual environment:<ul>
|
||||||
|
<li><code>poetry shell</code></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Running the source in a virtual environment:<ul>
|
||||||
|
<li><code>jrnl</code> (with or without arguments as necessary)</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Running tests:<ul>
|
||||||
|
<li><code>poe test</code></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Formatting the code to standardize its style:<ul>
|
||||||
|
<li><code>poe format</code></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="updating-automated-tests">Updating automated tests</h3>
|
||||||
|
<p>When resolving bugs or adding new functionality, please add tests to prevent that functionality from breaking in the future. If you notice any functionality that isn't covered in the tests, feel free to submit a test-only pull request as well.</p>
|
||||||
|
<p>For testing, jrnl uses <a href="https://docs.pytest.org">pytest</a> for unit tests, and <a href="https://pytest-bdd.readthedocs.io/">pytest-bdd</a> for integration testing. All tests are in the <code>tests</code> folder.</p>
|
||||||
|
<p>Many tests can be created by only editing <code>*.feature</code> files with the same format as other tests. For more complicated functionality, you may need to implement steps in <code>tests/lib/</code> which are then executed by your tests in the <code>feature</code> files.</p>
|
||||||
|
<h3 id="submitting-pull-requests">Submitting pull requests</h3>
|
||||||
|
<p>When you're ready, feel free to submit a pull request (PR). The jrnl maintainers generally review the pull requests every two weeks, but the continuous integration pipeline will run on automated tests on it within a matter of minutes and will report back any issues it has found with your code across a variety of environments.</p>
|
||||||
|
<p>The pull request template contains a checklist full of housekeeping items. Please fill them out as necessary when you submit.</p>
|
||||||
|
<p>If a pull request contains failing tests, it probably will not be reviewed, and it definitely will not be approved. However, if you need help resolving a failing test, please mention that in your PR.</p>
|
||||||
|
<h3 id="finding-things-to-work-on">Finding things to work on</h3>
|
||||||
|
<p>You can search the <a href="https://github.com/jrnl-org/jrnl/issues">jrnl GitHub issues</a> by <a href="https://github.com/jrnl-org/jrnl/labels">label</a> for things to work on. Here are some labels worth searching:</p>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/critical">critical</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/help%20wanted">help wanted</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/bug">bug</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/enhancement">enhancement</a></li>
|
||||||
|
</ul>
|
||||||
|
<p>You can also get a feel for the project's priorities by reviewing the <a href="https://github.com/jrnl-org/jrnl/milestones">milestones</a>.</p>
|
||||||
|
<h3 id="a-note-for-new-programmers-and-programmers-new-to-python">A note for new programmers and programmers new to python</h3>
|
||||||
|
<p>Although jrnl has grown quite a bit since its inception, the overall complexity (for an end-user program) is fairly low, and we hope you'll find the code easy enough to understand.</p>
|
||||||
|
<p>If you have a question, please don't hesitate to ask! Python is known for its welcoming community and openness to novice programmers, so feel free to fork the code and play around with it! If you create something you want to share with us, please create a pull request. We never expect pull requests to be perfect, idiomatic, instantly mergeable code. We can work through it together!</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../reference-config-file/" class="btn btn-neutral float-left" title="Configuration File"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../ja/overview/" class="btn btn-neutral float-right" title="概要">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-config-file/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../ja/overview/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
BIN
site/css/fonts/Roboto-Slab-Bold.woff
Normal file
BIN
site/css/fonts/Roboto-Slab-Bold.woff2
Normal file
BIN
site/css/fonts/Roboto-Slab-Regular.woff
Normal file
BIN
site/css/fonts/Roboto-Slab-Regular.woff2
Normal file
BIN
site/css/fonts/fontawesome-webfont.eot
Normal file
2671
site/css/fonts/fontawesome-webfont.svg
Normal file
After Width: | Height: | Size: 434 KiB |
BIN
site/css/fonts/fontawesome-webfont.ttf
Normal file
BIN
site/css/fonts/fontawesome-webfont.woff
Normal file
BIN
site/css/fonts/fontawesome-webfont.woff2
Normal file
BIN
site/css/fonts/lato-bold-italic.woff
Normal file
BIN
site/css/fonts/lato-bold-italic.woff2
Normal file
BIN
site/css/fonts/lato-bold.woff
Normal file
BIN
site/css/fonts/lato-bold.woff2
Normal file
BIN
site/css/fonts/lato-normal-italic.woff
Normal file
BIN
site/css/fonts/lato-normal-italic.woff2
Normal file
BIN
site/css/fonts/lato-normal.woff
Normal file
BIN
site/css/fonts/lato-normal.woff2
Normal file
13
site/css/theme.css
Normal file
197
site/css/theme_extra.css
Normal file
|
@ -0,0 +1,197 @@
|
||||||
|
/*
|
||||||
|
* Wrap inline code samples otherwise they shoot of the side and
|
||||||
|
* can't be read at all.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/313
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/233
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/834
|
||||||
|
*/
|
||||||
|
.rst-content code {
|
||||||
|
white-space: pre-wrap;
|
||||||
|
word-wrap: break-word;
|
||||||
|
padding: 2px 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make code blocks display as blocks and give them the appropriate
|
||||||
|
* font size and padding.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/855
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/834
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/233
|
||||||
|
*/
|
||||||
|
.rst-content pre code {
|
||||||
|
white-space: pre;
|
||||||
|
word-wrap: normal;
|
||||||
|
display: block;
|
||||||
|
padding: 12px;
|
||||||
|
font-size: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fix code colors
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/2027
|
||||||
|
*/
|
||||||
|
.rst-content code {
|
||||||
|
color: #E74C3C;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rst-content pre code {
|
||||||
|
color: #000;
|
||||||
|
background: #f8f8f8;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Fix link colors when the link text is inline code.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/718
|
||||||
|
*/
|
||||||
|
a code {
|
||||||
|
color: #2980B9;
|
||||||
|
}
|
||||||
|
a:hover code {
|
||||||
|
color: #3091d1;
|
||||||
|
}
|
||||||
|
a:visited code {
|
||||||
|
color: #9B59B6;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* The CSS classes from highlight.js seem to clash with the
|
||||||
|
* ReadTheDocs theme causing some code to be incorrectly made
|
||||||
|
* bold and italic.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/411
|
||||||
|
*/
|
||||||
|
pre .cs, pre .c {
|
||||||
|
font-weight: inherit;
|
||||||
|
font-style: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Fix some issues with the theme and non-highlighted code
|
||||||
|
* samples. Without and highlighting styles attached the
|
||||||
|
* formatting is broken.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/319
|
||||||
|
*/
|
||||||
|
.rst-content .no-highlight {
|
||||||
|
display: block;
|
||||||
|
padding: 0.5em;
|
||||||
|
color: #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Additions specific to the search functionality provided by MkDocs
|
||||||
|
*/
|
||||||
|
|
||||||
|
.search-results {
|
||||||
|
margin-top: 23px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-results article {
|
||||||
|
border-top: 1px solid #E1E4E5;
|
||||||
|
padding-top: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-results article:first-child {
|
||||||
|
border-top: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
form .search-query {
|
||||||
|
width: 100%;
|
||||||
|
border-radius: 50px;
|
||||||
|
padding: 6px 12px;
|
||||||
|
border-color: #D1D4D5;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Improve inline code blocks within admonitions.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/656
|
||||||
|
*/
|
||||||
|
.rst-content .admonition code {
|
||||||
|
color: #404040;
|
||||||
|
border: 1px solid #c7c9cb;
|
||||||
|
border: 1px solid rgba(0, 0, 0, 0.2);
|
||||||
|
background: #f8fbfd;
|
||||||
|
background: rgba(255, 255, 255, 0.7);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Account for wide tables which go off the side.
|
||||||
|
* Override borders to avoid weirdness on narrow tables.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/834
|
||||||
|
* https://github.com/mkdocs/mkdocs/pull/1034
|
||||||
|
*/
|
||||||
|
.rst-content .section .docutils {
|
||||||
|
width: 100%;
|
||||||
|
overflow: auto;
|
||||||
|
display: block;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
td, th {
|
||||||
|
border: 1px solid #e1e4e5 !important;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Without the following amendments, the navigation in the theme will be
|
||||||
|
* slightly cut off. This is due to the fact that the .wy-nav-side has a
|
||||||
|
* padding-bottom of 2em, which must not necessarily align with the font-size of
|
||||||
|
* 90 % on the .rst-current-version container, combined with the padding of 12px
|
||||||
|
* above and below. These amendments fix this in two steps: First, make sure the
|
||||||
|
* .rst-current-version container has a fixed height of 40px, achieved using
|
||||||
|
* line-height, and then applying a padding-bottom of 40px to this container. In
|
||||||
|
* a second step, the items within that container are re-aligned using flexbox.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||||
|
*/
|
||||||
|
.wy-nav-side {
|
||||||
|
padding-bottom: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* For section-index only */
|
||||||
|
.wy-menu-vertical .current-section p {
|
||||||
|
background-color: #e3e3e3;
|
||||||
|
color: #404040;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* The second step of above amendment: Here we make sure the items are aligned
|
||||||
|
* correctly within the .rst-current-version container. Using flexbox, we
|
||||||
|
* achieve it in such a way that it will look like the following:
|
||||||
|
*
|
||||||
|
* [No repo_name]
|
||||||
|
* Next >> // On the first page
|
||||||
|
* << Previous Next >> // On all subsequent pages
|
||||||
|
*
|
||||||
|
* [With repo_name]
|
||||||
|
* <repo_name> Next >> // On the first page
|
||||||
|
* <repo_name> << Previous Next >> // On all subsequent pages
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||||
|
*/
|
||||||
|
.rst-versions .rst-current-version {
|
||||||
|
padding: 0 12px;
|
||||||
|
display: flex;
|
||||||
|
font-size: initial;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: center;
|
||||||
|
line-height: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Please note that this amendment also involves removing certain inline-styles
|
||||||
|
* from the file ./mkdocs/themes/readthedocs/versions.html.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||||
|
*/
|
||||||
|
.rst-current-version span {
|
||||||
|
flex: 1;
|
||||||
|
text-align: center;
|
||||||
|
}
|
362
site/encryption/index.html
Normal file
|
@ -0,0 +1,362 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/encryption/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Encryption - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Encryption";
|
||||||
|
var mkdocs_page_input_path = "encryption.md";
|
||||||
|
var mkdocs_page_url = "/encryption/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Encryption</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#a-note-on-security">A Note on Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#encrypting-and-decrypting">Encrypting and Decrypting</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#storing-passwords-in-your-keychain">Storing Passwords in Your Keychain</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#manual-decryption">Manual Decryption</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Encryption</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/encryption.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="encryption">Encryption</h1>
|
||||||
|
<h2 id="a-note-on-security">A Note on Security</h2>
|
||||||
|
<p>While <code>jrnl</code> follows best practices, total security is never possible in the
|
||||||
|
real world. There are a number of ways that people can at least partially
|
||||||
|
compromise your <code>jrnl</code> data. See the <a href="../privacy-and-security/">Privacy and Security</a> page
|
||||||
|
for more information.</p>
|
||||||
|
<h2 id="encrypting-and-decrypting">Encrypting and Decrypting</h2>
|
||||||
|
<p>Existing plain text journal files can be encrypted using the <code>--encrypt</code>
|
||||||
|
command:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --encrypt [FILENAME]
|
||||||
|
</code></pre>
|
||||||
|
<p>You can then enter a new password, and the unencrypted file will replaced with
|
||||||
|
the new encrypted file.</p>
|
||||||
|
<p>This command also works to change the password for a journal file that is
|
||||||
|
already encrypted. <code>jrnl</code> will prompt you for the current password and then new
|
||||||
|
password.</p>
|
||||||
|
<p>Conversely,</p>
|
||||||
|
<pre><code class="language-sh">jrnl --decrypt [FILENAME]
|
||||||
|
</code></pre>
|
||||||
|
<p>replaces the encrypted journal file with a plain text file. You can also specify
|
||||||
|
a filename, e.g., <code>jrnl --decrypt plain_text_copy.txt</code>, to leave the original
|
||||||
|
encrypted file untouched and create a new plain text file next to it.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Changing <code>encrypt</code> in your <a href="../reference-config-file/">config file</a> to
|
||||||
|
a different value will not encrypt or decrypt your
|
||||||
|
journal file. It merely says whether or not your journal
|
||||||
|
is encrypted. Hence manually changing
|
||||||
|
this option will most likely result in your journal file being
|
||||||
|
impossible to load. This is why the above commands are necessary.</p>
|
||||||
|
</div>
|
||||||
|
<h2 id="storing-passwords-in-your-keychain">Storing Passwords in Your Keychain</h2>
|
||||||
|
<p>Nobody can recover or reset your <code>jrnl</code> password. If you lose it,
|
||||||
|
your data will be inaccessible forever.</p>
|
||||||
|
<p>For this reason, when encrypting a journal, <code>jrnl</code> asks whether you would like
|
||||||
|
to store the password in your system's keychain. An added benefit is that you
|
||||||
|
will not need to enter the password when interacting with the journal file.</p>
|
||||||
|
<p>If you don't initially store the password in your keychain but decide to do so
|
||||||
|
later---or if you want to store it in one computer's keychain but not in another
|
||||||
|
computer's---you can run <code>jrnl --encrypt</code> on an encrypted journal and use the
|
||||||
|
same password again. This will trigger the keychain storage prompt.</p>
|
||||||
|
<h2 id="manual-decryption">Manual Decryption</h2>
|
||||||
|
<p>The easiest way to decrypt your journal is with <code>jrnl --decrypt</code>, but you could
|
||||||
|
also decrypt your journal manually if needed. To do this, you can use any
|
||||||
|
program that supports the AES algorithm (specifically AES-CBC), and you'll need
|
||||||
|
the following relevant information for decryption:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Key:</strong> The key used for encryption is the
|
||||||
|
<a href="https://en.wikipedia.org/wiki/SHA-2">SHA-256</a> hash of your password.</li>
|
||||||
|
<li><strong>Initialization vector (IV):</strong> The IV is stored in the first 16 bytes of
|
||||||
|
your encrypted journal file.</li>
|
||||||
|
<li><strong>The actual text of the journal</strong> (everything after the first 16 bytes in
|
||||||
|
the encrypted journal file) is encoded in
|
||||||
|
<a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a> and padded according to
|
||||||
|
<a href="https://en.wikipedia.org/wiki/PKCS_7">PKCS#7</a> before being encrypted.</li>
|
||||||
|
</ul>
|
||||||
|
<p>If you'd like an example of what this might look like in script form, please
|
||||||
|
see below for some examples of Python scripts that you could use to manually
|
||||||
|
decrypt your journal.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>These are only examples, and are only here to illustrate that your journal files
|
||||||
|
will still be recoverable even if <code>jrnl</code> isn't around anymore. Please use
|
||||||
|
<code>jrnl --decrypt</code> if available.</p>
|
||||||
|
</div>
|
||||||
|
<p><strong>Example for jrnl v2 files</strong>:</p>
|
||||||
|
<pre><code class="language-python">#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Decrypt a jrnl v2 encrypted journal.
|
||||||
|
|
||||||
|
Note: the `cryptography` module must be installed (you can do this with
|
||||||
|
something like `pip3 install crytography`)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import getpass
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from cryptography.fernet import Fernet
|
||||||
|
from cryptography.hazmat.backends import default_backend
|
||||||
|
from cryptography.hazmat.primitives import hashes
|
||||||
|
from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
|
||||||
|
|
||||||
|
filepath = input("journal file path: ")
|
||||||
|
password = getpass.getpass("Password: ")
|
||||||
|
|
||||||
|
with open(Path(filepath), "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
password = password.encode("utf-8")
|
||||||
|
kdf = PBKDF2HMAC(
|
||||||
|
algorithm=hashes.SHA256(),
|
||||||
|
length=32,
|
||||||
|
salt=b"\xf2\xd5q\x0e\xc1\x8d.\xde\xdc\x8e6t\x89\x04\xce\xf8",
|
||||||
|
iterations=100_000,
|
||||||
|
backend=default_backend(),
|
||||||
|
)
|
||||||
|
|
||||||
|
key = base64.urlsafe_b64encode(kdf.derive(password))
|
||||||
|
|
||||||
|
print(Fernet(key).decrypt(ciphertext).decode("utf-8"))
|
||||||
|
</code></pre>
|
||||||
|
<p><strong>Example for jrnl v1 files</strong>:</p>
|
||||||
|
<pre><code class="language-python">#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Decrypt a jrnl v1 encrypted journal.
|
||||||
|
|
||||||
|
Note: the `pycrypto` module must be installed (you can do this with something
|
||||||
|
like `pip3 install pycrypto`)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import getpass
|
||||||
|
import hashlib
|
||||||
|
|
||||||
|
from Crypto.Cipher import AES
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument("filepath", help="journal file to decrypt")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
pwd = getpass.getpass()
|
||||||
|
key = hashlib.sha256(pwd.encode("utf-8")).digest()
|
||||||
|
|
||||||
|
with open(args.filepath, "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
|
||||||
|
plain = crypto.decrypt(ciphertext[16:])
|
||||||
|
plain = plain.strip(plain[-1:])
|
||||||
|
plain = plain.decode("utf-8")
|
||||||
|
print(plain)
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../usage/" class="btn btn-neutral float-left" title="Basic Usage"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../journal-types/" class="btn btn-neutral float-right" title="Journal Types">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../usage/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../journal-types/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
318
site/external-editors/index.html
Normal file
|
@ -0,0 +1,318 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/external-editors/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>External Editors - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "External Editors";
|
||||||
|
var mkdocs_page_input_path = "external-editors.md";
|
||||||
|
var mkdocs_page_url = "/external-editors/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">External Editors</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#sublime-text">Sublime Text</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#visual-studio-code">Visual Studio Code</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#macvim">MacVim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#vimneovim">Vim/Neovim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#ia-writer">iA Writer</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#notepad-on-windows">Notepad++ on Windows</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#emacs">emacs</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#other-editors">Other editors</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>External Editors</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/external-editors.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="external-editors">External editors</h1>
|
||||||
|
<p>Configure your preferred external editor by updating the <code>editor</code> option
|
||||||
|
in your <a href="../reference-config-file/#editor">configuration file</a>. If your editor is not
|
||||||
|
in your operating system's <code>PATH</code> environment variable, then you will have to
|
||||||
|
enter the full path of your editor.</p>
|
||||||
|
<p>Once it's configured, you can create an entry as a new document in your editor using the <code>jrnl</code>
|
||||||
|
command by itself:</p>
|
||||||
|
<pre><code class="language-text">jrnl
|
||||||
|
</code></pre>
|
||||||
|
<p>You can specify the time and title of the entry as usual on the first line of the document. </p>
|
||||||
|
<p>If you want, you can skip the editor by including a quick entry with the <code>jrnl</code> command:</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: All my troubles seemed so far away.
|
||||||
|
</code></pre>
|
||||||
|
<p>If you want to start the entry on the command line and continue writing in your chosen editor,
|
||||||
|
use the <code>--edit</code> flag. For example:</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: All my troubles seemed so far away. --edit
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>To save and log any entry edits, save and close the file.</p>
|
||||||
|
</div>
|
||||||
|
<p>All editors must be <a href="https://en.wikipedia.org/wiki/Blocking_(computing)">blocking processes</a> to work with jrnl. Some editors, such as <a href="https://micro-editor.github.io/">micro</a>, are blocking by default, though others can be made to block with additional arguments, such as many of those documented below. If jrnl opens your editor but finishes running immediately, then your editor is not a blocking process, and you may be able to correct that with one of the suggestions below.</p>
|
||||||
|
<p>Please see <a href="../privacy-and-security/#editor-history">this section</a> about how
|
||||||
|
your editor might leak sensitive information and how to mitigate that risk.</p>
|
||||||
|
<h2 id="sublime-text">Sublime Text</h2>
|
||||||
|
<p>To use <a href="https://www.sublimetext.com/">Sublime Text</a>, install the command line
|
||||||
|
tools for Sublime Text and configure your <code>jrnl.yaml</code> like this:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "subl -w"
|
||||||
|
</code></pre>
|
||||||
|
<p>Note the <code>-w</code> flag to make sure <code>jrnl</code> waits for Sublime Text to close the
|
||||||
|
file before writing into the journal.</p>
|
||||||
|
<h2 id="visual-studio-code">Visual Studio Code</h2>
|
||||||
|
<p><a href="https://code.visualstudio.com">Visual Studio Code</a> also requires a flag
|
||||||
|
that tells the process to wait until the file is closed before exiting:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "code --wait"
|
||||||
|
</code></pre>
|
||||||
|
<p>On Windows, <code>code</code> is not added to the path by default, so you'll need to
|
||||||
|
enter the full path to your <code>code.exe</code> file, or add it to the <code>PATH</code> variable.</p>
|
||||||
|
<h2 id="macvim">MacVim</h2>
|
||||||
|
<p>Also similar to Sublime Text, MacVim must be started with a flag that tells
|
||||||
|
the the process to wait until the file is closed before passing control
|
||||||
|
back to journal. In the case of MacVim, this is <code>-f</code>:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "mvim -f"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="vimneovim">Vim/Neovim</h2>
|
||||||
|
<p>To use any of the Vim derivatives as editor in Linux, simply set the <code>editor</code>
|
||||||
|
to the executable:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "vim"
|
||||||
|
# or
|
||||||
|
editor: "nvim"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="ia-writer">iA Writer</h2>
|
||||||
|
<p>On OS X, you can use the fabulous <a href="http://www.iawriter.com/mac">iA
|
||||||
|
Writer</a> to write entries. Configure your
|
||||||
|
<code>jrnl.yaml</code> like this:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "open -b pro.writer.mac -Wn"
|
||||||
|
</code></pre>
|
||||||
|
<p>What does this do? <code>open -b ...</code> opens a file using the application
|
||||||
|
identified by the bundle identifier (a unique string for every app out
|
||||||
|
there). <code>-Wn</code> tells the application to wait until it's closed before
|
||||||
|
passing back control, and to use a new instance of the application.</p>
|
||||||
|
<p>If the <code>pro.writer.mac</code> bundle identifier is not found on your system,
|
||||||
|
you can find the right string to use by inspecting iA Writer's
|
||||||
|
<code>Info.plist</code> file in your shell:</p>
|
||||||
|
<pre><code class="language-sh">grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="notepad-on-windows">Notepad++ on Windows</h2>
|
||||||
|
<p>To set <a href="http://notepad-plus-plus.org/">Notepad++</a> as your editor, edit
|
||||||
|
the <code>jrnl</code> config file (<code>jrnl.yaml</code>) like this:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession"
|
||||||
|
</code></pre>
|
||||||
|
<p>The double backslashes are needed so <code>jrnl</code> can read the file path
|
||||||
|
correctly. The <code>-multiInst -nosession</code> options will cause <code>jrnl</code> to open
|
||||||
|
its own Notepad++ window.</p>
|
||||||
|
<h2 id="emacs">emacs</h2>
|
||||||
|
<p>To use <code>emacs</code> as your editor, edit the <code>jrnl</code> config file (<code>jrnl.yaml</code>) like this:</p>
|
||||||
|
<pre><code class="language-yaml">editor: emacsclient -a "" -c
|
||||||
|
</code></pre>
|
||||||
|
<p>When you're done editing the message, save and <code>C-x #</code> to close the buffer and stop the emacsclient process.</p>
|
||||||
|
<h2 id="other-editors">Other editors</h2>
|
||||||
|
<p>If you're using another editor and would like to share, feel free to <a href="../contributing/#editing-documentation">contribute documentation</a> on it.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../advanced/" class="btn btn-neutral float-left" title="Advanced Usage"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../tips-and-tricks/" class="btn btn-neutral float-right" title="Tips and Tricks">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../advanced/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../tips-and-tricks/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
533
site/formats/index.html
Normal file
|
@ -0,0 +1,533 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/formats/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Formats - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Formats";
|
||||||
|
var mkdocs_page_input_path = "formats.md";
|
||||||
|
var mkdocs_page_url = "/formats/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Formats</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#display-formats">Display Formats</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#pretty">Pretty</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#short">Short</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#fancy-or-boxed">Fancy (or Boxed)</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#data-formats">Data Formats</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#json">JSON</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#markdown">Markdown</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#plain-text">Plain Text</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#xml">XML</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#yaml">YAML</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#report-formats">Report formats</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#tags">Tags</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#options">Options</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#exporting-with-file">Exporting with --file</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#exporting-to-directories">Exporting to directories</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Formats</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/formats.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="formats">Formats</h1>
|
||||||
|
<p><code>jrnl</code> supports a variety of alternate formats. These can be used to display your
|
||||||
|
journal in a different manner than the <code>jrnl</code> default, and can even be used to pipe data
|
||||||
|
from your journal for use in another program to create reports, or do whatever you want
|
||||||
|
with your <code>jrnl</code> data.</p>
|
||||||
|
<p>Any of these formats can be used with a search (e.g. <code>jrnl -contains "lorem ipsum"
|
||||||
|
--format json</code>) to display the results of that search in the given format, or can be
|
||||||
|
used alone (e.g. <code>jrnl --format json</code>) to display all entries from the selected journal.</p>
|
||||||
|
<p>This page shows examples of all the built-in formats, but since <code>jrnl</code> supports adding
|
||||||
|
more formats through plugins, you may have more available on your system. Please see
|
||||||
|
<code>jrnl --help</code> for a list of which formats are available on your system.</p>
|
||||||
|
<p>Any of these formats can be used interchangeably, and are only grouped into "display",
|
||||||
|
"data", and "report" formats below for convenience.</p>
|
||||||
|
<h2 id="display-formats">Display Formats</h2>
|
||||||
|
<p>These formats are mainly intended for displaying your journal in the terminal. Even so,
|
||||||
|
they can still be used in the same way as any other format (like written to a file, if
|
||||||
|
you choose).</p>
|
||||||
|
<h3 id="pretty">Pretty</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format pretty
|
||||||
|
# or
|
||||||
|
jrnl -1 # any search
|
||||||
|
</code></pre>
|
||||||
|
<p>This is the default format in <code>jrnl</code>. If no <code>--format</code> is given, <code>pretty</code> will be used.</p>
|
||||||
|
<p>It displays the timestamp of each entry formatted to by the user config followed by the
|
||||||
|
title on the same line. Then the body of the entry is shown below.</p>
|
||||||
|
<p>This format is configurable through these values from your config file (see
|
||||||
|
<a href="../advanced/">Advanced Usage</a> for more details):</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>colors</code><ul>
|
||||||
|
<li><code>body</code></li>
|
||||||
|
<li><code>date</code></li>
|
||||||
|
<li><code>tags</code></li>
|
||||||
|
<li><code>title</code></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><code>indent_character</code></li>
|
||||||
|
<li><code>linewrap</code></li>
|
||||||
|
<li><code>timeformat</code></li>
|
||||||
|
</ul>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-sh">2020-06-28 18:22 This is the first sample entry
|
||||||
|
| This is the sample body text of the first sample entry.
|
||||||
|
|
||||||
|
2020-07-01 20:00 This is the second sample entry
|
||||||
|
| This is the sample body text of the second sample entry, but
|
||||||
|
| this one has a @tag.
|
||||||
|
|
||||||
|
2020-07-02 09:00 This is the third sample entry
|
||||||
|
| This is the sample body text of the third sample entry.
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="short">Short</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format short
|
||||||
|
# or
|
||||||
|
jrnl --short
|
||||||
|
</code></pre>
|
||||||
|
<p>This will shorten entries to display only the date and title. It is essentially the
|
||||||
|
<code>pretty</code> format but without the body of each entry. This can be useful if you have long
|
||||||
|
journal entries and only want to see a list of entries that match your search.</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-sh">2020-06-28 18:22 This is the first sample entry
|
||||||
|
2020-07-01 20:00 This is the second sample entry
|
||||||
|
2020-07-02 09:00 This is the third sample entry
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="fancy-or-boxed">Fancy (or Boxed)</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format fancy
|
||||||
|
# or
|
||||||
|
jrnl --format boxed
|
||||||
|
</code></pre>
|
||||||
|
<p>This format outlines each entry with a border. This makes it much easier to tell where
|
||||||
|
each entry starts and ends. It's an example of how free-form the formats can be, and also
|
||||||
|
just looks kinda ~<em>~fancy~</em>~, if you're into that kind of thing.</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-sh">┎──────────────────────────────────────────────────────────────────────╮2020-06-28 18:22
|
||||||
|
┃ This is the first sample entry ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ This is the sample body text of the first sample entry. │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-01 20:00
|
||||||
|
┃ This is the second sample entry ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ This is the sample body text of the second sample entry, but this one has a @tag. │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-02 09:00
|
||||||
|
┃ This is the third sample entry ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ This is the sample body text of the third sample entry. │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="data-formats">Data Formats</h2>
|
||||||
|
<p>These formats are mainly intended for piping or exporting your journal to other
|
||||||
|
programs. Even so, they can still be used in the same way as any other format (like
|
||||||
|
written to a file, or displayed in your terminal, if you want).</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>You may see boxed messages like "2 entries found" when using these formats, but
|
||||||
|
those messages are written to <code>stderr</code> instead of <code>stdout</code>, and won't be piped when
|
||||||
|
using the <code>|</code> operator.</p>
|
||||||
|
<h3 id="json">JSON</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format json
|
||||||
|
</code></pre>
|
||||||
|
<p>JSON is a very handy format used by many programs and has support in nearly every
|
||||||
|
programming language. There are many things you could do with JSON data. Maybe you could
|
||||||
|
use <code>jq</code> (<a href="https://github.com/stedolan/jq">project page</a>) to filter through the fields in your journal.
|
||||||
|
Like this:</p>
|
||||||
|
<pre><code class="language-sh">$ j -3 --format json | jq '.entries[].date' jrnl-GFqVlfgP-py3.8
|
||||||
|
"2020-06-28"
|
||||||
|
"2020-07-01"
|
||||||
|
"2020-07-02"
|
||||||
|
</code></pre>
|
||||||
|
<p>Or why not create a <a href="http://timeline.knightlab.com/">beautiful timeline</a> of your journal?</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"tags": {
|
||||||
|
"@tag": 1
|
||||||
|
},
|
||||||
|
"entries": [
|
||||||
|
{
|
||||||
|
"title": "This is the first sample entry",
|
||||||
|
"body": "This is the sample body text of the first sample entry.",
|
||||||
|
"date": "2020-06-28",
|
||||||
|
"time": "18:22",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "This is the second sample entry",
|
||||||
|
"body": "This is the sample body text of the second sample entry, but this one has a @tag.",
|
||||||
|
"date": "2020-07-01",
|
||||||
|
"time": "20:00",
|
||||||
|
"tags": [
|
||||||
|
"@tag"
|
||||||
|
],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "This is the third sample entry",
|
||||||
|
"body": "This is the sample body text of the third sample entry.",
|
||||||
|
"date": "2020-07-02",
|
||||||
|
"time": "09:00",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="markdown">Markdown</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format markdown
|
||||||
|
# or
|
||||||
|
jrnl --format md
|
||||||
|
</code></pre>
|
||||||
|
<p>Markdown is a simple markup language that is human readable and can be used to be
|
||||||
|
rendered to other formats (html, pdf). <code>jrnl</code>'s
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/blob/develop/README.md">README</a> for example is
|
||||||
|
formatted in markdown, then Github adds some formatting to make it look nice.</p>
|
||||||
|
<p>The markdown format groups entries by date (first by year, then by month), and adds
|
||||||
|
header markings as needed (e.g. <code>#</code>, <code>##</code>, etc). If you already have markdown header
|
||||||
|
markings in your journal, they will be incremented as necessary to make them fit under
|
||||||
|
these new headers (i.e. <code>#</code> will become <code>##</code>).</p>
|
||||||
|
<p>This format can be very useful, for example, to export a journal to a program that
|
||||||
|
converts markdown to html to make a website or a blog from your journal.</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-markdown"># 2020
|
||||||
|
|
||||||
|
## June
|
||||||
|
|
||||||
|
### 2020-06-28 18:22 This is the first sample entry
|
||||||
|
|
||||||
|
This is the sample body text of the first sample entry.
|
||||||
|
|
||||||
|
## July
|
||||||
|
|
||||||
|
### 2020-07-01 20:00 This is the second sample entry
|
||||||
|
|
||||||
|
This is the sample body text of the second sample entry, but this one has a @tag.
|
||||||
|
|
||||||
|
### 2020-07-02 09:00 This is the third sample entry
|
||||||
|
|
||||||
|
This is the sample body text of the third sample entry.
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="plain-text">Plain Text</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format text
|
||||||
|
# or
|
||||||
|
jrnl --format txt
|
||||||
|
</code></pre>
|
||||||
|
<p>This outputs your journal in the same plain-text format that <code>jrnl</code> uses to store your
|
||||||
|
journal on disk. This format is particularly useful for importing and exporting journals
|
||||||
|
within <code>jrnl</code>.</p>
|
||||||
|
<p>You can use it, for example, to move entries from one journal to another, or to create a
|
||||||
|
new journal with search results from another journal.</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-sh">[2020-06-28 18:22] This is the first sample entry
|
||||||
|
This is the sample body text of the first sample entry.
|
||||||
|
|
||||||
|
[2020-07-01 20:00] This is the second sample entry
|
||||||
|
This is the sample body text of the second sample entry, but this one has a @tag.
|
||||||
|
|
||||||
|
[2020-07-02 09:00] This is the third sample entry
|
||||||
|
This is the sample body text of the third sample entry.
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="xml">XML</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format xml
|
||||||
|
</code></pre>
|
||||||
|
<p>This outputs your journal into XML format. XML is a commonly used data format and is
|
||||||
|
supported by many programs and programming languages.</p>
|
||||||
|
<p><strong>Example output</strong>:</p>
|
||||||
|
<pre><code class="language-xml"><?xml version="1.0" ?>
|
||||||
|
<journal>
|
||||||
|
<entries>
|
||||||
|
<entry date="2020-06-28T18:22:00" starred="">This is the first sample entry This is the sample body text of the first sample entry.</entry>
|
||||||
|
<entry date="2020-07-01T20:00:00" starred="">
|
||||||
|
<tag name="@tag"/>
|
||||||
|
This is the second sample entry This is the sample body text of the second sample entry, but this one has a @tag.
|
||||||
|
</entry>
|
||||||
|
<entry date="2020-07-02T09:00:00" starred="">*This is the third sample entry, and is starred This is the sample body text of the third sample entry.</entry>
|
||||||
|
</entries>
|
||||||
|
<tags>
|
||||||
|
<tag name="@tag">1</tag>
|
||||||
|
</tags>
|
||||||
|
</journal>
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="yaml">YAML</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format yaml --file 'my_directory/'
|
||||||
|
</code></pre>
|
||||||
|
<p>This outputs your journal into YAML format. YAML is a commonly used data format and is
|
||||||
|
supported by many programs and programming languages. <a href="#exporting-to-directories">Exporting to directories</a> is the
|
||||||
|
only supported YAML export option and each entry will be written to a separate file.</p>
|
||||||
|
<p><strong>Example file</strong>:</p>
|
||||||
|
<pre><code class="language-yaml">title: This is the second sample entry
|
||||||
|
date: 2020-07-01 20:00
|
||||||
|
starred: False
|
||||||
|
tags: tag
|
||||||
|
|
||||||
|
This is the sample body text of the second sample entry, but this one has a @tag.
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="report-formats">Report formats</h2>
|
||||||
|
<p>Since formats use your journal data and display it in different ways, they can also be
|
||||||
|
used to create reports.</p>
|
||||||
|
<h3 id="tags">Tags</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format tags
|
||||||
|
# or
|
||||||
|
jrnl --tags
|
||||||
|
</code></pre>
|
||||||
|
<p>This format is a simple example of how formats can be used to create reports. It
|
||||||
|
displays each tag, and a count of how many entries in which tag appears in your journal
|
||||||
|
(or in the search results), sorted by most frequent.</p>
|
||||||
|
<p>Example output:</p>
|
||||||
|
<pre><code class="language-sh">@one : 32
|
||||||
|
@two : 17
|
||||||
|
@three : 4
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="options">Options</h2>
|
||||||
|
<h3 id="exporting-with-file">Exporting with <code>--file</code></h3>
|
||||||
|
<p>Example: <code>jrnl --format json --file /some/path/to/a/file.txt</code></p>
|
||||||
|
<p>By default, <code>jrnl</code> will output entries to your terminal. But if you provide <code>--file</code>
|
||||||
|
along with a filename, the same output that would have been to your terminal will be
|
||||||
|
written to the file instead. This is the same as piping the output to a file.</p>
|
||||||
|
<p>So, in bash for example, the following two statements are equivalent:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --format json --file myjournal.json
|
||||||
|
</code></pre>
|
||||||
|
<pre><code class="language-sh">jrnl --format json > myjournal.json
|
||||||
|
</code></pre>
|
||||||
|
<h4 id="exporting-to-directories">Exporting to directories</h4>
|
||||||
|
<p>If the <code>--file</code> argument is a directory, jrnl will export each entry into an individual file:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --format yaml --file my_entries/
|
||||||
|
</code></pre>
|
||||||
|
<p>The contents of <code>my_entries/</code> will then look like this:</p>
|
||||||
|
<pre><code class="language-output">my_entries/
|
||||||
|
|- 2013_06_03_a-beautiful-day.yaml
|
||||||
|
|- 2013_06_07_dinner-with-gabriel.yaml
|
||||||
|
|- ...
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../privacy-and-security/" class="btn btn-neutral float-left" title="Privacy and Security"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../advanced/" class="btn btn-neutral float-right" title="Advanced Usage">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../privacy-and-security/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../advanced/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
BIN
site/img/banner_og.png
Normal file
After Width: | Height: | Size: 224 KiB |
BIN
site/img/banner_twitter.png
Normal file
After Width: | Height: | Size: 175 KiB |
BIN
site/img/favicon.ico
Normal file
After Width: | Height: | Size: 17 KiB |
15
site/img/favicon.svg
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="64px" height="64px" viewBox="0 0 64 64" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||||
|
<title>favicon</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs>
|
||||||
|
<linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
|
||||||
|
<stop stop-color="#986B9D" offset="0%"></stop>
|
||||||
|
<stop stop-color="#664C8B" offset="100%"></stop>
|
||||||
|
</linearGradient>
|
||||||
|
</defs>
|
||||||
|
<g id="favicon" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<path d="M47,9.75231557 L47,37 L42,32 L37,37 L37,7 L25,7 C17.8202983,7 12,12.8202983 12,20 L12,44 C12,51.1797017 17.8202983,57 25,57 L32,57 L32,7 L34,7 L34,57 L39,57 C46.1797017,57 52,51.1797017 52,44 L52,20 C52,15.8373552 50.0435392,12.1316662 47,9.75231557 Z M47.097641,7.37132944 C51.2495133,10.039075 54,14.6983322 54,20 L54,44 C54,49.3016678 51.2495133,53.960925 47.097641,56.6286706 C52.7817736,55.2392133 57,50.1122164 57,44 L57,20 C57,13.8877836 52.7817736,8.76078667 47.097641,7.37132944 Z M16.902359,56.6286706 C12.7504867,53.960925 10,49.3016678 10,44 L10,20 C10,14.6983322 12.7504867,10.039075 16.902359,7.37132944 C11.2182264,8.76078667 7,13.8877836 7,20 L7,44 C7,50.1122164 11.2182264,55.2392133 16.902359,56.6286706 Z M52.097641,7.37132944 C56.2495133,10.039075 59,14.6983322 59,20 L59,44 C59,49.3016678 56.2495133,53.960925 52.097641,56.6286706 C57.7817736,55.2392133 62,50.1122164 62,44 L62,20 C62,13.8877836 57.7817736,8.76078667 52.097641,7.37132944 Z M11.902359,56.6286706 C7.7504867,53.960925 5,49.3016678 5,44 L5,20 C5,14.6983322 7.7504867,10.039075 11.902359,7.37132944 C6.21822638,8.76078667 2,13.8877836 2,20 L2,44 C2,50.1122164 6.21822638,55.2392133 11.902359,56.6286706 Z M15,5 L49,5 C57.2842712,5 64,11.7157288 64,20 L64,44 C64,52.2842712 57.2842712,59 49,59 L15,59 C6.71572875,59 0,52.2842712 0,44 L0,20 C2.0539126e-15,11.7157288 6.71572875,5 15,5 Z" id="Combined-Shape" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 2.1 KiB |
10
site/img/jrnl_white.svg
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="90px" height="98px" viewBox="0 0 90 98" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||||
|
<title>jrnl_white</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<g id="jrnl_white" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<path d="M63,5.34786368 L63,43 L58,38 L53,43 L53,5 L30,5 C22.8202983,5 17,10.8202983 17,18 L17,58 C17,65.1797017 22.8202983,71 30,71 L45,71 L45,5 L47,5 L47,71 L60,71 C67.1797017,71 73,65.1797017 73,58 L73,18 C73,11.8528367 68.7334,6.70219128 63,5.34786368 Z M67.6693542,5.10618565 C72.0593056,7.72299627 75,12.5180801 75,18 L75,58 C75,63.4819199 72.0593056,68.2770037 67.6693542,70.8938143 C74.060623,70.0745197 79,64.6140865 79,58 L79,18 C79,11.3859135 74.060623,5.92548026 67.6693542,5.10618565 Z M22.3306458,70.8938143 C17.9406944,68.2770037 15,63.4819199 15,58 L15,18 C15,12.5180801 17.9406944,7.72299627 22.3306458,5.10618565 C15.939377,5.92548026 11,11.3859135 11,18 L11,58 C11,64.6140865 15.939377,70.0745197 22.3306458,70.8938143 Z M73.6693542,5.10618565 C78.0593056,7.72299627 81,12.5180801 81,18 L81,58 C81,63.4819199 78.0593056,68.2770037 73.6693542,70.8938143 C80.060623,70.0745197 85,64.6140865 85,58 L85,18 C85,11.3859135 80.060623,5.92548026 73.6693542,5.10618565 Z M16.3306458,70.8938143 C11.9406944,68.2770037 9,63.4819199 9,58 L9,18 C9,12.5180801 11.9406944,7.72299627 16.3306458,5.10618565 C9.93937703,5.92548026 5,11.3859135 5,18 L5,58 C5,64.6140865 9.93937703,70.0745197 16.3306458,70.8938143 Z M18,3 L72,3 C80.2842712,3 87,9.71572875 87,18 L87,58 C87,66.2842712 80.2842712,73 72,73 L18,73 C9.71572875,73 3,66.2842712 3,58 L3,18 C3,9.71572875 9.71572875,3 18,3 Z" id="Combined-Shape" fill="#FFFFFF" fill-rule="nonzero"></path>
|
||||||
|
<path d="M24.22,95.092 C24.0293324,95.092 23.7616684,95.0736668 23.417,95.037 C23.0723316,95.0003332 22.7680013,94.9306672 22.504,94.828 L22.856,92.65 C23.1786683,92.7526672 23.5673311,92.804 24.022,92.804 C24.6380031,92.804 25.0706654,92.6243351 25.32,92.265 C25.5693346,91.9056649 25.694,91.3666703 25.694,90.648 L25.694,82.642 L28.356,82.285 L28.356,90.692 C28.356,92.1880075 28.0003369,93.2953297 27.289,94.014 C26.5776631,94.7326703 25.5546733,95.092 24.22,95.092 Z M41.4,84.892 C41.1799989,84.8186663 40.8756686,84.7416671 40.487,84.661 C40.0983314,84.5803329 39.6473359,84.54 39.134,84.54 C38.8406652,84.54 38.5290017,84.569333 38.199,84.628 C37.8689984,84.686667 37.6380007,84.7379998 37.506,84.782 L37.506,94 L34.844,94 L34.844,83.044 C35.3573359,82.8533324 35.9989962,82.6736675 36.769,82.505 C37.5390039,82.3363325 38.3933286,82.252 39.332,82.252 C39.5080009,82.252 39.7133322,82.2629999 39.948,82.285 C40.1826678,82.3070001 40.4173322,82.3363332 40.652,82.373 C40.8866678,82.4096669 41.1139989,82.4536664 41.334,82.505 C41.5540011,82.5563336 41.7299993,82.6039998 41.862,82.648 L41.4,84.892 Z M46.81,82.868 C47.3233359,82.7213326 47.9906626,82.5820007 48.812,82.45 C49.6333374,82.3179993 50.5426617,82.252 51.54,82.252 C52.4786714,82.252 53.2633302,82.3803321 53.894,82.637 C54.5246698,82.893668 55.0269981,83.2529977 55.401,83.715 C55.7750019,84.1770023 56.0389992,84.7343301 56.193,85.387 C56.3470008,86.0396699 56.424,86.7546628 56.424,87.532 L56.424,94 L53.762,94 L53.762,87.95 C53.762,87.3339969 53.7216671,86.8096688 53.641,86.377 C53.5603329,85.9443312 53.4283342,85.5923347 53.245,85.321 C53.0616658,85.0496653 52.8123349,84.8516673 52.497,84.727 C52.1816651,84.6023327 51.7966689,84.54 51.342,84.54 C51.004665,84.54 50.6526685,84.5619998 50.286,84.606 C49.9193315,84.6500002 49.6480009,84.6866665 49.472,84.716 L49.472,94 L46.81,94 L46.81,82.868 Z M66.784,94.22 C65.991996,94.2053333 65.3356693,94.1173341 64.815,93.956 C64.2943307,93.7946659 63.8800015,93.5636682 63.572,93.263 C63.2639985,92.9623318 63.0476673,92.5883356 62.923,92.141 C62.7983327,91.6936644 62.736,91.1840029 62.736,90.612 L62.736,82.692 L65.398,82.252 L65.398,90.106 C65.398,90.4286683 65.4236664,90.6999989 65.475,90.92 C65.5263336,91.1400011 65.6179993,91.3269992 65.75,91.481 C65.8820007,91.6350008 66.0616655,91.7523329 66.289,91.833 C66.5163345,91.9136671 66.8059982,91.9759998 67.158,92.02 L66.784,94.22 Z" id="jrnl" fill="#FFFFFF" fill-rule="nonzero"></path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 4.2 KiB |
16
site/img/logo.svg
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="90px" height="98px" viewBox="0 0 90 98" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||||
|
<title>logo</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs>
|
||||||
|
<linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
|
||||||
|
<stop stop-color="#986B9D" offset="0%"></stop>
|
||||||
|
<stop stop-color="#664C8B" offset="100%"></stop>
|
||||||
|
</linearGradient>
|
||||||
|
</defs>
|
||||||
|
<g id="logo" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<path d="M63,5.34786368 L63,43 L58,38 L53,43 L53,5 L30,5 C22.8202983,5 17,10.8202983 17,18 L17,58 C17,65.1797017 22.8202983,71 30,71 L45,71 L45,5 L47,5 L47,71 L60,71 C67.1797017,71 73,65.1797017 73,58 L73,18 C73,11.8528367 68.7334,6.70219128 63,5.34786368 Z M67.6693542,5.10618565 C72.0593056,7.72299627 75,12.5180801 75,18 L75,58 C75,63.4819199 72.0593056,68.2770037 67.6693542,70.8938143 C74.060623,70.0745197 79,64.6140865 79,58 L79,18 C79,11.3859135 74.060623,5.92548026 67.6693542,5.10618565 Z M22.3306458,70.8938143 C17.9406944,68.2770037 15,63.4819199 15,58 L15,18 C15,12.5180801 17.9406944,7.72299627 22.3306458,5.10618565 C15.939377,5.92548026 11,11.3859135 11,18 L11,58 C11,64.6140865 15.939377,70.0745197 22.3306458,70.8938143 Z M73.6693542,5.10618565 C78.0593056,7.72299627 81,12.5180801 81,18 L81,58 C81,63.4819199 78.0593056,68.2770037 73.6693542,70.8938143 C80.060623,70.0745197 85,64.6140865 85,58 L85,18 C85,11.3859135 80.060623,5.92548026 73.6693542,5.10618565 Z M16.3306458,70.8938143 C11.9406944,68.2770037 9,63.4819199 9,58 L9,18 C9,12.5180801 11.9406944,7.72299627 16.3306458,5.10618565 C9.93937703,5.92548026 5,11.3859135 5,18 L5,58 C5,64.6140865 9.93937703,70.0745197 16.3306458,70.8938143 Z M18,3 L72,3 C80.2842712,3 87,9.71572875 87,18 L87,58 C87,66.2842712 80.2842712,73 72,73 L18,73 C9.71572875,73 3,66.2842712 3,58 L3,18 C3,9.71572875 9.71572875,3 18,3 Z" id="Combined-Shape" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
|
||||||
|
<path d="M24.22,95.092 C24.0293324,95.092 23.7616684,95.0736668 23.417,95.037 C23.0723316,95.0003332 22.7680013,94.9306672 22.504,94.828 L22.856,92.65 C23.1786683,92.7526672 23.5673311,92.804 24.022,92.804 C24.6380031,92.804 25.0706654,92.6243351 25.32,92.265 C25.5693346,91.9056649 25.694,91.3666703 25.694,90.648 L25.694,82.642 L28.356,82.285 L28.356,90.692 C28.356,92.1880075 28.0003369,93.2953297 27.289,94.014 C26.5776631,94.7326703 25.5546733,95.092 24.22,95.092 Z M41.4,84.892 C41.1799989,84.8186663 40.8756686,84.7416671 40.487,84.661 C40.0983314,84.5803329 39.6473359,84.54 39.134,84.54 C38.8406652,84.54 38.5290017,84.569333 38.199,84.628 C37.8689984,84.686667 37.6380007,84.7379998 37.506,84.782 L37.506,94 L34.844,94 L34.844,83.044 C35.3573359,82.8533324 35.9989962,82.6736675 36.769,82.505 C37.5390039,82.3363325 38.3933286,82.252 39.332,82.252 C39.5080009,82.252 39.7133322,82.2629999 39.948,82.285 C40.1826678,82.3070001 40.4173322,82.3363332 40.652,82.373 C40.8866678,82.4096669 41.1139989,82.4536664 41.334,82.505 C41.5540011,82.5563336 41.7299993,82.6039998 41.862,82.648 L41.4,84.892 Z M46.81,82.868 C47.3233359,82.7213326 47.9906626,82.5820007 48.812,82.45 C49.6333374,82.3179993 50.5426617,82.252 51.54,82.252 C52.4786714,82.252 53.2633302,82.3803321 53.894,82.637 C54.5246698,82.893668 55.0269981,83.2529977 55.401,83.715 C55.7750019,84.1770023 56.0389992,84.7343301 56.193,85.387 C56.3470008,86.0396699 56.424,86.7546628 56.424,87.532 L56.424,94 L53.762,94 L53.762,87.95 C53.762,87.3339969 53.7216671,86.8096688 53.641,86.377 C53.5603329,85.9443312 53.4283342,85.5923347 53.245,85.321 C53.0616658,85.0496653 52.8123349,84.8516673 52.497,84.727 C52.1816651,84.6023327 51.7966689,84.54 51.342,84.54 C51.004665,84.54 50.6526685,84.5619998 50.286,84.606 C49.9193315,84.6500002 49.6480009,84.6866665 49.472,84.716 L49.472,94 L46.81,94 L46.81,82.868 Z M66.784,94.22 C65.991996,94.2053333 65.3356693,94.1173341 64.815,93.956 C64.2943307,93.7946659 63.8800015,93.5636682 63.572,93.263 C63.2639985,92.9623318 63.0476673,92.5883356 62.923,92.141 C62.7983327,91.6936644 62.736,91.1840029 62.736,90.612 L62.736,82.692 L65.398,82.252 L65.398,90.106 C65.398,90.4286683 65.4236664,90.6999989 65.475,90.92 C65.5263336,91.1400011 65.6179993,91.3269992 65.75,91.481 C65.8820007,91.6350008 66.0616655,91.7523329 66.289,91.833 C66.5163345,91.9136671 66.8059982,91.9759998 67.158,92.02 L66.784,94.22 Z" id="jrnl" fill="#674C8B" fill-rule="nonzero"></path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 4.5 KiB |
9
site/img/logo_white.svg
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="84px" height="70px" viewBox="0 0 84 70" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||||
|
<title>logo_white</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<g id="logo_white" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<path d="M60,2.34786368 L60,40 L55,35 L50,40 L50,2 L27,2 C19.8202983,2 14,7.82029825 14,15 L14,55 C14,62.1797017 19.8202983,68 27,68 L42,68 L42,2 L44,2 L44,68 L57,68 C64.1797017,68 70,62.1797017 70,55 L70,15 C70,8.85283673 65.7334,3.70219128 60,2.34786368 Z M64.6693542,2.10618565 C69.0593056,4.72299627 72,9.51808015 72,15 L72,55 C72,60.4819199 69.0593056,65.2770037 64.6693542,67.8938143 C71.060623,67.0745197 76,61.6140865 76,55 L76,15 C76,8.38591347 71.060623,2.92548026 64.6693542,2.10618565 Z M19.3306458,67.8938143 C14.9406944,65.2770037 12,60.4819199 12,55 L12,15 C12,9.51808015 14.9406944,4.72299627 19.3306458,2.10618565 C12.939377,2.92548026 8,8.38591347 8,15 L8,55 C8,61.6140865 12.939377,67.0745197 19.3306458,67.8938143 Z M70.6693542,2.10618565 C75.0593056,4.72299627 78,9.51808015 78,15 L78,55 C78,60.4819199 75.0593056,65.2770037 70.6693542,67.8938143 C77.060623,67.0745197 82,61.6140865 82,55 L82,15 C82,8.38591347 77.060623,2.92548026 70.6693542,2.10618565 Z M13.3306458,67.8938143 C8.94069436,65.2770037 6,60.4819199 6,55 L6,15 C6,9.51808015 8.94069436,4.72299627 13.3306458,2.10618565 C6.93937703,2.92548026 2,8.38591347 2,15 L2,55 C2,61.6140865 6.93937703,67.0745197 13.3306458,67.8938143 Z M15,0 L69,0 C77.2842712,-1.33226763e-15 84,6.71572875 84,15 L84,55 C84,63.2842712 77.2842712,70 69,70 L15,70 C6.71572875,70 2.66453526e-15,63.2842712 0,55 L0,15 C-8.8817842e-16,6.71572875 6.71572875,1.33226763e-15 15,0 Z" id="Combined-Shape" fill="#FFFFFF" fill-rule="nonzero"></path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 1.9 KiB |
14
site/img/sprites.svg
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
<svg width="400" height="160" viewBox="0 0 400 160" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g id="sprites">
|
||||||
|
<path id="path10" fill-rule="evenodd" clip-rule="evenodd" d="M176.001 24.001C176.001 10.7458 186.746 0 200.002 0C213.257 0 224.003 10.7471 224 24.001C224 37.2562 213.254 48.002 199.999 48.002C195.938 48.002 192.117 46.9846 188.765 45.2019L172.083 61.8826L172.087 61.8866C170.806 63.192 169.028 64.004 167.058 64.004C163.16 64.004 160 60.8452 160 56.9464C160 54.973 160.812 53.1969 162.117 51.9142L162.103 51.9022L178.791 35.2175C177.014 31.8667 176.001 28.0532 176.001 24.001ZM167.058 60.4732C168.054 60.4732 168.946 60.0545 169.59 59.3865L185.718 43.2605C183.82 41.8457 182.14 40.1657 180.73 38.2643L164.598 54.3969L164.615 54.4129C163.948 55.0596 163.528 55.949 163.528 56.945C163.528 58.8958 165.108 60.4732 167.058 60.4732ZM200.002 44.0045C188.957 44.0045 180.001 35.0455 180.001 24.0037C180.001 12.9592 188.957 4.00283 200.002 4.00283C211.043 4.00283 220.003 12.9592 220.003 24.0037C220.003 35.0468 211.045 44.0045 200.002 44.0045ZM201.002 11.0018C201.002 10.4498 200.551 10.0017 200.002 10.0017C192.268 10.0017 186.001 16.2687 186.001 24.0023C186.001 24.5544 186.449 25.0024 187.001 25.0024C187.553 25.0024 188.001 24.5544 188.001 24.0023C188.001 17.3754 193.373 12.0018 200.002 12.0018C200.551 12.0018 201.002 11.5525 201.002 11.0018Z" fill="#684688"/>
|
||||||
|
<path id="path12" fill-rule="evenodd" clip-rule="evenodd" d="M42 26V18C42 8.05733 33.9427 0 24 0C14.0573 0 6 8.05733 6 18V26C2.68533 26 0 28.6853 0 32V38V40V44V46C0 55.9427 8.05733 64 18 64H30C39.9427 64 48 55.9427 48 46V44V40V38V32C48 28.684 45.312 26 42 26ZM10 18C10 10.268 16.268 4 24 4C31.732 4 38 10.268 38 18V26H34V18.004C34 12.48 29.524 8.004 24 8.004C18.476 8.004 14 12.48 14 18.004V26H10V18ZM32 18.0067V18C32 13.5827 28.4173 10 24 10C19.5813 10 16 13.5813 16 18V18.004V26H32V18.0067ZM44 38V40V44V46C44 53.7173 37.7173 60 30 60H18C10.2827 60 4 53.7173 4 46V44V40V38V32C4 30.896 4.896 30 6 30H10H38H42C43.1027 30 44 30.896 44 32V38ZM28 42C28 39.7907 26.208 38 24 38C21.792 38 20 39.7907 20 42C20 43.2133 20.6667 45.52 21.3333 47.344C21.8787 48.828 22.5627 49.996 24 49.996C25.564 49.996 26.1213 48.84 26.668 47.364C27.344 45.536 28 43.2173 28 42Z" fill="#684688"/>
|
||||||
|
<path id="path6" fill-rule="evenodd" clip-rule="evenodd" d="M37.4495 102.225L56 110.175V88.9754L49.2056 93.8301C44.3508 88.4239 37.3366 85 29.5 85C17.0237 85 6.58791 93.6333 3.7737 105.244L8.72074 107.291C10.6738 97.6002 19.2306 90.2993 29.5 90.2993C35.5547 90.2993 41.001 92.8572 44.8646 96.9285L37.4495 102.225ZM29.5 132.701C23.4453 132.701 17.9966 130.143 14.1354 126.073L21.5505 120.773L3 112.824V134.025L9.79444 129.17C14.6467 134.576 21.6634 138 29.5 138C41.9945 138 52.4412 129.342 55.2397 117.709L50.2975 115.594C48.3894 125.344 39.8083 132.701 29.5 132.701Z" fill="#684688"/>
|
||||||
|
<path id="Combined Shape" fill-rule="evenodd" clip-rule="evenodd" d="M124 84H130.667C138.03 84 144 89.9695 144 97.3333V126.667C144 134.03 138.03 140 130.667 140H124H100H93.3333C85.9695 140 80 134.03 80 126.667V97.3333C80 89.9695 85.9695 84 93.3333 84H100H124ZM110.667 88H100C94.8453 88 90.6667 92.1787 90.6667 97.3333V126.667C90.6667 131.821 94.8453 136 100 136H110.667V88ZM114.667 88V136H124C129.155 136 133.333 131.821 133.333 126.667V97.3333C133.333 94.1617 131.751 91.3595 129.333 89.6729V109.333L124 105.333L118.667 109.333V88H114.667ZM134.13 135.336C136.127 133.005 137.333 129.977 137.333 126.667V97.3333C137.333 94.0233 136.127 90.9949 134.13 88.6638C137.57 90.0393 140 93.4025 140 97.3333V126.667C140 130.597 137.57 133.961 134.13 135.336ZM89.8697 135.336C87.8729 133.005 86.6667 129.977 86.6667 126.667V97.3333C86.6667 94.0233 87.8728 90.9949 89.8697 88.6638C86.43 90.0393 84 93.4025 84 97.3333V126.667C84 130.597 86.43 133.961 89.8697 135.336Z" fill="#684688"/>
|
||||||
|
<path id="path8" fill-rule="evenodd" clip-rule="evenodd" d="M363.625 13.625V2L384 16.5417L363.625 31.0833V22.375C335.716 22.375 332.168 42.2843 331.708 47.375C332.463 13.711 363.625 13.625 363.625 13.625ZM320 16.5417C320 12.1097 323.568 8.54167 328 8.54167H353.333L344 12.5417H328C325.784 12.5417 324 14.3257 324 16.5417V52.5417C324 54.7577 325.784 56.5417 328 56.5417H369.333C371.549 56.5417 373.333 54.7577 373.333 52.5417V32.5417L377.333 29.875V52.5417C377.333 56.9737 373.765 60.5417 369.333 60.5417H328C323.568 60.5417 320 56.9737 320 52.5417V16.5417Z" fill="#684688"/>
|
||||||
|
<path id="path16" fill-rule="evenodd" clip-rule="evenodd" d="M272 3C254.327 3 240 13.7453 240 27C240 35.2547 245.557 42.532 254.016 46.852C254.016 46.878 254.012 46.8999 254.008 46.9224C254.004 46.9459 254 46.97 254 47C254 50.1096 251.986 53.4268 250.683 55.5737L250.683 55.5739C250.483 55.9023 250.3 56.2033 250.144 56.472H250.148C250.053 56.692 250 56.9333 250 57.188C250 58.188 250.809 59 251.812 59C251.902 59 252.025 58.9887 252.127 58.9792C252.239 58.9689 252.326 58.9609 252.321 58.972C258.572 57.948 264.46 52.2053 265.828 50.5427C267.827 50.836 269.887 51 272 51C289.671 51 304 40.2547 304 27C304 13.7453 289.672 3 272 3ZM272 13C272.552 13 273 13.448 273 14C273 14.552 272.549 15 272 15C261.345 15 252 20.608 252 27C252 27.552 251.552 28 251 28C250.448 28 250 27.552 250 27C250 19.412 260.075 13 272 13ZM266.408 46.5867C268.284 46.86 270.165 47 272 47C287.439 47 300 38.028 300 27C300 15.972 287.436 7 272 7C256.56 7 244 15.972 244 27C244 33.4147 248.424 39.504 255.836 43.2893C257.175 43.972 258.016 45.3467 258.016 46.8507C258.016 46.96 258.011 47.0907 257.999 47.2187C257.956 49.2867 257.347 51.292 256.567 53.0827C259.444 51.372 261.88 49.0467 262.736 48.004C263.503 47.072 264.64 46.544 265.828 46.544C266.02 46.544 266.213 46.5547 266.408 46.5867Z" fill="#684688"/>
|
||||||
|
<path id="path22" fill-rule="evenodd" clip-rule="evenodd" d="M160 112C160 94.3267 174.327 80 192 80C209.673 80 224 94.3267 224 112C224 129.673 209.673 144 192 144C174.327 144 160 129.673 160 112ZM220 112C220 96.536 207.464 84 192 84C176.536 84 164 96.536 164 112C164 124.684 172.434 135.391 184 138.833V137.75V135.125V132.875C184 130.334 184.875 128.5 186.583 127.333C185.501 127.229 184.489 127.062 183.583 126.875C182.838 126.721 182.282 126.524 181.545 126.261C181.387 126.205 181.22 126.146 181.042 126.083C180.031 125.73 179.135 125.282 178.333 124.792C177.532 124.301 176.74 123.656 176 122.875C175.26 122.094 174.625 121.239 174.125 120.25C173.625 119.261 173.25 118.052 172.958 116.667C172.666 115.281 172.5 113.75 172.5 112.083C172.5 108.854 173.563 106.104 175.667 103.833C174.708 101.355 174.833 98.667 176 95.7083C176.012 95.7042 176.025 95.6992 176.039 95.6938C176.097 95.6718 176.175 95.6422 176.292 95.625C176.437 95.6037 176.781 95.6253 177.292 95.6667C177.802 95.708 178.365 95.8227 178.958 96C179.552 96.1773 180.344 96.5107 181.333 97C182.323 97.4907 183.354 98.0827 184.458 98.8333C186.896 98.1467 189.437 97.8333 192.125 97.8333C194.792 97.8333 197.396 98.1453 199.875 98.8333C201.626 97.6453 203.178 96.813 204.583 96.2917C205.989 95.7703 206.959 95.5207 207.5 95.5833L208.292 95.6667C209.458 98.604 209.584 101.333 208.625 103.833C210.729 106.105 211.75 108.854 211.75 112.083C211.75 113.75 211.625 115.281 211.333 116.667C211.041 118.052 210.625 119.261 210.125 120.25C209.625 121.239 209.03 122.094 208.292 122.875C207.553 123.656 206.761 124.302 205.958 124.792C205.156 125.281 204.261 125.73 203.25 126.083C202.239 126.437 201.28 126.688 200.375 126.875C199.47 127.062 198.459 127.188 197.375 127.292C199.104 128.48 200 130.354 200 132.875V135.375V137.667V138.833C211.566 135.391 220 124.684 220 112Z" fill="#684688"/>
|
||||||
|
<path id="path3858" fill-rule="evenodd" clip-rule="evenodd" d="M100 0C99.0049 0 98.0752 0.350804 97.3333 0.958333C96.5914 1.56586 96 2.50111 96 3.625V5.33333H94.6667V6.66667H87.3333C87.264 6.66305 87.1944 6.66305 87.125 6.66667C86.1491 6.76895 85.3281 7.68544 85.3333 8.66667V9.33333H83.3333C82.2862 9.33344 81.3334 10.2862 81.3333 11.3333V12.125C80.563 12.3974 80.0044 13.1829 80 14V18C80.0001 19.0472 80.9528 19.9999 82 20H85.3333V53.3333L83.6667 54.9167C83.0569 55.2687 82.6604 55.9626 82.6667 56.6667V60.6667C82.6668 61.7138 83.6195 62.6666 84.6667 62.6667H95.2083H104.667H104.875H115.333C116.381 62.6666 117.333 61.7138 117.333 60.6667V56.6667C117.34 55.9626 116.943 55.2687 116.333 54.9167L114.667 53.3333V20H118C119.047 19.9999 120 19.0472 120 18V14C119.996 13.1829 119.437 12.3974 118.667 12.125V11.3333C118.667 10.2862 117.714 9.33344 116.667 9.33333H114.667V8.66667C114.667 7.6195 113.714 6.66677 112.667 6.66667H105.333V5.33333H104V3.625C104 2.50111 103.409 1.56586 102.667 0.958333C101.925 0.350804 100.995 0 100 0ZM100 2.66667C100.274 2.66667 100.684 2.81724 100.958 3.04167C101.232 3.26609 101.333 3.47936 101.333 3.625V5.33333H98.6667V3.625C98.6667 3.47936 98.7676 3.26609 99.0417 3.04167C99.3157 2.81724 99.7255 2.66667 100 2.66667ZM112 12V10.6667H88V12H85.3333C85.2542 12.8356 85.0919 13.6063 84 13.5417V17.3333H89.3333H110.667H116V13.4167C114.82 13.6844 114.596 12.9828 114.667 12H112ZM110.667 20V56L113.333 57.8333V58.6667H86.6667V57.8333L89.3333 56V20H110.667ZM92 28V22.6667H94.6667V28H92ZM96 22.6667V28H98.6667V22.6667H96ZM101.333 28V22.6667H104V28H101.333ZM105.333 22.6667V28H108V22.6667H105.333ZM92 34.6667V29.3333H94.6667V34.6667H92ZM96 29.3333V34.6667H98.6667V29.3333H96ZM101.333 34.6667V29.3333H104V34.6667H101.333ZM105.333 29.3333V34.6667H108V29.3333H105.333ZM101.333 42.6667C101.333 41.6527 102.153 40.8333 103.167 40.8333C104.181 40.8333 105 41.6527 105 42.6667C105 43.6806 104.181 44.5 103.167 44.5C102.153 44.5 101.333 43.6806 101.333 42.6667Z" fill="#684688"/>
|
||||||
|
<path id="path20" fill-rule="evenodd" clip-rule="evenodd" d="M247.472 80L243.472 115.792L247.43 116.208L251.013 84H291.93L295.513 116.208L299.472 115.792L295.472 80H247.472ZM255.472 88V92H287.472V88H255.472ZM255.472 100V96H287.472V100H255.472ZM255.472 104V108H287.472V104H255.472ZM255.472 116V112H287.472V116H255.472ZM241.472 120C240.372 120 239.749 120.873 240.097 121.917L246.847 142.083C247.195 143.127 248.372 144 249.472 144H293.472C294.572 144 295.749 143.127 296.097 142.083L302.847 121.917C303.196 120.873 302.572 120 301.472 120H241.472ZM279.472 124H263.472V128H279.472V124Z" fill="#684688"/>
|
||||||
|
<path id="Vector" d="M370.378 82H380.145L358.811 107.042L384 141H364.209L348.787 120.416L331.052 141H321.285L344.161 114.253L320 82H340.305L354.313 100.88L370.378 82ZM366.908 134.969H372.305L337.349 87.6378H331.438L366.908 134.969Z" fill="white"/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 10 KiB |
127
site/index.html
Normal file
|
@ -0,0 +1,127 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>jrnl - The Command Line Journal</title>
|
||||||
|
<meta name="description" content="Collect your thoughts and notes without leaving the command line.">
|
||||||
|
<meta name="image" content="https://jrnl.sh/en/stable/img/banner_og.png">
|
||||||
|
<meta itemprop="name" content="jrnl - The Command Line Journal">
|
||||||
|
<meta itemprop="description" content="Collect your thoughts and notes without leaving the command line.">
|
||||||
|
<meta itemprop="image" content="https://jrnl.sh/en/stable/img/banner_og.png">
|
||||||
|
<meta name="twitter:card" content="summary">
|
||||||
|
<meta name="twitter:title" content="jrnl - The Command Line Journal">
|
||||||
|
<meta name="twitter:description" content="Collect your thoughts and notes without leaving the command line.">
|
||||||
|
<meta name="twitter:creator" content="jrnl">
|
||||||
|
<meta name="twitter:image:src" content="https://jrnl.sh/en/stable/img/banner_twitter.png">
|
||||||
|
<meta name="og:title" content="jrnl - The Command Line Journal">
|
||||||
|
<meta name="og:description" content="Collect your thoughts and notes without leaving the command line.">
|
||||||
|
<meta name="og:image" content="https://jrnl.sh/en/stable/img/banner_og.png">
|
||||||
|
<meta name="og:url" content="https://jrnl.sh">
|
||||||
|
<meta name="og:site_name" content="jrnl - The Command Line Journal">
|
||||||
|
<meta name="og:type" content="website">
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400' rel='stylesheet' type='text/css'>
|
||||||
|
<link rel="stylesheet" href="assets/colors.css">
|
||||||
|
<link rel="stylesheet" href="assets/index.css">
|
||||||
|
<link rel="shortcut icon" href="img/favicon.ico">
|
||||||
|
<script type="application/ld+json">
|
||||||
|
{
|
||||||
|
"@context": "https://schema.org",
|
||||||
|
"@type": "SoftwareApplication",
|
||||||
|
"applicationCategory": "https://schema.org/LifestyleApplication",
|
||||||
|
"name": "jrnl",
|
||||||
|
"description": "Collect your thoughts and notes without leaving the command line.",
|
||||||
|
"operatingSystem": ["macOS", "Windows", "Linux"],
|
||||||
|
"thumbnailUrl": "https://jrnl.sh/en/stable/img/banner_og.png",
|
||||||
|
"installUrl": "https://jrnl.sh/en/stable/installation",
|
||||||
|
"softwareVersion": "2.5"
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<header>
|
||||||
|
<aside>
|
||||||
|
<a id="twitter" href="https://twitter.com/intent/tweet?text=Collect+your+thoughts+and+notes+without+leaving+the+command+line.+https%3A%2F%2Fjrnl.sh+via+@JrnlSh"><i class="icon twitter"></i>Tell your friends</a>
|
||||||
|
</aside>
|
||||||
|
<div id="title">
|
||||||
|
<img id="logo" src="img/jrnl_white.svg" width="90px" height="98px" title="jrnl" alt="jrnl logo" />
|
||||||
|
<h1>Collect your thoughts and notes <br />without leaving the command line.</h1>
|
||||||
|
</div>
|
||||||
|
<div id="prompt">
|
||||||
|
<div id="terminal">
|
||||||
|
<div id="typed"></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
<main>
|
||||||
|
<nav>
|
||||||
|
<a href="overview">Documentation</a>
|
||||||
|
<a href="installation" class="cta">Get Started</a>
|
||||||
|
<a href="http://github.com/jrnl-org/jrnl" title="View on Github">Fork on GitHub</a>
|
||||||
|
<a id="twitter-nav" href="https://twitter.com/intent/tweet?text=Collect+your+thoughts+and+notes+without+leaving+the+command+line.+https%3A%2F%2Fjrnl.sh+via+@JrnlSh">Tell your friends on X</a>
|
||||||
|
</nav>
|
||||||
|
<div class="flex">
|
||||||
|
<section>
|
||||||
|
<i class="icon nli"></i>
|
||||||
|
<h3>Human friendly.</h3>
|
||||||
|
<p>jrnl has a natural-language interface so you don't have to remember cryptic shortcuts when you're writing down your thoughts.</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<i class="icon future"></i>
|
||||||
|
<h3>Future-proof.</h3>
|
||||||
|
<p>Your journals are stored in plain-text files that will still be readable in 50 years when your fancy proprietary apps will have gone the way of the dodo.</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<i class="icon secure"></i>
|
||||||
|
<h3>Secure.</h3>
|
||||||
|
<p>Encrypt your journals with industry-strength AES encryption. Nobody will be able to read your dirty secrets—not even you, if you lose your password!</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<i class="icon sync"></i>
|
||||||
|
<h3>Accessible anywhere.</h3>
|
||||||
|
<p>Sync your journal files with other tools like Dropbox to capture your thoughts wherever you are.</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<i class="icon github"></i>
|
||||||
|
<h3>Free & Open Source.</h3>
|
||||||
|
<p>jrnl is made by a bunch of really friendly and remarkably amazing people. Maybe even <a href="https://www.github.com/jrnl-org/jrnl" title="Fork jrnl on GitHub">you</a>?</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<i class="icon folders"></i>
|
||||||
|
<h3>For work and play.</h3>
|
||||||
|
<p>Effortlessly access several journals for all parts of your life.</p>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
</main>
|
||||||
|
<footer>
|
||||||
|
jrnl is made with love by <a href="https://github.com/jrnl-org/jrnl/graphs/contributors" title="Contributors">many fabulous people</a>. If you need help, <a href="https://github.com/jrnl-org/jrnl/issues/new/choose" title="Open a new issue on Github">submit an issue</a> on Github.
|
||||||
|
</footer>
|
||||||
|
<script src="//cdnjs.cloudflare.com/ajax/libs/typed.js/2.0.12/typed.min.js"></script>
|
||||||
|
<script>
|
||||||
|
new Typed("#typed", {
|
||||||
|
strings: [
|
||||||
|
"jrnl Started writing my memoirs on the command line. 🎉🔥💻🔥🎉",
|
||||||
|
"jrnl yesterday 2pm: used jrnl to keep track of accomplished tasks. The done.txt for my todo.txt",
|
||||||
|
"jrnl <b>-from</b> 2019 <b>-until</b> may<br /><i>`(displays all entries from January 2019 to last May)`</i>",
|
||||||
|
"jrnl A day on the beach with @beth and @frank. Tagging them so I can easily look this up later.",
|
||||||
|
"jrnl <b>--tags</b><br /><i>`@frank 7<br />@beth 5</i>`",
|
||||||
|
"jrnl <b>--format</b> json<br /><i>`(Outputs your entire journal as json)</i>`",
|
||||||
|
"jrnl <b>--encrypt</b><br /><i>`(AES encryption. Don't lose your password!)</i>`"
|
||||||
|
],
|
||||||
|
typeSpeed: 20, // less is faster
|
||||||
|
backSpeed: 10,
|
||||||
|
backDelay: 2500,
|
||||||
|
loop: true,
|
||||||
|
showCursor: false
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
1
site/index.js
Normal file
|
@ -0,0 +1 @@
|
||||||
|
var typed2 =
|
251
site/installation/index.html
Normal file
|
@ -0,0 +1,251 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/installation/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Quickstart - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Quickstart";
|
||||||
|
var mkdocs_page_input_path = "installation.md";
|
||||||
|
var mkdocs_page_url = "/installation/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Quickstart</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Quickstart</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/installation.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="getting-started">Getting started</h1>
|
||||||
|
<h2 id="installation">Installation</h2>
|
||||||
|
<p>The easiest way to install <code>jrnl</code> is using
|
||||||
|
<a href="https://pipx.pypa.io/stable/installation/">pipx</a>
|
||||||
|
with <a href="https://www.python.org/">Python</a> 3.10+:</p>
|
||||||
|
<pre><code class="language-sh">pipx install jrnl
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition tip">
|
||||||
|
<p class="admonition-title">Tip</p>
|
||||||
|
<p>Do not use <code>sudo</code> while installing <code>jrnl</code>. This may lead to path issues.</p>
|
||||||
|
</div>
|
||||||
|
<p>The first time you run <code>jrnl</code> you will be asked where your journal file
|
||||||
|
should be created and whether you wish to encrypt it.</p>
|
||||||
|
<h2 id="quickstart">Quickstart</h2>
|
||||||
|
<p>To make a new entry, just type</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
|
||||||
|
</code></pre>
|
||||||
|
<p>and hit return. <code>yesterday:</code> will be interpreted as a time stamp.
|
||||||
|
Everything until the first sentence mark (<code>.?!:</code>) will be interpreted as
|
||||||
|
the title, the rest as the body. In your journal file, the result will
|
||||||
|
look like this:</p>
|
||||||
|
<pre><code class="language-output">2012-03-29 09:00 Called in sick.
|
||||||
|
Used the time to clean the house and spent 4h on writing my book.
|
||||||
|
</code></pre>
|
||||||
|
<p>If you just call <code>jrnl</code>, you will be prompted to compose your entry -
|
||||||
|
but you can also <a href="../advanced/">configure</a> <em>jrnl</em> to use your external editor.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../overview/" class="btn btn-neutral float-left" title="Overview"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../usage/" class="btn btn-neutral float-right" title="Basic Usage">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../overview/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../usage/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
306
site/ja/advanced/index.html
Normal file
|
@ -0,0 +1,306 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/advanced/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>高度な使い方 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u9ad8\u5ea6\u306a\u4f7f\u3044\u65b9";
|
||||||
|
var mkdocs_page_input_path = "ja/advanced.md";
|
||||||
|
var mkdocs_page_url = "/ja/advanced/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">高度な使い方</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">設定ファイル</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_3">複数のジャーナルファイル</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_4">コマンドラインから設定を変更する</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_6">代替設定の使用</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>高度な使い方</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/advanced.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">高度な使用方法</h1>
|
||||||
|
<h2 id="_2">設定ファイル</h2>
|
||||||
|
<p><code>jrnl</code>には、テンプレート、フォーマット、複数のジャーナルなど、設定ファイルを通
|
||||||
|
してカスタマイズできる多様なオプションがあります。詳細については<a href="../reference-config-file/">設定ファイルリ
|
||||||
|
ファレンス</a>を参照するか、以下の一般的な使用例をお読
|
||||||
|
みください。</p>
|
||||||
|
<h3 id="_3">複数のジャーナルファイル</h3>
|
||||||
|
<p><a href="../reference-config-file/">設定ファイル</a>でより多くのジャーナルを定義することで、<code>jrnl</code>を複数のジャーナル(例:<code>private</code>と<code>work</code>)で使用するように設定できます。例えば:</p>
|
||||||
|
<pre><code class="language-yaml">journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work: ~/work.txt
|
||||||
|
</code></pre>
|
||||||
|
<p><code>default</code>ジャーナルは<code>jrnl</code>を初めて起動したときに作成されます。
|
||||||
|
これで、<code>jrnl</code>の代わりに<code>jrnl work</code>を使用して<code>work</code>ジャーナルにアクセスできます。例えば:</p>
|
||||||
|
<pre><code class="language-sh">jrnl work at 10am: @Steveとのミーティング
|
||||||
|
jrnl work -n 3
|
||||||
|
</code></pre>
|
||||||
|
<p>これらはどちらも<code>~/work.txt</code>を使用しますが、<code>jrnl -n 3</code>は<code>~/journal.txt</code>から最後の3つのエントリーを表示します(<code>jrnl default -n 3</code>も同様です)。</p>
|
||||||
|
<p>各ジャーナルのデフォルトオプションを個別にオーバーライドすることもできます。
|
||||||
|
<code>jrnl.yaml</code>が以下のようになっている場合:</p>
|
||||||
|
<pre><code class="language-yaml">encrypt: false
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
food: ~/my_recipes.txt
|
||||||
|
</code></pre>
|
||||||
|
<p><code>default</code>と<code>food</code>ジャーナルは暗号化されませんが、<code>work</code>ジャーナルは暗号化されます!</p>
|
||||||
|
<p><code>jrnl.yaml</code>のトップレベルにあるすべてのオプションをオーバーライドできますが、少なくともそのジャーナルのジャーナルファイルを指す<code>journal: ...</code>キーを指定してください。</p>
|
||||||
|
<p>以下の設定例を考えてみましょう:</p>
|
||||||
|
<pre><code class="language-yaml">editor: vi -c startinsert
|
||||||
|
journals:
|
||||||
|
default: ~/journal.txt
|
||||||
|
work:
|
||||||
|
journal: ~/work.txt
|
||||||
|
encrypt: true
|
||||||
|
display_format: json
|
||||||
|
editor: code -rw
|
||||||
|
food:
|
||||||
|
display_format: markdown
|
||||||
|
journal: ~/recipes.txt
|
||||||
|
</code></pre>
|
||||||
|
<p><code>work</code>ジャーナルは暗号化され、デフォルトで<code>json</code>形式で出力され、VSCodeの既存のウィンドウで編集されます。同様に、<code>food</code>ジャーナルはデフォルトでmarkdown形式で出力されますが、他のすべてのデフォルト設定を使用します。</p>
|
||||||
|
<h3 id="_4">コマンドラインから設定を変更する</h3>
|
||||||
|
<p>現在の<code>jrnl</code>インスタンスの設定フィールドを<code>--config-override CONFIG_KEY CONFIG_VALUE</code>を使用してオーバーライドできます。ここで、<code>CONFIG_KEY</code>は有効な設定フィールドをドット表記で指定し、<code>CONFIG_VALUE</code>は希望する(有効な)オーバーライド値です。ドット表記を使用して、<code>colors.title</code>のような他のキー内のキーを変更することもできます。</p>
|
||||||
|
<p>複数のオーバーライドを指定するには、<code>--config-override</code>を複数回呼び出します。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>これらのオーバーライドにより、jrnl設定の<strong><em>任意の</em></strong>フィールドを変更できます。自己責任で使用してください。</p>
|
||||||
|
<h4 id="_5">例</h4>
|
||||||
|
<pre><code class="language-sh"># 高速ログ記録のために`stdin`プロンプトを使用してエントリーを作成する
|
||||||
|
jrnl --config-override editor ""
|
||||||
|
|
||||||
|
# プロジェクトのログを記録する
|
||||||
|
jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo タオルを見つける
|
||||||
|
|
||||||
|
# 複数のオーバーライドを渡す
|
||||||
|
jrnl --config-override display_format fancy --config-override linewrap 20 \
|
||||||
|
--config-override colors.title green
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="_6">代替設定の使用</h3>
|
||||||
|
<p>現在の<code>jrnl</code>インスタンスに対して、<code>--config-file CONFIG_FILE_PATH</code>を使用して代替設定ファイルを指定できます。ここで<code>CONFIG_FILE_PATH</code>は代替<code>jrnl</code>設定ファイルへのパスです。</p>
|
||||||
|
<h4 id="_7">例</h4>
|
||||||
|
<pre><code class="language-sh"># 個人的なジャーナルエントリーに個人用設定ファイルを使用する
|
||||||
|
jrnl --config-file ~/foo/jrnl/personal-config.yaml
|
||||||
|
|
||||||
|
# 仕事関連のエントリーに代替設定ファイルを使用する
|
||||||
|
jrnl --config-file ~/foo/jrnl/work-config.yaml
|
||||||
|
|
||||||
|
# デフォルトの設定ファイルを使用する(初回実行時に作成される)
|
||||||
|
jrnl
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../formats/" class="btn btn-neutral float-left" title="フォーマット"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../external-editors/" class="btn btn-neutral float-right" title="外部エディタ">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../formats/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../external-editors/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
347
site/ja/contributing/index.html
Normal file
|
@ -0,0 +1,347 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/contributing/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>jrnlへの貢献 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "jrnl\u3078\u306e\u8ca2\u732e";
|
||||||
|
var mkdocs_page_input_path = "ja/contributing.md";
|
||||||
|
var mkdocs_page_url = "/ja/contributing/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >貢献</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">jrnlへの貢献</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_1">目次</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">行動規範</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">バグの報告</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">ドキュメントの編集</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_5">外部エディタとヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_6">テスト</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_7">プレリリース</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_8">プルリクエスト</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_9">バグ報告の確認</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_10">自動テスト</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_11">機能リクエストとアイデアの提出</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_12">開発</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_13">環境のセットアップ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_14">ブランチの理解</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_15">一般的な開発コマンド</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_16">自動テストの更新</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_17">プルリクエストの提出</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_18">作業対象を見つける</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#python">新しいプログラマーとPythonを初めて使うプログラマーへの注意</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>貢献 »</li>
|
||||||
|
<li>jrnlへの貢献</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/contributing.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="jrnl">jrnlへの貢献</h1>
|
||||||
|
<p>jrnlへの貢献を歓迎します。バグの報告、ドキュメントの改善、リリースのテスト、機能やバグに関する議論への参加、コードの作成など、さまざまな形での貢献が可能です。</p>
|
||||||
|
<h2 id="_1">目次</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#行動規範">行動規範</a></li>
|
||||||
|
<li><a href="#バグの報告">バグの報告</a></li>
|
||||||
|
<li><a href="#ドキュメントの編集">ドキュメントの編集</a></li>
|
||||||
|
<li><a href="#テスト">テスト</a></li>
|
||||||
|
<li><a href="#機能リクエストとアイデアの提出">機能リクエストとアイデアの提出</a></li>
|
||||||
|
<li><a href="#開発">jrnlの開発</a></li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="_2">行動規範</h2>
|
||||||
|
<p>まず始めに、<a href="https://github.com/jrnl-org/jrnl/blob/develop/CODE_OF_CONDUCT.md">行動規範</a>をお読みください。</p>
|
||||||
|
<h2 id="_3">バグの報告</h2>
|
||||||
|
<p>バグは<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開く</a>ことで報告してください。できるだけ詳細に説明してください。多くのバグは特定のオペレーティングシステムやPythonのバージョンに固有のものなので、その情報も含めてください!</p>
|
||||||
|
<h2 id="_4">ドキュメントの編集</h2>
|
||||||
|
<p>ドキュメントにタイプミスや間違いを見つけた場合は、すぐに修正してプルリクエストを送ってください。何を変更すべきか不確かだが問題を見つけた場合は、「ドキュメントの変更」タイプで<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開く</a>ことができます。</p>
|
||||||
|
<p>ドキュメントを編集するには、<strong>develop</strong>ブランチの<code>docs/*.md</code>ファイルを編集します。プロジェクトのルートディレクトリで<code>poe docs-run</code>を実行し、ブラウザで<a href="http://localhost:8000">localhost:8000</a>にアクセスすることで結果を確認できます。</p>
|
||||||
|
<h3 id="_5">外部エディタとヒントとコツ</h3>
|
||||||
|
<p>便利だと思うjrnlのコマンドラインテクニックを共有したい場合は、<a href="../tips-and-tricks/">"ヒントとコツ"セクション</a>に追加するとよいでしょう。特定の外部エディタとの統合に関するアドバイスは、<a href="../external-editors/">"外部エディタ"セクション</a>に追加できます。</p>
|
||||||
|
<h2 id="_6">テスト</h2>
|
||||||
|
<p>jrnlの保守作業の多くは、コーディングよりもテストに関わるものです。</p>
|
||||||
|
<p>jrnlの性質上、非常に機密性の高いデータを扱うため、データ損失のリスクを冒すことはできません。jrnlには包括的な自動テストスイートがありますが、ユーザーテストはこのリスクを軽減する上で極めて重要です。</p>
|
||||||
|
<h3 id="_7">プレリリース</h3>
|
||||||
|
<p><a href="https://pypi.org/project/jrnl/#history">プレリリースは通常のリリースと同様にPyPiを通じてデプロイされます</a>。<a href="https://pypi.org/project/pipx/">pipx</a>を使用してそれらを取得し、テストすることができます。各リリースで変更された内容については<a href="https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md">チェンジログ</a>を参照してください。</p>
|
||||||
|
<h3 id="_8">プルリクエスト</h3>
|
||||||
|
<p>gitに慣れている場合は、特定の<a href="https://github.com/jrnl-org/jrnl/pulls">プルリクエスト</a>をフェッチし、自分でテストして、結果を報告してください。新機能の動作をスクリーンキャストで示すとなおよいでしょう。</p>
|
||||||
|
<h3 id="_9">バグ報告の確認</h3>
|
||||||
|
<p><a href="https://github.com/jrnl-org/jrnl/issues?q=is%3Aissue+is%3Aopen+label%3Abug">GitHubの問題</a>には常にオープンなバグがあり、多くは特定のOS、Pythonバージョン、またはjrnlバージョンに固有のものです。「jrnl v2.2、MacOS 10.15、Python 3.8.1で確認」といった簡単なコメントでも、バグの追跡に非常に役立ちます。</p>
|
||||||
|
<h3 id="_10">自動テスト</h3>
|
||||||
|
<p>新しい自動テストの追加方法については、以下の開発セクションを参照してください。</p>
|
||||||
|
<h2 id="_11">機能リクエストとアイデアの提出</h2>
|
||||||
|
<p>jrnlに対する機能リクエストやアイデアがある場合は、<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開いて</a>機能の目的と関連するユースケースを説明してください。私たちはあなたと議論し、それがプロジェクトに適しているかどうかを決定します。</p>
|
||||||
|
<p>新機能について議論する際は、私たちの設計目標を念頭に置いてください。jrnlは<a href="https://en.wikipedia.org/wiki/Unix_philosophy">一つのことをうまく行う</a>ことを目指しています。私たちにとって、それは以下を意味します:</p>
|
||||||
|
<ul>
|
||||||
|
<li><em>機敏</em>であること</li>
|
||||||
|
<li>シンプルなインターフェースを持つこと</li>
|
||||||
|
<li>機能の重複を避けること</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="_12">開発</h2>
|
||||||
|
<h3 id="_13">環境のセットアップ</h3>
|
||||||
|
<p>jrnlを開発するには<a href="https://python-poetry.org/">poetry</a>をインストールする必要があります。poetryがプロジェクトの他のすべての依存関係を管理します。</p>
|
||||||
|
<h3 id="_14">ブランチの理解</h3>
|
||||||
|
<p>jrnlは主に2つのブランチを使用します:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>develop</code> - 継続的な開発用</li>
|
||||||
|
<li><code>release</code> - リリース用</li>
|
||||||
|
</ul>
|
||||||
|
<p>一般的に、プルリクエストは<code>develop</code>ブランチに対して行われるべきです。</p>
|
||||||
|
<h3 id="_15">一般的な開発コマンド</h3>
|
||||||
|
<p><code>pyproject.toml</code>にコマンドの一覧があります。ユーザーは<code>poe</code>の後にコマンド名を入力することでコマンドを実行できます(<a href="https://github.com/nat-n/poethepoet">Poe the Poet</a>は単独で、または<code>poetry install</code>の一部としてインストールできます)。</p>
|
||||||
|
<p>典型的な開発ワークフローには以下が含まれます:</p>
|
||||||
|
<ul>
|
||||||
|
<li>依存関係のインストール:</li>
|
||||||
|
<li><code>poetry install</code></li>
|
||||||
|
<li>仮想環境の有効化:</li>
|
||||||
|
<li><code>poetry shell</code></li>
|
||||||
|
<li>仮想環境でソースを実行:</li>
|
||||||
|
<li><code>jrnl</code>(必要に応じて引数を付けて)</li>
|
||||||
|
<li>テストの実行:</li>
|
||||||
|
<li><code>poe test</code></li>
|
||||||
|
<li>コードのフォーマットをスタイルに標準化:</li>
|
||||||
|
<li><code>poe format</code></li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="_16">自動テストの更新</h3>
|
||||||
|
<p>バグの解決や新機能の追加時には、将来その機能が壊れるのを防ぐためにテストを追加してください。テストでカバーされていない機能に気づいた場合は、テストのみのプルリクエストを提出することもできます。</p>
|
||||||
|
<p>テストには、ユニットテスト用に<a href="https://docs.pytest.org">pytest</a>を、統合テスト用に<a href="https://pytest-bdd.readthedocs.io/">pytest-bdd</a>を使用しています。すべてのテストは<code>tests</code>フォルダーにあります。</p>
|
||||||
|
<p>多くのテストは、他のテストと同じフォーマットの<code>*.feature</code>ファイルを編集するだけで作成できます。より複雑な機能については、<code>tests/lib/</code>にステップを実装し、それを<code>feature</code>ファイルのテストで実行する必要があるかもしれません。</p>
|
||||||
|
<h3 id="_17">プルリクエストの提出</h3>
|
||||||
|
<p>準備ができたら、プルリクエスト(PR)を提出してください。jrnlのメンテナーは通常2週間ごとにプルリクエストをレビューしますが、継続的統合パイプラインは数分以内にあなたのコードに対して自動テストを実行し、さまざまな環境で見つかった問題を報告します。</p>
|
||||||
|
<p>プルリクエストのテンプレートにはハウスキーピング項目のチェックリストが含まれています。提出時に必要に応じてそれらを記入してください。</p>
|
||||||
|
<p>プルリクエストにテスト失敗が含まれている場合、おそらくレビューされず、確実に承認されません。ただし、テスト失敗の解決に助けが必要な場合は、PRでその旨を言及してください。</p>
|
||||||
|
<h3 id="_18">作業対象を見つける</h3>
|
||||||
|
<p><a href="https://github.com/jrnl-org/jrnl/issues">jrnlのGitHub Issues</a>を<a href="https://github.com/jrnl-org/jrnl/labels">ラベル</a>で検索して、作業対象を見つけることができます。以下は検索する価値のあるラベルです:</p>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/critical">critical</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/help%20wanted">help wanted</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/bug">bug</a></li>
|
||||||
|
<li><a href="https://github.com/jrnl-org/jrnl/labels/enhancement">enhancement</a></li>
|
||||||
|
</ul>
|
||||||
|
<p><a href="https://github.com/jrnl-org/jrnl/milestones">マイルストーン</a>をレビューして、プロジェクトの優先事項を把握することもできます。</p>
|
||||||
|
<h3 id="python">新しいプログラマーとPythonを初めて使うプログラマーへの注意</h3>
|
||||||
|
<p>jrnlは発足以来かなり成長しましたが、全体的な複雑さ(エンドユーザープログラムとしては)は比較的低く、コードを理解しやすいと思います。</p>
|
||||||
|
<p>質問がある場合は、遠慮なく聞いてください!Pythonは初心者プログラマーを歓迎し、オープンなコミュニティとして知られています。コードをフォークして自由に試してみてください!私たちと共有したいものを作成した場合は、プルリクエストを作成してください。プルリクエストが完璧で、慣用的で、すぐにマージできるコードであることは期待していません。一緒に取り組んでいきましょう!</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../reference-config-file/" class="btn btn-neutral float-left" title="設定ファイル"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-config-file/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
353
site/ja/encryption/index.html
Normal file
|
@ -0,0 +1,353 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/encryption/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>暗号化 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u6697\u53f7\u5316";
|
||||||
|
var mkdocs_page_input_path = "ja/encryption.md";
|
||||||
|
var mkdocs_page_url = "/ja/encryption/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">暗号化</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">セキュリティに関する注意</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">暗号化と復号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">パスワードをキーチェーンに保存する</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_5">手動復号化</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>暗号化</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/encryption.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">暗号化</h1>
|
||||||
|
<h2 id="_2">セキュリティに関する注意</h2>
|
||||||
|
<p><code>jrnl</code>はベストプラクティスに従っていますが、現実世界で完全なセキュリティを実現することは不可能です。あなたの<code>jrnl</code>データを少なくとも部分的に侵害する方法はいくつかあります。詳細については、<a href="../privacy-and-security/">プライバシーとセキュリティ</a>のページを参照してください。</p>
|
||||||
|
<h2 id="_3">暗号化と復号化</h2>
|
||||||
|
<p>既存のプレーンテキストのジャーナルファイルは、<code>--encrypt</code>コマンドを使用して暗号化できます:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --encrypt [ファイル名]
|
||||||
|
</code></pre>
|
||||||
|
<p>その後、新しいパスワードを入力すると、暗号化されていないファイルが新しい暗号化されたファイルに置き換えられます。</p>
|
||||||
|
<p>このコマンドは、既に暗号化されているジャーナルファイルのパスワードを変更する際にも機能します。<code>jrnl</code>は現在のパスワードと新しいパスワードの入力を求めます。</p>
|
||||||
|
<p>逆に、</p>
|
||||||
|
<pre><code class="language-sh">jrnl --decrypt [ファイル名]
|
||||||
|
</code></pre>
|
||||||
|
<p>は暗号化されたジャーナルファイルをプレーンテキストファイルに置き換えます。また、ファイル名を指定することもできます(例:<code>jrnl --decrypt plain_text_copy.txt</code>)。これにより、元の暗号化されたファイルはそのままで、その隣に新しいプレーンテキストファイルが作成されます。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p><a href="../reference-config-file/">設定ファイル</a>の<code>encrypt</code>を別の値に変更しても、
|
||||||
|
ジャーナルファイルの暗号化や復号化は行われません。それはただ、あなたの
|
||||||
|
ジャーナルが暗号化されているかどうかを示すだけです。したがって、この
|
||||||
|
オプションを手動で変更すると、ほとんどの場合、ジャーナルファイルを
|
||||||
|
ロードできなくなります。そのため、上記のコマンドが必要になります。</p>
|
||||||
|
<h2 id="_4">パスワードをキーチェーンに保存する</h2>
|
||||||
|
<p>誰も<code>jrnl</code>のパスワードを回復またはリセットすることはできません。パスワードを失うと、
|
||||||
|
あなたのデータに永久にアクセスできなくなります。</p>
|
||||||
|
<p>このため、ジャーナルを暗号化する際、<code>jrnl</code>はパスワードをシステムのキーチェーンに
|
||||||
|
保存するかどうかを尋ねます。追加の利点として、ジャーナルファイルとやり取りする際に
|
||||||
|
パスワードを入力する必要がなくなります。</p>
|
||||||
|
<p>最初にパスワードをキーチェーンに保存しなかったが、後で保存することにした場合
|
||||||
|
(または、あるコンピューターのキーチェーンには保存したいが、別のコンピューターでは
|
||||||
|
保存したくない場合)、暗号化されたジャーナルに対して<code>jrnl --encrypt</code>を実行し、
|
||||||
|
同じパスワードを再度使用することができます。これによりキーチェーン保存のプロンプトが
|
||||||
|
トリガーされます。</p>
|
||||||
|
<h2 id="_5">手動復号化</h2>
|
||||||
|
<p>ジャーナルを復号化する最も簡単な方法は<code>jrnl --decrypt</code>を使用することですが、
|
||||||
|
必要に応じてジャーナルを手動で復号化することもできます。これを行うには、
|
||||||
|
AESアルゴリズム(特にAES-CBC)をサポートする任意のプログラムを使用できます。
|
||||||
|
復号化には以下の関連情報が必要です:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>キー:</strong> 暗号化に使用されるキーは、パスワードの
|
||||||
|
<a href="https://en.wikipedia.org/wiki/SHA-2">SHA-256</a>ハッシュです。</li>
|
||||||
|
<li><strong>初期化ベクトル(IV):</strong> IVは暗号化されたジャーナルファイルの最初の16バイトに
|
||||||
|
保存されています。</li>
|
||||||
|
<li><strong>ジャーナルの実際のテキスト</strong>(暗号化されたジャーナルファイルの最初の16バイト
|
||||||
|
以降のすべて)は<a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a>でエンコードされ、
|
||||||
|
暗号化される前に<a href="https://en.wikipedia.org/wiki/PKCS_7">PKCS#7</a>に従って
|
||||||
|
パディングされます。</li>
|
||||||
|
</ul>
|
||||||
|
<p>スクリプト形式でどのように見えるかの例が必要な場合は、以下にジャーナルを手動で
|
||||||
|
復号化するのに使用できるPythonスクリプトの例をいくつか示します。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>これらは単なる例であり、<code>jrnl</code>が存在しなくなっても、ジャーナルファイルが
|
||||||
|
まだ復元可能であることを示すためにここにあります。可能な場合は
|
||||||
|
<code>jrnl --decrypt</code>を使用してください。</p>
|
||||||
|
<p><strong>jrnl v2ファイルの例</strong>:</p>
|
||||||
|
<pre><code class="language-python">#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
jrnl v2の暗号化されたジャーナルを復号化します。
|
||||||
|
|
||||||
|
注意:`cryptography`モジュールがインストールされている必要があります
|
||||||
|
(`pip3 install crytography`のようなコマンドでインストールできます)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import getpass
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from cryptography.fernet import Fernet
|
||||||
|
from cryptography.hazmat.backends import default_backend
|
||||||
|
from cryptography.hazmat.primitives import hashes
|
||||||
|
from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
|
||||||
|
|
||||||
|
filepath = input("ジャーナルファイルのパス: ")
|
||||||
|
password = getpass.getpass("パスワード: ")
|
||||||
|
|
||||||
|
with open(Path(filepath), "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
password = password.encode("utf-8")
|
||||||
|
kdf = PBKDF2HMAC(
|
||||||
|
algorithm=hashes.SHA256(),
|
||||||
|
length=32,
|
||||||
|
salt=b"\xf2\xd5q\x0e\xc1\x8d.\xde\xdc\x8e6t\x89\x04\xce\xf8",
|
||||||
|
iterations=100_000,
|
||||||
|
backend=default_backend(),
|
||||||
|
)
|
||||||
|
|
||||||
|
key = base64.urlsafe_b64encode(kdf.derive(password))
|
||||||
|
|
||||||
|
print(Fernet(key).decrypt(ciphertext).decode("utf-8"))
|
||||||
|
</code></pre>
|
||||||
|
<p><strong>jrnl v1ファイルの例</strong>:</p>
|
||||||
|
<pre><code class="language-python">#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
jrnl v1の暗号化されたジャーナルを復号化します。
|
||||||
|
|
||||||
|
注意:`pycrypto`モジュールがインストールされている必要があります
|
||||||
|
(`pip3 install pycrypto`のようなコマンドでインストールできます)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import getpass
|
||||||
|
import hashlib
|
||||||
|
|
||||||
|
from Crypto.Cipher import AES
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument("filepath", help="復号化するジャーナルファイル")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
pwd = getpass.getpass()
|
||||||
|
key = hashlib.sha256(pwd.encode("utf-8")).digest()
|
||||||
|
|
||||||
|
with open(args.filepath, "rb") as f:
|
||||||
|
ciphertext = f.read()
|
||||||
|
|
||||||
|
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
|
||||||
|
plain = crypto.decrypt(ciphertext[16:])
|
||||||
|
plain = plain.strip(plain[-1:])
|
||||||
|
plain = plain.decode("utf-8")
|
||||||
|
print(plain)
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../usage/" class="btn btn-neutral float-left" title="基本的な使い方"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../journal-types/" class="btn btn-neutral float-right" title="ジャーナルの種類">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../usage/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../journal-types/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
296
site/ja/external-editors/index.html
Normal file
|
@ -0,0 +1,296 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/external-editors/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>外部エディタ - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u5916\u90e8\u30a8\u30c7\u30a3\u30bf";
|
||||||
|
var mkdocs_page_input_path = "ja/external-editors.md";
|
||||||
|
var mkdocs_page_url = "/ja/external-editors/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">外部エディタ</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#sublime-text">Sublime Text</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#visual-studio-code">Visual Studio Code</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#macvim">MacVim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#vimneovim">Vim/Neovim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#ia-writer">iA Writer</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#windowsnotepad">Windows上のNotepad++</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#emacs">emacs</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">その他のエディタ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>外部エディタ</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/external-editors.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">外部エディタ</h1>
|
||||||
|
<p>お好みの外部エディタを設定するには、<a href="../reference-config-file/#editor">設定ファイル</a>の<code>editor</code>オプションを更新してください。エディタがオペレーティングシステムの<code>PATH</code>環境変数に含まれていない場合は、エディタのフルパスを入力する必要があります。</p>
|
||||||
|
<p>設定が完了したら、<code>jrnl</code>コマンドを単独で使用して、エディタで新しいドキュメントとしてエントリーを作成できます:</p>
|
||||||
|
<pre><code class="language-text">jrnl
|
||||||
|
</code></pre>
|
||||||
|
<p>ドキュメントの最初の行に、通常通りエントリーの時間とタイトルを指定できます。</p>
|
||||||
|
<p>クイックエントリーを含めることで、エディタをスキップすることもできます:</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: All my troubles seemed so far away.
|
||||||
|
</code></pre>
|
||||||
|
<p>コマンドラインでエントリーを開始し、選択したエディタで書き続けたい場合は、<code>--edit</code>フラグを使用します。例:</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: All my troubles seemed so far away. --edit
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>エントリーの編集を保存してログに記録するには、ファイルを保存して閉じてください。</p>
|
||||||
|
<p>jrnlで動作するには、すべてのエディタが<a href="https://en.wikipedia.org/wiki/Blocking_(computing)">ブロッキングプロセス</a>である必要があります。<a href="https://micro-editor.github.io/">micro</a>のような一部のエディタはデフォルトでブロッキングですが、他のエディタは以下に記載されているような追加の引数でブロッキングにすることができます。jrnlがエディタを開いても即座に実行が終了する場合、そのエディタはブロッキングプロセスではありません。以下の提案のいずれかで修正できる可能性があります。</p>
|
||||||
|
<p>エディタが機密情報を漏洩する可能性とそのリスクを軽減する方法については、<a href="../privacy-and-security/#editor-history">このセクション</a>を参照してください。</p>
|
||||||
|
<h2 id="sublime-text">Sublime Text</h2>
|
||||||
|
<p><a href="https://www.sublimetext.com/">Sublime Text</a>を使用するには、Sublime Textのコマンドラインツールをインストールし、<code>jrnl.yaml</code>を以下のように設定します:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "subl -w"
|
||||||
|
</code></pre>
|
||||||
|
<p><code>-w</code>フラグは、jrnlがSublime Textがファイルを閉じるのを待ってからジャーナルに書き込むようにするためのものです。</p>
|
||||||
|
<h2 id="visual-studio-code">Visual Studio Code</h2>
|
||||||
|
<p><a href="https://code.visualstudio.com">Visual Studio Code</a>も、プロセスがファイルを閉じるまで待機するように指示するフラグが必要です:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "code --wait"
|
||||||
|
</code></pre>
|
||||||
|
<p>Windowsでは、<code>code</code>はデフォルトでパスに追加されていないので、<code>code.exe</code>ファイルのフルパスを入力するか、<code>PATH</code>変数に追加する必要があります。</p>
|
||||||
|
<h2 id="macvim">MacVim</h2>
|
||||||
|
<p>Sublime Textと同様に、MacVimもプロセスがファイルを閉じるまで待機してからジャーナルに制御を戻すように指示するフラグで起動する必要があります。MacVimの場合、このフラグは<code>-f</code>です:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "mvim -f"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="vimneovim">Vim/Neovim</h2>
|
||||||
|
<p>Linuxでエディタとしてvimの派生版を使用するには、単純に<code>editor</code>を実行ファイルに設定します:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "vim"
|
||||||
|
# または
|
||||||
|
editor: "nvim"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="ia-writer">iA Writer</h2>
|
||||||
|
<p>OS Xでは、素晴らしい<a href="http://www.iawriter.com/mac">iA Writer</a>を使用してエントリーを書くことができます。<code>jrnl.yaml</code>を以下のように設定してください:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "open -b pro.writer.mac -Wn"
|
||||||
|
</code></pre>
|
||||||
|
<p>これは何をしているのでしょうか?<code>open -b ...</code>は、バンドル識別子(すべてのアプリに固有の文字列)で識別されるアプリケーションを使用してファイルを開きます。<code>-Wn</code>は、制御を戻す前にアプリケーションが閉じるまで待つこと、およびアプリケーションの新しいインスタンスを使用することをアプリケーションに指示します。</p>
|
||||||
|
<p>システムで<code>pro.writer.mac</code>バンドル識別子が見つからない場合は、シェルでiA Writerの<code>Info.plist</code>ファイルを調べることで、使用する正しい文字列を見つけることができます:</p>
|
||||||
|
<pre><code class="language-sh">grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="windowsnotepad">Windows上のNotepad++</h2>
|
||||||
|
<p><a href="http://notepad-plus-plus.org/">Notepad++</a>をエディタとして設定するには、<code>jrnl</code>の設定ファイル(<code>jrnl.yaml</code>)を以下のように編集します:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession"
|
||||||
|
</code></pre>
|
||||||
|
<p>二重のバックスラッシュは、<code>jrnl</code>がファイルパスを正しく読み取るために必要です。<code>-multiInst -nosession</code>オプションにより、<code>jrnl</code>は独自のNotepad++ウィンドウを開きます。</p>
|
||||||
|
<h2 id="emacs">emacs</h2>
|
||||||
|
<p><code>emacs</code>をエディタとして使用するには、<code>jrnl</code>の設定ファイル(<code>jrnl.yaml</code>)を以下のように編集します:</p>
|
||||||
|
<pre><code class="language-yaml">editor: emacsclient -a "" -c
|
||||||
|
</code></pre>
|
||||||
|
<p>メッセージの編集が終わったら、保存して<code>C-x #</code>でバッファを閉じ、emacsclientプロセスを停止します。</p>
|
||||||
|
<h2 id="_2">その他のエディタ</h2>
|
||||||
|
<p>他のエディタを使用していて、共有したい場合は、<a href="../contributing/#editing-documentation">ドキュメントの貢献</a>を自由に行ってください。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../advanced/" class="btn btn-neutral float-left" title="高度な使い方"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../tips-and-tricks/" class="btn btn-neutral float-right" title="ヒントとコツ">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../advanced/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../tips-and-tricks/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
487
site/ja/formats/index.html
Normal file
|
@ -0,0 +1,487 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/formats/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>フォーマット - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30d5\u30a9\u30fc\u30de\u30c3\u30c8";
|
||||||
|
var mkdocs_page_input_path = "ja/formats.md";
|
||||||
|
var mkdocs_page_url = "/ja/formats/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">フォーマット</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">表示フォーマット</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#pretty">Pretty</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#short">Short</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#fancy-boxed">Fancy (または Boxed)</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">データフォーマット</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#json">JSON</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#markdown">Markdown</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_4">プレーンテキスト</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#xml">XML</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#yaml">YAML</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_5">レポートフォーマット</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_6">タグ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_7">オプション</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-file">--fileを使用したエクスポート</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>フォーマット</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/formats.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">フォーマット</h1>
|
||||||
|
<p><code>jrnl</code>は様々な代替フォーマットをサポートしています。これらは、ジャーナルを<code>jrnl</code>のデフォルトとは異なる方法で表示したり、ジャーナルからのデータを他のプログラムにパイプして報告書を作成したり、<code>jrnl</code>のデータを好きなように使用したりするのに利用できます。</p>
|
||||||
|
<p>これらのフォーマットはいずれも検索と組み合わせて使用でき(例:<code>jrnl -contains "lorem ipsum" --format json</code>)、検索結果を指定されたフォーマットで表示したり、単独で使用して(例:<code>jrnl --format json</code>)選択されたジャーナルのすべてのエントリーを表示したりできます。</p>
|
||||||
|
<p>このページでは、すべての組み込みフォーマットの例を示していますが、<code>jrnl</code>はプラグインを通じてさらにフォーマットを追加することをサポートしているため、システムによってはさらに多くのフォーマットが利用可能な場合があります。システムで利用可能なフォーマットのリストについては、<code>jrnl --help</code>を参照してください。</p>
|
||||||
|
<p>これらのフォーマットはどれも互換性があり、以下では便宜上「表示」、「データ」、「レポート」フォーマットにグループ分けしているだけです。</p>
|
||||||
|
<h2 id="_2">表示フォーマット</h2>
|
||||||
|
<p>これらのフォーマットは主にターミナルでジャーナルを表示することを目的としています。それでも、他のフォーマットと同じように使用できます(選択すればファイルに書き込むこともできます)。</p>
|
||||||
|
<h3 id="pretty">Pretty</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format pretty
|
||||||
|
# または
|
||||||
|
jrnl -1 # 任意の検索
|
||||||
|
</code></pre>
|
||||||
|
<p>これは<code>jrnl</code>のデフォルトフォーマットです。<code>--format</code>が指定されていない場合、<code>pretty</code>が使用されます。</p>
|
||||||
|
<p>各エントリーのタイムスタンプをユーザー設定に従ってフォーマットし、同じ行にタイトルを表示します。その後、エントリーの本文が下に表示されます。</p>
|
||||||
|
<p>このフォーマットは、設定ファイルの以下の値を通じて設定可能です(詳細は<a href="../advanced/">Advanced Usage</a>を参照):</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>colors</code></li>
|
||||||
|
<li><code>body</code></li>
|
||||||
|
<li><code>date</code></li>
|
||||||
|
<li><code>tags</code></li>
|
||||||
|
<li><code>title</code></li>
|
||||||
|
<li><code>indent_character</code></li>
|
||||||
|
<li><code>linewrap</code></li>
|
||||||
|
<li><code>timeformat</code></li>
|
||||||
|
</ul>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-sh">2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
| これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
| これは2番目のサンプルエントリーの本文テキストですが、
|
||||||
|
| これには@tagがあります。
|
||||||
|
|
||||||
|
2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
| これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="short">Short</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format short
|
||||||
|
# または
|
||||||
|
jrnl --short
|
||||||
|
</code></pre>
|
||||||
|
<p>これはエントリーを短縮して、日付とタイトルのみを表示します。本質的には<code>pretty</code>フォーマットから各エントリーの本文を除いたものです。長いジャーナルエントリーがあり、検索に一致するエントリーのリストのみを表示したい場合に便利です。</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-sh">2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="fancy-boxed">Fancy (または Boxed)</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format fancy
|
||||||
|
# または
|
||||||
|
jrnl --format boxed
|
||||||
|
</code></pre>
|
||||||
|
<p>このフォーマットは各エントリーを枠線で囲みます。これにより、各エントリーの開始と終了がわかりやすくなります。フォーマットがいかに自由形式であるかを示す例であり、また、そういったものが好きな人にとっては~<em>~ファンシー~</em>~に見えるかもしれません。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>日本語の場合、文字幅の問題でボックスが崩れてしまうようです。</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-sh">┎──────────────────────────────────────────────────────────────────────╮2020-06-28 18:22
|
||||||
|
┃ これは最初のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは最初のサンプルエントリーの本文テキストです。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-01 20:00
|
||||||
|
┃ これは2番目のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
┎──────────────────────────────────────────────────────────────────────╮2020-07-02 09:00
|
||||||
|
┃ これは3番目のサンプルエントリーです ╘═══════════════╕
|
||||||
|
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
|
||||||
|
┃ これは3番目のサンプルエントリーの本文テキストです。 │
|
||||||
|
┖──────────────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_3">データフォーマット</h2>
|
||||||
|
<p>これらのフォーマットは主に、ジャーナルを他のプログラムにパイプしたりエクスポートしたりすることを目的としています。それでも、他のフォーマットと同じように使用できます(必要に応じてファイルに書き込んだり、ターミナルに表示したりできます)。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>これらのフォーマットを使用する際に「2つのエントリーが見つかりました」のようなメッセージボックスが表示されることがありますが、これらのメッセージは<code>stdout</code>ではなく<code>stderr</code>に書き込まれるため、<code>|</code>演算子を使用してパイプする際には含まれません。</p>
|
||||||
|
<h3 id="json">JSON</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format json
|
||||||
|
</code></pre>
|
||||||
|
<p>JSONは多くのプログラムで使用される非常に便利なフォーマットで、ほぼすべてのプログラミング言語でサポートされています。JSONデータでできることは多岐にわたります。例えば、<code>jq</code>(<a href="https://github.com/stedolan/jq">プロジェクトページ</a>)を使用してジャーナルのフィールドをフィルタリングすることができます。
|
||||||
|
以下のように:</p>
|
||||||
|
<pre><code class="language-sh">$ j -3 --format json | jq '.entries[].date' jrnl-GFqVlfgP-py3.8
|
||||||
|
"2020-06-28"
|
||||||
|
"2020-07-01"
|
||||||
|
"2020-07-02"
|
||||||
|
</code></pre>
|
||||||
|
<p>あるいは、ジャーナルの<a href="http://timeline.knightlab.com/">美しいタイムライン</a>を作成するのはどうでしょうか?</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"tags": {
|
||||||
|
"@tag": 1
|
||||||
|
},
|
||||||
|
"entries": [
|
||||||
|
{
|
||||||
|
"title": "これは最初のサンプルエントリーです",
|
||||||
|
"body": "これは最初のサンプルエントリーの本文テキストです。",
|
||||||
|
"date": "2020-06-28",
|
||||||
|
"time": "18:22",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "これは2番目のサンプルエントリーです",
|
||||||
|
"body": "これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。",
|
||||||
|
"date": "2020-07-01",
|
||||||
|
"time": "20:00",
|
||||||
|
"tags": ["@tag"],
|
||||||
|
"starred": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "これは3番目のサンプルエントリーです",
|
||||||
|
"body": "これは3番目のサンプルエントリーの本文テキストです。",
|
||||||
|
"date": "2020-07-02",
|
||||||
|
"time": "09:00",
|
||||||
|
"tags": [],
|
||||||
|
"starred": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="markdown">Markdown</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format markdown
|
||||||
|
# または
|
||||||
|
jrnl --format md
|
||||||
|
</code></pre>
|
||||||
|
<p>Markdownは人間が読みやすく、他のフォーマット(html、pdf)にレンダリングできるシンプルなマークアップ言語です。例えば、<code>jrnl</code>の<a href="https://github.com/jrnl-org/jrnl/blob/develop/README.md">README</a>はmarkdownでフォーマットされており、Githubが一部のフォーマットを追加して見栄えを良くしています。</p>
|
||||||
|
<p>markdownフォーマットはエントリーを日付でグループ化し(まず年、次に月)、必要に応じてヘッダーマーキング(例:<code>#</code>、<code>##</code>など)を追加します。すでにジャーナルにmarkdownのヘッダーマーキングがある場合、これらの新しいヘッダーの下に適合するように必要に応じて増加します(つまり、<code>#</code>は<code>##</code>になります)。</p>
|
||||||
|
<p>このフォーマットは、例えば、ジャーナルをmarkdownからhtmlに変換するプログラムにエクスポートして、ジャーナルからウェブサイトやブログを作成するのに非常に便利です。</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-markdown"># 2020
|
||||||
|
|
||||||
|
## 6月
|
||||||
|
|
||||||
|
### 2020-06-28 18:22 これは最初のサンプルエントリーです
|
||||||
|
|
||||||
|
これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
## 7月
|
||||||
|
|
||||||
|
### 2020-07-01 20:00 これは2番目のサンプルエントリーです
|
||||||
|
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
|
||||||
|
### 2020-07-02 09:00 これは3番目のサンプルエントリーです
|
||||||
|
|
||||||
|
これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="_4">プレーンテキスト</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format text
|
||||||
|
# または
|
||||||
|
jrnl --format txt
|
||||||
|
</code></pre>
|
||||||
|
<p>これは、<code>jrnl</code>がジャーナルをディスクに保存するのに使用するのと同じプレーンテキストフォーマットでジャーナルを出力します。このフォーマットは特に<code>jrnl</code>内でのジャーナルのインポートとエクスポートに便利です。</p>
|
||||||
|
<p>例えば、あるジャーナルから別のジャーナルにエントリーを移動したり、別のジャーナルからの検索結果で新しいジャーナルを作成したりするのに使用できます。</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-sh">[2020-06-28 18:22] これは最初のサンプルエントリーです
|
||||||
|
これは最初のサンプルエントリーの本文テキストです。
|
||||||
|
|
||||||
|
[2020-07-01 20:00] これは2番目のサンプルエントリーです
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
|
||||||
|
[2020-07-02 09:00] これは3番目のサンプルエントリーです
|
||||||
|
これは3番目のサンプルエントリーの本文テキストです。
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="xml">XML</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format xml
|
||||||
|
</code></pre>
|
||||||
|
<p>これはジャーナルをXML形式で出力します。XMLは一般的に使用されるデータ形式で、多くのプログラムやプログラミング言語でサポートされています。</p>
|
||||||
|
<p><strong>出力例</strong>:</p>
|
||||||
|
<pre><code class="language-xml"><?xml version="1.0" ?>
|
||||||
|
<journal>
|
||||||
|
<entries>
|
||||||
|
<entry date="2020-06-28T18:22:00" starred="">これは最初のサンプルエントリーです これは最初のサンプルエントリーの本文テキストです。</entry>
|
||||||
|
<entry date="2020-07-01T20:00:00" starred="">これは2番目のサンプルエントリーです これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。</entry>
|
||||||
|
<entry date="2020-07-02T09:00:00" starred="">これは3番目のサンプルエントリーです これは3番目のサンプルエントリーの本文テキストです。</entry>
|
||||||
|
</entries>
|
||||||
|
<tags>
|
||||||
|
<tag name="@tag">1</tag>
|
||||||
|
</tags>
|
||||||
|
</journal>
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="yaml">YAML</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format yaml --file 'my_directory/'
|
||||||
|
</code></pre>
|
||||||
|
<p>これはジャーナルをYAML形式で出力します。YAMLは一般的に使用されるデータ形式で、多くのプログラムやプログラミング言語でサポートされています。<a href="#ディレクトリへのエクスポート">ディレクトリへのエクスポート</a>は唯一サポートされているYAMLエクスポートオプションであり、各エントリーは別々のファイルに書き込まれます。</p>
|
||||||
|
<p><strong>ファイル例</strong>:</p>
|
||||||
|
<pre><code class="language-yaml">title: これは2番目のサンプルエントリーです
|
||||||
|
date: 2020-07-01 20:00
|
||||||
|
starred: False
|
||||||
|
tags: tag
|
||||||
|
|
||||||
|
これは2番目のサンプルエントリーの本文テキストですが、これには@tagがあります。
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_5">レポートフォーマット</h2>
|
||||||
|
<p>フォーマットはジャーナルデータを使用して異なる方法で表示するため、レポートの作成にも使用できます。</p>
|
||||||
|
<h3 id="_6">タグ</h3>
|
||||||
|
<pre><code class="language-sh">jrnl --format tags
|
||||||
|
# または
|
||||||
|
jrnl --tags
|
||||||
|
</code></pre>
|
||||||
|
<p>このフォーマットは、フォーマットがどのようにレポート作成に使用できるかの簡単な例です。ジャーナル内(または検索結果内)の各タグと、そのタグが出現するエントリーの数を表示し、頻度順にソートします。</p>
|
||||||
|
<p>出力例:</p>
|
||||||
|
<pre><code class="language-sh">@one : 32
|
||||||
|
@two : 17
|
||||||
|
@three : 4
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_7">オプション</h2>
|
||||||
|
<h3 id="-file"><code>--file</code>を使用したエクスポート</h3>
|
||||||
|
<p>例: <code>jrnl --format json --file /some/path/to/a/file.txt</code></p>
|
||||||
|
<p>デフォルトでは、<code>jrnl</code>はエントリーをターミナルに出力します。しかし、<code>--file</code>とファイル名を一緒に指定すると、ターミナルに出力されるはずだった同じ出力がファイルに書き込まれます。これは出力をファイルにパイプするのと同じです。</p>
|
||||||
|
<p>したがって、bashの場合、以下の2つの文は同等です:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --format json --file myjournal.json
|
||||||
|
</code></pre>
|
||||||
|
<pre><code class="language-sh">jrnl --format json > myjournal.json
|
||||||
|
</code></pre>
|
||||||
|
<h4 id="_8">ディレクトリへのエクスポート</h4>
|
||||||
|
<p><code>--file</code>引数がディレクトリの場合、jrnlは各エントリーを個別のファイルにエクスポートします:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --format yaml --file my_entries/
|
||||||
|
</code></pre>
|
||||||
|
<p><code>my_entries/</code>の内容は次のようになります:</p>
|
||||||
|
<pre><code class="language-output">my_entries/
|
||||||
|
|- 2013_06_03_a-beautiful-day.yaml
|
||||||
|
|- 2013_06_07_dinner-with-gabriel.yaml
|
||||||
|
|- ...
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../privacy-and-security/" class="btn btn-neutral float-left" title="プライバシーとセキュリティ"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../advanced/" class="btn btn-neutral float-right" title="高度な使い方">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../privacy-and-security/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../advanced/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
246
site/ja/installation/index.html
Normal file
|
@ -0,0 +1,246 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/installation/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>クイックスタート - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30af\u30a4\u30c3\u30af\u30b9\u30bf\u30fc\u30c8";
|
||||||
|
var mkdocs_page_input_path = "ja/installation.md";
|
||||||
|
var mkdocs_page_url = "/ja/installation/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">クイックスタート</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">インストール</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>クイックスタート</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/installation.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">はじめに</h1>
|
||||||
|
<h2 id="_2">インストール</h2>
|
||||||
|
<p><code>jrnl</code>をインストールする最も簡単な方法は、<a href="https://www.python.org/">Python</a> 3.10以上で<a href="https://pipx.pypa.io/stable/installation/">pipx</a>を使用することです:</p>
|
||||||
|
<pre><code class="language-sh">pipx install jrnl
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition tip">
|
||||||
|
<p class="admonition-title">Tip</p>
|
||||||
|
</div>
|
||||||
|
<p><code>jrnl</code>のインストール時に<code>sudo</code>を使用しないでください。パスの問題が発生する可能性があります。</p>
|
||||||
|
<p><code>jrnl</code>を初めて実行すると、ジャーナルファイルをどこに作成するか、そして暗号化するかどうかを尋ねられます。</p>
|
||||||
|
<h2 id="_3">クイックスタート</h2>
|
||||||
|
<p>新しいエントリーを作成するには、以下のように入力します</p>
|
||||||
|
<pre><code class="language-text">jrnl yesterday: 病欠した。時間を使って掃除をし、本の執筆に4時間費やした。
|
||||||
|
</code></pre>
|
||||||
|
<p>そしてリターンキーを押します。<code>yesterday:</code>はタイムスタンプとして解釈されます。
|
||||||
|
最初の文章の区切り(<code>.?!:</code>)までがタイトルとして、残りが本文として解釈されます。ジャーナルファイルでは、結果は次のようになります:</p>
|
||||||
|
<pre><code class="language-output">2012-03-29 09:00 病欠した。
|
||||||
|
時間を使って家の掃除をし、本の執筆に4時間費やした。
|
||||||
|
</code></pre>
|
||||||
|
<p>単に<code>jrnl</code>と入力すると、エントリーの作成を促されますが、外部エディタを使用するように<em>jrnl</em>を<a href="../advanced/">設定する</a>こともできます。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../overview/" class="btn btn-neutral float-left" title="概要"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../usage/" class="btn btn-neutral float-right" title="基本的な使い方">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../overview/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../usage/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
284
site/ja/journal-types/index.html
Normal file
|
@ -0,0 +1,284 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/journal-types/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>ジャーナルの種類 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30b8\u30e3\u30fc\u30ca\u30eb\u306e\u7a2e\u985e";
|
||||||
|
var mkdocs_page_input_path = "ja/journal-types.md";
|
||||||
|
var mkdocs_page_url = "/ja/journal-types/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">ジャーナルの種類</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">単一ファイル</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">フォルダ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#day-one-classic">Day One Classic</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">ジャーナルタイプの変更</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>ジャーナルの種類</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/journal-types.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">ジャーナルタイプ</h1>
|
||||||
|
<p><code>jrnl</code>はいくつかの異なる方法でジャーナルを保存できます:</p>
|
||||||
|
<ul>
|
||||||
|
<li>単一のテキストファイル(暗号化されているかどうかにかかわらず)</li>
|
||||||
|
<li>日付ごとに整理された暗号化されていないテキストファイルを含むフォルダ構造</li>
|
||||||
|
<li>DayOne Classicフォーマット</li>
|
||||||
|
</ul>
|
||||||
|
<p>使用したいジャーナルタイプを指定する必要はありません。代わりに、
|
||||||
|
<code>jrnl</code>は<a href="../advanced/">設定ファイル</a>でファイルを参照しているかフォルダを参照しているか、
|
||||||
|
そしてそれがフォルダの場合、DayOne Classicのコンテンツがそこに存在するかどうかに基づいて、
|
||||||
|
自動的にジャーナルタイプを検出します。</p>
|
||||||
|
<h2 id="_2">単一ファイル</h2>
|
||||||
|
<p>単一ファイルフォーマットは最も柔軟で、<a href="../encryption/">暗号化</a>することができます。
|
||||||
|
使用するには、ファイルへのパス、または既に存在しないパスを入力します。任意の拡張子を
|
||||||
|
使用できます。最初のエントリーを保存すると、<code>jrnl</code>は自動的にファイルを作成します。</p>
|
||||||
|
<h2 id="_3">フォルダ</h2>
|
||||||
|
<p>フォルダジャーナルフォーマットは、エントリーを年と月のサブフォルダ、そして各日の<code>.txt</code>ファイルに
|
||||||
|
整理します。1日に複数のエントリーがある場合、それらはすべて同じ<code>.txt</code>ファイルに表示されます。</p>
|
||||||
|
<p>ディレクトリツリー構造は以下の形式です:<code>YYYY/MM/DD.txt</code>。例えば、
|
||||||
|
<code>~/folderjournal</code>にあるフォルダジャーナルに2021年5月5日のエントリーがある場合、
|
||||||
|
次の場所に配置されます:<code>~/folderjournal/2021/05/05.txt</code></p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>新しいフォルダジャーナルの作成は2つの方法で行えます:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>jrnl</code>を実行する前に、ジャーナルの名前でフォルダを作成します。そうしないと、<code>jrnl</code>を初めて実行したとき、単一ファイルジャーナルを作成していると見なされ、そのパスにファイルが作成されます。</li>
|
||||||
|
<li><a href="../advanced/">設定ファイル</a>で新しいジャーナルを作成し、パスの最後に<code>/</code>(POSIXシステムのLinuxやMacOSXの場合)または<code>\</code>(Windowsシステムの場合)を付けます。フォルダが存在しない場合は自動的に作成されます。</li>
|
||||||
|
</ul>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>フォルダジャーナルは暗号化できません。</p>
|
||||||
|
<h2 id="day-one-classic">Day One Classic</h2>
|
||||||
|
<p><code>jrnl</code>はDayOneで使用されていた元のデータフォーマットをサポートしています。これはフォルダ
|
||||||
|
ジャーナルフォーマットに似ていますが、以下の特徴のいずれかで識別されます:</p>
|
||||||
|
<ul>
|
||||||
|
<li>フォルダに<code>.dayone</code>拡張子がある</li>
|
||||||
|
<li>フォルダに<code>entries</code>という名前のサブフォルダがある</li>
|
||||||
|
</ul>
|
||||||
|
<p>これはDayOne 2.0フォーマットとは混同しないでください。<a href="https://help.dayoneapp.com/en/articles/1187337-day-one-classic-is-retired">それは非常に異なります</a>。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>DayOne Classicジャーナルは暗号化できません。</p>
|
||||||
|
<h2 id="_4">ジャーナルタイプの変更</h2>
|
||||||
|
<p>ジャーナルの設定を単に変更してタイプを変更することはできません。代わりに、
|
||||||
|
希望するタイプの新しいジャーナルを定義し、
|
||||||
|
<a href="https://en.wikipedia.org/wiki/Redirection_(computing)#Piping">パイピング</a>
|
||||||
|
を使用して古いジャーナルを<code>txt</code>としてエクスポートし、新しいジャーナルにインポートコマンドを実行します。</p>
|
||||||
|
<p>例えば、<code>projects</code>ジャーナルを<code>new</code>ジャーナルにインポートしたい場合、
|
||||||
|
<code>new</code>ジャーナルの設定を行った後、次のように実行します:</p>
|
||||||
|
<pre><code>jrnl projects --format txt | jrnl new --import
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../encryption/" class="btn btn-neutral float-left" title="暗号化"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../privacy-and-security/" class="btn btn-neutral float-right" title="プライバシーとセキュリティ">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../encryption/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../privacy-and-security/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
257
site/ja/overview/index.html
Normal file
|
@ -0,0 +1,257 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/overview/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>概要 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u6982\u8981";
|
||||||
|
var mkdocs_page_input_path = "ja/overview.md";
|
||||||
|
var mkdocs_page_url = "/ja/overview/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">概要</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_2">プレーンテキスト</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_3">タグ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_4">複数の日記のサポート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_5">外部エディタのサポート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_6">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_7">インポートとエクスポート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_8">マルチプラットフォームサポート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#_9">オープンソース</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>概要</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/overview.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">概要</h1>
|
||||||
|
<p><code>jrnl</code>はコマンドライン用のシンプルな日記アプリケーションです。</p>
|
||||||
|
<p>簡単に日記エントリーの作成、検索、閲覧ができます。日記は人間が読める形式のプレーンテキストで保存され、<a href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES暗号化</a>を使用して暗号化することもできます。</p>
|
||||||
|
<p><code>jrnl</code>には必要な機能のほとんどが備わっており、不要な機能はほとんどありません。</p>
|
||||||
|
<h2 id="_2">プレーンテキスト</h2>
|
||||||
|
<p><code>jrnl</code>は各日記をプレーンテキストで保存します。<code>jrnl</code>ファイルは任意の場所に保存でき、共有フォルダに保存してデバイス間で同期することもできます。日記ファイルはコンパクトで(数千のエントリーでも1MiB未満)、現在そして近い将来にわたってほぼすべての電子デバイスで読むことができます。</p>
|
||||||
|
<h2 id="_3">タグ</h2>
|
||||||
|
<p>後でエントリーを見つけやすくするために、<code>jrnl</code>はインラインタグをサポートしています(デフォルトのタグ記号は<code>@</code>です)。タグを他の検索条件と組み合わせて、エントリーを検索およびフィルタリングできます。</p>
|
||||||
|
<h2 id="_4">複数の日記のサポート</h2>
|
||||||
|
<p><code>jrnl</code>は複数の日記の作成をサポートしており、各日記は単一のファイルまたは一連のファイルとして保存できます。エントリーは人間が読める形式で自動的にタイムスタンプが付けられ、複数のエントリーを一度に簡単に閲覧できます。<code>jrnl</code>は必要なエントリーを簡単に見つけ出し、読んだり編集したりすることができます。</p>
|
||||||
|
<h2 id="_5">外部エディタのサポート</h2>
|
||||||
|
<p><code>jrnl</code>はお気に入りのテキストエディタと上手く連携します。エディタで日記エントリーを書くことを好む場合や、より包括的なアプリケーションを必要とする変更を加えたい場合があるかもしれません。<code>jrnl</code>は特定のエントリーをフィルタリングし、選択した<a href="../external-editors/">外部エディタ</a>に渡すことができます。</p>
|
||||||
|
<h2 id="_6">暗号化</h2>
|
||||||
|
<p><code>jrnl</code>は<a href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES暗号化</a>をサポートしています。詳細については<a href="../encryption/">暗号化ページ</a>をご覧ください。</p>
|
||||||
|
<h2 id="_7">インポートとエクスポート</h2>
|
||||||
|
<p><code>jrnl</code>は他のソースからエントリーを簡単にインポートできます。既存のエントリーは様々な<a href="../formats/">フォーマット</a>でエクスポートできます。</p>
|
||||||
|
<h2 id="_8">マルチプラットフォームサポート</h2>
|
||||||
|
<p><code>jrnl</code>はほとんどのオペレーティングシステムと互換性があります。様々なパッケージマネージャーを使用して<a href="../installation/">ダウンロード</a>するか、ソースからビルドすることができます。</p>
|
||||||
|
<h2 id="_9">オープンソース</h2>
|
||||||
|
<p><code>jrnl</code>は<a href="https://www.python.org">Python</a>で書かれており、オープンソースソフトウェア愛好家の<a href="https://github.com/jrnl-org/jrnl">フレンドリーなコミュニティ</a>によって維持されています。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../../contributing/" class="btn btn-neutral float-left" title="Contributing to jrnl"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../installation/" class="btn btn-neutral float-right" title="クイックスタート">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../../contributing/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../installation/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
417
site/ja/privacy-and-security/index.html
Normal file
|
@ -0,0 +1,417 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/privacy-and-security/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>プライバシーとセキュリティ - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30d7\u30e9\u30a4\u30d0\u30b7\u30fc\u3068\u30bb\u30ad\u30e5\u30ea\u30c6\u30a3";
|
||||||
|
var mkdocs_page_input_path = "ja/privacy-and-security.md";
|
||||||
|
var mkdocs_page_url = "/ja/privacy-and-security/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">プライバシーとセキュリティ</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">パスワードの強度</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">合理的否認</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">スパイ行為</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_5">保存されたパスワード</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_6">シェル履歴</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#bash">bash</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#zsh">zsh</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#fish">fish</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#windows">Windowsコマンドプロンプト</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#jrnl">エディターからjrnlへの転送中のファイル</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_7">エディター履歴</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#visual-studio-code">Visual Studio Code</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#vim">Vim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#neovim">Neovim</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_8">他のリスクに気づいた場合</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>プライバシーとセキュリティ</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/privacy-and-security.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">プライバシーとセキュリティ</h1>
|
||||||
|
<p><code>jrnl</code>はプライバシーとセキュリティを念頭に置いて設計されていますが、他のプログラムと同様に、
|
||||||
|
注意すべきいくつかの制限があります。</p>
|
||||||
|
<h2 id="_2">パスワードの強度</h2>
|
||||||
|
<p><code>jrnl</code>はパスワードの強度要件を強制しません。短いまたは一般的に使用されるパスワードは、
|
||||||
|
基本的なセキュリティスキルを持つ人が暗号化された<code>jrnl</code>ファイルにアクセスするのを
|
||||||
|
簡単に回避できてしまいます。</p>
|
||||||
|
<h2 id="_3">合理的否認</h2>
|
||||||
|
<p>ジャーナルの内容を暗号化の層の背後に隠すことはできますが、誰かがあなたの設定ファイルに
|
||||||
|
アクセスできる場合、ジャーナルの存在、そのジャーナルファイルの場所、最後に編集した
|
||||||
|
時期を知ることができます。十分な力の不均衡がある場合、誰かが非技術的な手段を通じて
|
||||||
|
あなたに暗号化を解除させることができるかもしれません。</p>
|
||||||
|
<h2 id="_4">スパイ行為</h2>
|
||||||
|
<p><code>jrnl</code>は開かれていない間のジャーナルエントリーへの不正アクセスから保護できますが、
|
||||||
|
安全でないコンピューター/場所からは保護できません。例えば:</p>
|
||||||
|
<ul>
|
||||||
|
<li>誰かがキーロガーをインストールし、ジャーナルに入力する内容を追跡する。</li>
|
||||||
|
<li>誰かがエントリーを書いている間にあなたの画面を見ている。</li>
|
||||||
|
<li>誰かが<code>jrnl</code>にバックドアをインストールしたり、ジャーナルを毒して
|
||||||
|
エントリーを明らかにするよう仕向けたりする。</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="_5">保存されたパスワード</h2>
|
||||||
|
<p>暗号化されたジャーナルを作成する際、「パスワードをキーチェーンに保存するか」と
|
||||||
|
尋ねられます。このキーチェーンは<a href="https://pypi.org/project/keyring/">Python keyringライブラリ</a>を
|
||||||
|
使用してアクセスされ、オペレーティングシステムによって動作が異なります。</p>
|
||||||
|
<p>Windowsでは、キーチェーンはWindows Credential Manager(WCM)で、ロックできず、
|
||||||
|
あなたのユーザー名で実行されている他のアプリケーションからアクセスできます。
|
||||||
|
これが心配な場合は、パスワードを保存しないほうがよいかもしれません。</p>
|
||||||
|
<h2 id="_6">シェル履歴</h2>
|
||||||
|
<p>コマンドラインからエントリーを入力できるため、コマンドライン操作をログに記録する
|
||||||
|
ツールは潜在的なセキュリティリスクとなります。以下に、様々なシェルでこの問題に
|
||||||
|
対処する方法を示します。</p>
|
||||||
|
<h3 id="bash">bash</h3>
|
||||||
|
<p><code>~/.bashrc</code>ファイルに以下の行を追加することで、jrnlの履歴ログを無効にできます:</p>
|
||||||
|
<pre><code class="language-sh">HISTIGNORE="$HISTIGNORE:jrnl *"
|
||||||
|
</code></pre>
|
||||||
|
<p><code>bash</code>履歴から既存の<code>jrnl</code>コマンドを削除するには、bashの履歴ファイルから
|
||||||
|
単純に削除します。このファイルのデフォルトの場所は<code>~/.bash_history</code>ですが、
|
||||||
|
必要に応じて<code>echo "$HISTFILE"</code>を実行して見つけることができます。また、
|
||||||
|
<code>history -c</code>を実行して履歴からすべてのコマンドを削除することもできます。</p>
|
||||||
|
<h3 id="zsh">zsh</h3>
|
||||||
|
<p><code>~/.zshrc</code>ファイルに以下を追加することで、jrnlの履歴ログを無効にできます:</p>
|
||||||
|
<pre><code class="language-sh">setopt HIST_IGNORE_SPACE
|
||||||
|
alias jrnl=" jrnl"
|
||||||
|
</code></pre>
|
||||||
|
<p><code>zsh</code>履歴から既存の<code>jrnl</code>コマンドを削除するには、zshの履歴ファイルから
|
||||||
|
単純に削除します。このファイルのデフォルトの場所は<code>~/.zsh_history</code>ですが、
|
||||||
|
必要に応じて<code>echo "$HISTFILE"</code>を実行して見つけることができます。また、
|
||||||
|
<code>history -c</code>を実行して履歴からすべてのコマンドを削除することもできます。</p>
|
||||||
|
<h3 id="fish">fish</h3>
|
||||||
|
<p>デフォルトでは、<code>fish</code>はスペースで始まるコマンドをログに記録しません。
|
||||||
|
常にjrnlの前にスペースを付けて実行したい場合は、<code>~/.config/fish/config.fish</code>
|
||||||
|
ファイルに以下を追加できます:</p>
|
||||||
|
<pre><code class="language-sh">abbr --add jrnl " jrnl"
|
||||||
|
</code></pre>
|
||||||
|
<p><code>fish</code>履歴から既存のjrnlコマンドを削除するには、<code>history delete --prefix 'jrnl '</code>を実行します。</p>
|
||||||
|
<h3 id="windows">Windowsコマンドプロンプト</h3>
|
||||||
|
<p>Windowsは履歴をディスクにログ記録しませんが、コマンドプロンプトセッションには
|
||||||
|
保持されます。ジャーナリング後、コマンドプロンプトを閉じるか<code>Alt</code>+<code>F7</code>を
|
||||||
|
押して履歴をクリアしてください。</p>
|
||||||
|
<h2 id="jrnl">エディターからjrnlへの転送中のファイル</h2>
|
||||||
|
<p>エントリーの作成や編集時、<code>jrnl</code>はエディターがジャーナルにアクセスできるよう
|
||||||
|
ディスク上に暗号化されていない一時ファイルを使用します。エディターを閉じた後、
|
||||||
|
<code>jrnl</code>はこの一時ファイルを削除します。</p>
|
||||||
|
<p>つまり、ジャーナルエントリーを保存したがまだエディターを閉じていない場合、
|
||||||
|
暗号化されていない一時ファイルがディスク上に残ります。この間にコンピューターが
|
||||||
|
シャットダウンしたり、<code>jrnl</code>プロセスが予期せず終了したりすると、暗号化されて
|
||||||
|
いない一時ファイルがディスク上に残ります。この問題を軽減するには、エディターを
|
||||||
|
閉じる直前にのみ保存するようにしてください。また、一時フォルダからこれらの
|
||||||
|
ファイルを手動で削除することもできます。デフォルトでは、これらは<code>jrnl*.jrnl</code>
|
||||||
|
という名前ですが、<a href="../reference-config-file/#template">テンプレート</a>を使用して
|
||||||
|
いる場合は、テンプレートと同じ拡張子になります。</p>
|
||||||
|
<h2 id="_7">エディター履歴</h2>
|
||||||
|
<p>一部のエディターは、将来の使用のためにディスク上に使用履歴を保存します。
|
||||||
|
これは、最近の検索パターンやエディターコマンドを通じて機密情報が漏洩する
|
||||||
|
可能性があるという意味でセキュリティリスクとなる可能性があります。</p>
|
||||||
|
<h3 id="visual-studio-code">Visual Studio Code</h3>
|
||||||
|
<p>Visual Studio Codeは、後でコンテンツを復元またはレビューできるように、
|
||||||
|
保存されたファイルの内容を保存します。すべてのファイルに対してこの機能を
|
||||||
|
無効にするには、<a href="https://code.visualstudio.com/docs/getstarted/settings#_settings-editor">設定エディター</a>で
|
||||||
|
<code>workbench.localHistory.enabled</code>設定のチェックを外します。</p>
|
||||||
|
<p>または、<code>workbench.localHistory.exclude</code>設定で<a href="https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options">パターン</a>を
|
||||||
|
設定することで、特定のファイルに対してこの機能を無効にできます。<code>jrnl</code>によって
|
||||||
|
生成される暗号化されていない一時ファイルを除外するには、<a href="https://code.visualstudio.com/docs/getstarted/settings#_settings-editor">設定エディター</a>で
|
||||||
|
<code>workbench.localHistory.exclude</code>設定に<code>**/jrnl*.jrnl</code>パターンを設定できます
|
||||||
|
(<a href="../reference-config-file/#template">テンプレート</a>を使用していない場合)。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>Windowsでは、履歴の場所は通常<code>%APPDATA%\Code\User\History</code>にあります。</p>
|
||||||
|
<p>Visual Studio Codeは、開いているすべての未保存ファイルのコピーも作成します。
|
||||||
|
これらのコピーはバックアップ場所に保存され、ファイルを保存すると自動的に
|
||||||
|
クリーンアップされます。ただし、ファイルを保存する前にコンピューターが
|
||||||
|
シャットダウンしたり、Visual Studio Codeプロセスが予期せず停止したりすると、
|
||||||
|
暗号化されていない一時ファイルがディスク上に残る可能性があります。これらの
|
||||||
|
ファイルはバックアップ場所から手動で削除できます。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>Windowsでは、バックアップ場所は通常<code>%APPDATA%\Code\Backups</code>にあります。</p>
|
||||||
|
<h3 id="vim">Vim</h3>
|
||||||
|
<p>Vimは<code>~/.viminfo</code>にある所謂Viminfoファイルに進捗データを保存します。
|
||||||
|
これにはコマンドライン履歴、検索文字列履歴、検索/置換パターン、レジスタの
|
||||||
|
内容など、あらゆる種類のユーザーデータが含まれています。また、予期せぬ
|
||||||
|
アプリケーションの終了後に開いていたファイルを復元できるよう、Vimはスワップ
|
||||||
|
ファイルを使用します。</p>
|
||||||
|
<p>これらのオプションや他の情報漏洩の可能性のある機能は、Jrnl設定の<code>editor</code>キーを
|
||||||
|
以下のように設定することで無効にできます:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "vim -c 'set viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
</code></pre>
|
||||||
|
<p>すべてのプラグインとカスタム設定を無効にし、デフォルト設定でVimを起動するには、
|
||||||
|
コマンドラインで<code>-u NONE</code>を渡すこともできます。これにより、悪意のあるプラグインや
|
||||||
|
その他の検出が困難な情報漏洩が確実に排除されます。ただし、これによりエディター
|
||||||
|
の使用感が大幅に低下します。</p>
|
||||||
|
<p>代わりに、Jrnlファイルが編集されているときに自動的に検出するようVimに設定するには、
|
||||||
|
autocommandを使用できます。これを<code>~/.vimrc</code>に配置します:</p>
|
||||||
|
<pre><code class="language-vim">autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p><a href="../reference-config-file/#template">テンプレート</a>を使用している場合は、
|
||||||
|
<code>.jrnl</code>の代わりにテンプレートのファイル拡張子を使用する必要があります。</p>
|
||||||
|
<p>言及したオプションの詳細については、Vimで<code>:h <option></code>を参照してください。</p>
|
||||||
|
<h3 id="neovim">Neovim</h3>
|
||||||
|
<p>Neovimは主にVimと互換性があるよう努めており、そのためVimと同様の機能を
|
||||||
|
持っています。Neovimの1つの違いは、Viminfoファイルの代わりにShaDa
|
||||||
|
("shared data")ファイルと呼ばれるものが<code>~/.local/state/nvim</code>
|
||||||
|
(Neovim v0.8.0以前は<code>~/.local/share/nvim</code>)にあることです。ShaDaファイルは
|
||||||
|
Vimと同じ方法で無効にできます。</p>
|
||||||
|
<pre><code class="language-yaml">editor: "nvim -c 'set shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
</code></pre>
|
||||||
|
<p>ここでも<code>-u NONE</code>を渡して、デフォルト設定でセッションを開始できます。</p>
|
||||||
|
<p>上記のVimと同様に、Vimscriptでautocommandを作成できます:</p>
|
||||||
|
<pre><code class="language-vim">autocmd BufNewFile,BufReadPre *.jrnl setlocal shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
</code></pre>
|
||||||
|
<p>または、同じことをLuaで:</p>
|
||||||
|
<pre><code class="language-lua">vim.api.nvim_create_autocmd( {"BufNewFile","BufReadPre" }, {
|
||||||
|
group = vim.api.nvim_create_augroup("PrivateJrnl", {}),
|
||||||
|
pattern = "*.jrnl",
|
||||||
|
callback = function()
|
||||||
|
vim.o.shada = ""
|
||||||
|
vim.o.swapfile = false
|
||||||
|
vim.o.undofile = false
|
||||||
|
vim.o.backup = false
|
||||||
|
vim.o.writebackup = false
|
||||||
|
vim.o.shelltemp = false
|
||||||
|
vim.o.history = 0
|
||||||
|
vim.o.modeline = false
|
||||||
|
vim.o.secure = true
|
||||||
|
end,
|
||||||
|
})
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p><a href="../reference-config-file/#template">テンプレート</a>を使用している場合は、
|
||||||
|
<code>.jrnl</code>の代わりにテンプレートのファイル拡張子を使用する必要があります。</p>
|
||||||
|
<p>言及したオプションの詳細については、Neovimで<code>:h <option></code>を参照してください。</p>
|
||||||
|
<h2 id="_8">他のリスクに気づいた場合</h2>
|
||||||
|
<p><a href="https://github.com/jrnl-org/jrnl/issues">GitHubで問題を提出</a>して、メンテナーに知らせてください。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../journal-types/" class="btn btn-neutral float-left" title="ジャーナルの種類"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../formats/" class="btn btn-neutral float-right" title="フォーマット">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../journal-types/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../formats/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
426
site/ja/reference-command-line/index.html
Normal file
|
@ -0,0 +1,426 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/reference-command-line/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>コマンドライン - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3";
|
||||||
|
var mkdocs_page_input_path = "ja/reference-command-line.md";
|
||||||
|
var mkdocs_page_url = "/ja/reference-command-line/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >リファレンス</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">コマンドライン</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">スタンドアロンコマンド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-help">--help</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-version">--version</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-list">--list</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-encrypt">--encrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-decrypt">--decrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-import">--import</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">新しいエントリーの書き込み</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_5">検索</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_6">検索オプション</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-edit">--edit</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-delete">--delete</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-change-time-date">--change-time DATE</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-format-type">--format TYPE</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-tags">--tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-short">--short</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_8">設定引数</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-config-override-config_key-config_value">--config-override CONFIG_KEY CONFIG_VALUE</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-config-file-config_file_path">--config-file CONFIG_FILE_PATH</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_9">その他の引数</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-debug">--debug</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#-diagnostic">--diagnostic</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>リファレンス »</li>
|
||||||
|
<li>コマンドライン</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/reference-command-line.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">コマンドライン参照</h1>
|
||||||
|
<h2 id="_2">概要</h2>
|
||||||
|
<pre><code>使用法: jrnl [--debug] [--help] [--version] [--list] [--encrypt] [--decrypt]
|
||||||
|
[--import] [-on DATE] [-today-in-history] [-month DATE]
|
||||||
|
[-day DATE] [-year DATE] [-from DATE] [-to DATE] [-contains TEXT]
|
||||||
|
[-and] [-starred] [-n [NUMBER]] [-not [TAG]] [--edit] [--delete]
|
||||||
|
[--format TYPE] [--tags] [--short]
|
||||||
|
[--config-override CONFIG_KEY CONFIG_VALUE]
|
||||||
|
[--config-file CONFIG_FILE_PATH]
|
||||||
|
[[...]]
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_3">スタンドアロンコマンド</h2>
|
||||||
|
<p>これらのコマンドは完了後に終了します。一度に1つだけ実行できます。</p>
|
||||||
|
<h3 id="-help">--help</h3>
|
||||||
|
<p>ヘルプメッセージを表示します。</p>
|
||||||
|
<h3 id="-version">--version</h3>
|
||||||
|
<p>バージョンとライセンス情報を表示します。</p>
|
||||||
|
<h3 id="-list">--list</h3>
|
||||||
|
<p>設定ファイルの場所、設定されているすべてのジャーナル、およびそれらの場所を一覧表示します。</p>
|
||||||
|
<h3 id="-encrypt">--encrypt</h3>
|
||||||
|
<p>ジャーナルを暗号化します。詳細は<a href="../encryption/">暗号化</a>を参照してください。</p>
|
||||||
|
<h3 id="-decrypt">--decrypt</h3>
|
||||||
|
<p>ジャーナルを復号化します。詳細は<a href="../encryption/">暗号化</a>を参照してください。</p>
|
||||||
|
<h3 id="-import">--import</h3>
|
||||||
|
<p>他のジャーナルからエントリーをインポートします。同じ内容とタイムスタンプを持つエントリーがある場合、重複は排除されます。</p>
|
||||||
|
<p>オプションパラメータ:</p>
|
||||||
|
<pre><code class="language-sh">--file FILENAME
|
||||||
|
</code></pre>
|
||||||
|
<p>インポートするファイルを指定します。指定されない場合、<code>jrnl</code>はSTDINをデータソースとして使用します。</p>
|
||||||
|
<pre><code class="language-sh">--format TYPE
|
||||||
|
</code></pre>
|
||||||
|
<p>インポートされるファイルのフォーマットを指定します。デフォルトはjrnlが使用するのと同じデータ保存方法です。詳細は<a href="../formats/">フォーマット</a>を参照してください。</p>
|
||||||
|
<h2 id="_4">新しいエントリーの書き込み</h2>
|
||||||
|
<p><a href="../usage/">基本的な使用方法</a>を参照してください。</p>
|
||||||
|
<h2 id="_5">検索</h2>
|
||||||
|
<p>ジャーナルからエントリーを見つけるには、以下のフィルターの任意の組み合わせを使用します。
|
||||||
|
すべてのフィルターに一致するエントリーのみが表示されます。</p>
|
||||||
|
<p>日付を指定する際は、新しいエントリーで使用するのと同じ種類の日付を使用できます。
|
||||||
|
例えば、<code>yesterday</code>、<code>today</code>、<code>Tuesday</code>、または<code>2021-08-01</code>などです。</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>検索引数</th>
|
||||||
|
<th>説明</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>-on DATE</td>
|
||||||
|
<td>この日付のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-today-in-history</td>
|
||||||
|
<td>年をまたいで今日の日付のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-month DATE</td>
|
||||||
|
<td>任意の年のこの月のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-day DATE</td>
|
||||||
|
<td>任意の月のこの日のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-year DATE</td>
|
||||||
|
<td>特定の年のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-from DATE</td>
|
||||||
|
<td>この日付以降(この日を含む)のエントリーを表示</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-to DATE</td>
|
||||||
|
<td>この日付以前(この日を含む)のエントリーを表示(別名: -until)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-contains TEXT</td>
|
||||||
|
<td>特定のテキストを含むエントリーを表示(スペースを含むテキストは引用符で囲む)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-and</td>
|
||||||
|
<td>すべての条件に一致するエントリーのみを表示、"x AND y"と言うのと同じ(デフォルト: OR)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-starred</td>
|
||||||
|
<td>スター付きのエントリーのみを表示(*でマークされたもの)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-tagged</td>
|
||||||
|
<td>タグ付きのエントリーのみを表示(<a href="../reference-config-file/#tagsymbols">設定されたtagsymbols</a>でマークされたもの)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-n [NUMBER]</td>
|
||||||
|
<td>最大NUMBER個のエントリーを表示(注: '-n 3'と'-3'は同じ効果)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not [TAG]</td>
|
||||||
|
<td>このタグを持つエントリーを除外</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not -starred</td>
|
||||||
|
<td>スター付きのエントリーを除外</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not -tagged</td>
|
||||||
|
<td>タグ付きのエントリーを除外</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h2 id="_6">検索オプション</h2>
|
||||||
|
<p>これらは検索で選択されたエントリーでさまざまなタスクを実行するのに役立ちます。
|
||||||
|
単独で使用した場合(検索なし)、ジャーナル全体に対して動作します。</p>
|
||||||
|
<h3 id="-edit">--edit</h3>
|
||||||
|
<p>選択されたエントリーを設定されたエディタで開きます。設定ファイルに<code>editor</code>キーが
|
||||||
|
設定されていない場合は失敗します。</p>
|
||||||
|
<p>編集を開始すると、エディタでテキストを修正することで複数のエントリーを追加したり
|
||||||
|
削除したりできます。エディタを閉じると、jrnlは編集していた一時ファイルを読み取り、
|
||||||
|
ジャーナルに変更を加えます。</p>
|
||||||
|
<h3 id="-delete">--delete</h3>
|
||||||
|
<p>選択されたエントリーを対話的に削除します。各エントリーの削除を確認するよう求められます。</p>
|
||||||
|
<h3 id="-change-time-date">--change-time DATE</h3>
|
||||||
|
<p>選択されたエントリーの時間を指定された日付に、または日付が指定されていない場合は
|
||||||
|
現在の時刻に対話的に変更します。各エントリーの確認を求められますが、単一のエントリーに
|
||||||
|
対して<code>--edit</code>と一緒に使用している場合は除きます。</p>
|
||||||
|
<h3 id="-format-type">--format TYPE</h3>
|
||||||
|
<p>選択されたエントリーを別のフォーマットで表示します。<a href="../formats/">フォーマット</a>を参照してください。</p>
|
||||||
|
<h4 id="_7">オプションパラメータ</h4>
|
||||||
|
<pre><code class="language-sh">--file FILENAME
|
||||||
|
</code></pre>
|
||||||
|
<p>出力をSTDOUTの代わりにファイルに書き込みます。ほとんどのシェルでは、
|
||||||
|
<code>></code>を使用して同じ効果を得ることができます。</p>
|
||||||
|
<h3 id="-tags">--tags</h3>
|
||||||
|
<p>'--format tags'のエイリアスです。検索されたエントリー内のすべてのタグとその出現回数の
|
||||||
|
リストを返します。タグが見つからない場合、<code>jrnl</code>はその旨のメッセージを出力します。</p>
|
||||||
|
<h3 id="-short">--short</h3>
|
||||||
|
<p>検索されたエントリーの日付とタイトルのみを表示します。</p>
|
||||||
|
<h2 id="_8">設定引数</h2>
|
||||||
|
<h3 id="-config-override-config_key-config_value">--config-override CONFIG_KEY CONFIG_VALUE</h3>
|
||||||
|
<p>このコマンド呼び出しのみ、設定されたキーと値のペアをCONFIG_KV_PAIRで上書きします。
|
||||||
|
トップレベルにないconfig keyにアクセスするには、キーをドットで区切ります。
|
||||||
|
例えば、<code>colors</code>キー内の<code>title</code>キーにアクセスするには<code>colors.title</code>を使用します。
|
||||||
|
例については<a href="../advanced/">高度な使用方法</a>を参照してください。</p>
|
||||||
|
<h3 id="-config-file-config_file_path">--config-file CONFIG_FILE_PATH</h3>
|
||||||
|
<p>このコマンド呼び出しのみ、CONFIG_FILE_PATHにある設定ファイルを使用します。
|
||||||
|
例については<a href="../advanced/">高度な使用方法</a>を参照してください。</p>
|
||||||
|
<h2 id="_9">その他の引数</h2>
|
||||||
|
<h3 id="-debug">--debug</h3>
|
||||||
|
<p><code>jrnl</code>の実行中にトラブルシューティングに役立つ情報を出力します。</p>
|
||||||
|
<h3 id="-diagnostic">--diagnostic</h3>
|
||||||
|
<p><a href="https://github.com/jrnl-org/jrnl/issues">問題を報告する</a>際に役立つ診断情報を出力します。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../tips-and-tricks/" class="btn btn-neutral float-left" title="ヒントとコツ"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../reference-config-file/" class="btn btn-neutral float-right" title="設定ファイル">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../tips-and-tricks/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-config-file/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
342
site/ja/reference-config-file/index.html
Normal file
|
@ -0,0 +1,342 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/reference-config-file/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>設定ファイル - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u8a2d\u5b9a\u30d5\u30a1\u30a4\u30eb";
|
||||||
|
var mkdocs_page_input_path = "ja/reference-config-file.md";
|
||||||
|
var mkdocs_page_url = "/ja/reference-config-file/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >リファレンス</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">設定ファイル</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">設定ファイルの場所</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">設定フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">設定キー</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#journals">journals</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#editor">editor</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#encrypt">encrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#template">template</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#tagsymbols">tagsymbols</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#default_hour-default_minute">default_hour と default_minute</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#timeformat">timeformat</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#highlight">highlight</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#linewrap">linewrap</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#colors">colors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#display_format">display_format</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#version">version</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>リファレンス »</li>
|
||||||
|
<li>設定ファイル</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/reference-config-file.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">設定ファイル参照</h1>
|
||||||
|
<p><code>jrnl</code>はYAML形式の設定ファイルに情報を保存します。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>編集前にジャーナルと設定ファイルをバックアップしてください。設定ファイルの
|
||||||
|
変更はジャーナルに破壊的な影響を与える可能性があります!</p>
|
||||||
|
<h2 id="_2">設定ファイルの場所</h2>
|
||||||
|
<p>以下のコマンドを実行すると、設定ファイルの場所を確認できます:
|
||||||
|
<code>jrnl --list</code></p>
|
||||||
|
<p>デフォルトでは、設定ファイルは<code>~/.config/jrnl/jrnl.yaml</code>にあります。
|
||||||
|
<code>XDG_CONFIG_HOME</code>変数が設定されている場合、設定ファイルは
|
||||||
|
<code>$XDG_CONFIG_HOME/jrnl/jrnl.yaml</code>として保存されます。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>Windowsでは、設定ファイルは通常
|
||||||
|
<code>%USERPROFILE%\.config\jrnl\jrnl.yaml</code>にあります。</p>
|
||||||
|
<h2 id="_3">設定フォーマット</h2>
|
||||||
|
<p>設定ファイルは<a href="https://yaml.org/">YAML</a>形式で、テキストエディタで編集できます。</p>
|
||||||
|
<h2 id="_4">設定キー</h2>
|
||||||
|
<h3 id="journals">journals</h3>
|
||||||
|
<p><code>jrnl</code>が使用する各ジャーナルを記述します。このキーの後の各インデントされたキーは
|
||||||
|
ジャーナルの名前です。</p>
|
||||||
|
<p>ジャーナルキーに値がある場合、その値はジャーナルへのパスとして解釈されます。
|
||||||
|
そうでない場合、ジャーナルはパスを指定するための追加のインデントされた
|
||||||
|
<code>journal</code>キーが必要です。</p>
|
||||||
|
<p>以下のすべてのキーは、<code>journal</code>キーと同じレベルで各ジャーナルに対して指定できます。
|
||||||
|
キーがトップレベルのキーと競合する場合、ジャーナル固有のキーが代わりに使用されます。</p>
|
||||||
|
<h3 id="editor">editor</h3>
|
||||||
|
<p>設定されている場合、このコマンドを実行して外部エディタを起動し、
|
||||||
|
エントリーの作成と編集を行います。一時ファイルへのパスがその後に
|
||||||
|
渡され、エディタが制御を<code>jrnl</code>に戻すと、<code>jrnl</code>がファイルを処理します。</p>
|
||||||
|
<p>一部のエディタは<code>jrnl</code>で動作するためにブロッキングプロセスである必要があるため、
|
||||||
|
特別なオプションが必要です。詳細は<a href="../external-editors/">外部エディタ</a>を参照してください。</p>
|
||||||
|
<h3 id="encrypt">encrypt</h3>
|
||||||
|
<p><code>true</code>の場合、AESを使用してジャーナルを暗号化します。既にデータがある
|
||||||
|
ジャーナルでは、この値を変更しないでください。</p>
|
||||||
|
<h3 id="template">template</h3>
|
||||||
|
<p>新しいエントリーのテンプレートとして使用するテキストファイルへのパス。<code>editor</code>フィールドが
|
||||||
|
設定されている場合のみ機能します。テンプレートを使用する場合、エディタの
|
||||||
|
<a href="../privacy-and-security/#files-in-transit-from-editor-to-jrnl">一時ファイル</a>は
|
||||||
|
テンプレートと同じ拡張子を持ちます。</p>
|
||||||
|
<h3 id="tagsymbols">tagsymbols</h3>
|
||||||
|
<p>タグとして解釈されるシンボル。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>タグに<code>#</code>文字を使用するのが直感的に思えますが、欠点があります:ほとんどの
|
||||||
|
シェルでは、これはコメントを開始するメタ文字として解釈されます。つまり、
|
||||||
|
以下のように入力すると:</p>
|
||||||
|
<pre><code>> `jrnl Implemented endless scrolling on the #frontend of our website.`
|
||||||
|
|
||||||
|
bashは`#`以降をすべて切り捨てて`jrnl`に渡します。これを避けるには、
|
||||||
|
入力を次のように引用符で囲みます:
|
||||||
|
|
||||||
|
> `jrnl "Implemented endless scrolling on the #frontend of our website."`
|
||||||
|
|
||||||
|
または、組み込みのプロンプトや外部エディタを使用してエントリーを
|
||||||
|
作成してください。
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="default_hour-default_minute">default_hour と default_minute</h3>
|
||||||
|
<p>日付を指定しても具体的な時間を指定しない場合(例:<code>last thursday</code>)、エントリーはこの時間に作成されます。</p>
|
||||||
|
<h3 id="timeformat">timeformat</h3>
|
||||||
|
<p>ジャーナルに保存されるタイムスタンプの形式を定義します。
|
||||||
|
参照は<a href="http://docs.python.org/library/time.html#time.strftime">pythonドキュメント</a>を確認してください。</p>
|
||||||
|
<p>既存のジャーナルでは変更しないでください。データ損失につながる可能性があります。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p><code>jrnl</code>は<code>%z</code>または<code>%Z</code>タイムゾーン識別子をサポートしていません。</p>
|
||||||
|
<h3 id="highlight">highlight</h3>
|
||||||
|
<p><code>true</code>の場合、タグはシアン色で強調表示されます。</p>
|
||||||
|
<h3 id="linewrap">linewrap</h3>
|
||||||
|
<p>出力の幅を制御します。長い行を折り返したくない場合は<code>false</code>に設定します。
|
||||||
|
<code>jrnl</code>に自動的に端末幅を決定させる場合は<code>auto</code>に設定します。</p>
|
||||||
|
<h3 id="colors">colors</h3>
|
||||||
|
<p>ジャーナルエントリーの表示に使用される色を制御する辞書です。
|
||||||
|
4つのサブキーがあります:<code>body</code>、<code>date</code>、<code>tags</code>、<code>title</code>。</p>
|
||||||
|
<p>現在有効な値は:<code>BLACK</code>、<code>RED</code>、<code>GREEN</code>、<code>YELLOW</code>、<code>BLUE</code>、
|
||||||
|
<code>MAGENTA</code>、<code>CYAN</code>、<code>WHITE</code>、<code>NONE</code>です。</p>
|
||||||
|
<p>色付けには<code>colorama.Fore</code>が使用され、<a href="https://github.com/tartley/colorama#colored-output">ドキュメントはこちら</a>で確認できます。</p>
|
||||||
|
<p>色付き出力を無効にするには、値を<code>NONE</code>に設定します。</p>
|
||||||
|
<h3 id="display_format">display_format</h3>
|
||||||
|
<p>デフォルトで使用するフォーマッタを指定します。<a href="../formats/">フォーマット</a>を参照してください。</p>
|
||||||
|
<h3 id="version">version</h3>
|
||||||
|
<p><code>jrnl</code>は自動的にこのフィールドを実行中のバージョンに更新します。
|
||||||
|
このフィールドを手動で変更する必要はありません。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../reference-command-line/" class="btn btn-neutral float-left" title="コマンドライン"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../contributing/" class="btn btn-neutral float-right" title="jrnlへの貢献">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-command-line/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../contributing/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
380
site/ja/tips-and-tricks/index.html
Normal file
|
@ -0,0 +1,380 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/tips-and-tricks/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>ヒントとコツ - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u30d2\u30f3\u30c8\u3068\u30b3\u30c4";
|
||||||
|
var mkdocs_page_input_path = "ja/tips-and-tricks.md";
|
||||||
|
var mkdocs_page_url = "/ja/tips-and-tricks/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">ヒントとコツ</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#co-occurrence-of-tags">Co-occurrence of tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">フィルターの組み合わせ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_3">統計</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_4">古いファイルのインポート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_5">テンプレートの使用</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#1-template-xdg_data_homejrnltemplates">1. --template コマンドライン引数とデフォルトの $XDG_DATA_HOME/jrnl/templates ディレクトリを使用</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#2-template">2. --template コマンドライン引数とローカル/絶対パスを使用</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#3-jrnlyaml">3. jrnl.yaml にデフォルトのテンプレートファイルを設定</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_6">シェルのリロード時にプロンプトを表示</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_7">ランダムエントリの表示</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_8">高速記録用の端末を起動</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#cli-markdown">CLI でフォーマットされた Markdown を視覚化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#vi">バッファの末尾にジャンプ(vi使用時)</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>ヒントとコツ</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/tips-and-tricks.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">ヒントとコツ</h1>
|
||||||
|
<p>このページでは、他のツールや外部エディタと組み合わせて
|
||||||
|
jrnlを使用するためのヒントとコツを紹介します。</p>
|
||||||
|
<h2 id="co-occurrence-of-tags">Co-occurrence of tags</h2>
|
||||||
|
<p>ルームメイトの AlbertoとMeloを同じエントリーでどれくらい一緒に言及したか調べたい場合、
|
||||||
|
次のコマンドを使います。</p>
|
||||||
|
<pre><code class="language-sh">jrnl @alberto --tags | grep @melo
|
||||||
|
</code></pre>
|
||||||
|
<p>これにより、<code>@melo: 9</code>と言った結果が表示されます。これは<code>@alberto</code>と
|
||||||
|
<code>@melo</code>の両方がタグ付けされたエントリーが9件あることを意味しています。
|
||||||
|
仕組みを説明すると、まず<code>jrnl @alberto</code> が<code>@alberto</code>タグの有るエントリーだけを
|
||||||
|
抽出します。次に <code>--tags</code>オプションを使うと、その抽出されたエントリー内で
|
||||||
|
各タグがどれくらい使われているかが表示されます。最後に、<code>grep</code>で<code>@melo</code>を
|
||||||
|
含み行だけを示しています。</p>
|
||||||
|
<h2 id="_2">フィルターの組み合わせ</h2>
|
||||||
|
<p>次のようにコマンドを使うことが出来ます。</p>
|
||||||
|
<pre><code class="language-sh">jrnl @fixed -starred -n 10 -to "jan 2013" --short
|
||||||
|
</code></pre>
|
||||||
|
<p>これで2013年1月1日以前に<code>@fixed</code>タグが付けられた最近のお気に入りの10件の
|
||||||
|
エントリーの要約を取得できます。</p>
|
||||||
|
<h2 id="_3">統計</h2>
|
||||||
|
<p>昨年どれくらい書いたか知りたい場合は?</p>
|
||||||
|
<pre><code class="language-sh">jrnl -from "jan 1 2013" -to "dec 31 2013" | wc -w
|
||||||
|
</code></pre>
|
||||||
|
<p>このコマンドを実行すると、2013年に書いた単語数が表示されます。</p>
|
||||||
|
<p>エントリーの平均の長さを知りたい場合は?</p>
|
||||||
|
<pre><code class="language-sh">expr $(jrnl --export text | wc -w) / $(jrnl --short | wc -l)
|
||||||
|
</code></pre>
|
||||||
|
<p>このコマンドは、まずジャーナル全体の単語数を取得し、それをエントリーの数で
|
||||||
|
割ります(<code>jrnl --short</code>は各エントリーごとに1行だけ出力するため、この方法が機能
|
||||||
|
します)。</p>
|
||||||
|
<h2 id="_4">古いファイルのインポート</h2>
|
||||||
|
<p>ファイルを <code>jrnl</code> のエントリとしてインポートしたい場合は、
|
||||||
|
単に <code>jrnl < entry.ext</code> と実行するだけです。
|
||||||
|
しかし、ファイルの最終更新日時を <code>jrnl</code> のエントリの日付として設定したい場合はどうでしょうか?</p>
|
||||||
|
<p>次のコマンドを試してみてください。</p>
|
||||||
|
<pre><code class="language-sh">echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' entry.txt` `cat entry.txt` | jrnl
|
||||||
|
</code></pre>
|
||||||
|
<p>このコマンドの前半部分は <code>entry.txt</code> の最終更新日時をフォーマットし、ファイルの内容と結合してからそれを <code>jrnl</code> にパイプします。これを頻繁に行う場合は、<code>.bashrc</code> や <code>.bash_profile</code> に関数を作成することを検討してください。</p>
|
||||||
|
<pre><code class="language-sh">jrnlimport () {
|
||||||
|
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' $1` `cat $1` | jrnl
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_5">テンプレートの使用</h2>
|
||||||
|
<div class="admonition 注意">
|
||||||
|
<p class="admonition-title">注意</p>
|
||||||
|
</div>
|
||||||
|
<p>テンプレートを使用するには、<a href="../advanced/">外部エディタ</a> の設定が必要です。</p>
|
||||||
|
<p>テンプレートは、構造化されたジャーナルを作成するために使うテキストファイルです。テンプレートを使用する方法は3つあります。</p>
|
||||||
|
<h3 id="1-template-xdg_data_homejrnltemplates">1. <code>--template</code> コマンドライン引数とデフォルトの <code>$XDG_DATA_HOME/jrnl/templates</code> ディレクトリを使用</h3>
|
||||||
|
<p><code>$XDG_DATA_HOME/jrnl/templates</code> は、テンプレートを保存するためにデフォルトで作成されます!このディレクトリにテンプレート(例えば <code>default.md</code>)を作成し、<code>--template FILE_IN_DIR</code> として指定します。</p>
|
||||||
|
<pre><code class="language-sh">jrnl --template default.md
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="2-template">2. <code>--template</code> コマンドライン引数とローカル/絶対パスを使用</h3>
|
||||||
|
<p>任意のテキストでテンプレートファイルを作成できます。例は以下の通りです:</p>
|
||||||
|
<pre><code class="language-sh"># /tmp/template.txt
|
||||||
|
私の個人ジャーナル
|
||||||
|
タイトル:
|
||||||
|
|
||||||
|
本文:
|
||||||
|
</code></pre>
|
||||||
|
<p>その後、テンプレートファイルの絶対パスまたは相対パスを引数として指定すると、外部エディタが開き、テンプレートが事前に入力された状態になります。</p>
|
||||||
|
<pre><code class="language-sh">jrnl --template /tmp/template.md
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="3-jrnlyaml">3. <code>jrnl.yaml</code> にデフォルトのテンプレートファイルを設定</h3>
|
||||||
|
<p>デフォルトでテンプレートを使用したい場合は、<a href="../reference-config-file/">設定ファイル</a> 内の <code>template</code> の値を <code>false</code> からダブルクオーテーションで囲まれたテンプレートファイルのパスに変更します。</p>
|
||||||
|
<pre><code class="language-sh">...
|
||||||
|
template: "/path/to/template.txt"
|
||||||
|
...
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition ヒント">
|
||||||
|
<p class="admonition-title">ヒント</p>
|
||||||
|
</div>
|
||||||
|
<p>ジャーナルエントリを確認したり、保存されたエントリを確認したい場合は、以下のコマンドを使用します:<code>jrnl -n 1</code> (他のオプションについては<a href="../formats/">フォーマット</a> を確認してください)。</p>
|
||||||
|
<pre><code class="language-sh">jrnl -n 1
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_6">シェルのリロード時にプロンプトを表示</h2>
|
||||||
|
<p>シェルをリフレッシュするたびにプロンプトを表示させたい場合は、以下を <code>.bash_profile</code> に追加できます:</p>
|
||||||
|
<pre><code class="language-sh">function log_question()
|
||||||
|
{
|
||||||
|
echo $1
|
||||||
|
read
|
||||||
|
jrnl today: ${1}. $REPLY
|
||||||
|
}
|
||||||
|
log_question '今日達成したことは何ですか?'
|
||||||
|
log_question 'どんな進展がありましたか?'
|
||||||
|
</code></pre>
|
||||||
|
<p>シェルがリロードされるたびに、上記の質問に回答するように促されます。各回答は、<code>jrnl.yaml</code> の <code>default_hour</code> および <code>default_minute</code> にリストされている時刻で別々のジャーナルエントリとして記録されます。</p>
|
||||||
|
<h2 id="_7">ランダムエントリの表示</h2>
|
||||||
|
<p>ランダムに1つのタイトルを選択し、エントリ全体を表示することができます。タイムスタンプのフォーマットに合わせて <code>cut</code> の呼び出しを調整します。日時要素の間にスペースがあるタイムスタンプでは、以下のようにフィールド1と2を選択します。スペースがないタイムスタンプの場合は、フィールド1のみを選択します。</p>
|
||||||
|
<pre><code class="language-sh">jrnl -on "$(jrnl --short | shuf -n 1 | cut -d' ' -f1,2)"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_8">高速記録用の端末を起動</h2>
|
||||||
|
<p><code>jrnl</code> の stdin プロンプトを持つ端末を起動し、すぐに入力を開始できるようにすることができます。</p>
|
||||||
|
<pre><code class="language-bash">jrnl --config-override editor ""
|
||||||
|
</code></pre>
|
||||||
|
<p>これをキーボードショートカットに割り当てます。</p>
|
||||||
|
<p><code>Super+Alt+J</code> に <code>jrnl</code> プロンプトを持つ端末を起動するようにマップする</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>xbindkeys</strong>
|
||||||
|
あなたの <code>.xbindkeysrc</code> に以下を追加します</li>
|
||||||
|
</ul>
|
||||||
|
<pre><code class="language-ini">Mod4+Mod1+j
|
||||||
|
alacritty -t floating-jrnl -e jrnl --config-override editor "",
|
||||||
|
</code></pre>
|
||||||
|
<ul>
|
||||||
|
<li><strong>I3 WM</strong> <code>jrnl</code> プロンプトを持つフローティング端末を起動します</li>
|
||||||
|
</ul>
|
||||||
|
<pre><code class="language-ini">bindsym Mod4+Mod1+j exec --no-startup-id alacritty -t floating-jrnl -e jrnl --config-override editor ""
|
||||||
|
for_window[title="floating *"] floating enable
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="cli-markdown">CLI でフォーマットされた Markdown を視覚化</h2>
|
||||||
|
<p><code>jrnl</code> はデフォルトでジャーナルエントリをMarkdown形式で出力できます。これを視覚化するには、<a href="https://github.com/ttscoff/mdless">mdless</a> にパイプします。<code>mdless</code> は、Markdownテキストをフォーマットおよびシンタックスハイライト付きでCLIで表示できる、<a href="https://en.wikipedia.org/wiki/Less_(Unix)">less</a> のようなツールです。この機能は、パイプをサポートする任意のシェルで使用できます。</p>
|
||||||
|
<p>Markdown出力を <code>mdless</code> で視覚化する最も簡単な方法は次の通りです:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --export md | mdless
|
||||||
|
</code></pre>
|
||||||
|
<p>これにより、画面全体にMarkdown出力がレンダリングされます。</p>
|
||||||
|
<p>幸いなことに、<code>mdless</code> には画面幅を調整するための <code>-w</code> オプションがあります。以下のように使用します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --export md | mdless -w 70
|
||||||
|
</code></pre>
|
||||||
|
<p>Markdownをデフォルトの表示形式にしたい場合は、設定ファイルで次のように定義できます:</p>
|
||||||
|
<pre><code class="language-yaml">display_format: md
|
||||||
|
# または
|
||||||
|
display_format: markdown
|
||||||
|
</code></pre>
|
||||||
|
<p><code>jrnl</code> がエントリをMarkdown形式で出力する方法についての詳細は、<a href="../formats/">フォーマット</a> セクションを参照してください。</p>
|
||||||
|
<h2 id="vi">バッファの末尾にジャンプ(vi使用時)</h2>
|
||||||
|
<p>viを使用して編集する際に、エントリの最後の行にジャンプさせるには、設定ファイルで次のように設定します:</p>
|
||||||
|
<pre><code class="language-yaml">editor: vi + -c "call cursor('.',strwidth(getline('.')))"
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../external-editors/" class="btn btn-neutral float-left" title="外部エディタ"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../reference-command-line/" class="btn btn-neutral float-right" title="コマンドライン">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../external-editors/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-command-line/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
417
site/ja/usage/index.html
Normal file
|
@ -0,0 +1,417 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/usage/" />
|
||||||
|
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||||
|
<title>基本的な使い方 - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "\u57fa\u672c\u7684\u306a\u4f7f\u3044\u65b9";
|
||||||
|
var mkdocs_page_input_path = "ja/usage.md";
|
||||||
|
var mkdocs_page_url = "/ja/usage/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="../.." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" >ユーザーガイド</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal current" href="#">基本的な使い方</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_2">エントリーの作成</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_3">日付と時間の指定</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_4">タグの使用</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_5">エントリーにスターを付ける</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_6">エントリーの閲覧と検索</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_7">テキスト検索</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_8">タグによるフィルタリング</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#_9">スター付きエントリーの表示</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_10">エントリーの編集</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_11">エントリーの削除</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#_12">ジャーナルのリスト表示</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="../..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>ja »</li>
|
||||||
|
<li>ユーザーガイド »</li>
|
||||||
|
<li>基本的な使い方</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/usage.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="_1">基本的な使い方</h1>
|
||||||
|
<p><code>jrnl</code>には2つのモードがあります:<strong>作成モード</strong>と<strong>閲覧モード</strong>です。ダッシュ(<code>-</code>)
|
||||||
|
やダブルダッシュ(<code>--</code>)で始まる引数を入力しない場合は作成モードになり、
|
||||||
|
コマンドラインでエントリーを書くことができます。</p>
|
||||||
|
<p>私たちは意図的にコマンドライン引数の慣例を破っています:<em>一重のダッシュ</em>(<code>-</code>)で
|
||||||
|
始まるすべての引数は、閲覧前にジャーナルを<em>フィルタリング</em>します。フィルタ引数は
|
||||||
|
任意に組み合わせることができます。<em>二重のダッシュ</em>(<code>--</code>)で始まる引数は、
|
||||||
|
ジャーナルの表示やエクスポートの方法を<em>制御</em>します。制御引数は相互に排他的です
|
||||||
|
(つまり、一度に一つの方法でのみジャーナルの表示やエクスポートを指定できます)。</p>
|
||||||
|
<p>コマンドのリストを表示するには、<code>jrnl --help</code>と入力してください。</p>
|
||||||
|
<h2 id="_2">エントリーの作成</h2>
|
||||||
|
<p>作成モードは、引数なしで<code>jrnl</code>を起動する(外部エディタが起動します)か、
|
||||||
|
コマンドラインに直接エントリーを書くことで入ります:</p>
|
||||||
|
<pre><code class="language-text">jrnl today at 3am: バーでスティーブ・ブシェミに会った!とても良い人だった。
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>ほとんどのシェルには<code>#</code>や<code>*</code>などの予約文字があります。これらの文字や、
|
||||||
|
バランスの取れていない単一または二重引用符、括弧などは、おそらく問題を
|
||||||
|
引き起こします。予約文字は<code>\</code>を使ってエスケープできますが、長文の
|
||||||
|
書き込みには理想的ではありません。解決策:まず<code>jrnl</code>と入力してリターンキーを
|
||||||
|
押します。その後、ジャーナルエントリーのテキストを入力できます。
|
||||||
|
または、<a href="../advanced/">外部エディタを使用する</a>こともできます。</p>
|
||||||
|
<p>ファイルから直接エントリーをインポートすることもできます:</p>
|
||||||
|
<pre><code class="language-sh">jrnl < my_entry.txt
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="_3">日付と時間の指定</h3>
|
||||||
|
<p>日付と時間を指定しない場合(例:<code>jrnl 弟への手紙を書き終えた</code>)、<code>jrnl</code>は現在の日付と時間を使用してエントリーを作成します。過去のエントリーの場合、タイムスタンプを使用して<code>jrnl</code>にエントリーの配置場所を指示できます。タイムスタンプは様々な形式で入力できます。以下は機能する例です:</p>
|
||||||
|
<ul>
|
||||||
|
<li>at 6am</li>
|
||||||
|
<li>yesterday</li>
|
||||||
|
<li>last monday</li>
|
||||||
|
<li>sunday at noon</li>
|
||||||
|
<li>2 march 2012</li>
|
||||||
|
<li>7 apr</li>
|
||||||
|
<li>5/20/1998 at 23:42</li>
|
||||||
|
<li>2020-05-22T15:55-04:00</li>
|
||||||
|
</ul>
|
||||||
|
<p>タイムスタンプを使用しない場合、<code>jrnl</code>は現在の時刻を使用してエントリーを作成します。
|
||||||
|
日付のみを使用する場合(時刻なし)、<code>jrnl</code>は<a href="../reference-config-file/#default_hour-and-default_minute">設定ファイル</a>で
|
||||||
|
指定されたデフォルトの時刻を使用します。
|
||||||
|
内部的には、<code>jrnl</code>はエントリーを年代順に並べ替えます。</p>
|
||||||
|
<h3 id="_4">タグの使用</h3>
|
||||||
|
<p><code>jrnl</code>はタグをサポートしています。デフォルトのタグシンボルは<code>@</code>です(主に<code>#</code>が
|
||||||
|
予約文字であるため)。<a href="../reference-config-file/#tagsymbols">設定ファイル</a>で
|
||||||
|
独自のタグシンボルを指定できます。タグを使用するには、目的のタグの前にシンボルを
|
||||||
|
付けます:</p>
|
||||||
|
<pre><code class="language-sh">jrnl @ビーチで@トムと@アンナと素晴らしい一日を過ごした。
|
||||||
|
</code></pre>
|
||||||
|
<p>エントリーにタグを付ける際に大文字を使用できますが、タグによる検索は
|
||||||
|
大文字小文字を区別しません。</p>
|
||||||
|
<p>1つのエントリーで使用できるタグの数に制限はありません。</p>
|
||||||
|
<h3 id="_5">エントリーにスターを付ける</h3>
|
||||||
|
<p>エントリーをお気に入りとしてマークするには、単にアスタリスク(<code>*</code>)を使って
|
||||||
|
「スター」を付けます:</p>
|
||||||
|
<pre><code class="language-sh">jrnl last sunday *: 人生最高の日。
|
||||||
|
</code></pre>
|
||||||
|
<p>日付を追加したくない場合(つまり、日付を<em>now</em>として入力したい場合)、
|
||||||
|
以下のオプションは同等です:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>jrnl *: 人生最高の日。</code></li>
|
||||||
|
<li><code>jrnl *人生最高の日。</code></li>
|
||||||
|
<li><code>jrnl 人生最高の日。*</code></li>
|
||||||
|
</ul>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>アスタリスク(<code>*</code>)の前後に空白がないことを確認してください。
|
||||||
|
<code>jrnl 人生最高の日! *</code>は機能しません。なぜなら、<code>*</code>文字はほとんどの
|
||||||
|
シェルで特別な意味を持つからです。</p>
|
||||||
|
<h2 id="_6">エントリーの閲覧と検索</h2>
|
||||||
|
<p><code>jrnl</code>は様々な方法でエントリーを表示できます。</p>
|
||||||
|
<p>すべてのエントリーを表示するには、次のように入力します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to today
|
||||||
|
</code></pre>
|
||||||
|
<p><code>jrnl</code>はいくつかのフィルタリングコマンドを提供しており、一重のダッシュ(<code>-</code>)で
|
||||||
|
始まり、より具体的な範囲のエントリーを見つけることができます。例えば、</p>
|
||||||
|
<pre><code class="language-sh">jrnl -n 10
|
||||||
|
</code></pre>
|
||||||
|
<p>は最新の10件のエントリーを表示します。<code>jrnl -10</code>はさらに簡潔で、同じように機能します。
|
||||||
|
昨年の初めから今年の3月末までに書いたすべてのエントリーを見たい場合は、
|
||||||
|
次のように入力します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -from "last year" -to march
|
||||||
|
</code></pre>
|
||||||
|
<p>複数の単語を使用するフィルタ条件は、引用符(<code>""</code>)で囲む必要があります。</p>
|
||||||
|
<p>特定の日のエントリーを見るには、<code>-on</code>を使用します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -on yesterday
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="_7">テキスト検索</h3>
|
||||||
|
<p><code>-contains</code>コマンドは、その後に入力したテキストを含むすべてのエントリーを表示します。
|
||||||
|
これは、エントリーを検索する際に、書いた時にタグを付けたかどうか覚えていない場合に
|
||||||
|
役立つかもしれません。</p>
|
||||||
|
<p>ある単語をよく使っていることに気づき、過去のすべてのエントリーでそれをタグに
|
||||||
|
変えたいと思うかもしれません。</p>
|
||||||
|
<pre><code class="language-sh">jrnl -contains "犬" --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>外部エディタを開き、"犬"という単語のすべてのインスタンスにタグシンボル
|
||||||
|
(デフォルトでは<code>@</code>)を追加できます。</p>
|
||||||
|
<h3 id="_8">タグによるフィルタリング</h3>
|
||||||
|
<p>ジャーナルエントリーをタグでフィルタリングできます。例えば、</p>
|
||||||
|
<pre><code class="language-sh">jrnl @ピンキー @世界征服
|
||||||
|
</code></pre>
|
||||||
|
<p>は<code>@ピンキー</code>または<code>@世界征服</code>のいずれかが出現するすべてのエントリーを表示します。
|
||||||
|
タグフィルタは他のフィルタと組み合わせることができます:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -n 5 @ピンキー -and @世界征服
|
||||||
|
</code></pre>
|
||||||
|
<p>は<code>@ピンキー</code><em>と</em><code>@世界征服</code>の<em>両方</em>を含む最新の5つのエントリーを表示します。
|
||||||
|
<a href="../reference-config-file/#tagsymbols">設定ファイル</a>でタグに使用したいシンボルを
|
||||||
|
変更できます。</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p><code>jrnl @ピンキー @世界征服</code>と入力すると、両方のタグが存在するエントリーが
|
||||||
|
表示されます。これは、コマンドライン引数が与えられていないにもかかわらず、
|
||||||
|
すべての入力文字列がタグのように見えるためです。<code>jrnl</code>は、タグのみで
|
||||||
|
構成される新しいエントリーを作成するのではなく、タグでフィルタリング
|
||||||
|
したいと想定します。</p>
|
||||||
|
<p>ジャーナル内のすべてのタグのリストを表示するには、次のように入力します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --tags
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="_9">スター付きエントリーの表示</h3>
|
||||||
|
<p>お気に入り(スター付き)のエントリーのみを表示するには、次のように入力します:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -starred
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="_10">エントリーの編集</h2>
|
||||||
|
<p>エントリーを書いた後で編集することができます。これは特に、ジャーナルファイルが
|
||||||
|
暗号化されている場合に便利です。この機能を使用するには、<a href="../reference-config-file/#editor">設定ファイル</a>で
|
||||||
|
外部エディタを設定する必要があります。また、特定の検索条件に一致するエントリー
|
||||||
|
のみを編集することもできます。例えば、</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 1950 @テキサス -and @歴史 --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>は外部エディタを開き、1950年以前に書かれた<code>@テキサス</code>と<code>@歴史</code>のタグが付いた
|
||||||
|
すべてのエントリーを表示します。変更を加えてファイルを保存して閉じると、
|
||||||
|
それらのエントリーのみが変更されます(該当する場合は暗号化されます)。</p>
|
||||||
|
<p>複数のジャーナルを使用している場合、特定のジャーナルから特定のエントリーを
|
||||||
|
簡単に編集できます。フィルタ文字列の前にジャーナルの名前を付けるだけです。
|
||||||
|
例えば、</p>
|
||||||
|
<pre><code class="language-sh">jrnl work -n 1 --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>は'work'ジャーナルの最新のエントリーを外部エディタで開きます。</p>
|
||||||
|
<h2 id="_11">エントリーの削除</h2>
|
||||||
|
<p><code>--delete</code>コマンドは、エントリーを削除するための対話型インターフェースを開きます。
|
||||||
|
ジャーナル内の各エントリーの日付とタイトルが一つずつ表示され、各エントリーを
|
||||||
|
保持するか削除するかを選択できます。</p>
|
||||||
|
<p>フィルタが指定されていない場合、<code>jrnl</code>はジャーナル全体の各エントリーを一つずつ
|
||||||
|
保持するか削除するかを尋ねます。ジャーナルに多くのエントリーがある場合は、
|
||||||
|
<code>--delete</code>コマンドを渡す前にエントリーをフィルタリングする方が効率的かもしれません。</p>
|
||||||
|
<p>例を挙げます。過去12年間のブログ投稿をインポートしたジャーナルがあるとします。
|
||||||
|
<code>@本</code>タグを頻繁に使用しており、何らかの理由で、そのタグを使用したエントリーの
|
||||||
|
一部(全部ではない)を削除したいのですが、2004年以前に書いたものだけです。
|
||||||
|
どのエントリーを保持したいかわからず、決定する前に確認したいとします。
|
||||||
|
次のように入力するかもしれません:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 2004 @本 --delete
|
||||||
|
</code></pre>
|
||||||
|
<p><code>jrnl</code>は関連するエントリーのみを表示し、削除したいものを選択できます。</p>
|
||||||
|
<p>2004年以前に書いた<code>@本</code>を含むすべてのエントリーを削除したい場合もあるでしょう。
|
||||||
|
数十または数百ある場合、最も簡単な方法は外部エディタを使用することです。
|
||||||
|
削除したいエントリーをエディタで開きます...</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 2004 @本 --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>...すべてを選択し、削除して保存して閉じると、それらのエントリーすべてが
|
||||||
|
ジャーナルから削除されます。</p>
|
||||||
|
<h2 id="_12">ジャーナルのリスト表示</h2>
|
||||||
|
<p>すべてのジャーナルをリスト表示するには:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --list
|
||||||
|
</code></pre>
|
||||||
|
<p>表示されるジャーナルは、<code>jrnl</code>の<a href="../reference-config-file/#journals">設定ファイル</a>で
|
||||||
|
指定されたものに対応します。</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../installation/" class="btn btn-neutral float-left" title="クイックスタート"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../encryption/" class="btn btn-neutral float-right" title="暗号化">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../installation/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../encryption/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "../..";</script>
|
||||||
|
<script src="../../js/theme_extra.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
<script src="../../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
286
site/journal-types/index.html
Normal file
|
@ -0,0 +1,286 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/journal-types/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Journal Types - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Journal Types";
|
||||||
|
var mkdocs_page_input_path = "journal-types.md";
|
||||||
|
var mkdocs_page_url = "/journal-types/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Journal Types</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#single-file">Single File</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#folder">Folder</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#day-one-classic">Day One Classic</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#changing-your-journal-type">Changing your journal type</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Journal Types</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/journal-types.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="journal-types">Journal Types</h1>
|
||||||
|
<p><code>jrnl</code> can store your journal in a few different ways:</p>
|
||||||
|
<ul>
|
||||||
|
<li>a single text file (encrypted or otherwise)</li>
|
||||||
|
<li>a folder structure organized by date containing unencrypted text files</li>
|
||||||
|
<li>the DayOne Classic format</li>
|
||||||
|
</ul>
|
||||||
|
<p>There is no need to specify what type of journal you'd like to use. Instead,
|
||||||
|
<code>jrnl</code> will automatically detect the journal type based on whether you're
|
||||||
|
referencing a file or a folder in your <a href="../advanced/">config file</a>,
|
||||||
|
and if it's a folder, whether or not DayOne Classic content exists in it.</p>
|
||||||
|
<h2 id="single-file">Single File</h2>
|
||||||
|
<p>The single file format is the most flexible, as it can be <a href="../encryption/">encrypted</a>.
|
||||||
|
To use it, enter any path that is a file or does not already exist. You can
|
||||||
|
use any extension. <code>jrnl</code> will automatically create the file when you save
|
||||||
|
your first entry.</p>
|
||||||
|
<h2 id="folder">Folder</h2>
|
||||||
|
<p>The folder journal format organizes your entries into subfolders for the year
|
||||||
|
and month and <code>.txt</code> files for each day. If there are multiple entries in a day,
|
||||||
|
they all appear in the same <code>.txt</code> file.</p>
|
||||||
|
<p>The directory tree structure is in this format: <code>YYYY/MM/DD.txt</code>. For instance, if
|
||||||
|
you have an entry on May 5th, 2021 in a folder journal at <code>~/folderjournal</code>, it will
|
||||||
|
be located in: <code>~/folderjournal/2021/05/05.txt</code></p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>Creating a new folder journal can be done in two ways:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Create a folder with the name of the journal before running <code>jrnl</code>. Otherwise, when you run <code>jrnl</code> for the first time, it will assume that you are creating a single file journal instead, and it will create a file at that path.</li>
|
||||||
|
<li>Create a new journal in your <a href="../advanced/">config_file</a> and end the path with a <code>/</code> (on a POSIX system like Linux or MacOSX) or a <code>\</code> (on a Windows system). The folder will be created automatically if it doesn't exist.</li>
|
||||||
|
</ul>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>Folder journals can't be encrypted.</p>
|
||||||
|
<h2 id="day-one-classic">Day One Classic</h2>
|
||||||
|
<p><code>jrnl</code> supports the original data format used by DayOne. It's similar to the folder
|
||||||
|
journal format, except it's identified by either of these characteristics:</p>
|
||||||
|
<ul>
|
||||||
|
<li>the folder has a <code>.dayone</code> extension</li>
|
||||||
|
<li>the folder has a subfolder named <code>entries</code></li>
|
||||||
|
</ul>
|
||||||
|
<p>This is not to be confused with the DayOne 2.0 format, <a href="https://help.dayoneapp.com/en/articles/1187337-day-one-classic-is-retired">which is very different</a>.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
</div>
|
||||||
|
<p>DayOne Classic journals can't be encrypted.</p>
|
||||||
|
<h2 id="changing-your-journal-type">Changing your journal type</h2>
|
||||||
|
<p>You can't simply modify a journal's configuration to change its type. Instead,
|
||||||
|
define a new journal as the type you'd like, and use
|
||||||
|
<a href="https://en.wikipedia.org/wiki/Redirection_(computing)#Piping">piping</a>
|
||||||
|
to export your old journal as <code>txt</code> to an import command on your new journal.</p>
|
||||||
|
<p>For instance, if you have a <code>projects</code> journal you would like to import into
|
||||||
|
a <code>new</code> journal, you would run the following after setting up the configuration
|
||||||
|
for your <code>new</code> journal:</p>
|
||||||
|
<pre><code>jrnl projects --format txt | jrnl new --import
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../encryption/" class="btn btn-neutral float-left" title="Encryption"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../privacy-and-security/" class="btn btn-neutral float-right" title="Privacy and Security">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../encryption/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../privacy-and-security/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
4
site/js/html5shiv.min.js
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
/**
|
||||||
|
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||||
|
*/
|
||||||
|
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
2
site/js/jquery-3.6.0.min.js
vendored
Normal file
2
site/js/theme.js
Normal file
8
site/js/theme_extra.js
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
/*
|
||||||
|
* Assign 'docutils' class to tables so styling and
|
||||||
|
* JavaScript behavior is applied.
|
||||||
|
*
|
||||||
|
* https://github.com/mkdocs/mkdocs/issues/2028
|
||||||
|
*/
|
||||||
|
|
||||||
|
$('div.rst-content table').addClass('docutils');
|
273
site/overview/index.html
Normal file
|
@ -0,0 +1,273 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/overview/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Overview - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Overview";
|
||||||
|
var mkdocs_page_input_path = "overview.md";
|
||||||
|
var mkdocs_page_url = "/overview/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Overview</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#plain-text">Plain Text</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#tags">Tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#support-for-multiple-journals">Support for Multiple Journals</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#support-for-external-editors">Support for External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#encryption">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#import-and-export">Import and Export</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#multi-platform-support">Multi-Platform Support</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#open-source">Open-Source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>Overview</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/overview.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="overview">Overview</h1>
|
||||||
|
<p><code>jrnl</code> is a simple journal application for the command line.</p>
|
||||||
|
<p>You can use it to easily create, search, and view journal entries. Journals are
|
||||||
|
stored as human-readable plain text, and can also be encrypted using <a href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES
|
||||||
|
encryption</a>.</p>
|
||||||
|
<p><code>jrnl</code> has most of the features you need, and few of the ones you don't.</p>
|
||||||
|
<h2 id="plain-text">Plain Text</h2>
|
||||||
|
<p><code>jrnl</code> stores each journal in plain text. You can store <code>jrnl</code> files anywhere,
|
||||||
|
including in shared folders to keep them synchronized between devices. Journal
|
||||||
|
files are compact (thousands of entries take up less than 1 MiB) and can be read
|
||||||
|
by almost any electronic device, now and for the foreseeable future.</p>
|
||||||
|
<h2 id="tags">Tags</h2>
|
||||||
|
<p>To make it easier to find entries later, <code>jrnl</code> includes support for inline tags
|
||||||
|
(the default tag symbol is <code>@</code>). You can find and filter entries by using tags
|
||||||
|
along with other search criteria.</p>
|
||||||
|
<h2 id="support-for-multiple-journals">Support for Multiple Journals</h2>
|
||||||
|
<p><code>jrnl</code> includes support for the creation of multiple journals, each of which
|
||||||
|
can be stored as a single file or as a set of files. Entries are automatically
|
||||||
|
timestamped in a human-readable format that makes it easy to view multiple
|
||||||
|
entries at a time. <code>jrnl</code> can easily find the entries you want so that you can
|
||||||
|
read them or edit them.</p>
|
||||||
|
<h2 id="support-for-external-editors">Support for External Editors</h2>
|
||||||
|
<p><code>jrnl</code> plays nicely with your favorite text editor. You may prefer to write
|
||||||
|
journal entries in an editor. Or you may want to make changes that require a
|
||||||
|
more comprehensive application. <code>jrnl</code> can filter specific entries and pass them
|
||||||
|
to the <a href="../external-editors/">external editor</a> of your choice.</p>
|
||||||
|
<h2 id="encryption">Encryption</h2>
|
||||||
|
<p><code>jrnl</code> includes support for <a href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES
|
||||||
|
encryption</a>. See the
|
||||||
|
<a href="../encryption/">encryption page</a> for more information.</p>
|
||||||
|
<h2 id="import-and-export">Import and Export</h2>
|
||||||
|
<p><code>jrnl</code> makes it easy to import entries from other sources. Existing entries can
|
||||||
|
be exported in a variety of <a href="../formats/">formats</a>.</p>
|
||||||
|
<h2 id="multi-platform-support">Multi-Platform Support</h2>
|
||||||
|
<p><code>jrnl</code> is compatible with most operating systems. You can <a href="../installation/">download</a> it using one
|
||||||
|
of a variety of package managers, or you can build from source.</p>
|
||||||
|
<h2 id="open-source">Open-Source</h2>
|
||||||
|
<p><code>jrnl</code> is written in <a href="https://www.python.org">Python</a> and maintained by a
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl">friendly community</a> of open-source software
|
||||||
|
enthusiasts.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../installation/" class="btn btn-neutral float-right" title="Quickstart">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../installation/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
425
site/privacy-and-security/index.html
Normal file
|
@ -0,0 +1,425 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/privacy-and-security/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Privacy and Security - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Privacy and Security";
|
||||||
|
var mkdocs_page_input_path = "privacy-and-security.md";
|
||||||
|
var mkdocs_page_url = "/privacy-and-security/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Privacy and Security</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#password-strength">Password strength</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#plausible-deniability">Plausible deniability</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#spying">Spying</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#saved-passwords">Saved Passwords</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#shell-history">Shell history</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#bash">bash</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#zsh">zsh</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#fish">fish</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#windows-command-prompt">Windows Command Prompt</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#files-in-transit-from-editor-to-jrnl">Files in transit from editor to jrnl</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#editor-history">Editor history</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#visual-studio-code">Visual Studio Code</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#vim">Vim</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#neovim">Neovim</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#notice-any-other-risks">Notice any other risks?</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Privacy and Security</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/privacy-and-security.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="privacy-and-security">Privacy and Security</h1>
|
||||||
|
<p><code>jrnl</code> is designed with privacy and security in mind, but like any other
|
||||||
|
program there are some limitations to be aware of.</p>
|
||||||
|
<h2 id="password-strength">Password strength</h2>
|
||||||
|
<p><code>jrnl</code> doesn't enforce password strength requirements. Short or commonly-used
|
||||||
|
passwords can be easily circumvented by someone with basic security skills
|
||||||
|
to access to your encrypted <code>jrnl</code> file.</p>
|
||||||
|
<h2 id="plausible-deniability">Plausible deniability</h2>
|
||||||
|
<p>You may be able to hide the contents of your journal behind a layer of encryption,
|
||||||
|
but if someone has access to your configuration file, then they can figure out that
|
||||||
|
you have a journal, where that journal file is, and when you last edited it.
|
||||||
|
With a sufficient power imbalance, someone may be able to force you to unencrypt
|
||||||
|
it through non-technical means.</p>
|
||||||
|
<h2 id="spying">Spying</h2>
|
||||||
|
<p>While <code>jrnl</code> can protect against unauthorized access to your journal entries while
|
||||||
|
it isn't open, it cannot protect you against an unsafe computer/location.
|
||||||
|
For example:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Someone installs a keylogger, tracking what you type into your journal.</li>
|
||||||
|
<li>Someone watches your screen while you write your entry.</li>
|
||||||
|
<li>Someone installs a backdoor into <code>jrnl</code> or poisons your journal into revealing your entries.</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="saved-passwords">Saved Passwords</h2>
|
||||||
|
<p>When creating an encrypted journal, you'll be prompted as to whether or not you
|
||||||
|
want to "store the password in your keychain." This keychain is accessed using
|
||||||
|
the <a href="https://pypi.org/project/keyring/">Python keyring library</a>, which has different
|
||||||
|
behavior depending on your operating system.</p>
|
||||||
|
<p>In Windows, the keychain is the Windows Credential Manager (WCM), which can't be locked
|
||||||
|
and can be accessed by any other application running under your username. If this is
|
||||||
|
a concern for you, you may not want to store your password.</p>
|
||||||
|
<h2 id="shell-history">Shell history</h2>
|
||||||
|
<p>Since you can enter entries from the command line, any tool that logs command
|
||||||
|
line actions is a potential security risk. See below for how to deal with this
|
||||||
|
problem in various shells.</p>
|
||||||
|
<h3 id="bash">bash</h3>
|
||||||
|
<p>You can disable history logging for jrnl by adding this line into your
|
||||||
|
<code>~/.bashrc</code> file:</p>
|
||||||
|
<pre><code class="language-sh">HISTIGNORE="$HISTIGNORE:jrnl *"
|
||||||
|
</code></pre>
|
||||||
|
<p>To delete existing <code>jrnl</code> commands from <code>bash</code> history, simply delete them from
|
||||||
|
your bash history file. The default location of this file is <code>~/.bash_history</code>,
|
||||||
|
but you can run <code>echo "$HISTFILE"</code> to find it if needed. Also, you can run
|
||||||
|
<code>history -c</code> to delete all commands from your history.</p>
|
||||||
|
<h3 id="zsh">zsh</h3>
|
||||||
|
<p>You can disable history logging for jrnl by adding this to your <code>~/.zshrc</code>
|
||||||
|
file:</p>
|
||||||
|
<pre><code class="language-sh">setopt HIST_IGNORE_SPACE
|
||||||
|
alias jrnl=" jrnl"
|
||||||
|
</code></pre>
|
||||||
|
<p>To delete existing <code>jrnl</code> commands from <code>zsh</code> history, simply remove them from
|
||||||
|
your zsh history file. The default location of this file is <code>~/.zsh_history</code>,
|
||||||
|
but you can run <code>echo "$HISTFILE"</code> to find it if needed. Also, you can run
|
||||||
|
<code>history -c</code> to delete all commands from your history.</p>
|
||||||
|
<h3 id="fish">fish</h3>
|
||||||
|
<p>By default <code>fish</code> will not log any command that starts with a space. If you
|
||||||
|
want to always run jrnl with a space before it, then you can add this to your
|
||||||
|
<code>~/.config/fish/config.fish</code> file:</p>
|
||||||
|
<pre><code class="language-sh">abbr --add jrnl " jrnl"
|
||||||
|
</code></pre>
|
||||||
|
<p>To delete existing jrnl commands from <code>fish</code> history, run <code>history delete --prefix 'jrnl '</code>.</p>
|
||||||
|
<h3 id="windows-command-prompt">Windows Command Prompt</h3>
|
||||||
|
<p>Windows doesn't log history to disk, but it does keep it in your command prompt
|
||||||
|
session. Close the command prompt or press <code>Alt</code>+<code>F7</code> to clear your history
|
||||||
|
after journaling.</p>
|
||||||
|
<h2 id="files-in-transit-from-editor-to-jrnl">Files in transit from editor to jrnl</h2>
|
||||||
|
<p>When creating or editing an entry, <code>jrnl</code> uses a unencrypted temporary file on
|
||||||
|
disk in order to give your editor access to your journal. After you close your
|
||||||
|
editor, <code>jrnl</code> then deletes this temporary file.</p>
|
||||||
|
<p>So, if you have saved a journal entry but haven't closed your editor yet, the
|
||||||
|
unencrypted temporary remains on your disk. If your computer were to shut off
|
||||||
|
during this time, or the <code>jrnl</code> process were killed unexpectedly, then the
|
||||||
|
unencrypted temporary file will remain on your disk. You can mitigate this
|
||||||
|
issue by only saving with your editor right before closing it. You can also
|
||||||
|
manually delete these files from your temporary folder. By default, they
|
||||||
|
are named <code>jrnl*.jrnl</code>, but if you use a
|
||||||
|
<a href="../reference-config-file/#template">template</a>, they will have the same
|
||||||
|
extension as the template.</p>
|
||||||
|
<h2 id="editor-history">Editor history</h2>
|
||||||
|
<p>Some editors keep usage history stored on disk for future use. This can be a
|
||||||
|
security risk in the sense that sensitive information can leak via recent
|
||||||
|
search patterns or editor commands.</p>
|
||||||
|
<h3 id="visual-studio-code">Visual Studio Code</h3>
|
||||||
|
<p>Visual Studio Code stores the contents of saved files to allow you to restore or
|
||||||
|
review the contents later. You can disable this feature for all files by unchecking
|
||||||
|
the <code>workbench.localHistory.enabled</code> setting in the
|
||||||
|
<a href="https://code.visualstudio.com/docs/getstarted/settings#_settings-editor">Settings editor</a>.</p>
|
||||||
|
<p>Alternatively, you can disable this feature for specific files by configuring a
|
||||||
|
<a href="https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options">pattern</a>
|
||||||
|
in the <code>workbench.localHistory.exclude</code> setting. To exclude unencrypted temporary files generated
|
||||||
|
by <code>jrnl</code>, you can set the <code>**/jrnl*.jrnl</code> (unless you are using a
|
||||||
|
<a href="../reference-config-file/#template">template</a>) pattern for the <code>workbench.localHistory.exclude</code> setting
|
||||||
|
in the <a href="https://code.visualstudio.com/docs/getstarted/settings#_settings-editor">Settings editor</a>.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>On Windows, the history location is typically found at
|
||||||
|
<code>%APPDATA%\Code\User\History</code>.</p>
|
||||||
|
</div>
|
||||||
|
<p>Visual Studio Code also creates a copy of all unsaved files that are open.
|
||||||
|
It stores these copies in a backup location that's automatically cleaned when
|
||||||
|
you save the file. However, if your computer shuts off before you save the file,
|
||||||
|
or the Visual Studio Code process stops unexpectedly, then an unencrypted
|
||||||
|
temporary file may remain on your disk. You can manually delete these files
|
||||||
|
from the backup location.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>On Windows, the backup location is typically found at
|
||||||
|
<code>%APPDATA%\Code\Backups</code>.</p>
|
||||||
|
</div>
|
||||||
|
<h3 id="vim">Vim</h3>
|
||||||
|
<p>Vim stores progress data in a so called Viminfo file located at <code>~/.viminfo</code>
|
||||||
|
which contains all sorts of user data including command line history, search
|
||||||
|
string history, search/substitute patterns, contents of register etc. Also to
|
||||||
|
be able to recover opened files after an unexpected application close Vim uses
|
||||||
|
swap files.</p>
|
||||||
|
<p>These options as well as other leaky features can be disabled by setting the
|
||||||
|
<code>editor</code> key in the Jrnl settings like this:</p>
|
||||||
|
<pre><code class="language-yaml">editor: "vim -c 'set viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
</code></pre>
|
||||||
|
<p>To disable all plugins and custom configurations and start Vim with the default
|
||||||
|
configuration <code>-u NONE</code> can be passed on the command line as well. This will
|
||||||
|
ensure that any rogue plugins or other difficult to catch information leaks are
|
||||||
|
eliminated. The downside to this is that the editor experience will decrease
|
||||||
|
quite a bit.</p>
|
||||||
|
<p>To instead let Vim automatically detect when a Jrnl file is being edited an
|
||||||
|
autocommand can be used. Place this in your <code>~/.vimrc</code>:</p>
|
||||||
|
<pre><code class="language-vim">autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>If you're using a <a href="../reference-config-file/#template">template</a>, you will
|
||||||
|
have to use the template's file extension instead of <code>.jrnl</code>.</p>
|
||||||
|
</div>
|
||||||
|
<p>See <code>:h <option></code> in Vim for more information about the options mentioned.</p>
|
||||||
|
<h3 id="neovim">Neovim</h3>
|
||||||
|
<p>Neovim strives to be mostly compatible with Vim and has therefore similar
|
||||||
|
functionality as Vim. One difference in Neovim is that the Viminfo file is
|
||||||
|
instead called the ShaDa ("shared data") file which resides in
|
||||||
|
<code>~/.local/state/nvim</code> (<code>~/.local/share/nvim</code> pre Neovim v0.8.0). The ShaDa file
|
||||||
|
can be disabled in the same way as for Vim.</p>
|
||||||
|
<pre><code class="language-yaml">editor: "nvim -c 'set shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'"
|
||||||
|
</code></pre>
|
||||||
|
<p><code>-u NONE</code> can be passed here as well to start a session with the default configs.</p>
|
||||||
|
<p>As for Vim above we can create an autocommand in Vimscript:</p>
|
||||||
|
<pre><code class="language-vim">autocmd BufNewFile,BufReadPre *.jrnl setlocal shada= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure
|
||||||
|
</code></pre>
|
||||||
|
<p>or the same but in Lua:</p>
|
||||||
|
<pre><code class="language-lua">vim.api.nvim_create_autocmd( {"BufNewFile","BufReadPre" }, {
|
||||||
|
group = vim.api.nvim_create_augroup("PrivateJrnl", {}),
|
||||||
|
pattern = "*.jrnl",
|
||||||
|
callback = function()
|
||||||
|
vim.o.shada = ""
|
||||||
|
vim.o.swapfile = false
|
||||||
|
vim.o.undofile = false
|
||||||
|
vim.o.backup = false
|
||||||
|
vim.o.writebackup = false
|
||||||
|
vim.o.shelltemp = false
|
||||||
|
vim.o.history = 0
|
||||||
|
vim.o.modeline = false
|
||||||
|
vim.o.secure = true
|
||||||
|
end,
|
||||||
|
})
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>If you're using a <a href="../reference-config-file/#template">template</a>, you will
|
||||||
|
have to use the template's file extension instead of <code>.jrnl</code>.</p>
|
||||||
|
</div>
|
||||||
|
<p>Please see <code>:h <option></code> in Neovim for more information about the options mentioned.</p>
|
||||||
|
<h2 id="notice-any-other-risks">Notice any other risks?</h2>
|
||||||
|
<p>Please let the maintainers know by <a href="https://github.com/jrnl-org/jrnl/issues">filing an issue on GitHub</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../journal-types/" class="btn btn-neutral float-left" title="Journal Types"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../formats/" class="btn btn-neutral float-right" title="Formats">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../journal-types/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../formats/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
429
site/reference-command-line/index.html
Normal file
|
@ -0,0 +1,429 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/reference-command-line/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Command Line - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Command Line";
|
||||||
|
var mkdocs_page_input_path = "reference-command-line.md";
|
||||||
|
var mkdocs_page_url = "/reference-command-line/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Command Line</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#standalone-commands">Standalone Commands</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-help">--help</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-version">--version</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-list">--list</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-encrypt">---encrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-decrypt">--decrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-import">--import</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#writing-new-entries">Writing new entries</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#searching">Searching</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#searching-options">Searching Options</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-edit">--edit</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-delete">--delete</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-change-time-date">--change-time DATE</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-format-type">--format TYPE</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#optional-parameters">Optional parameters</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-tags">--tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-short">--short</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#configuration-arguments">Configuration arguments</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-config-override-config_key-config_value">--config-override CONFIG_KEY CONFIG_VALUE</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-config-file-config_file_path">--config-file CONFIG_FILE_PATH</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#other-arguments">Other Arguments</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-debug">--debug</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#-diagnostic">--diagnostic</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>Reference »</li>
|
||||||
|
<li>Command Line</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/reference-command-line.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="command-line-reference">Command Line Reference</h1>
|
||||||
|
<h2 id="synopsis">Synopsis</h2>
|
||||||
|
<pre><code>usage: jrnl [--debug] [--help] [--version] [--list] [--encrypt] [--decrypt]
|
||||||
|
[--import] [-on DATE] [-today-in-history] [-month DATE]
|
||||||
|
[-day DATE] [-year DATE] [-from DATE] [-to DATE] [-contains TEXT]
|
||||||
|
[-and] [-starred] [-n [NUMBER]] [-not [TAG]] [--edit] [--delete]
|
||||||
|
[--format TYPE] [--tags] [--short]
|
||||||
|
[--config-override CONFIG_KEY CONFIG_VALUE]
|
||||||
|
[--config-file CONFIG_FILE_PATH]
|
||||||
|
[[...]]
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="standalone-commands">Standalone Commands</h2>
|
||||||
|
<p>These commands will exit after they complete. You may only run one at a time.</p>
|
||||||
|
<h3 id="-help">--help</h3>
|
||||||
|
<p>Show a help message.</p>
|
||||||
|
<h3 id="-version">--version</h3>
|
||||||
|
<p>Print version and license information.</p>
|
||||||
|
<h3 id="-list">--list</h3>
|
||||||
|
<p>List the config file location, all configured journals, and their locations.</p>
|
||||||
|
<h3 id="-encrypt">---encrypt</h3>
|
||||||
|
<p>Encrypt a journal. See <a href="../encryption/">encryption</a> for more information.</p>
|
||||||
|
<h3 id="-decrypt">--decrypt</h3>
|
||||||
|
<p>Decrypt a journal. See <a href="../encryption/">encryption</a> for more information.</p>
|
||||||
|
<h3 id="-import">--import</h3>
|
||||||
|
<p>Import entries from another journal. If any entries have the exact same content
|
||||||
|
and timestamp, they will be deduplicated.</p>
|
||||||
|
<p>Optional parameters:</p>
|
||||||
|
<pre><code class="language-sh">--file FILENAME
|
||||||
|
</code></pre>
|
||||||
|
<p>Specify a file to import. If not provided, <code>jrnl</code> will use STDIN as the data source.</p>
|
||||||
|
<pre><code class="language-sh">--format TYPE
|
||||||
|
</code></pre>
|
||||||
|
<p>Specify the format of the file that is being imported. Defaults to the same data
|
||||||
|
storage method that jrnl uses. See <a href="../formats/">formats</a> for more information.</p>
|
||||||
|
<h2 id="writing-new-entries">Writing new entries</h2>
|
||||||
|
<p>See <a href="../usage/">Basic Usage</a>.</p>
|
||||||
|
<h2 id="searching">Searching</h2>
|
||||||
|
<p>To find entries from your journal, use any combination of the below filters.
|
||||||
|
Only entries that match all the filters will be displayed.</p>
|
||||||
|
<p>When specifying dates, you can use the same kinds of dates you use for new
|
||||||
|
entries, such as <code>yesterday</code>, <code>today</code>, <code>Tuesday</code>, or <code>2021-08-01</code>.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Search Argument</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>-on DATE</td>
|
||||||
|
<td>Show entries on this date</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-today-in-history</td>
|
||||||
|
<td>Show entries of today over the years</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-month DATE</td>
|
||||||
|
<td>Show entries on this month of any year</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-day DATE</td>
|
||||||
|
<td>Show entries on this day of any month</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-year DATE</td>
|
||||||
|
<td>Show entries of a specific year</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-from DATE</td>
|
||||||
|
<td>Show entries after, or on, this date</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-to DATE</td>
|
||||||
|
<td>Show entries before, or on, this date (alias: -until)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-contains TEXT</td>
|
||||||
|
<td>Show entries containing specific text (put quotes around text with spaces)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-and</td>
|
||||||
|
<td>Show only entries that match all conditions, like saying "x AND y" (default: OR)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-starred</td>
|
||||||
|
<td>Show only starred entries (marked with *)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-tagged</td>
|
||||||
|
<td>Show only tagged entries (marked with the <a href="../reference-config-file/#tagsymbols">configured tagsymbols</a>)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-n [NUMBER]</td>
|
||||||
|
<td>Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the same effect)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not [TAG]</td>
|
||||||
|
<td>Exclude entries with this tag</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not -starred</td>
|
||||||
|
<td>Exclude entries that are starred</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>-not -tagged</td>
|
||||||
|
<td>Exclude entries that are tagged</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h2 id="searching-options">Searching Options</h2>
|
||||||
|
<p>These help you do various tasks with the selected entries from your search.
|
||||||
|
If used on their own (with no search), they will act on your entire journal.</p>
|
||||||
|
<h3 id="-edit">--edit</h3>
|
||||||
|
<p>Opens the selected entries in your configured editor. It will fail if the
|
||||||
|
<code>editor</code> key is not set in your config file.</p>
|
||||||
|
<p>Once you begin editing, you can add multiple entries and delete entries
|
||||||
|
by modifying the text in your editor. When your editor closes, jrnl reads
|
||||||
|
the temporary file you were editing and makes the changes to your journal.</p>
|
||||||
|
<h3 id="-delete">--delete</h3>
|
||||||
|
<p>Interactively deletes selected entries. You'll be asked to confirm deletion of
|
||||||
|
each entry.</p>
|
||||||
|
<h3 id="-change-time-date">--change-time DATE</h3>
|
||||||
|
<p>Interactively changes the time of the selected entries to the date specified,
|
||||||
|
or to right now if no date is specified. You'll be asked to confirm each entry,
|
||||||
|
unless you are using this with <code>--edit</code> on a single entry.</p>
|
||||||
|
<h3 id="-format-type">--format TYPE</h3>
|
||||||
|
<p>Display selected entries in an alternate format. See <a href="../formats/">formats</a>.</p>
|
||||||
|
<h4 id="optional-parameters">Optional parameters</h4>
|
||||||
|
<pre><code class="language-sh">--file FILENAME
|
||||||
|
</code></pre>
|
||||||
|
<p>Write output to file instead of STDOUT. In most shells, the
|
||||||
|
same effect can be achieved using <code>></code>.</p>
|
||||||
|
<h3 id="-tags">--tags</h3>
|
||||||
|
<p>Alias for '--format tags'. Returns a list of all tags and the number of times
|
||||||
|
they occur within the searched entries. If there are no tags found, <code>jrnl</code> will output a message saying so.</p>
|
||||||
|
<h3 id="-short">--short</h3>
|
||||||
|
<p>Only shows the date and titles of the searched entries.</p>
|
||||||
|
<h2 id="configuration-arguments">Configuration arguments</h2>
|
||||||
|
<h3 id="-config-override-config_key-config_value">--config-override CONFIG_KEY CONFIG_VALUE</h3>
|
||||||
|
<p>Override configured key-value pair with CONFIG_KV_PAIR for this command invocation only. To access config keys that aren't at the top level, separate the keys with a dot, such as <code>colors.title</code> to access the <code>title</code> key within the <code>colors</code> key. Read <a href="../advanced/">advanced usage</a> for examples.</p>
|
||||||
|
<h3 id="-config-file-config_file_path">--config-file CONFIG_FILE_PATH</h3>
|
||||||
|
<p>Use the config file at CONFIG_FILE_PATH for this command invocation only.
|
||||||
|
Read <a href="../advanced/">advanced usage</a> for examples.</p>
|
||||||
|
<h2 id="other-arguments">Other Arguments</h2>
|
||||||
|
<h3 id="-debug">--debug</h3>
|
||||||
|
<p>Prints information useful for troubleshooting while <code>jrnl</code> executes.</p>
|
||||||
|
<h3 id="-diagnostic">--diagnostic</h3>
|
||||||
|
<p>Prints diagnostic information useful for <a href="https://github.com/jrnl-org/jrnl/issues">reporting issues</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../tips-and-tricks/" class="btn btn-neutral float-left" title="Tips and Tricks"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../reference-config-file/" class="btn btn-neutral float-right" title="Configuration File">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../tips-and-tricks/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-config-file/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
349
site/reference-config-file/index.html
Normal file
|
@ -0,0 +1,349 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/reference-config-file/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Configuration File - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Configuration File";
|
||||||
|
var mkdocs_page_input_path = "reference-config-file.md";
|
||||||
|
var mkdocs_page_url = "/reference-config-file/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Configuration File</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#config-location">Config location</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#config-format">Config format</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#config-keys">Config keys</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#journals">journals</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#editor">editor</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#encrypt">encrypt</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#template">template</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#tagsymbols">tagsymbols</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#default_hour-and-default_minute">default_hour and default_minute</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#timeformat">timeformat</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#highlight">highlight</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#linewrap">linewrap</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#colors">colors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#display_format">display_format</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#version">version</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>Reference »</li>
|
||||||
|
<li>Configuration File</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/reference-config-file.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="configuration-file-reference">Configuration File Reference</h1>
|
||||||
|
<p><code>jrnl</code> stores its information in a YAML configuration file.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Backup your journal and config file before editing. Changes to the config file
|
||||||
|
can have destructive effects on your journal!</p>
|
||||||
|
</div>
|
||||||
|
<h2 id="config-location">Config location</h2>
|
||||||
|
<p>You can find your configuration file location by running:
|
||||||
|
<code>jrnl --list</code></p>
|
||||||
|
<p>By default, the configuration file is <code>~/.config/jrnl/jrnl.yaml</code>.
|
||||||
|
If you have the <code>XDG_CONFIG_HOME</code> variable set, the configuration
|
||||||
|
file will be saved as <code>$XDG_CONFIG_HOME/jrnl/jrnl.yaml</code>.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>On Windows, the configuration file is typically found at
|
||||||
|
<code>%USERPROFILE%\.config\jrnl\jrnl.yaml</code>.</p>
|
||||||
|
</div>
|
||||||
|
<h2 id="config-format">Config format</h2>
|
||||||
|
<p>The configuration file is a <a href="https://yaml.org/">YAML</a> file and can be edited with
|
||||||
|
a text editor.</p>
|
||||||
|
<h2 id="config-keys">Config keys</h2>
|
||||||
|
<h3 id="journals">journals</h3>
|
||||||
|
<p>Describes each journal used by <code>jrnl</code>. Each indented key after this key is
|
||||||
|
the name of a journal.</p>
|
||||||
|
<p>If a journal key has a value, that value will be interpreted as the path
|
||||||
|
to the journal. Otherwise, the journal needs the additional indented key
|
||||||
|
<code>journal</code> to specify its path.</p>
|
||||||
|
<p>All keys below can be specified for each journal at the same level as the
|
||||||
|
<code>journal</code> key. If a key conflicts with a top-level key, the journal-specific
|
||||||
|
key will be used instead.</p>
|
||||||
|
<h3 id="editor">editor</h3>
|
||||||
|
<p>If set, executes this command to launch an external editor for
|
||||||
|
writing and editing your entries. The path to a temporary file
|
||||||
|
is passed after it, and <code>jrnl</code> processes the file once
|
||||||
|
the editor returns control to <code>jrnl</code>.</p>
|
||||||
|
<p>Some editors require special options to work properly, since they must be
|
||||||
|
blocking processes to work with <code>jrnl</code>. See <a href="../external-editors/">External Editors</a>
|
||||||
|
for details.</p>
|
||||||
|
<h3 id="encrypt">encrypt</h3>
|
||||||
|
<p>If <code>true</code>, encrypts your journal using AES. Do not change this
|
||||||
|
value for journals that already have data in them.</p>
|
||||||
|
<h3 id="template">template</h3>
|
||||||
|
<p>The path to a text file to use as a template for new entries. Only works when you
|
||||||
|
have the <code>editor</code> field configured. If you use a template, the editor's
|
||||||
|
<a href="../privacy-and-security/#files-in-transit-from-editor-to-jrnl">temporary files</a>
|
||||||
|
will have the same extension as the template.</p>
|
||||||
|
<h3 id="tagsymbols">tagsymbols</h3>
|
||||||
|
<p>Symbols to be interpreted as tags.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Although it seems intuitive to use the <code>#</code>
|
||||||
|
character for tags, there's a drawback: on most shells, this is
|
||||||
|
interpreted as a meta-character starting a comment. This means that if
|
||||||
|
you type</p>
|
||||||
|
<blockquote>
|
||||||
|
<p><code>jrnl Implemented endless scrolling on the #frontend of our website.</code></p>
|
||||||
|
</blockquote>
|
||||||
|
<p>your bash will chop off everything after the <code>#</code> before passing it to
|
||||||
|
<code>jrnl</code>. To avoid this, wrap your input into quotation marks like
|
||||||
|
this:</p>
|
||||||
|
<blockquote>
|
||||||
|
<p><code>jrnl "Implemented endless scrolling on the #frontend of our website."</code></p>
|
||||||
|
</blockquote>
|
||||||
|
</div>
|
||||||
|
<p>Or use the built-in prompt or an external editor to compose your
|
||||||
|
entries.</p>
|
||||||
|
<h3 id="default_hour-and-default_minute">default_hour and default_minute</h3>
|
||||||
|
<p>Entries will be created at this time if you supply a date but no specific time (for example, <code>last thursday</code>).</p>
|
||||||
|
<h3 id="timeformat">timeformat</h3>
|
||||||
|
<p>Defines how to format the timestamps as they are stored in your journal.
|
||||||
|
See the <a href="http://docs.python.org/library/time.html#time.strftime">python docs</a> for reference.</p>
|
||||||
|
<p>Do not change this for an existing journal, since that might lead
|
||||||
|
to data loss.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p><code>jrnl</code> doesn't support the <code>%z</code> or <code>%Z</code> time zone identifiers.</p>
|
||||||
|
</div>
|
||||||
|
<h3 id="highlight">highlight</h3>
|
||||||
|
<p>If <code>true</code>, tags will be highlighted in cyan.</p>
|
||||||
|
<h3 id="linewrap">linewrap</h3>
|
||||||
|
<p>Controls the width of the output. Set to <code>false</code> if you don't want to
|
||||||
|
wrap long lines. Set to <code>auto</code> to let <code>jrnl</code> automatically determine
|
||||||
|
the terminal width.</p>
|
||||||
|
<h3 id="colors">colors</h3>
|
||||||
|
<p>A dictionary that controls the colors used to display journal entries.
|
||||||
|
It has four subkeys, which are: <code>body</code>, <code>date</code>, <code>tags</code>, and <code>title</code>.</p>
|
||||||
|
<p>Current valid values are: <code>BLACK</code>, <code>RED</code>, <code>GREEN</code>, <code>YELLOW</code>, <code>BLUE</code>,
|
||||||
|
<code>MAGENTA</code>, <code>CYAN</code>, <code>WHITE</code>, and <code>NONE</code>.</p>
|
||||||
|
<p><code>colorama.Fore</code> is used for colorization, and you can find the <a href="https://github.com/tartley/colorama#colored-output">docs here</a>.</p>
|
||||||
|
<p>To disable colored output, set the value to <code>NONE</code>.</p>
|
||||||
|
<h3 id="display_format">display_format</h3>
|
||||||
|
<p>Specifies formatter to use by default. See <a href="../formats/">formats</a>.</p>
|
||||||
|
<h3 id="version">version</h3>
|
||||||
|
<p><code>jrnl</code> automatically updates this field to the version that it is running.
|
||||||
|
There is no need to change this field manually.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../reference-command-line/" class="btn btn-neutral float-left" title="Command Line"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../contributing/" class="btn btn-neutral float-right" title="Contributing to jrnl">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-command-line/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../contributing/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
2
site/requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
mkdocs>=1.4
|
||||||
|
jinja2==3.1.3
|
226
site/search.html
Normal file
|
@ -0,0 +1,226 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" />
|
||||||
|
<link rel="shortcut icon" href="./img/favicon.ico" />
|
||||||
|
<title>jrnl</title>
|
||||||
|
<link rel="stylesheet" href="./css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="./css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="./assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="./assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="./assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="./js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href="./." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="./search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="./ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="./ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="./.">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="./." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="content_search" class="wy-form mkdocs-search" action="./search.html" method="get">
|
||||||
|
|
||||||
|
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
|
||||||
|
<input
|
||||||
|
name="q"
|
||||||
|
id="mkdocs-search-query"
|
||||||
|
type="text"
|
||||||
|
class="search_input search-query ui-autocomplete-input"
|
||||||
|
placeholder="Search the Docs"
|
||||||
|
autocomplete="off"
|
||||||
|
autofocus
|
||||||
|
title="Type search term here"
|
||||||
|
>
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h1 id="search">Results</h1>
|
||||||
|
|
||||||
|
<div id="mkdocs-search-results" class="search-results">
|
||||||
|
Searching...
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="./js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = ".";</script>
|
||||||
|
<script src="./js/theme_extra.js"></script>
|
||||||
|
<script src="./js/theme.js"></script>
|
||||||
|
<script src="./search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
3475
site/search/lunr.js
Normal file
109
site/search/main.js
Normal file
|
@ -0,0 +1,109 @@
|
||||||
|
function getSearchTermFromLocation() {
|
||||||
|
var sPageURL = window.location.search.substring(1);
|
||||||
|
var sURLVariables = sPageURL.split('&');
|
||||||
|
for (var i = 0; i < sURLVariables.length; i++) {
|
||||||
|
var sParameterName = sURLVariables[i].split('=');
|
||||||
|
if (sParameterName[0] == 'q') {
|
||||||
|
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function joinUrl (base, path) {
|
||||||
|
if (path.substring(0, 1) === "/") {
|
||||||
|
// path starts with `/`. Thus it is absolute.
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
if (base.substring(base.length-1) === "/") {
|
||||||
|
// base ends with `/`
|
||||||
|
return base + path;
|
||||||
|
}
|
||||||
|
return base + "/" + path;
|
||||||
|
}
|
||||||
|
|
||||||
|
function escapeHtml (value) {
|
||||||
|
return value.replace(/&/g, '&')
|
||||||
|
.replace(/"/g, '"')
|
||||||
|
.replace(/</g, '<')
|
||||||
|
.replace(/>/g, '>');
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatResult (location, title, summary) {
|
||||||
|
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function displayResults (results) {
|
||||||
|
var search_results = document.getElementById("mkdocs-search-results");
|
||||||
|
while (search_results.firstChild) {
|
||||||
|
search_results.removeChild(search_results.firstChild);
|
||||||
|
}
|
||||||
|
if (results.length > 0){
|
||||||
|
for (var i=0; i < results.length; i++){
|
||||||
|
var result = results[i];
|
||||||
|
var html = formatResult(result.location, result.title, result.summary);
|
||||||
|
search_results.insertAdjacentHTML('beforeend', html);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var noResultsText = search_results.getAttribute('data-no-results-text');
|
||||||
|
if (!noResultsText) {
|
||||||
|
noResultsText = "No results found";
|
||||||
|
}
|
||||||
|
search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function doSearch () {
|
||||||
|
var query = document.getElementById('mkdocs-search-query').value;
|
||||||
|
if (query.length > min_search_length) {
|
||||||
|
if (!window.Worker) {
|
||||||
|
displayResults(search(query));
|
||||||
|
} else {
|
||||||
|
searchWorker.postMessage({query: query});
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Clear results for short queries
|
||||||
|
displayResults([]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function initSearch () {
|
||||||
|
var search_input = document.getElementById('mkdocs-search-query');
|
||||||
|
if (search_input) {
|
||||||
|
search_input.addEventListener("keyup", doSearch);
|
||||||
|
}
|
||||||
|
var term = getSearchTermFromLocation();
|
||||||
|
if (term) {
|
||||||
|
search_input.value = term;
|
||||||
|
doSearch();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWorkerMessage (e) {
|
||||||
|
if (e.data.allowSearch) {
|
||||||
|
initSearch();
|
||||||
|
} else if (e.data.results) {
|
||||||
|
var results = e.data.results;
|
||||||
|
displayResults(results);
|
||||||
|
} else if (e.data.config) {
|
||||||
|
min_search_length = e.data.config.min_search_length-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!window.Worker) {
|
||||||
|
console.log('Web Worker API not supported');
|
||||||
|
// load index in main thread
|
||||||
|
$.getScript(joinUrl(base_url, "search/worker.js")).done(function () {
|
||||||
|
console.log('Loaded worker');
|
||||||
|
init();
|
||||||
|
window.postMessage = function (msg) {
|
||||||
|
onWorkerMessage({data: msg});
|
||||||
|
};
|
||||||
|
}).fail(function (jqxhr, settings, exception) {
|
||||||
|
console.error('Could not load worker.js');
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
// Wrap search in a web worker
|
||||||
|
var searchWorker = new Worker(joinUrl(base_url, "search/worker.js"));
|
||||||
|
searchWorker.postMessage({init: true});
|
||||||
|
searchWorker.onmessage = onWorkerMessage;
|
||||||
|
}
|
1
site/search/search_index.json
Normal file
133
site/search/worker.js
Normal file
|
@ -0,0 +1,133 @@
|
||||||
|
var base_path = 'function' === typeof importScripts ? '.' : '/search/';
|
||||||
|
var allowSearch = false;
|
||||||
|
var index;
|
||||||
|
var documents = {};
|
||||||
|
var lang = ['en'];
|
||||||
|
var data;
|
||||||
|
|
||||||
|
function getScript(script, callback) {
|
||||||
|
console.log('Loading script: ' + script);
|
||||||
|
$.getScript(base_path + script).done(function () {
|
||||||
|
callback();
|
||||||
|
}).fail(function (jqxhr, settings, exception) {
|
||||||
|
console.log('Error: ' + exception);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function getScriptsInOrder(scripts, callback) {
|
||||||
|
if (scripts.length === 0) {
|
||||||
|
callback();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
getScript(scripts[0], function() {
|
||||||
|
getScriptsInOrder(scripts.slice(1), callback);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadScripts(urls, callback) {
|
||||||
|
if( 'function' === typeof importScripts ) {
|
||||||
|
importScripts.apply(null, urls);
|
||||||
|
callback();
|
||||||
|
} else {
|
||||||
|
getScriptsInOrder(urls, callback);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onJSONLoaded () {
|
||||||
|
data = JSON.parse(this.responseText);
|
||||||
|
var scriptsToLoad = ['lunr.js'];
|
||||||
|
if (data.config && data.config.lang && data.config.lang.length) {
|
||||||
|
lang = data.config.lang;
|
||||||
|
}
|
||||||
|
if (lang.length > 1 || lang[0] !== "en") {
|
||||||
|
scriptsToLoad.push('lunr.stemmer.support.js');
|
||||||
|
if (lang.length > 1) {
|
||||||
|
scriptsToLoad.push('lunr.multi.js');
|
||||||
|
}
|
||||||
|
if (lang.includes("ja") || lang.includes("jp")) {
|
||||||
|
scriptsToLoad.push('tinyseg.js');
|
||||||
|
}
|
||||||
|
for (var i=0; i < lang.length; i++) {
|
||||||
|
if (lang[i] != 'en') {
|
||||||
|
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
loadScripts(scriptsToLoad, onScriptsLoaded);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onScriptsLoaded () {
|
||||||
|
console.log('All search scripts loaded, building Lunr index...');
|
||||||
|
if (data.config && data.config.separator && data.config.separator.length) {
|
||||||
|
lunr.tokenizer.separator = new RegExp(data.config.separator);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data.index) {
|
||||||
|
index = lunr.Index.load(data.index);
|
||||||
|
data.docs.forEach(function (doc) {
|
||||||
|
documents[doc.location] = doc;
|
||||||
|
});
|
||||||
|
console.log('Lunr pre-built index loaded, search ready');
|
||||||
|
} else {
|
||||||
|
index = lunr(function () {
|
||||||
|
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
|
||||||
|
this.use(lunr[lang[0]]);
|
||||||
|
} else if (lang.length > 1) {
|
||||||
|
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
|
||||||
|
}
|
||||||
|
this.field('title');
|
||||||
|
this.field('text');
|
||||||
|
this.ref('location');
|
||||||
|
|
||||||
|
for (var i=0; i < data.docs.length; i++) {
|
||||||
|
var doc = data.docs[i];
|
||||||
|
this.add(doc);
|
||||||
|
documents[doc.location] = doc;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
console.log('Lunr index built, search ready');
|
||||||
|
}
|
||||||
|
allowSearch = true;
|
||||||
|
postMessage({config: data.config});
|
||||||
|
postMessage({allowSearch: allowSearch});
|
||||||
|
}
|
||||||
|
|
||||||
|
function init () {
|
||||||
|
var oReq = new XMLHttpRequest();
|
||||||
|
oReq.addEventListener("load", onJSONLoaded);
|
||||||
|
var index_path = base_path + '/search_index.json';
|
||||||
|
if( 'function' === typeof importScripts ){
|
||||||
|
index_path = 'search_index.json';
|
||||||
|
}
|
||||||
|
oReq.open("GET", index_path);
|
||||||
|
oReq.send();
|
||||||
|
}
|
||||||
|
|
||||||
|
function search (query) {
|
||||||
|
if (!allowSearch) {
|
||||||
|
console.error('Assets for search still loading');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var resultDocuments = [];
|
||||||
|
var results = index.search(query);
|
||||||
|
for (var i=0; i < results.length; i++){
|
||||||
|
var result = results[i];
|
||||||
|
doc = documents[result.ref];
|
||||||
|
doc.summary = doc.text.substring(0, 200);
|
||||||
|
resultDocuments.push(doc);
|
||||||
|
}
|
||||||
|
return resultDocuments;
|
||||||
|
}
|
||||||
|
|
||||||
|
if( 'function' === typeof importScripts ) {
|
||||||
|
onmessage = function (e) {
|
||||||
|
if (e.data.init) {
|
||||||
|
init();
|
||||||
|
} else if (e.data.query) {
|
||||||
|
postMessage({ results: search(e.data.query) });
|
||||||
|
} else {
|
||||||
|
console.error("Worker - Unrecognized message: " + e);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
107
site/sitemap.xml
Normal file
|
@ -0,0 +1,107 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/advanced/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/contributing/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/encryption/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/external-editors/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/formats/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/installation/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/journal-types/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/overview/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/privacy-and-security/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/reference-command-line/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/reference-config-file/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/tips-and-tricks/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/usage/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/advanced/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/contributing/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/encryption/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/external-editors/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/formats/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/installation/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/journal-types/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/overview/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/privacy-and-security/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/reference-command-line/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/reference-config-file/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/tips-and-tricks/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://jrnl.sh/ja/usage/</loc>
|
||||||
|
<lastmod>2024-09-26</lastmod>
|
||||||
|
</url>
|
||||||
|
</urlset>
|
BIN
site/sitemap.xml.gz
Normal file
392
site/tips-and-tricks/index.html
Normal file
|
@ -0,0 +1,392 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/tips-and-tricks/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Tips and Tricks - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Tips and Tricks";
|
||||||
|
var mkdocs_page_input_path = "tips-and-tricks.md";
|
||||||
|
var mkdocs_page_url = "/tips-and-tricks/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../usage/">Basic Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Tips and Tricks</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#co-occurrence-of-tags">Co-occurrence of tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#combining-filters">Combining filters</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#statistics">Statistics</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#importing-older-files">Importing older files</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#using-templates">Using Templates</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#1-use-the-template-command-line-argument-and-the-default-xdg_data_homejrnltemplates-directory">1. Use the --template command line argument and the default $XDG_DATA_HOME/jrnl/templates directory</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#2-use-the-template-command-line-argument-with-a-local-absolute-path">2. Use the --template command line argument with a local / absolute path</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#3-set-a-default-template-file-in-jrnlyaml">3. Set a default template file in jrnl.yaml</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#prompts-on-shell-reload">Prompts on shell reload</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#display-random-entry">Display random entry</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#launch-a-terminal-for-rapid-logging">Launch a terminal for rapid logging</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#visualize-formatted-markdown-in-the-cli">Visualize Formatted Markdown in the CLI</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#jump-to-end-of-buffer-with-vi">Jump to end of buffer (with vi)</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Tips and Tricks</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/tips-and-tricks.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="tips-and-tricks">Tips and Tricks</h1>
|
||||||
|
<p>This page contains tips and tricks for using <code>jrnl</code>, often in conjunction
|
||||||
|
with other tools, including external editors.</p>
|
||||||
|
<h2 id="co-occurrence-of-tags">Co-occurrence of tags</h2>
|
||||||
|
<p>If I want to find out how often I mentioned my flatmates Alberto and
|
||||||
|
Melo in the same entry, I run</p>
|
||||||
|
<pre><code class="language-sh">jrnl @alberto --tags | grep @melo
|
||||||
|
</code></pre>
|
||||||
|
<p>And will get something like <code>@melo: 9</code>, meaning there are 9 entries
|
||||||
|
where both <code>@alberto</code> and <code>@melo</code> are tagged. How does this work? First,
|
||||||
|
<code>jrnl @alberto</code> will filter the journal to only entries containing the
|
||||||
|
tag <code>@alberto</code>, and then the <code>--tags</code> option will print out how often
|
||||||
|
each tag occurred in this filtered journal. Finally, we pipe this to
|
||||||
|
<code>grep</code> which will only display the line containing <code>@melo</code>.</p>
|
||||||
|
<h2 id="combining-filters">Combining filters</h2>
|
||||||
|
<p>You can do things like</p>
|
||||||
|
<pre><code class="language-sh">jrnl @fixed -starred -n 10 -to "jan 2013" --short
|
||||||
|
</code></pre>
|
||||||
|
<p>To get a short summary of the 10 most recent, favourite entries before
|
||||||
|
January 1, 2013 that are tagged with <code>@fixed</code>.</p>
|
||||||
|
<h2 id="statistics">Statistics</h2>
|
||||||
|
<p>How much did I write last year?</p>
|
||||||
|
<pre><code class="language-sh">jrnl -from "jan 1 2013" -to "dec 31 2013" | wc -w
|
||||||
|
</code></pre>
|
||||||
|
<p>Will give you the number of words you wrote in 2013. How long is my
|
||||||
|
average entry?</p>
|
||||||
|
<pre><code class="language-sh">expr $(jrnl --export text | wc -w) / $(jrnl --short | wc -l)
|
||||||
|
</code></pre>
|
||||||
|
<p>This will first get the total number of words in the journal and divide
|
||||||
|
it by the number of entries (this works because <code>jrnl --short</code> will
|
||||||
|
print exactly one line per entry).</p>
|
||||||
|
<h2 id="importing-older-files">Importing older files</h2>
|
||||||
|
<p>If you want to import a file as an entry to <code>jrnl</code>, you can just do <code>jrnl < entry.ext</code>. But what if you want the modification date of the file to
|
||||||
|
be the date of the entry in <code>jrnl</code>? Try this</p>
|
||||||
|
<pre><code class="language-sh">echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' entry.txt` `cat entry.txt` | jrnl
|
||||||
|
</code></pre>
|
||||||
|
<p>The first part will format the modification date of <code>entry.txt</code>, and
|
||||||
|
then combine it with the contents of the file before piping it to jrnl.
|
||||||
|
If you do that often, consider creating a function in your <code>.bashrc</code> or
|
||||||
|
<code>.bash_profile</code></p>
|
||||||
|
<pre><code class="language-sh">jrnlimport () {
|
||||||
|
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' $1` `cat $1` | jrnl
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="using-templates">Using Templates</h2>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Templates require an <a href="../advanced/">external editor</a> be configured.</p>
|
||||||
|
</div>
|
||||||
|
<p>Templates are text files that are used for creating structured journals.
|
||||||
|
There are three ways you can use templates:</p>
|
||||||
|
<h3 id="1-use-the-template-command-line-argument-and-the-default-xdg_data_homejrnltemplates-directory">1. Use the <code>--template</code> command line argument and the default $XDG_DATA_HOME/jrnl/templates directory</h3>
|
||||||
|
<p><code>$XDG_DATA_HOME/jrnl/templates</code> is created by default to store your templates! Create a template (like <code>default.md</code>) in this directory and pass <code>--template FILE_IN_DIR</code>.</p>
|
||||||
|
<pre><code class="language-sh">jrnl --template default.md
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="2-use-the-template-command-line-argument-with-a-local-absolute-path">2. Use the <code>--template</code> command line argument with a local / absolute path</h3>
|
||||||
|
<p>You can create a template file with any text. Here is an example:</p>
|
||||||
|
<pre><code class="language-sh"># /tmp/template.txt
|
||||||
|
My Personal Journal
|
||||||
|
Title:
|
||||||
|
|
||||||
|
Body:
|
||||||
|
</code></pre>
|
||||||
|
<p>Then, pass the absolute or relative path to the template file as an argument, and your external
|
||||||
|
editor will open and have your template pre-populated.</p>
|
||||||
|
<pre><code class="language-sh">jrnl --template /tmp/template.md
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="3-set-a-default-template-file-in-jrnlyaml">3. Set a default template file in <code>jrnl.yaml</code></h3>
|
||||||
|
<p>If you want a template by default, change the value of <code>template</code> in the <a href="../reference-config-file/">config file</a>
|
||||||
|
from <code>false</code> to the template file's path, wrapped in double quotes:</p>
|
||||||
|
<pre><code class="language-sh">...
|
||||||
|
template: "/path/to/template.txt"
|
||||||
|
...
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition tip">
|
||||||
|
<p class="admonition-title">Tip</p>
|
||||||
|
<p>To read your journal entry or to verify the entry saved, you can use this
|
||||||
|
command: <code>jrnl -n 1</code> (Check out <a href="../formats/">Formats</a> for more options).</p>
|
||||||
|
</div>
|
||||||
|
<pre><code class="language-sh">jrnl -n 1
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="prompts-on-shell-reload">Prompts on shell reload</h2>
|
||||||
|
<p>If you'd like to be prompted each time you refresh your shell, you can include
|
||||||
|
this in your <code>.bash_profile</code>:</p>
|
||||||
|
<pre><code class="language-sh">function log_question()
|
||||||
|
{
|
||||||
|
echo $1
|
||||||
|
read
|
||||||
|
jrnl today: ${1}. $REPLY
|
||||||
|
}
|
||||||
|
log_question 'What did I achieve today?'
|
||||||
|
log_question 'What did I make progress with?'
|
||||||
|
</code></pre>
|
||||||
|
<p>Whenever your shell is reloaded, you will be prompted to answer each of the
|
||||||
|
questions in the example above. Each answer will be logged as a separate
|
||||||
|
journal entry at the <code>default_hour</code> and <code>default_minute</code> listed in your
|
||||||
|
<code>jrnl.yaml</code> <a href="../advanced/#configuration-file">config file</a>.</p>
|
||||||
|
<h2 id="display-random-entry">Display random entry</h2>
|
||||||
|
<p>You can use this to select one title at random and then display the whole
|
||||||
|
entry. The invocation of <code>cut</code> needs to match the format of the timestamp.
|
||||||
|
For timestamps that have a space between data and time components, select
|
||||||
|
fields 1 and 2 as shown. For timestamps that have no whitespace, select
|
||||||
|
only field 1.</p>
|
||||||
|
<pre><code class="language-sh">jrnl -on "$(jrnl --short | shuf -n 1 | cut -d' ' -f1,2)"
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="launch-a-terminal-for-rapid-logging">Launch a terminal for rapid logging</h2>
|
||||||
|
<p>You can use this to launch a terminal that is the <code>jrnl</code> stdin prompt so you can start typing away immediately.</p>
|
||||||
|
<pre><code class="language-bash">jrnl --config-override editor ""
|
||||||
|
</code></pre>
|
||||||
|
<p>Bind this to a keyboard shortcut.</p>
|
||||||
|
<p>Map <code>Super+Alt+J</code> to launch the terminal with <code>jrnl</code> prompt</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>xbindkeys</strong>
|
||||||
|
In your <code>.xbindkeysrc</code></li>
|
||||||
|
</ul>
|
||||||
|
<pre><code class="language-ini">Mod4+Mod1+j
|
||||||
|
alacritty -t floating-jrnl -e jrnl --config-override editor "",
|
||||||
|
</code></pre>
|
||||||
|
<ul>
|
||||||
|
<li><strong>I3 WM</strong> Launch a floating terminal with the <code>jrnl</code> prompt</li>
|
||||||
|
</ul>
|
||||||
|
<pre><code class="language-ini">bindsym Mod4+Mod1+j exec --no-startup-id alacritty -t floating-jrnl -e jrnl --config-override editor ""
|
||||||
|
for_window[title="floating *"] floating enable
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="visualize-formatted-markdown-in-the-cli">Visualize Formatted Markdown in the CLI</h2>
|
||||||
|
<p>Out of the box, <code>jrnl</code> can output journal entries in Markdown. To visualize it, you can pipe to <a href="https://github.com/ttscoff/mdless">mdless</a>, which is a <a href="https://en.wikipedia.org/wiki/Less_(Unix)">less</a>-like tool that allows you to visualize your Markdown text with formatting and syntax highlighting from the CLI. You can use this in any shell that supports piping.</p>
|
||||||
|
<p>The simplest way to visualize your Markdown output with <code>mdless</code> is as follows:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --export md | mdless
|
||||||
|
</code></pre>
|
||||||
|
<p>This will render your Markdown output in the whole screen.</p>
|
||||||
|
<p>Fortunately, <code>mdless</code> has an option that allows you to adjust the screen width by using the <code>-w</code> option as follows:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --export md | mdless -w 70
|
||||||
|
</code></pre>
|
||||||
|
<p>If you want Markdown to be your default display format, you can define this in your config file as follows:</p>
|
||||||
|
<pre><code class="language-yaml">display_format: md
|
||||||
|
# or
|
||||||
|
display_format: markdown
|
||||||
|
</code></pre>
|
||||||
|
<p>For more information on how <code>jrnl</code> outputs your entries in Markdown, please visit the <a href="../formats/">Formats</a> section.</p>
|
||||||
|
<h2 id="jump-to-end-of-buffer-with-vi">Jump to end of buffer (with vi)</h2>
|
||||||
|
<p>To cause vi to jump to the end of the last line of the entry you edit, in your config file set:</p>
|
||||||
|
<pre><code class="language-yaml">editor: vi + -c "call cursor('.',strwidth(getline('.')))"
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../external-editors/" class="btn btn-neutral float-left" title="External Editors"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../reference-command-line/" class="btn btn-neutral float-right" title="Command Line">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../external-editors/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../reference-command-line/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
420
site/usage/index.html
Normal file
|
@ -0,0 +1,420 @@
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/usage/" />
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||||
|
<title>Basic Usage - jrnl</title>
|
||||||
|
<link rel="stylesheet" href="../css/theme.css" />
|
||||||
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||||||
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||||||
|
<link href="../assets/colors.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/theme.css" rel="stylesheet" />
|
||||||
|
<link href="../assets/highlight.css" rel="stylesheet" />
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Current page data
|
||||||
|
var mkdocs_page_name = "Basic Usage";
|
||||||
|
var mkdocs_page_input_path = "usage.md";
|
||||||
|
var mkdocs_page_url = "/usage/";
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="../js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||||||
|
<script>hljs.highlightAll();</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav" role="document">
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search">
|
||||||
|
<a href=".." class="icon icon-home"> jrnl
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||||
|
<button class="icon icon-search" aria-label="submit"></button>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../installation/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Basic Usage</a>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#composing-entries">Composing Entries</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#specifying-date-and-time">Specifying Date and Time</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#using-tags">Using Tags</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#starring-entries">Starring Entries</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#viewing-and-searching-entries">Viewing and Searching Entries</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#text-search">Text Search</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#filtering-by-tag">Filtering by Tag</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#viewing-starred-entries">Viewing Starred Entries</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#editing-entries">Editing Entries</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#deleting-entries">Deleting Entries</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#listing-journals">Listing Journals</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../encryption/">Encryption</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../journal-types/">Journal Types</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../privacy-and-security/">Privacy and Security</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../formats/">Formats</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../advanced/">Advanced Usage</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../external-editors/">External Editors</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../tips-and-tricks/">Tips and Tricks</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-command-line/">Command Line</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../reference-config-file/">Configuration File</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../contributing/">Contributing to jrnl</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption"><span class="caption-text">ja</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../ja/overview/">概要</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/installation/">クイックスタート</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/usage/">基本的な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/encryption/">暗号化</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/journal-types/">ジャーナルの種類</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/privacy-and-security/">プライバシーとセキュリティ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/formats/">フォーマット</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/advanced/">高度な使い方</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/external-editors/">外部エディタ</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/tips-and-tricks/">ヒントとコツ</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-command-line/">コマンドライン</a>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/reference-config-file/">設定ファイル</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" >貢献</a>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="../ja/contributing/">jrnlへの貢献</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="..">jrnl</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content"><!--
|
||||||
|
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||||||
|
Then lightly modified for accessibility
|
||||||
|
-->
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||||||
|
<li>User Guide »</li>
|
||||||
|
<li>Basic Usage</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/usage.md" class="icon icon-github"> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div class="section" itemprop="articleBody">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Copyright © 2012-2023 jrnl contributors
|
||||||
|
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1 id="basic-usage">Basic Usage</h1>
|
||||||
|
<p><code>jrnl</code> has two modes: <strong>composing</strong> and <strong>viewing</strong>. Whenever you don't enter
|
||||||
|
any arguments that start with a dash (<code>-</code>) or double-dash (<code>--</code>), you're in
|
||||||
|
composing mode, meaning that you can write your entry on the command line.</p>
|
||||||
|
<p>We intentionally break a convention on command line arguments: all arguments
|
||||||
|
starting with a <em>single dash</em> (<code>-</code>) will <em>filter</em> your journal before viewing
|
||||||
|
it. Filter arguments can be combined arbitrarily. Arguments with a <em>double dash</em>
|
||||||
|
(<code>--</code>) will <em>control</em> how your journal is displayed or exported. Control
|
||||||
|
arguments are mutually exclusive (i.e., you can only specify one way to display
|
||||||
|
or export your journal at a time).</p>
|
||||||
|
<p>For a list of commands, enter <code>jrnl --help</code>.</p>
|
||||||
|
<h2 id="composing-entries">Composing Entries</h2>
|
||||||
|
<p>Composing mode is entered by either starting <code>jrnl</code> without any arguments --
|
||||||
|
which will launch an external editor -- or by just writing an entry on the
|
||||||
|
command line:</p>
|
||||||
|
<pre><code class="language-text">jrnl today at 3am: I just met Steve Buscemi in a bar! What a nice guy.
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Most shells contain a certain number of reserved characters, such as <code>#</code> and
|
||||||
|
<code>*</code>. These characters, as well as unbalanced single or double quotation
|
||||||
|
marks, parentheses, and others, likely will cause problems. Although
|
||||||
|
reserved characters can be escaped using <code>\</code>, this is not ideal for
|
||||||
|
long-form writing. The solution: first enter <code>jrnl</code> and hit <code>return</code>. You
|
||||||
|
can then enter the text of your journal entry. Alternatively, you can <a href="../advanced/">use
|
||||||
|
an external editor</a>.</p>
|
||||||
|
</div>
|
||||||
|
<p>You can also import an entry directly from a file:</p>
|
||||||
|
<pre><code class="language-sh">jrnl < my_entry.txt
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="specifying-date-and-time">Specifying Date and Time</h3>
|
||||||
|
<p>If you don't specify a date and time (e.g., <code>jrnl finished writing letter to brother</code>), <code>jrnl</code> will create an entry using the current date and time. For retrospective entries, you can use a timestamp to tell <code>jrnl</code> where to put the entry. Timestamps can be entered using a variety of formats. Here are some that work:</p>
|
||||||
|
<ul>
|
||||||
|
<li>at 6am</li>
|
||||||
|
<li>yesterday</li>
|
||||||
|
<li>last monday</li>
|
||||||
|
<li>sunday at noon</li>
|
||||||
|
<li>2 march 2012</li>
|
||||||
|
<li>7 apr</li>
|
||||||
|
<li>5/20/1998 at 23:42</li>
|
||||||
|
<li>2020-05-22T15:55-04:00</li>
|
||||||
|
</ul>
|
||||||
|
<p>If you don't use a timestamp, <code>jrnl</code> will create an entry using the current
|
||||||
|
time. If you use a date only (no time), <code>jrnl</code> will use the default time
|
||||||
|
specified in your <a href="../reference-config-file/#default_hour-and-default_minute">configuration file</a>.
|
||||||
|
Behind the scenes, <code>jrnl</code> reorganizes entries in chronological order.</p>
|
||||||
|
<h3 id="using-tags">Using Tags</h3>
|
||||||
|
<p><code>jrnl</code> supports tags. The default tag symbol is <code>@</code> (largely because <code>#</code> is a
|
||||||
|
reserved character). You can specify your own tag symbol in the
|
||||||
|
<a href="../reference-config-file/#tagsymbols">configuration file</a>. To use tags, preface the
|
||||||
|
desired tag with the symbol:</p>
|
||||||
|
<pre><code class="language-sh">jrnl Had a wonderful day at the @beach with @Tom and @Anna.
|
||||||
|
</code></pre>
|
||||||
|
<p>Although you can use capitals while tagging an entry, searches by tag are
|
||||||
|
case-insensitive.</p>
|
||||||
|
<p>There is no limit to how many tags you can use in an entry.</p>
|
||||||
|
<h3 id="starring-entries">Starring Entries</h3>
|
||||||
|
<p>To mark an entry as a favorite, simply "star" it using an asterisk (<code>*</code>):</p>
|
||||||
|
<pre><code class="language-sh">jrnl last sunday *: Best day of my life.
|
||||||
|
</code></pre>
|
||||||
|
<p>If you don't want to add a date (i.e., you want the date to be entered as
|
||||||
|
<em>now</em>), the following options are equivalent:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>jrnl *: Best day of my life.</code></li>
|
||||||
|
<li><code>jrnl *Best day of my life.</code></li>
|
||||||
|
<li><code>jrnl Best day of my life.*</code></li>
|
||||||
|
</ul>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Make sure that the asterisk (<code>*</code>) is <strong>not</strong> surrounded by whitespaces.
|
||||||
|
<code>jrnl Best day of my life! *</code> will not work because the <code>*</code> character has a
|
||||||
|
special meaning in most shells.</p>
|
||||||
|
</div>
|
||||||
|
<h2 id="viewing-and-searching-entries">Viewing and Searching Entries</h2>
|
||||||
|
<p><code>jrnl</code> can display entries in a variety of ways.</p>
|
||||||
|
<p>To view all entries, enter:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to today
|
||||||
|
</code></pre>
|
||||||
|
<p><code>jrnl</code> provides several filtering commands, prefaced by a single dash (<code>-</code>), that
|
||||||
|
allow you to find a more specific range of entries. For example,</p>
|
||||||
|
<pre><code class="language-sh">jrnl -n 10
|
||||||
|
</code></pre>
|
||||||
|
<p>lists the ten most recent entries. <code>jrnl -10</code> is even more concise and works the
|
||||||
|
same way. If you want to see all of the entries you wrote from the beginning of
|
||||||
|
last year until the end of this past March, you would enter</p>
|
||||||
|
<pre><code class="language-sh">jrnl -from "last year" -to march
|
||||||
|
</code></pre>
|
||||||
|
<p>Filter criteria that use more than one word require surrounding quotes (<code>""</code>).</p>
|
||||||
|
<p>To see entries on a particular date, use <code>-on</code>:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -on yesterday
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="text-search">Text Search</h3>
|
||||||
|
<p>The <code>-contains</code> command displays all entries containing the text you enter after it.
|
||||||
|
This may be helpful when you're searching for entries and you can't remember if you
|
||||||
|
tagged any words when you wrote them.</p>
|
||||||
|
<p>You may realize that you use a word a lot and want to turn it into a tag in all
|
||||||
|
of your previous entries.</p>
|
||||||
|
<pre><code class="language-sh">jrnl -contains "dogs" --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>opens your external editor so that you can add a tag symbol (<code>@</code> by default) to
|
||||||
|
all instances of the word "dogs."</p>
|
||||||
|
<h3 id="filtering-by-tag">Filtering by Tag</h3>
|
||||||
|
<p>You can filter your journal entries by tag. For example,</p>
|
||||||
|
<pre><code class="language-sh">jrnl @pinkie @WorldDomination
|
||||||
|
</code></pre>
|
||||||
|
<p>displays all entries in which either <code>@pinkie</code> or <code>@WorldDomination</code>
|
||||||
|
occurred. Tag filters can be combined with other filters:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -n 5 @pinkie -and @WorldDomination
|
||||||
|
</code></pre>
|
||||||
|
<p>displays the last five entries containing <em>both</em> <code>@pinkie</code> <em>and</em>
|
||||||
|
<code>@worldDomination</code>. You can change which symbols you'd like to use for tagging
|
||||||
|
in the <a href="../reference-config-file/#tagsymbols">configuration file</a>.</p>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>Entering <code>jrnl @pinkie @WorldDomination</code> will display entries in which both
|
||||||
|
tags are present because, although no command line arguments are given, all
|
||||||
|
of the input strings look like tags. <code>jrnl</code> will assume you want to filter
|
||||||
|
by tag, rather than create a new entry that consists only of tags.</p>
|
||||||
|
</div>
|
||||||
|
<p>To view a list of all tags in the journal, enter:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --tags
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="viewing-starred-entries">Viewing Starred Entries</h3>
|
||||||
|
<p>To display only your favorite (starred) entries, enter</p>
|
||||||
|
<pre><code class="language-sh">jrnl -starred
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="editing-entries">Editing Entries</h2>
|
||||||
|
<p>You can edit entries after writing them. This is particularly useful when your
|
||||||
|
journal file is encrypted. To use this feature, you need to have an external
|
||||||
|
editor configured in your <a href="../reference-config-file/#editor">configuration file</a>. You
|
||||||
|
can also edit only the entries that match specific search criteria. For example,</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 1950 @texas -and @history --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>opens your external editor displaying all entries tagged with <code>@texas</code> and
|
||||||
|
<code>@history</code> that were written before 1950. After making changes, save and close
|
||||||
|
the file, and only those entries will be modified (and encrypted, if
|
||||||
|
applicable).</p>
|
||||||
|
<p>If you are using multiple journals, it's easy to edit specific entries from
|
||||||
|
specific journals. Simply prefix the filter string with the name of the journal.
|
||||||
|
For example,</p>
|
||||||
|
<pre><code class="language-sh">jrnl work -n 1 --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>opens the most recent entry in the 'work' journal in your external editor.</p>
|
||||||
|
<h2 id="deleting-entries">Deleting Entries</h2>
|
||||||
|
<p>The <code>--delete</code> command opens an interactive interface for deleting entries. The
|
||||||
|
date and title of each entry in the journal are presented one at a time, and you
|
||||||
|
can choose whether to keep or delete each entry.</p>
|
||||||
|
<p>If no filters are specified, <code>jrnl</code> will ask you to keep or delete each entry in
|
||||||
|
the entire journal, one by one. If there are a lot of entries in the journal, it
|
||||||
|
may be more efficient to filter entries before passing the <code>--delete</code> command.</p>
|
||||||
|
<p>Here's an example. Say you have a journal into which you've imported the last 12
|
||||||
|
years of blog posts. You use the <code>@book</code> tag a lot, and for some reason you want
|
||||||
|
to delete some, but not all, of the entries in which you used that tag, but only
|
||||||
|
the ones you wrote at some point in 2004 or earlier. You're not sure which
|
||||||
|
entries you want to keep, and you want to look through them before deciding.
|
||||||
|
This is what you might enter:</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 2004 @book --delete
|
||||||
|
</code></pre>
|
||||||
|
<p><code>jrnl</code> will show you only the relevant entries, and you can choose the ones you
|
||||||
|
want to delete.</p>
|
||||||
|
<p>You may want to delete <em>all</em> of the entries containing <code>@book</code> that you wrote in
|
||||||
|
2004 or earlier. If there are dozens or hundreds, the easiest way would be to
|
||||||
|
use an external editor. Open an editor with the entries you want to delete...</p>
|
||||||
|
<pre><code class="language-sh">jrnl -to 2004 @book --edit
|
||||||
|
</code></pre>
|
||||||
|
<p>...select everything, delete it, save and close, and all of those entries are
|
||||||
|
removed from the journal.</p>
|
||||||
|
<h2 id="listing-journals">Listing Journals</h2>
|
||||||
|
<p>To list all of your journals:</p>
|
||||||
|
<pre><code class="language-sh">jrnl --list
|
||||||
|
</code></pre>
|
||||||
|
<p>The journals displayed correspond to those specified in the <code>jrnl</code>
|
||||||
|
<a href="../reference-config-file/#journals">configuration file</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div><footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||||
|
<a href="../installation/" class="btn btn-neutral float-left" title="Quickstart"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||||
|
<a href="../encryption/" class="btn btn-neutral float-right" title="Encryption">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<!-- Copyright etc -->
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rst-versions" role="note" aria-label="Versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
|
||||||
|
<span>
|
||||||
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../installation/" style="color: #fcfcfc">« Previous</a></span>
|
||||||
|
|
||||||
|
|
||||||
|
<span><a href="../encryption/" style="color: #fcfcfc">Next »</a></span>
|
||||||
|
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
||||||
|
<script>var base_url = "..";</script>
|
||||||
|
<script src="../js/theme_extra.js"></script>
|
||||||
|
<script src="../js/theme.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|