.clro ノート形式

同梱リポジトリ版: (ZIP配布物ではここにバージョンが記載されます)

.clro は、PDF Note Workspaceで新しく作るノートの標準拡張子です。名前は Classroom に由来します。中身は UTF-8 の通常テキストであり、バイナリ形式でも PDF 注釈ファイルでもありません。

まず知っておくこと

.clro と .md / .markdown は、同じMarkdown系の記法で読み書きできます。

違いはアプリ内での役割です。新規ノートの既定値、候補名、既定の命名規則には .clro を使います。既存の .md を勝手に .clro へ改名・変換することはなく、コピー、リネーム、リンク先の作成でも選んだノートの拡張子を保ちます。

得意なこと

入力アシストの操作と対応する記述例の一覧は、ノートの書き方ガイド を参照してください。左下の「書き方ガイド」ボタンからも開けます。

見出し、箇条書き、強調、リンク、コード、表などの Markdown 系記法で、授業・読書・調査のノートを構造化できます。見出しはアプリ内の見出し表示でも確認できます。

表

パイプ記法の表は、通常時には列をそろえた構成表示になります。ヘッダーは区別して表示し、区切り行の : による左寄せ・中央寄せ・右寄せも反映します。列が画面より広いときはノートの横スクロールで確認できます。

表のセルにキャレットを置く、または表へ選択範囲を広げると、表全体を編集用の原文表示へ切り替えます。表から離れると構成表示へ戻ります。この切替により、同じ表を原文と構成表示で重ねて表示しません。

Markdown にない見た目やアプリ内の移動を使うときは、対応する独自 markup を追加できます。たとえば、下線、文字色、背景色、フォント、ノート内リンクの指定があります。

<u>下線を引いた文字</>
<char=1a73e8>青い文字</>
<back=fff2cc>背景色を付けた文字</>
<link=sample-note>ノート内リンク用の目印</>

独自 markup は .clro だけの機能ではなく、.md / .markdown も同じノート経路で扱います。新しく書く場合は、まず Markdown の通常記法を使い、アプリ固有の表示やノート内リンクが必要な箇所だけ独自 markup を使うと読みやすく保てます。

囲みブロック

単独行の ::: タイトル と ::: で本文を囲むと、タイトル・背景・枠・余白のあるブロックとして表示します。本文の見出し、強調、リンク、表、数式は通常どおり解釈します。コードブロックは、その中でも本文を記法として解釈せずに表示するブロックです。

::: 間欠跛行
休んだり歩いたりを繰り返す歩行です。
:::

開始行の ::: の後ろをタイトルとして表示します。::: note title="注意事項" のように明示することもできます。タイトルは記法として解釈せず、そのまま太字で表示します。title="" はタイトルなし、閉じていない引用符や重複した title= はタイトル表示をしません。原文は変更しません。空白を含む明示タイトルは二重引用符または単引用符で囲みます。

名前を省いた ::: でも開始できます。名前付きの開始行を内部に置けば入れ子になり、名前のない終了行は最も内側の囲みを閉じます。終了行のコロンは開始行と同数以上にします。行頭の空白は3個までです。閉じ忘れた囲みは文書末尾まで続きます。タイトル以外の属性による装飾指定や折り畳みは行いません。

コードブロックは開始行を ```cpp title="example.cpp" とすると、言語名 cpp と別にタイトルを表示します。タイトルの指定がなければ従来どおりです。

編集中・選択中の行は原文表示になり、囲み全体を一律に原文表示にはしません。ただし内部の表・ブロック数式は、それぞれの編集単位で切り替わります。TXT出力では囲み記号だけを除いてタイトルと本文を残します。HTML出力にもタイトルを含めます。コードや数式内の ::: は囲みとして解釈しません。

数式

数式は $...$、$$...$$、\(...\)、\[...\] で記述できます。数式表示は試験的な機能です。重要なノートでは、保存後に表示結果を確認してください。

.clro / .md / .markdown では、TeX数式を <math>...</math> で囲むこともできます。文章中ならインライン数式、前後に文章がない単独の囲みならブロック数式になります。

式は <math>E = mc^2</math> です。

<math>
\frac{1}{2}
</math>

終了には </math> と </> の両方を使えます。数式が終了記号を所有するため、外側の下線やリンク装飾を誤って閉じません。<math display=inline>x</> は単独行でもインライン数式、<math display='block'>x</math> はブロック数式です。値は引用符なし・一重引用符・二重引用符で指定でき、タグ名・属性名・表示種別の大文字小文字は区別しません。開始タグは1行に記述します。

未知の属性は原文とMarkdown出力に残し、表示には反映せず診断で知らせます。display の不正な値や重複指定、閉じ忘れ、入れ子は数式化せず原文を残します。インライン数式は1行、ブロック数式は前後に文章がない囲みとして記述してください。コード内やエスケープした開始タグは解釈しません。自己終了タグとMathMLには対応せず、中身はTeXです。編集中は既存の数式と同じく、インラインならその行、ブロックなら囲み全体を原文表示します。.tex の表示ではTeXの数式区切りのみを使います。

他のソフトで開く場合

.clro は普通のテキストとして開けます。Markdown の一般的な部分は他のMarkdown対応ソフトでも読めることがありますが、独自 markup、数式の見え方、ノート内リンクは同じ表示や動作を保証しません。

他のソフトとの共有・編集を優先するノートは、最初から .md または .markdown を選びます。互換性を優先する場合でも、PDF Note Workspaceが対応していない Markdown の全機能や、GitHubと同じ表示を保証するものではありません。

.clrop との違い

.clro は人が書くノートです。PDFへのマーカー、手書き、文字、図形などは .clro には保存されず、PDFに対応する .clrop 注釈データ に保存されます。

形式全体の選び方は File_Formats.md を参照してください。