Commit a94a3781 authored by Yuri Chornoivan's avatar Yuri Chornoivan
Browse files

Sync docs with the current ktexteditor framework interface

parent 55a9f4e3
Pipeline #75234 passed with stage
in 6 minutes and 30 seconds
......@@ -30,8 +30,13 @@ by changing them per document during an editing session.</para>
<sect2 id="appearance">
<title>Appearance</title>
<sect3 id="prefcolors-fonts">
<title>Font</title>
<sect3 id="appearance-general">
<title>General</title>
<variablelist>
<varlistentry>
<term><guilabel>Editor font</guilabel></term>
<listitem>
<para>
Here you can choose the font of the editor text. You can choose from
any font available on your system, and set a default size. A sample text
......@@ -40,98 +45,79 @@ is displayed at the bottom of the dialog, so you can see the effect of your choi
<para>For more information about selecting a font, see the
<ulink url="help:/fundamentals/fonts.html"><emphasis>Choosing Fonts</emphasis>
section of the <emphasis>&kde; Fundamentals</emphasis> documentation</ulink>.</para>
</sect3>
<sect3 id="appearance-general">
<title>General</title>
<variablelist>
<varlistentry>
<term><guilabel>Dynamic Word Wrap</guilabel></term>
<listitem>
<para>If this option is checked, the text lines
will be wrapped at the view border on the screen.</para>
<variablelist>
<varlistentry>
<term><guilabel>Dynamic word wrap indicators (if applicable)</guilabel></term>
<listitem><para>Choose when the Dynamic word wrap indicators
should be displayed, either <guilabel>Off</guilabel>, <guilabel>Follow Line
Numbers</guilabel> or <guilabel>Always on</guilabel>.
</para></listitem></varlistentry>
<varlistentry>
<term><guilabel>Align dynamically wrapped lines
to indentation depth:
</guilabel></term>
<listitem><para>Enables the start of dynamically wrapped
lines to be aligned vertically to the indentation level of the first
line. This can help to make code and markup more
readable.</para><para>Additionally, this allows you to
set a maximum width of the screen, as a percentage,
after which dynamically wrapped lines will no longer be vertically aligned.
For example, at 50%, lines whose indentation levels are deeper than 50% of the
width of the screen will not have vertical alignment applied to subsequent
wrapped lines.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Whitespace Highlighting</guilabel></term>
<term><guilabel>Show whitespace indicators</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Highlight tabulators</guilabel></term>
<listitem><para>The editor will display a &raquo; symbol to indicate the presence
of a tab in the text.</para></listitem>
<term><guilabel>Never</guilabel></term>
<listitem><para>The editor will never display dots to indicate the presence of whitespace.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Highlight trailing spaces</guilabel></term>
<term><guilabel>At the end of a line</guilabel></term>
<listitem><para>The editor will display dots to indicate the presence of extra
whitespace at the end of lines.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Highlight marker size</guilabel></term>
<listitem><para>Use the slider to change the size of the visible highlight marker.</para></listitem>
<term><guilabel>Always</guilabel></term>
<listitem><para>The editor will always display dots to indicate the presence of whitespace.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Whitespace indicator size</guilabel></term>
<listitem><para>Use the slider to change the size of the visible indicator marker.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show tab indicators</guilabel></term>
<listitem><para>When checked the editor will display a &raquo; symbol to indicate the presence
of a tab in the text.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Advanced
<term><guilabel>Bracket matching
</guilabel></term>
<listitem><para>
<variablelist>
<varlistentry>
<term><guilabel>Show indentation lines
</guilabel></term>
<listitem><para>If this is checked, the editor will display
vertical lines to help identifying indent lines.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Highlight range between selected brackets
</guilabel></term>
<listitem><para>If this is enabled, the range between the selected matching brackets will be highlighted.</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
<varlistentry>
<term><guilabel>Show preview of matching open bracket
</guilabel></term>
<listitem><para>When enabled, the editor will show a tooltip of the matching open bracket.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Animate bracket matching
<term><guilabel>Flash matching bracket when cursor moves to other bracket in pair
</guilabel></term>
<listitem><para>If enabled, moving on the brackets (<keycap>{</keycap>, <keycap>[</keycap>,
<keycap>]</keycap>, <keycap>}</keycap>,<keycap>(</keycap> or <keycap>)</keycap>) will
quickly animate the matching bracket.</para></listitem>
quickly flash the matching bracket.</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Fold first line
<term><guilabel>Show indentation lines
</guilabel></term>
<listitem><para>If enabled, the first line is folded, if possible. This is useful,
if the file starts with a comment, such as a copyright</para></listitem>
<listitem><para>If this is checked, the editor will display
vertical lines to help identifying indent lines.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show Word Count
<term><guilabel>Counts
</guilabel></term>
<listitem><para>
<variablelist>
<varlistentry>
<term><guilabel>Show word count
</guilabel></term>
<listitem><para>Displays the number of words and characters in the document and
in the current selection in the status bar.
......@@ -144,6 +130,59 @@ This option is also available in the status bar context menu.</para></listitem>
This option is also available in the status bar context menu.</para></listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Fold first line
</guilabel></term>
<listitem><para>If enabled, the first line is folded, if possible. This is useful,
if the file starts with a comment, such as a copyright</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Dynamic Word Wrap</guilabel></term>
<listitem>
<para>If this option is checked, the text lines
will be wrapped at the view border on the screen.</para>
<para>
<variablelist>
<varlistentry>
<term><guilabel>Wrap dynamically at static word wrap marker
</guilabel></term>
<listitem><para>When checked, editor wraps lines dynamically at the <link linkend="pref-word-wrap">static word wrap position</link>.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Disregard word boundaries for dynamic wrapping
</guilabel></term>
<listitem><para>When checked, the editor does not take into account word boundaries when wrapping text lines.</para></listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Dynamic word wrap indicators</guilabel></term>
<listitem><para>Choose when the Dynamic word wrap indicators
should be displayed, either <guilabel>Off</guilabel>, <guilabel>Follow Line
Numbers</guilabel> or <guilabel>Always on</guilabel>.
</para></listitem></varlistentry>
<varlistentry>
<term><guilabel>Align dynamically wrapped lines
to indentation depth:
</guilabel></term>
<listitem><para>Enables the start of dynamically wrapped
lines to be aligned vertically to the indentation level of the first
line. This can help to make code and markup more
readable.</para><para>Additionally, this allows you to
set a maximum width of the screen, as a percentage,
after which dynamically wrapped lines will no longer be vertically aligned.
For example, at 50%, lines whose indentation levels are deeper than 50% of the
width of the screen will not have vertical alignment applied to subsequent
wrapped lines.</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="appearance-borders">
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment