[kate] doc/katepart: Update configuring.docbook to ktexteditor 5.38
Burkhard Lück
null at kde.org
Fri Sep 8 17:35:34 UTC 2017
Git commit 1f0ce03670d12bb58ecc3248b93634a89df3781e by Burkhard Lück.
Committed on 08/09/2017 at 17:35.
Pushed by lueck into branch 'master'.
Update configuring.docbook to ktexteditor 5.38
add missing options in configuration dialog
update + cleanup document variables section
Differential Revision: https://phabricator.kde.org/D7718
M +47 -50 doc/katepart/configuring.docbook
M +1 -1 doc/katepart/development.docbook
https://commits.kde.org/kate/1f0ce03670d12bb58ecc3248b93634a89df3781e
diff --git a/doc/katepart/configuring.docbook b/doc/katepart/configuring.docbook
index dbc33bfd4..5f6c4877f 100644
--- a/doc/katepart/configuring.docbook
+++ b/doc/katepart/configuring.docbook
@@ -132,6 +132,12 @@ if the file starts with a comment, such as a copyright</para></listitem>
for code folding, if code folding is available.</para></listitem>
</varlistentry>
<varlistentry>
+<term><guilabel>Show preview of folded code
+</guilabel></term>
+<listitem><para>If checked, hovering over a folded region shows a preview of the folded text
+in a popup.</para></listitem>
+</varlistentry>
+<varlistentry>
<term><guilabel>Show icon border
</guilabel></term>
<listitem><para>If this is checked, you will see an icon border on the left
@@ -158,6 +164,13 @@ will show marks on the vertical scrollbar. These marks will
for instance show bookmarks.</para></listitem>
</varlistentry>
<varlistentry>
+<term><guilabel>Show text preview on scrollbar</guilabel></term>
+<listitem><para>If this option is checked, and you hover the scrollbar with the mouse cursor
+a small text preview with several lines of the current document around the cursor position will be displayed.
+This allows you to quickly switch to another part of the document.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
<term><guilabel>Show scrollbar mini-map</guilabel></term>
<listitem><para>If this option is checked, every new view will show a mini map of the
document on the vertical scrollbar.</para>
@@ -169,6 +182,13 @@ document on the vertical scrollbar.</para>
<listitem><para>Adjusts the width of the scrollbar mini-map, defined in pixels.
</para></listitem>
</varlistentry>
+<varlistentry>
+<term><guilabel>Scrollbars visibility</guilabel></term>
+<listitem><para>Switch the scrollbar on, off or show the scroolbar only when needed.
+Click with the &LMB; on the blue rectangle to display the line numer range of the docmument displayed on the screen.
+Keep the &LMB; pressed outside the blue rectangle to automatically scroll through the document
+</para></listitem>
+</varlistentry>
</variablelist>
</listitem>
</varlistentry>
@@ -1272,7 +1292,7 @@ by other objects such as plugins, which can use them for their own purpose.
For example, the variable indent mode uses document variables for its
configuration.</para>
-<para>The variables listed here documents &kappname; version 3.7. More variables
+<para>The variables listed here documents &kappname; version 5.38. More variables
may be added in the future. There are 3 possible types of values for variables,
with the following valid expressions:
<itemizedlist>
@@ -1289,17 +1309,16 @@ with the following valid expressions:
<variablelist>
+<varlistentry id="variable-auto-brackets">
+<term><cmdsynopsis><command>auto-brackets</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Enable automatic insertion of brackets.</para></listitem>
+</varlistentry>
+
<varlistentry id="variable-auto-center-lines">
<term><cmdsynopsis><command>auto-center-lines</command><arg>INT</arg></cmdsynopsis></term>
<listitem><para>Set the number of autocenter lines.</para></listitem>
</varlistentry>
-<varlistentry id="variable-auto-insert-doxygen">
-<term><cmdsynopsis><command>auto-insert-doxygen</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Turn insertion of the leading asterisk in doxygen comments on or
-off. This has no effect unless you use the C-style auto-indenter. </para></listitem>
-</varlistentry>
-
<varlistentry id="variable-background-color">
<term><cmdsynopsis><command>background-color</command><arg>STRING</arg></cmdsynopsis></term>
<listitem><para>Set the document background color. The value must be something
@@ -1319,20 +1338,12 @@ on or off.</para></listitem>
</varlistentry>
<varlistentry id="variable-byte-order-mark">
-<term><cmdsynopsis><command>bom | byte-order-mark</command><arg>BOOL</arg></cmdsynopsis></term>
+<term><cmdsynopsis><command>bom | byte-order-mark | byte-order-marker</command><arg>BOOL</arg></cmdsynopsis></term>
<listitem><para>Enable/disable the byte order mark (BOM) when saving files in Unicode format
(utf8, utf16, utf32).</para>
<para>Since: &kate; 3.4 (&kde; 4.4)</para></listitem>
</varlistentry>
-<varlistentry id="variable-encoding">
-<term><cmdsynopsis><command>encoding</command><arg>STRING</arg></cmdsynopsis></term>
-<listitem><para>Set the encoding used for loading or saving the file.
-As the variables in the document will be read after loading, this impacts only the saving.
-If you place it in a <filename>.kateconfig</filename> file, it will have an effect for the loading, too.</para>
-<para>Since: &kate; 3.10 (&kde; 4.10)</para></listitem>
-</varlistentry>
-
<varlistentry id="variable-bracket-highlight-color">
<term><cmdsynopsis><command>bracket-highlight-color</command><arg>STRING</arg></cmdsynopsis></term>
<listitem><para>Set the color for the bracket highlight. The value must be
@@ -1373,6 +1384,11 @@ on or off.
</para></listitem>
</varlistentry>
+<varlistentry id="variable-folding-preview">
+<term><cmdsynopsis><command>folding-preview</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Enable folding preview in the editor border.</para></listitem>
+</varlistentry>
+
<varlistentry id="variable-font-size">
<term><cmdsynopsis><command>font-size</command><arg>INT</arg></cmdsynopsis></term>
<listitem><para>Set the point size of the document font.</para></listitem>
@@ -1431,12 +1447,6 @@ be evaluated to a valid color, for example <userinput>#ff0000</userinput>.</para
<listitem><para>Set the display of line numbers on or off.</para></listitem>
</varlistentry>
-<varlistentry id="variable-mixed-indent">
-<term><cmdsynopsis><command>mixed-indent</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set mixed indentation, as with &Emacs;, on or off.</para>
-<para>Note: Deprecated since &kate; 3 in &kde;4. This variable is ignored, set <command>replace-tabs on;</command> instead for the future.</para></listitem>
-</varlistentry>
-
<varlistentry id="variable-newline-at-eof">
<term><cmdsynopsis><command>newline-at-eof</command><arg>BOOL</arg></cmdsynopsis></term>
<listitem><para>Add an empty line at the end of the file (EOF) when saving the document.</para>
@@ -1454,12 +1464,14 @@ be evaluated to a valid color, for example <userinput>#ff0000</userinput>.</para
on or off.</para></listitem>
</varlistentry>
-<varlistentry id="variable-remove-trailing-space">
-<term><cmdsynopsis><command>remove-trailing-space</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set dynamic end of line cleanup on or off.</para>
-<para>Note: Deprecated since &kde; 4.10. Please use <link linkend="variable-remove-trailing-spaces">
-remove-trailing-spaces</link> with the desired choice instead.
-</para></listitem>
+<varlistentry id="variable-replace-tabs-save">
+<term><cmdsynopsis><command>replace-tabs-save</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Set tab to space conversion on save on or off.</para></listitem>
+</varlistentry>
+
+<varlistentry id="variable-replace-tabs">
+<term><cmdsynopsis><command>replace-tabs</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Set dynamic tab to space conversion on or off.</para></listitem>
</varlistentry>
<varlistentry id="variable-remove-trailing-spaces">
@@ -1471,26 +1483,18 @@ remove-trailing-spaces</link> with the desired choice instead.
modified lines. The modified lines are marked by the line modification system.</para></listitem>
<listitem><para><userinput>all</userinput>, <userinput>*</userinput> or <userinput>2</userinput>: remove trailing spaces in the entire document.</para></listitem>
</itemizedlist>
-<para>Since: &kde; 4.10. This deprecates the options <userinput>remove-trailing-space</userinput> and <userinput>replace-trailing-space-save</userinput>.
+<para>Since: &kde; 4.10.
</para></listitem>
</varlistentry>
-<varlistentry id="variable-replace-tabs-save">
-<term><cmdsynopsis><command>replace-tabs-save</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set tab to space conversion on save on or off.</para></listitem>
+<varlistentry id="variable-scrollbar-minimap">
+<term><cmdsynopsis><command>scrollbar-minimap</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Show scrollbar minimap.</para></listitem>
</varlistentry>
-<varlistentry id="variable-replace-tabs">
-<term><cmdsynopsis><command>replace-tabs</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set dynamic tab to space conversion on or off.</para></listitem>
-</varlistentry>
-
-<varlistentry id="variable-replace-trailing-space-save">
-<term><cmdsynopsis><command>replace-trailing-space-save</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set end of line cleanup on save on or off.</para>
-<para>Note: Deprecated since &kde; 4.10. Please use <link linkend="variable-remove-trailing-spaces">
-remove-trailing-spaces</link> with the desired choice instead.
-</para></listitem>
+<varlistentry id="variable-scrollbar-preview">
+<term><cmdsynopsis><command>scrollbar-preview</command><arg>BOOL</arg></cmdsynopsis></term>
+<listitem><para>Show scrollbar preview.</para></listitem>
</varlistentry>
<varlistentry id="variable-scheme">
@@ -1516,13 +1520,6 @@ be evaluated to a valid color, for example <userinput>#ff0000</userinput>.</para
on or off.</para></listitem>
</varlistentry>
-<varlistentry id="variable-space-indent">
-<term><cmdsynopsis><command>space-indent</command><arg>BOOL</arg></cmdsynopsis></term>
-<listitem><para>Set indentation with spaces on or off.</para>
-<para>Note: Deprecated since &kate; 3 in &kde;4. Mixed indentation is the default behavior.
-Set <command>replace-tabs on;</command> to achieve space-only indentation.</para></listitem>
-</varlistentry>
-
<varlistentry id="variable-tab-indents">
<term><cmdsynopsis><command>tab-indents</command><arg>BOOL</arg></cmdsynopsis></term>
<listitem><para>Set key indentation on or off.</para></listitem>
diff --git a/doc/katepart/development.docbook b/doc/katepart/development.docbook
index 90b1216bb..669be3e85 100644
--- a/doc/katepart/development.docbook
+++ b/doc/katepart/development.docbook
@@ -273,7 +273,7 @@ Available attributes are:</term>
<para><userinput>casesensitive</userinput> defines, whether the keywords are case sensitive or not.</para>
<para><userinput>priority</userinput> is necessary if another highlight definition file uses the same extensions. The higher priority will win.</para>
<para><userinput>author</userinput> contains the name of the author and his email-address.</para>
-<para><userinput>license</userinput> contains the license, usually LGPL, Artistic, GPL or others.</para>
+<para><userinput>license</userinput> contains the license, usually the MIT license for new syntax-highlighting files.</para>
<para><userinput>style</userinput> contains the provided language and is used by the indenters for the attribute <literal>required-syntax-style</literal>.</para>
<para><userinput>hidden</userinput> defines whether the name should appear in &kappname;'s menus.</para>
<para>So the next line may look like this:</para>
More information about the kde-doc-english
mailing list