Skip to content

Commit

Permalink
Update help contents
Browse files Browse the repository at this point in the history
  • Loading branch information
1024jp committed Sep 9, 2023
1 parent e861db7 commit 1a5137c
Show file tree
Hide file tree
Showing 31 changed files with 107 additions and 90 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h2>Powerful find and replace</h2>
<img class="snapshot" src="gfx/ov_color@2x.png" width="400"/>

<h2>Capture the document structure by syntax highlighting</h2>
<p>CotEditor colorizes particular strings such as reserved words of programming languages, TeX commands, and HTML elements to make the document’s structure easy to understand.</p>
<p>CotEditor colorizes particular strings such as reserved words of programming languages, Markdown headings, and HTML elements to make the document’s structure easy to understand.</p>
<ul>
<li><a href="pgs/syntax_definition.html">How to define syntaxes</a></li>
</ul>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ <h1>Count characters in CotEditor</h1>

<h2>Standard character count</h2>

<p>CotEditor can display the character count both in the status bar and the document inspector. By the standard character count, it counts each grapheme cluster, that is defined as the extended grapheme cluster in Unicode.</p>
<p>CotEditor can display the character count both in the status bar and the document inspector.</p>

<p>A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit for humans. For instance, while a normal character, such as A, is naturally counted as one character, an emoji consisting of multiple Unicode code points, such as 1️⃣ (<code>U+0031</code> <code>U+FE0F</code> <code>U+20E3</code>), will also be counted as one character.</p>
<p>The standard character count counts each grapheme cluster, that is defined as the “extended grapheme cluster” in Unicode. A grapheme cluster is a sequence of one or more Unicode code points that should be treated as a single unit for humans. For instance, while a normal character, such as A, is naturally counted as one character, an emoji consisting of multiple Unicode code points, such as 1️⃣ (<code>U+0031</code> <code>U+FE0F</code> <code>U+20E3</code>), will also be counted as one character.</p>


<h2>Advanced character count</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h1>Sort lines using specific pattern in CotEditor</h1>
<p>From Sort by Pattern command in the Text &gt; Lines menu, you can sort selected lines by specifying the way to compare.</p>


<p>The simple Sort command in the Text &gt; Lines menu is the same as sorting “Entire line” with “Ignore case” and “Respect language rules” options on.</p>
<p>The normal Sort command in the Text &gt; Lines menu is the same as sorting “Entire line” with “Ignore case” and “Respect language rules” options on.</p>


<section>
Expand All @@ -31,28 +31,33 @@ <h2>Sort key</h2>
<p>Specify the part in lines to compare on sort.</p>

<dl>
<dt>Entire line</dt>
<dd>Compare entire lines.</dd>

<dt>Column</dt>
<dd>Treat lines as CSV (character-separated values) format and use the specific column for comparison. Whitespace around the separator will just be ignored.</dd>
<dd><dl>
<dt>Delimiter</dt>
<dd>The character separating each column. You can use escape sequences such as <code>\t</code> for the tabular character. A comma will be used when this field is blank.</dd>
<dt>Position</dt>
<dd>The number of the column to use as the sort key. The column count starts at 1.</dd>
</dl></dd>
<dd><table>
<thead>
<tr><th>Option</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>Delimiter</td><td>The character separating each column. You can use escape sequences such as <code>\t</code> for the tabular character. A comma will be used when this field is blank.</dd>
<tr><td>Position</td><td>The number of the column to use as the sort key. The column count starts at 1.</td></tr>
</tbody>
</table></dd>

<dt>Regular expression</dt>
<dd>Specify the part to compare with the regular expression.</dd>
<dd><dl>
<dt>Pattern</dt>
<dd>The regular expression pattern to extract the part to compare.</dd>
<dt>Ignore case</dt>
<dd>Whether ignore the character case by extracting the regular expression pattern. This option will be used only for the sort key extraction. To set case-insensitive state for the sort phase, set in the sort option bellow.</dd>
<dt>Use captured group</dt>
<dd>The part in matches to use as the sort key. The entire match will be used when this checkbox is turned off.</dd>
</dl></dd>

<dt>Entire line</dt>
<dd>Compare entire lines.</dd>
<dd><table>
<thead>
<tr><th>Option</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>Pattern</td><td>The regular expression pattern to extract the part to compare.</dd>
<tr><td>Ignore case</td><td>Whether ignore the character case by extracting the regular expression pattern. This option will be used only for the sort key extraction. To set case-insensitive state for the sort phase, set in the sort option bellow.</td></tr>
<tr><td>Use captured group</td><td>The part in matches to use as the sort key. The entire match will be used when this checkbox is turned off.</td></tr>
</tbody>
</table></dd>
</dl>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@

<h1>Build Outline of a document in CotEditor</h1>

<p>The Outline feature extracts specific parts of your document and generates a list according to the definition of the syntax.</p>
<p>The <dfn>Outline feature</dfn> extracts specific parts of your document and generates a list according to the definition of the syntax.</p>

<p>The generated outline is shown in the navigation bar and the inspector.</p>


<h2>Display Outline menu</h2>

<p>The Outline menu is a pop-up menu displayed in the navigation bar located beneath the toolbar. It displays the nearest Outline item above the insertion point and moves the insertion point to the corresponding part by opening the menu and clicking an item in the menu.</p>
<p>The Outline menu is a pop-up menu displayed in the navigation bar located beneath the toolbar. The menu displays the nearest Outline item above the insertion point. By selecting an item in the menu, the editor moves the insertion point to the corresponding part and scrolls.</p>

<p>To show the Outline menu:</p>
<ol>
Expand All @@ -45,7 +45,7 @@ <h2>Move among Outline items</h2>

<h2>Customize extraction rules</h2>

<p>The rules, what items should appear and how they should be titled in the Outline list, are set per syntax. You can configure them in the <a href="syntax_definition.html">Syntax definition</a> &gt; <a href="syntax_outline_settings.html">outline rules</a>.</p>
<p>The rules, what items should appear and how they should be titled in the Outline list, are set per syntax. You can configure them in the <a href="syntax_definition.html">Syntax definition</a> &gt; <a href="syntax_outline_settings.html">outline settings</a>.</p>



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,31 @@ <h1>Change Appearance settings in CotEditor</h1>
<tbody>
<tr>
<th>Prefer font using</th>
<td>Select whether to use the standard or monospaced font in the editors when opening a document. If you select “Automatic,” font will be automatically selected from the standard and monospaced depending on the document’s syntax kind.</td>
<td>Select whether to use the standard or monospaced font in editors. If you select “Automatic,” font will be automatically selected from the standard and monospaced depending on the document’s syntax kind.</td>
</tr>

<tr>
<th>Standard font</th>
<td>The standard font to display text in the editors.
<td>The standard font to display text in editors.

<dl>
<dt>Font</dt>
<dd>The font and font size. To change the font, click the Select button, then choose a font name or font size in the Font window.</dd>
<dt>Antialias</dt>
<dd>Display text in the editor antialiased. Antialias is a rendering feature that smoothes jagged edges.</dd>
<dd>Display text in editors antialiased. Antialias is a rendering feature that smoothes jagged edges.</dd>
<dt>Ligatures</dt>
<dd>Apply the standard ligature rules to the editor’s text, or turn off all ligatures. A ligature is a typographic feature joining specific characters as a single glyph.</dd>
</dl></td>
</tr>

<tr>
<th>Monospaced font</th>
<td>The monospaced font to display text in the editors.</td>
<td>The monospaced font to display text in editors.</td>
</tr>

<tr>
<th>Line height</th>
<td>Line height with a value indicating the number of lines. The range must be from 0.1 to 10.0.</td>
<td>The line height with a value indicating the multiple of a line. The range must be from 0.1 to 10.0.</td>
</tr>

<tr>
Expand All @@ -63,12 +65,12 @@ <h1>Change Appearance settings in CotEditor</h1>

<tr>
<th>Theme</th>
<td>Choose your default coloring theme for the editor, and manage the themes. See <a href="howto_customize_theme.html">About theme</a> for about theme customization.</td>
<td>Choose your default coloring theme for editors, and manage themes. See <a href="howto_customize_theme.html">About theme</a> for about the theme customization.</td>
</tr>

<tr>
<th>Theme list</th>
<td>Choose your default theme for the text view.</td>
<td>Choose your default theme for editors.</td>
</tr>

<tr>
Expand Down Expand Up @@ -100,7 +102,7 @@ <h1>Change Appearance settings in CotEditor</h1>
<th>Theme editor</th>
<td>Edit the selected theme. Click the color wells to choose colors.<dl>
<dt>Basic</dt>
<dd>Basic text coloring other than syntax highlighting. If the “Use system color” checkbox for the “Selection” is turned on, the setting in System Settings &gt; Appearance &gt; Highlight Color is used for the selection highlighting.</dd>
<dd>Basic text coloring other than syntax highlighting. If the “Use system color” checkboxex are turned on, the setting in System Settings &gt; Appearance is used for the selection highlighting and text cursors.</dd>

