Skip to content

Commit 21df637

Browse files
authored
Translate language & plugin settings improvement (#142)
* feat(Add): logseq-l10n & ja-JP & plugin settings improvement * feat(Add): Translation zh-CN (Chinese) I don't understand Chinese. I had ChatGPT translate it based on the Japanese translation I made earlier. So please do the validation for this without me. * Improvement of “README”, Japanese translation
1 parent b1de596 commit 21df637

9 files changed

Lines changed: 5193 additions & 91 deletions

File tree

README.ja.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
[English](https://github.com/omnivore-app/logseq-omnivore)
2+
3+
# Logseq Plugin: *Omnivore*
4+
5+
このプラグインは、Webアプリ[Omnivore.app](https://omnivore.app/)(そのサーバー)にある、Webクリップの記事やそのハイライトなどをLogseqのグラフにインポート、同期します。
6+
7+
## 「Omnivore.app」を利用する
8+
9+
[Omnivore.app](https://omnivore.app)アカウントにサインアップします。
10+
- 「Omnivore.app」というサイトは、Webクリップのためのツール(Webアプリ)です。気になったページをただ「ブラウザのお気に入りに登録する」のではなく、Webクリップとして管理します。気になった個所などハイライトとともに、複数のサイトを整理して保存します。
11+
- このアプリは、デスクトップとモバイル、どちらからも無料で利用できます。Webクリップのデータはサーバー(クラウド)上に保存されます。このプラグインでは、それをLogseqに取り込んで保存します。その記事につけたノートも取り込みできます。
12+
13+
### ショーケース
14+
15+
* 日付ごと: Logseq上では、Webクリップされた日付、ハイライトされた日付など、日付ごとに自動的に分類されます。
16+
* 分類と参照: Webクリップにつけたラベルは、タグとしてリンクが機能します。そのため、Webクリップしたページやそのハイライトを、既存のページに関連付けることができます。(そのページの"Linked References"に表示されます。)
17+
> Omnivore.appでラベル付けをして、それらの記事をグループ化できます。そのラベルが、Logseqグラフにあるページへリンクするのと同じ役割をもちます。ただし、Omnivore.appからLogseqに取り込んだ記事に限ります。
18+
* フィルタリング: [高度な検索構文](https://docs.omnivore.app/using/search.html)を使用して、記事データに基づくフィルタリングが可能
19+
* Webクリップの保存先として: Omnivore.appからの記事データに基づいたグラフを作成
20+
> 既存のグラフに入れる場合、新規グラフに入れる場合など
21+
* カスタム: 記事データ用のカスタムテンプレート
22+
23+
## 使用方法
24+
25+
1. 通常、マーケットプレースからプラグインをインストールします。
26+
1. プラグインがオンになると、APIキーの発行ページが開きます。 (Omnivoreの[APIキー発行ページ](https://omnivore.app/settings/api))
27+
1. プラグイン設定画面を開いて API キーを登録します。
28+
1. 右上のツールバーにある🔨ボタンを押して、Omnivoreのツールバーアイコンを有効にします。そのアイコンボタンを押すと[[Omnivore]]ページが開きます。そのとき、同期が開始されます。少し時間がかかる場合があります。
29+
> Omnivore.appのINBOXに記事が存在しない場合は、記事を1つも取り込むことができません。先に、Omnivore.appのINBOXに記事をいれてください。
30+
31+
## 同期について
32+
33+
1. プラグインは「Omnivore」という専用ページを作成して同期をおこないます。
34+
1. Omnivore.appでハイライトをつけたコンテンツ、および追加したノートが記事ブロック内に、挿入されます。プラグイン設定のカスタムテンプレートが適用されます。その属性データとラベルリンクが含まれます。
35+
1. 同期のタイミング: プラグインを開いたときと、設定変更をおこなうたびに、Omnivore.appとの同期を開始します。
36+
> さらにプラグイン設定で、API キー、検索フィルタ、プラグインがOmnivore.appとどれくらい頻繁に同期するかを変更できます。ツールバーのOmnivoreアイコンをクリックして、手動でOmnivore.appと同期することもできます。
37+
38+
## デモ
39+
40+
### 記事の同期
41+
42+
![取得中](screenshots/fetching.gif)
43+
44+
### プラグイン設定
45+
46+
![設定](screenshots/settings.gif)
47+
48+
## 連絡先
49+
50+
開発者: [Hongbo Wu](https://github.com/sywhb)[Omnivore](https://github.com/omnivore-app)
51+
52+
日本語の翻訳者: [YU000jp](https://github.com/YU000jp)
53+
54+
## 貢献
55+
56+
- Omnivore.app およびこのプラグインの使用方法に関する素晴らしい[ガイド](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5)を提供してくれた[@Brian](https://twitter.com/Bsunter)に感謝します。[中国語翻訳](https://sywhb.github.io/#/page/omnivore-logseq%20指南)[@吴洪博](https://twitter.com/Sy98715020)によって提供されました。
57+
58+
プルリクエストは歓迎されています。大規模な変更については、まず問題を開いて変更内容を議論してください。
59+
60+
## ライセンス
61+
62+
[MIT](https://choosealicense.com/licenses/mit/)
63+
64+
## FAQ
65+
66+
### 記事を取得しようとしたときに `TypeError: Cannot read properties of null (reading: 'uuid')` と表示されます。
67+
68+
この問題はプラグインの最新バージョンで修正されています。それにもかかわらず、この問題が引き続き発生する場合は、「Omnivore」ページの空のブロックをクリックしてみてください。
69+
70+
### Omnivore との同期ボタンが設定を更新した後に動作しません。
71+
72+
この問題はプラグインの最新バージョンで修正されています。それにもかかわらず、この問題が引き続き発生する場合は、プラグインを再読み込みしてみてください。それでも動作しない場合は、問題を開いてください。

README.md

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,58 @@
1+
[日本語](https://github.com/omnivore-app/logseq-omnivore/blob/develop/README.ja.md)
2+
13
# logseq-omnivore
24

3-
This plugin imports your saved [Omnivore](https://omnivore.app/) articles and highlights into Logseq.
5+
This plugin enables importing and syncing web clippings, articles, and highlights from the web app [Omnivore.app](https://omnivore.app/) (its server) into a Logseq graph.
46

5-
## Features
7+
## Utilizing "Omnivore.app"
68

7-
* Import your highlights and saved article
8-
* Create graphs based on Omnivore data
9-
* Filter imported data using Omnivores [advanced search syntax](https://docs.omnivore.app/using/search.html)
10-
* Custom templates for imported data
9+
1. Register for an account on [Omnivore.app](https://omnivore.app).
10+
- "Omnivore.app" functions as a web tool (web app) specifically designed for web clippings. Instead of simply bookmarking interesting pages in a browser, users can manage them as web clippings, alongside highlights, and organize multiple sites.
11+
- This application is available for free on both desktop and mobile devices, and web clipping data is stored on the server (cloud). With this plugin, one can import and save this data in Logseq. Additionally, any attached notes related to the articles can also be imported.
1112

12-
## Installation
13+
### Showcase
1314

14-
1. Install the plugin from the marketplace or build it from source and load unpacked plugin
15-
2. Sign up for an [Omnivore account](https://omnivore.app)
16-
3. Go to [Omnivore](https://omnivore.app/settings/api) and Create an API key
17-
4. Open settings and add your api key
15+
* Sorted by Date: In Logseq, web clippings and highlights are automatically categorized based on their respective dates.
16+
* Tagging and Referencing: Labels attached to web clippings act as tags with links, allowing users to associate web-clipped pages and their highlights with existing pages (displayed in the "Linked References" section of the page).
17+
> Labeling can be done in Omnivore.app, permitting users to group articles. These labels serve the same role as linking to pages within the Logseq graph but only for articles imported from Omnivore.app to Logseq.
18+
* Filtering: Article data can be filtered using [advanced search syntax](https://docs.omnivore.app/using/search.html).
19+
* As a Storage Location for Web Clippings: Create a graph based on article data from Omnivore.app.
20+
> Whether one wants to add it to an existing graph or create a new one.
21+
* Customization: Custom templates for article data.
1822

19-
## Usage
23+
## Usage Instructions
2024

21-
1. The plugin will automatically sync with Omnivore every time you open the plugin and every time you change the settings
22-
2. You can also manually sync with Omnivore by clicking the Omnivore icon on the toolbar
23-
3. You can also change the API key, the search filter, and how often the plugin syncs with Omnivore by updating the settings
24-
4. The plugin creates a new page named "Omnivore" and a block for each saved article including metadata, labels. Content you have highlighted in Omnivore, and any notes you added, will be nested
25-
in the article block
26-
5. Clicking on the article will open the Omnivore article in a new tab
27-
6. We also create an internal link to each label in the article so you can group articles by label
28-
7. Kudos to [@Brian](https://twitter.com/Bsunter) for the great [guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5) on how to use Omnivore and the plugin. [Chinese translation](https://sywhb.github.io/#/page/omnivore-logseq%20指南) by [@吴洪博](https://twitter.com/Sy98715020)
25+
1. Typically, the plugin is installed from the marketplace.
26+
1. Once the plugin is enabled, the API key issuance page will open (Omnivore's [API Key Issuance Page](https://omnivore.app/settings/api)).
27+
1. Open the plugin settings and register the API key.
28+
1. Click the 🔨 button in the top right toolbar to enable the Omnivore toolbar icon. Clicking that icon opens the [[Omnivore]] page, and synchronization begins at that point. This process may take some time.
29+
> If there are no articles in Omnivore.app's INBOX, importing articles won't be possible. Therefore, it's recommended to add articles to Omnivore.app's INBOX first.
2930
30-
## Demo
31+
## Synchronization Details
3132

32-
### Settings
33+
1. The plugin generates a dedicated page named "Omnivore" for synchronization.
34+
1. Content with highlights and additional notes added in Omnivore.app is inserted into article blocks, and custom templates from the plugin settings are applied. This includes attribute data and label links.
35+
1. Synchronization Timing: Synchronization with Omnivore.app starts when the plugin is opened and whenever changes are made to the settings.
36+
> Moreover, adjustments to the API key, search filters, and synchronization frequency can be made in the plugin settings. Manual synchronization with Omnivore.app can also be initiated by clicking the Omnivore icon in the toolbar.
3337
34-
![settings](screenshots/settings.gif)
38+
## Demo
3539

3640
### Fetching
3741

3842
![fetching](screenshots/fetching.gif)
3943

44+
### Settings
45+
46+
![settings](screenshots/settings.gif)
47+
4048
## Contacts
4149

4250
Developer: [Hongbo Wu](https://github.com/sywhb) @ [Omnivore](https://github.com/omnivore-app)
4351

4452
## Contributing
4553

54+
- Kudos to [@Brian](https://twitter.com/Bsunter) for the great [guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5) on how to use Omnivore.app and this plugin. [Chinese translation](https://sywhb.github.io/#/page/omnivore-logseq%20指南) by [@吴洪博](https://twitter.com/Sy98715020), Japanese translation by [YU000jp](https://github.com/YU000jp)
55+
4656
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
4757

4858
## License

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"date-fns": "^2.29.3",
2929
"diff-match-patch": "^1.0.5",
3030
"lodash": "^4.17.21",
31+
"logseq-l10n": "^0.2.0",
3132
"luxon": "^3.2.1",
3233
"markdown-escape": "^1.1.0",
3334
"mustache": "^4.2.0",

0 commit comments

Comments
 (0)