Differential D7718 Diff 19265 doc/katepart/configuring.docbook

Changeset View

Standalone View

View Options

doc/katepart/configuring.docbook

Context not available.
132for code folding, if code folding is available.</para></listitem> 132​for code folding, if code folding is available.</para></listitem>
133</varlistentry> 133​</varlistentry>
134<varlistentry> 134​<varlistentry>
135​<term><guilabel>Show preview of folded code
136​</guilabel></term>
137​<listitem><para>If checked, hovering over a folded region shows a preview of the folded text
138​in a popup.</para></listitem>
139​</varlistentry>
140​<varlistentry>
135<term><guilabel>Show icon border 141​<term><guilabel>Show icon border
136</guilabel></term> 142​</guilabel></term>
137<listitem><para>If this is checked, you will see an icon border on the left 143​<listitem><para>If this is checked, you will see an icon border on the left
Context not available.
158for instance show bookmarks.</para></listitem> 164​for instance show bookmarks.</para></listitem>
159</varlistentry> 165​</varlistentry>
160<varlistentry> 166​<varlistentry>
167​<term><guilabel>Show text preview on scrollbar</guilabel></term>
168​<listitem><para>If this option is checked, and you hover the scrollbar with the mouse cursor
dhaumannUnsubmitted
Done

Typo: hoover -> hover

dhaumann: Typo: hoover -> hover
169​a small text preview with several lines of the current document around the cursor position will be displayed.
170​This allows you to quickly switch to another part of the document.</para>
171​</listitem>
172​</varlistentry>
173​<varlistentry>
161<term><guilabel>Show scrollbar mini-map</guilabel></term> 174​<term><guilabel>Show scrollbar mini-map</guilabel></term>
162<listitem><para>If this option is checked, every new view will show a mini map of the 175​<listitem><para>If this option is checked, every new view will show a mini map of the
163document on the vertical scrollbar.</para> 176​document on the vertical scrollbar.</para>
Context not available.
169<listitem><para>Adjusts the width of the scrollbar mini-map, defined in pixels. 182​<listitem><para>Adjusts the width of the scrollbar mini-map, defined in pixels.
170</para></listitem> 183​</para></listitem>
171</varlistentry> 184​</varlistentry>
185​<varlistentry>
186​<term><guilabel>Scrollbars visibility</guilabel></term>
187​<listitem><para>Switch the scrollbar on, off or show the scroolbar only when needed.
188​Click with the &LMB; on the blue rectangle to display the line numer range of the docmument displayed on the screen.
189​Keep the &LMB; pressed outside the blue rectangle to automatically scroll through the document
190​</para></listitem>
191​</varlistentry>
172</variablelist> 192​</variablelist>
173</listitem> 193​</listitem>
174</varlistentry> 194​</varlistentry>
Context not available.
1272For example, the variable indent mode uses document variables for its 1292​For example, the variable indent mode uses document variables for its
1273configuration.</para> 1293​configuration.</para>
1274 1294​
1275<para>The variables listed here documents &kappname; version 3.7. More variables 1295​<para>The variables listed here documents &kappname; version 5.38. More variables
dhaumannUnsubmitted
Not Done

This will get outdated again and again. Maybe just say: The variables listed here documents the current state. More ...

Or similar?

dhaumann: This will get outdated again and again. Maybe just say: The variables listed here documents the…
lueckAuthorUnsubmitted
Not Done

I'd prefer to have a date/version similar to date/releaseinfo in the docbook header.
This helps to see if the info could be obsolete as before this patch with "version 3.7"

lueck: I'd prefer to have a date/version similar to date/releaseinfo in the docbook header. This helps…
1276may be added in the future. There are 3 possible types of values for variables, 1296​may be added in the future. There are 3 possible types of values for variables,
1277with the following valid expressions: 1297​with the following valid expressions:
1278<itemizedlist> 1298​<itemizedlist>
Context not available.
1289 1309​
1290<variablelist> 1310​<variablelist>
1291 1311​
1312​<varlistentry id="variable-auto-brackets">
1313​<term><cmdsynopsis><command>auto-brackets</command><arg>BOOL</arg></cmdsynopsis></term>
dhaumannUnsubmitted
Done