<dt>Syntax</dt>
<dd>The text colors for syntax highlighting.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h1>Change General settings in CotEditor</h1>

<tr>
<th>Enable Auto Save with Versions</th>
<td>Automatically save documents to your file constantly while editing. This option also enables Versions, the modern system feature allowing you to go back to previous versions, as well as modify document name or location from the window title bar.<br/>Even if it is turned off, CotEditor creates backup covertly for unexpected quit.</td>
<td>Automatically save documents to your file constantly while editing. This option also enables Versions, the system feature allowing you to go back to previous versions, as well as modify document name or location from the window title bar.<br/>Even if the option is turned off, CotEditor creates backup covertly for unexpected quit.</td>
</tr>

<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<h1>Important changes on CotEditor 2.2</h1>

<p>CotEditor has been Sandboxed since version 2.2.0. It includes some specification changes from the previous versions in order to conform to the Sandbox and the Mac App Store rules. If you’ve used the legacy version before, you may need some manual migrations.</p>
<p>CotEditor has been Sandboxed since version 2.2.0, which was released in October 2015. It includes some specification changes from the previous versions in order to conform to the Sandbox and the Mac App Store rules. If you’ve used the legacy version before, you may need some manual migrations.</p>


<h2>User Settings Location</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

<h1>Important changes on CotEditor 4.2</h1>

<p>Prior to version 4.2.0, all line ending codes were internally treated as LF (<code>U+000A</code>). From version 4.2.0, the actual line ending codes in document files are treated as they are. Therefore, users, especially those who have used earlier versions, require awareness of this change and may need manual migration for some settings.</p>
<p>The way to handle line endings was changed in CotEditor 4.2.0, which was released in May 2022. Prior to version 4.2.0, all line ending codes were internally treated as LF (<code>U+000A</code>). From version 4.2.0, the actual line ending codes in document files are treated as they are. Therefore, users, especially those who have used earlier versions, require awareness of this change and may need manual migration for some settings.</p>
<p>For details on how the latest CotEditor treats line endings, see <a href="about_line_endings.html">Handle various types of line endings</a>.</p>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

<h1>Define Outline extraction rules in CotEditor</h1>

<p>Define the patterns to extract items in the document for the <a href="howto_show_outlinemenu.html">Outline feature</a>.</p>

<p>The options for the Outline settings are as follows:</p>

<table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h1>Table of Contents</h1>
<li><a href="pgs/about_sourcecode.html">CotEditor’s source code</a></li>
<li><a href="pgs/releasenotes.html">Release notes</a></li>
<li><details>
<summary>Important changes</summary>
<summary>Important changes in the past</summary>
<ul>
<li><a href="pgs/specification_changes_on_4.2.html">Important changes on CotEditor 4.2</a></li>
<li><a href="pgs/specification_changes_on_2.2.html">Important changes on CotEditor 2.2</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <h1>CotEditorユーザガイド</h1>
</header>

<main>
<p>CotEditorはプログラムから日々のメモまでプレーンテキストの編集に特化したテキストエディタです。CotEditorにはmacOS付属のテキストエディットにはない多くの便利な機能があります</p>
<p>CotEditorは、プログラムから日々のメモまでプレーンテキストの編集に特化したテキストエディタです。macOS付属のテキストエディットにはない多くの便利な機能があります</p>

<section>
<img class="snapshot" src="gfx/ov_find@2x.png" width="400"/>
Expand All @@ -35,7 +35,7 @@ <h2>強力な検索/置換機能</h2>
<img class="snapshot" src="gfx/ov_color@2x.png" width="400"/>

<h2>シンタックスカラーリングで書類の構造を捉える</h2>
<p>プログラム言語の予約語や、TeXのコマンド、HTMLの要素など特定のキーワードに色をつけて書類の構造をわかりやすくします。</p>
<p>プログラム言語の予約語や、Markdownの見出し、HTMLの要素など特定のキーワードに色をつけて書類の構造をわかりやすくします。</p>
<ul>
<li><a href="pgs/syntax_definition.html">シンタックスを定義する方法</a></li>
</ul>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2>CotEditorが扱う改行コード</h2>
</tr>
</tbody>
<tbody>
<tr>td>NEL</td>
<tr><td>NEL</td>
<td>Next Line</td>
<td><code>U+0085</code></td>
<td></td>
Expand Down Expand Up @@ -112,7 +112,7 @@ <h2>書類の改行コードを変更する</h2>

<h2>書類と異なる改行コードを挿入する</h2>

