~ubuntu-branches/ubuntu/maverick/kdebase/maverick-updates

« back to all changes in this revision

Viewing changes to apps/doc/kwrite/index.docbook

Tags: 4:4.5.5-0ubuntu2
Update to final 4.5 version per micro-release exception (LP:  #757065)

Show diffs side-by-side

added added

removed removed

Lines of Context:
40
40
</copyright>
41
41
<legalnotice>&FDLNotice;</legalnotice>
42
42
 
43
 
<date>2010-03-04</date>
 
43
<date>2010-09-16</date>
44
44
<releaseinfo>4.5</releaseinfo>
45
45
 
46
46
<abstract>
1373
1373
<para>You can overwrite the default encoding set in <menuchoice>
1374
1374
<guimenu>Settings</guimenu>
1375
1375
<guimenuitem>Configure
1376
 
Editor...</guimenuitem></menuchoice> in the <guilabel>Open/Save</guilabel> tab
 
1376
Editor...</guimenuitem></menuchoice> in the <guilabel>Open/Save</guilabel> page
1377
1377
to set a different encoding for your current document. The encoding you
1378
1378
set here will be only valid for your current document.</para>
1379
1379
 </listitem>
1395
1395
<varlistentry>
1396
1396
<term><anchor id="tools-add-byte-mark-order"/><menuchoice>
1397
1397
<guimenu>Tools</guimenu>
1398
 
<guisubmenu>Add Byte Mark Order</guisubmenu></menuchoice></term>
 
1398
<guisubmenu>Add Byte Mark Order (BOM)</guisubmenu></menuchoice></term>
1399
1399
 <listitem>
1400
1400
<para>Checking this action you can explicitly add a byte order mark for unicode
1401
1401
encoded documents. The byte order mark (BOM) is a Unicode character used to signal 
1423
1423
<guimenuitem>Word Completion</guimenuitem>
1424
1424
</menuchoice> (Power user mode)</term>
1425
1425
<listitem>
1426
 
<para><guimenuitem>Reuse Word Below</guimenuitem> and <guimenuitem>Reuse Word
1427
 
Above</guimenuitem> complete the currently typed text by searching for similar
 
1426
<para><guimenuitem>Reuse Word Below</guimenuitem> (<keycombo action="simul">&Ctrl;
 
1427
<keycap>9</keycap></keycombo>) and <guimenuitem>Reuse Word Above</guimenuitem> 
 
1428
(<keycombo action="simul">&Ctrl; <keycap>8</keycap></keycombo>) complete the 
 
1429
currently typed text by searching for similar
1428
1430
words backward or forward from the current cursor position. <guimenuitem>Shell
1429
1431
Completion</guimenuitem> pops up a completion box with matching entries.</para>
1430
1432
</listitem>
1436
1438
<keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
1437
1439
</shortcut>
1438
1440
<guimenu>Tools</guimenu>
1439
 
<guimenuitem>Automatic Spelling</guimenuitem>
 
1441
<guimenuitem>Automatic Spell Checking</guimenuitem>
1440
1442
</menuchoice></term>
1441
1443
<listitem>
1442
 
<para>When <guimenuitem>Automatic Spelling</guimenuitem> is enabled, wrong text
 
1444
<para>When <guimenuitem>Automatic Spell Checking</guimenuitem> is enabled, wrong text
1443
1445
is underlined in the document on-the-fly.</para>
1444
1446
</listitem>
1445
1447
</varlistentry>
1581
1583
 </listitem>
1582
1584
</varlistentry>
1583
1585
 
 
1586
<!-- Indent/Inindent no longer in the menu ???, but shortcuts work-->
1584
1587
<varlistentry>
1585
1588
<term><anchor id="indent"/><menuchoice>
1586
1589
<shortcut>
1603
1606
<listitem>
1604
1607
<para>This reduces the paragraph's indentation by one step. The size of the step
1605
1608
depends on the <link linkend="pref-edit-indent"> indentation settings</link>.</para>
1606
 
 
1607
1609
</listitem>
1608
1610
</varlistentry>
1609
 
 
 
1611
<!-- -->
1610
1612
<varlistentry>
1611
1613
<term><anchor id="cleanindent"/><menuchoice>
1612
1614
<guimenu>Tools</guimenu><guimenuitem>Clean
1682
1684
<varlistentry>
1683
1685
<term><menuchoice>
1684
1686
<shortcut>
1685
 
<keycombo action="simul">&Alt;&Ctrl;<keycap>U</keycap></keycombo>
 
1687
<keycombo action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo>
1686
1688
</shortcut>
1687
1689
<guimenu>Tools</guimenu>
1688
1690
<guimenuitem>Capitalize</guimenuitem>
1707
1709
<varlistentry>
1708
1710
<term><menuchoice>
1709
1711
<guimenu>Tools</guimenu>
1710
 
<guimenuitem>Word Wrap Document</guimenuitem>
 
1712
<guimenuitem>Apply Word Wrap</guimenuitem>
1711
1713
</menuchoice></term>
1712
1714
<listitem><para>Apply static word wrapping on all the document. That means that
1713
1715
a new line of text will automatically start when the current
1721
1723
<para>If the <link linkend="pref-plugins">plugin</link> Insert File is enabled, you will
1722
1724
find here an additional menu item <guimenuitem>Insert File...</guimenuitem>.
1723
1725
</para>
 
1726
<!-- Data Tools and Insane HTML (LE) Expansion Ctrl+. when plugins are enabled-->
1724
1727
</sect1>
1725
1728
 
1726
1729
<sect1 id="settings">
2240
2243
 
2241
2244
<varlistentry>
2242
2245
<term><guilabel>Allow scrolling past the end of the document</guilabel></term> <listitem>
2243
 
<para>This option lets you scroll past the end of the document. This can be used to vertically centre the bottom of the document, or put it on top of the current view.</para></listitem>
 
2246
<para>This option lets you scroll past the end of the document. This can be used to vertically center the bottom of the document, or put it on top of the current view.</para></listitem>
2244
2247
</varlistentry>
2245
2248
</variablelist>
2246
2249
</listitem>
2448
2451
<varlistentry>
2449
2452
<term><guilabel>Auto Completion enabled</guilabel></term>
2450
2453
<listitem>
2451
 
<para>If this is enabled, the editor will calculate the number
2452
 
of spaces up to the next tab position as defined by the tab width,
2453
 
and insert that number of spaces instead of a &Tab; character.</para>
 
2454
<para>If enabled, a word completion box automatically pops up during typing
 
2455
showing a list of text entries to complete the current text under the
 
2456
cursor.</para>
2454
2457
</listitem>
2455
2458
</varlistentry>
2456
2459
</variablelist>
2498
2501
<para>By default, an extra status bar will be used when the Vi input mode is
2499
2502
enabled. This status bar shows commands while they are being typed and
2500
2503
messages/errors produced by Vi commands.</para>
2501
 
<para>Checking this options will hide this extra status line.</para>
 
2504
<para>Checking this option will hide this extra status line.</para>
2502
2505
</listitem>
2503
2506
</varlistentry>
2504
2507
</variablelist>
2540
2543
<term><guilabel>File Format</guilabel></term>
2541
2544
<listitem>
2542
2545
<variablelist>
 
2546
 
2543
2547
<varlistentry>
2544
2548
<term><guilabel>Encoding:</guilabel></term>
2545
2549
<listitem>
2546
 
<para>This sets the default character encoding for your files.</para>
 
2550
<para>This defines the standard encoding to use to open/save files, if not changed 
 
2551
in the open/save dialog or by using a command line option.</para>
2547
2552
</listitem>
2548
2553
</varlistentry>
 
2554
 
2549
2555
<varlistentry>
2550
 
<term><guilabel>Encoding autodetection</guilabel></term>
 
2556
<term><guilabel>Encoding Detection</guilabel></term>
2551
2557
<listitem>
2552
2558
<para>Select an item from the drop down box, either to disable autodetection or
2553
2559
use <guilabel>Universal</guilabel> to enable autodetection for all encodings. But as
2554
2560
this may probably only detect utf-8/utf-16, selecting a region will use custom heuristics
2555
 
for better results.</para>
2556
 
</listitem>
2557
 
</varlistentry>
 
2561
for better results.
 
2562
If neither the encoding chosen as standard above, nor the encoding specified 
 
2563
in the open/save dialog, nor the encoding specified on command line match 
 
2564
the content of the file, this detection will be run.</para>
 
2565
</listitem>
 
2566
</varlistentry>
 
2567
 
 
2568
<varlistentry>
 
2569
<term><guilabel>Fallback Encoding</guilabel></term>
 
2570
<listitem>
 
2571
<para>This defines the fallback encoding to try for opening files if neither the 
 
2572
encoding chosen as standard above, nor the encoding specified in the open/
 
2573
save dialog, nor the encoding specified on command line match the content of 
 
2574
the file.  Before this is used, an attempt will be made to determine the 
 
2575
encoding to use by looking for a byte order marker at start of file: if one 
 
2576
is found, the right unicode encoding will be chosen; otherwise encoding 
 
2577
detection will run, if both fail fallback encoding will be tried.</para>
 
2578
</listitem>
 
2579
</varlistentry>
 
2580
 
2558
2581
<varlistentry>
2559
2582
<term><guilabel>End of line:</guilabel></term>
2560
2583
<listitem>
2562
2585
document. You have the choice between &UNIX;, DOS/&Windows; or Macintosh.</para>
2563
2586
</listitem>
2564
2587
</varlistentry>
 
2588
 
2565
2589
<varlistentry>
2566
2590
<term><guilabel>Automatic end of line detection</guilabel></term>
2567
2591
<listitem>
2791
2815
If you press Enter and AutoBrace is enabled, it will insert your favorite new brace where it belongs. Looks like this:
2792
2816
-->
2793
2817
<varlistentry>
2794
 
<term><guilabel>DataTools</guilabel></term>
 
2818
<term><guilabel>Data Tools</guilabel></term>
2795
2819
<listitem><para>Enables data tools like thesaurus and spell check (if installed).
2796
2820
Data tools are only available when text is selected, or when the right mouse
2797
2821
button is clicked over a word. If no data tools are offered even when text
2809
2833
as HTML to the system clipboard.</para></listitem>
2810
2834
</varlistentry>
2811
2835
<varlistentry>
 
2836
<term><guilabel>IconInserter</guilabel></term>
 
2837
<listitem><para>The icon inserter plugin is only of use for &kde; developers: It adds an item 
 
2838
<guimenuitem>Insert KIcon-Code</guimenuitem> into the context menu of the editor. 
 
2839
If activated, the &kde;'s icon chooser opens (showing application icons, action icons &etc;..). 
 
2840
If you click on it, the file name without file extension will be inserted as 
 
2841
text. Useful only for setting icons via &kde;'s framework through the KIcon() class.
 
2842
</para></listitem>
 
2843
</varlistentry>
 
2844
<varlistentry>
 
2845
<term><guilabel>Insane (not ZEN) HTML coding (light edition)</guilabel></term>
 
2846
<listitem><para>A plugin, which does zen-coding like selector completion.
 
2847
For more information see <ulink url="http://en.wikipedia.org/wiki/Zen_Coding">
 
2848
Zen Coding</ulink>.</para></listitem>
 
2849
</varlistentry>
 
2850
 
 
2851
<varlistentry>
2812
2852
<term><guilabel>Insert File</guilabel></term>
2813
2853
<listitem><para>This plugin allows you to insert any readable file at the cursor position.
2814
2854
If enabled, the <guimenu>Tools</guimenu> menu has an additional menu item
2815
2855
<guimenuitem>Insert File</guimenuitem>.</para></listitem>
2816
2856
</varlistentry>
 
2857
<!-- not build any longer in kde 4.5
2817
2858
<varlistentry>
2818
2859
<term>Python Encoding check</term>
2819
2860
<listitem><para>This plugin is always enabled.
2823
2864
current encoding to the file.
2824
2865
</para></listitem>
2825
2866
</varlistentry>
 
2867
-->
2826
2868
</variablelist>
2827
2869
<!--
2828
2870
kdelibs/kate/plugins/ has additional plugins