spell-checking in the auto-brackets section looks wrong. Could you have a second look?

dhaumann: spell-checking in the auto-brackets section looks wrong. Could you have a second look?
1314​<listitem><para>Enable automatic insertion of brackets.</para></listitem>
1315​</varlistentry>
1316​
1292<varlistentry id="variable-auto-center-lines"> 1317​<varlistentry id="variable-auto-center-lines">
1293<term><cmdsynopsis><command>auto-center-lines</command><arg>INT</arg></cmdsynopsis></term> 1318​<term><cmdsynopsis><command>auto-center-lines</command><arg>INT</arg></cmdsynopsis></term>
1294<listitem><para>Set the number of autocenter lines.</para></listitem> 1319​<listitem><para>Set the number of autocenter lines.</para></listitem>
1295</varlistentry> 1320​</varlistentry>
1296 1321​
1297<varlistentry id="variable-auto-insert-doxygen"> ​
1298<term><cmdsynopsis><command>auto-insert-doxygen</command><arg>BOOL</arg></cmdsynopsis></term> ​
1299<listitem><para>Turn insertion of the leading asterisk in doxygen comments on or ​
1300off. This has no effect unless you use the C-style auto-indenter. </para></listitem> ​
1301</varlistentry> ​
1302 ​
1303<varlistentry id="variable-background-color"> 1322​<varlistentry id="variable-background-color">
1304<term><cmdsynopsis><command>background-color</command><arg>STRING</arg></cmdsynopsis></term> 1323​<term><cmdsynopsis><command>background-color</command><arg>STRING</arg></cmdsynopsis></term>
1305<listitem><para>Set the document background color. The value must be something 1324​<listitem><para>Set the document background color. The value must be something
Context not available.
1319</varlistentry> 1338​</varlistentry>
1320 1339​
1321<varlistentry id="variable-byte-order-mark"> 1340​<varlistentry id="variable-byte-order-mark">
1322<term><cmdsynopsis><command>bom | byte-order-mark</command><arg>BOOL</arg></cmdsynopsis></term> 1341​<term><cmdsynopsis><command>bom | byte-order-mark | byte-order-marker</command><arg>BOOL</arg></cmdsynopsis></term>
1323<listitem><para>Enable/disable the byte order mark (BOM) when saving files in Unicode format 1342​<listitem><para>Enable/disable the byte order mark (BOM) when saving files in Unicode format
1324(utf8, utf16, utf32).</para> 1343​(utf8, utf16, utf32).</para>
1325<para>Since: &kate; 3.4 (&kde; 4.4)</para></listitem> 1344​<para>Since: &kate; 3.4 (&kde; 4.4)</para></listitem>
1326</varlistentry> 1345​</varlistentry>
1327 1346​
1328<varlistentry id="variable-encoding"> ​
1329<term><cmdsynopsis><command>encoding</command><arg>STRING</arg></cmdsynopsis></term> ​
1330<listitem><para>Set the encoding used for loading or saving the file. ​
1331As the variables in the document will be read after loading, this impacts only the saving. ​
1332If you place it in a <filename>.kateconfig</filename> file, it will have an effect for the loading, too.</para> ​
1333<para>Since: &kate; 3.10 (&kde; 4.10)</para></listitem> ​
1334</varlistentry> ​
1335 ​
1336<varlistentry id="variable-bracket-highlight-color"> 1347​<varlistentry id="variable-bracket-highlight-color">
1337<term><cmdsynopsis><command>bracket-highlight-color</command><arg>STRING</arg></cmdsynopsis></term> 1348​<term><cmdsynopsis><command>bracket-highlight-color</command><arg>STRING</arg></cmdsynopsis></term>
1338<listitem><para>Set the color for the bracket highlight. The value must be 1349​<listitem><para>Set the color for the bracket highlight. The value must be
Context not available.
1373</para></listitem> 1384​</para></listitem>
1374</varlistentry> 1385​</varlistentry>
1375 1386​
1387​<varlistentry id="variable-folding-preview">
1388​<term><cmdsynopsis><command>folding-preview</command><arg>BOOL</arg></cmdsynopsis></term>
1389​<listitem><para>Enable folding preview in the editor border.</para></listitem>
dhaumannUnsubmitted
Done

remove "on"

dhaumann: remove "on"
lueckAuthorUnsubmitted
Done

frameworks/ktexteditor/src/variableeditor/variablelineedit.cpp:200 has this typo as well:
item->setHelpText(i18nc("short translation please", "Enable folding preview on in the editor border."));

lueck: frameworks/ktexteditor/src/variableeditor/variablelineedit.cpp:200 has this typo as well: item…
lueckAuthorUnsubmitted
Not Done

Fixed typo in variablelineedit.cpp with https://commits.kde.org/ktexteditor/fd670c9d44ff1923266f2547b88b164cd13e6d20

lueck: Fixed typo in variablelineedit.cpp with https://commits.kde.
1390​</varlistentry>
1391​
1376<varlistentry id="variable-font-size"> 1392​<varlistentry id="variable-font-size">
1377<term><cmdsynopsis><command>font-size</command><arg>INT</arg></cmdsynopsis></term> 1393​<term><cmdsynopsis><command>font-size</command><arg>INT</arg></cmdsynopsis></term>
1378<listitem><para>Set the point size of the document font.</para></listitem> 1394​<listitem><para>Set the point size of the document font.</para></listitem>
Context not available.
1431<listitem><para>Set the display of line numbers on or off.</para></listitem> 1447​<listitem><para>Set the display of line numbers on or off.</para></listitem>
1432</varlistentry> 1448​</varlistentry>
1433 1449​
1434<varlistentry id="variable-mixed-indent"> ​
1435<term><cmdsynopsis><command>mixed-indent</command><arg>BOOL</arg></cmdsynopsis></term> ​
1436<listitem><para>Set mixed indentation, as with &Emacs;, on or off.</para> ​
1437<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> ​
1438</varlistentry> ​
1439 ​
1440<varlistentry id="variable-newline-at-eof"> 1450​<varlistentry id="variable-newline-at-eof">
1441<term><cmdsynopsis><command>newline-at-eof</command><arg>BOOL</arg></cmdsynopsis></term> 1451​<term><cmdsynopsis><command>newline-at-eof</command><arg>BOOL</arg></cmdsynopsis></term>
1442<listitem><para>Add an empty line at the end of the file (EOF) when saving the document.</para> 1452​<listitem><para>Add an empty line at the end of the file (EOF) when saving the document.</para>
Context not available.
1454on or off.</para></listitem> 1464​on or off.</para></listitem>
1455</varlistentry> 1465​</varlistentry>
1456 1466​
1457<varlistentry id="variable-remove-trailing-space"> 1467​<varlistentry id="variable-replace-tabs-save">
1458<term><cmdsynopsis><command>remove-trailing-space</command><arg>BOOL</arg></cmdsynopsis></term> 1468​<term><cmdsynopsis><command>replace-tabs-save</command><arg>BOOL</arg></cmdsynopsis></term>
1459<listitem><para>Set dynamic end of line cleanup on or off.</para> 1469​<listitem><para>Set tab to space conversion on save on or off.</para></listitem>
1460<para>Note: Deprecated since &kde; 4.10. Please use <link linkend="variable-remove-trailing-spaces"> 1470​</varlistentry>
1461remove-trailing-spaces</link> with the desired choice instead. 1471​
1462</para></listitem> 1472​<varlistentry id="variable-replace-tabs">
1473​<term><cmdsynopsis><command>replace-tabs</command><arg>BOOL</arg></cmdsynopsis></term>
1474​<listitem><para>Set dynamic tab to space conversion on or off.</para></listitem>
dhaumannUnsubmitted
Not Done

Instead of the term 'conversion' we may want to use "expansion". But I may be wrong, since I am not a native English speaker.