<p>ユーザが改行コードの違いを意識しなくて良いように、基本的にCotEditorは、改行には書類の改行コードのみを使用します。例えCotEditorスクリプトや正規表現での置換などで書類の改行コードとは異なる改行を含むテキストを挿入したときさえも、CotEditorは暗黙で挿入されるテキストに含まれるすべての改行コードを書類の改行コードに揃えてから書類に挿入します。</p>
<p>ユーザが改行コードの違いを意識しなくて良いように、基本的にCotEditorは、改行には書類の改行コードのみを使用します。たとえCotEditorスクリプトや正規表現での置換などで書類の改行コードとは異なる改行を含むテキストを挿入したときさえも、CotEditorは暗黙で挿入されるテキストに含まれるすべての改行コードを書類の改行コードに揃えてから書類に挿入します。</p>

<p>現時点では、CotEditorで書類と異なる改行コードを挿入する方法は以下の2種類しか提供されていません:</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ <h1>CotEditorで文字をカウントする</h1>

<h2>標準の文字カウント</h2>

<p>CotEditorはステータスバーと書類インスペクタの2箇所で文字カウントを表示することができます。標準の文字カウントでは、Unicodeでextended grapheme clusterと定義されている書記素クラスタ (grapheme cluster) 単位で文字をカウントをします。</p>
<p>CotEditorはステータスバーと書類インスペクタの2箇所で文字カウントを表示することができます。</p>

<p>書記素クラスタは、1つ以上のUnicodeコードポイントから成り立つ、人間の感覚にあった文字単位です。例えば、A(<code>U+0041</code>のような通常の1コードポイントの文字を1文字と数えながら、複数のUnicodeコードポイントから成り立つ1️⃣(<code>U+0031</code> <code>U+FE0F</code> <code>U+20E3</code>)のような絵文字も1文字と数えます。</p>
<p>標準の文字カウントでは、Unicodeでextended grapheme clusterと定義されている書記素クラスタ (grapheme cluster) 単位で文字をカウントをします。書記素クラスタは、1つ以上のUnicodeコードポイントから成り立つ、人間の感覚にあった文字単位です。例えば、A(<code>U+0041</code>のような通常の1コードポイントの文字はもちろん、複数のUnicodeコードポイントから成り立つ1️⃣(<code>U+0031</code> <code>U+FE0F</code> <code>U+20E3</code>)のような絵文字も1文字と数えます。</p>


<h2>高度な文字カウント</h2>
Expand All @@ -32,7 +32,7 @@ <h2>高度な文字カウント</h2>
<img src="../gfx/advancedCount@2x.png" width="701" alt="高度な文字カウント設定ダイアログ"/>
</figure>

<p>高度な文字カウントを開始すると、カウンタがエディタの下部に表示されます。このカウンタは高度な文字カウントオプションダイアログで設定した方法で文字をライブカウントします。カウンタはエディタで何か文字を選択している間は選択された文字を、そうでないときは書類全体の文字をカウントして表示します。カウンタをドラッグして邪魔にならない場所に移動することができます</p>
<p>高度な文字カウントを開始すると、カウンタがエディタの下部に表示されます。このカウンタは高度な文字カウントオプションダイアログで設定した方法で文字をライブカウントします。カウンタはエディタで何か文字を選択している間は選択された文字を、そうでないときは書類全体の文字をカウントして表示します。カウンタはドラッグして邪魔にならない場所に移動することができます</p>
<p>文字カウントオプションはアプリケーションで共通です。一つのエディタでオプションを変更すると、他のエディタのカウント方法も変更されます。</p>

<p>特にカウントする書類のサイズが大きいときに、高度な文字カウントは設定によっては処理パフォーマンスに影響することに留意してください。カウントを止めるには、「テキスト」&gt;「高度な文字カウントを停止」を選択します。</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<h1>CotEditorでファイルをエディタにドロップする</h1>

<p>ファイルドロップは、ファイルをエディタにドロップしたとき、ファイルに応じてあらかじめ指定しておいた定型テキストをドロップ位置に挿入する機能です。例えばHTML書類に画像をドロップしたときに<code>img</code>タグを挿入するといった使い方ができます。</p>
<p>ファイルドロップは、ファイルをエディタにドロップしたとき、ファイルに応じてあらかじめ指定しておいた定型テキストをドロップ位置に挿入する機能です。例えば、HTML書類に画像ファイルをFinderからドロップしたときに<code>img</code>タグを挿入するといった使い方ができます。</p>


<h2>ファイルドロップを使う</h2>
Expand Down
Loading

0 comments on commit 1a5137c

Please sign in to comment.