dhaumann: Instead of the term 'conversion' we may want to use "expansion". But I may be wrong, since I am…
1463</varlistentry> 1475​</varlistentry>
1464 1476​
1465<varlistentry id="variable-remove-trailing-spaces"> 1477​<varlistentry id="variable-remove-trailing-spaces">
Context not available.
1471modified lines. The modified lines are marked by the line modification system.</para></listitem> 1483​modified lines. The modified lines are marked by the line modification system.</para></listitem>
1472<listitem><para><userinput>all</userinput>, <userinput>*</userinput> or <userinput>2</userinput>: remove trailing spaces in the entire document.</para></listitem> 1484​<listitem><para><userinput>all</userinput>, <userinput>*</userinput> or <userinput>2</userinput>: remove trailing spaces in the entire document.</para></listitem>
1473</itemizedlist> 1485​</itemizedlist>
1474<para>Since: &kde; 4.10. This deprecates the options <userinput>remove-trailing-space</userinput> and <userinput>replace-trailing-space-save</userinput>. 1486​<para>Since: &kde; 4.10.
1475</para></listitem> 1487​</para></listitem>
1476</varlistentry> 1488​</varlistentry>
1477 1489​
1478<varlistentry id="variable-replace-tabs-save"> 1490​<varlistentry id="variable-scrollbar-minimap">
1479<term><cmdsynopsis><command>replace-tabs-save</command><arg>BOOL</arg></cmdsynopsis></term> 1491​<term><cmdsynopsis><command>scrollbar-minimap</command><arg>BOOL</arg></cmdsynopsis></term>
1480<listitem><para>Set tab to space conversion on save on or off.</para></listitem> 1492​<listitem><para>Show scrollbar minimap.</para></listitem>
1481</varlistentry> 1493​</varlistentry>
1482 1494​
1483<varlistentry id="variable-replace-tabs"> 1495​<varlistentry id="variable-scrollbar-preview">
1484<term><cmdsynopsis><command>replace-tabs</command><arg>BOOL</arg></cmdsynopsis></term> 1496​<term><cmdsynopsis><command>scrollbar-preview</command><arg>BOOL</arg></cmdsynopsis></term>
1485<listitem><para>Set dynamic tab to space conversion on or off.</para></listitem> 1497​<listitem><para>Show scrollbar preview.</para></listitem>
1486</varlistentry> ​
1487 ​
1488<varlistentry id="variable-replace-trailing-space-save"> ​
1489<term><cmdsynopsis><command>replace-trailing-space-save</command><arg>BOOL</arg></cmdsynopsis></term> ​
1490<listitem><para>Set end of line cleanup on save on or off.</para> ​
1491<para>Note: Deprecated since &kde; 4.10. Please use <link linkend="variable-remove-trailing-spaces"> ​
1492remove-trailing-spaces</link> with the desired choice instead. ​
1493</para></listitem> ​
1494</varlistentry> 1498​</varlistentry>
1495 1499​
1496<varlistentry id="variable-scheme"> 1500​<varlistentry id="variable-scheme">
Context not available.
1516on or off.</para></listitem> 1520​on or off.</para></listitem>
1517</varlistentry> 1521​</varlistentry>
1518 1522​
1519<varlistentry id="variable-space-indent"> ​
1520<term><cmdsynopsis><command>space-indent</command><arg>BOOL</arg></cmdsynopsis></term> ​
1521<listitem><para>Set indentation with spaces on or off.</para> ​
1522<para>Note: Deprecated since &kate; 3 in &kde;4. Mixed indentation is the default behavior. ​
1523Set <command>replace-tabs on;</command> to achieve space-only indentation.</para></listitem> ​
1524</varlistentry> ​
1525 ​
1526<varlistentry id="variable-tab-indents"> 1523​<varlistentry id="variable-tab-indents">
1527<term><cmdsynopsis><command>tab-indents</command><arg>BOOL</arg></cmdsynopsis></term> 1524​<term><cmdsynopsis><command>tab-indents</command><arg>BOOL</arg></cmdsynopsis></term>
1528<listitem><para>Set &Tab; key indentation on or off.</para></listitem> 1525​<listitem><para>Set &Tab; key indentation on or off.</para></listitem>
Context not available.