← Back to branch summary

~ubuntu-branches/ubuntu/saucy/kate/saucy

« back to all changes in this revision

Viewing changes to doc/kate/fundamentals.docbook

  • Committer: Package Import Robot
  • Author(s): Jonathan Riddell, Rohan Garg, Jonathan Riddell
  • Date: 2013-06-21 00:48:29 UTC
  • mfrom: (1.1.28)
  • Revision ID: package-import@ubuntu.com-20130621004829-y2ui02eg0j47h94y
Tags: 4:4.10.80-0ubuntu1
[ Rohan Garg ]
* New upstream release
  - Update and sort install files
  - Drop kubuntu_pate_find_python.diff, kubuntu_kate_initial_preference.patch,
    kubuntu_find_python.diff from debian/patches , not required

[ Jonathan Riddell ]
* New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kate/fundamentals.docbook
510
510
 
511
511
</sect1>
512
512
 
 
513
<sect1 id="kate-mdi">
 
514
<title>Working With the &kate; <acronym>MDI</acronym></title>
 
515
 
 
516
<sect2 id="kate-mdi-overview">
 
517
<title>Overview</title>
 
518
 
 
519
<para>Window, View, Document, Frame, Editor... What are they all in
 
520
the terminology of &kate;, and how do you get the most out of it? This
 
521
chapter will explain all of that, and even more.</para>
 
522
 
 
523
<sect3 id="kate-mdi-overview-mainwindow">
 
524
 
 
525
<title>The Main Window</title>
 
526
 
 
527
<para><indexterm><primary>Main window</primary></indexterm>
 
528
The &kate; Main Window is a standard &kde; application window,
 
529
with the addition of side bars containing tool views. It has a
 
530
menubar with all the common menus, and some more, and a toolbar
 
531
providing access to commonly used commands.</para>
 
532
 
 
533
<para>The most important part of the window is the editing area, by
 
534
default displaying a single text editor component, in which you can
 
535
work with your documents.</para>
 
536
 
 
537
<para>The docking capabilities of the window is used for the tool
 
538
windows:</para>
 
539
 
 
540
<itemizedlist>
 
541
<listitem><para><link linkend="kate-mdi-tools-file-list">The Documents List</link></para></listitem>
 
542
<listitem><para><link linkend="kate-application-plugin-fsbrowser">The Filesystem
 
543
Browser</link></para></listitem>
 
544
<listitem><para><link linkend="kate-mdi-tools-konsole">The Built in Terminal Emulator</link></para></listitem>
 
545
</itemizedlist>
 
546
 
 
547
<para>And possibly other tool views, for example provided by
 
548
plugins.</para>
 
549
 
 
550
<para>Tool views can be positioned in any sidebar, to move a tool right click
 
551
its sidebar button and select from the &RMB; menu</para>
 
552
 
 
553
<para>A tool view can be marked as <emphasis>persistent</emphasis> in the &RMB;
 
554
menu for its sidebar button. The sidebar can contain
 
555
more tools at one time so that when a tool is persistant other tools can be
 
556
shown simultaneously.</para>
 
557
 
 
558
</sect3>
 
559
 
 
560
 
 
561
</sect2>
 
562
 
 
563
<sect2 id="kate-mdi-editor">
 
564
 
 
565
<title>The Editor area</title>
 
566
 
 
567
<para><indexterm><primary>Editing Area</primary></indexterm>
 
568
&kate; is capable of having more than one document open at the
 
569
same time, and also of splitting the editing area into any number of
 
570
frames, similar to how for example &konqueror; or the popular
 
571
<application>emacs</application> text editor works. This way you can
 
572
view several documents at the same time, or more instances of the same
 
573
document, handy for example if your document contains definitions in
 
574
the top that you want to see often for reference. Or you could view a
 
575
program source header in one frame, while editing the implementation
 
576
file in another.</para>
 
577
 
 
578
<para>When a document is available in more than one editor, changes
 
579
made in one editor will immediately be reflected in the others as
 
580
well. This includes changing the text as well as selecting
 
581
text. Search operations or cursor movement is only reflected in the
 
582
current editor.</para>
 
583
 
 
584
<para>It is currently not possible to have more instances of the same
 
585
document open in the sense that one instance will be edited while the
 
586
other will not.</para>
 
587
 
 
588
<para>When splitting an editor into two frames, it is divided into two
 
589
equally sized frames, both displaying the current document of that
 
590
editor. The new frame will be at the bottom (in the case of a
 
591
horizontal split) or at the right (for a vertical split). The new
 
592
frame gets the focus, which is visualized by the blinking cursor bar in the
 
593
focused frame.</para>
 
594
 
 
595
</sect2>
 
596
 
 
597
<sect2 id="kate-mdi-tools-file-list">
 
598
<title>The Documents List</title>
 
599
 
 
600
<para><indexterm><primary>Documents list</primary></indexterm>
 
601
The documents list displays a list of all documents currently open in
 
602
&kate;. Modified files will have a small <guiicon>floppy
 
603
disk</guiicon> icon on their left to indicate that state.</para>
 
604
 
 
605
<para>By default, the Documents list appears in
 
606
<guimenuitem>Tree Mode</guimenuitem>, which displays the folder structure
 
607
surrounding all currently open documents. Also available is
 
608
<guimenuitem>List Mode</guimenuitem>, which displays a simple list of all
 
609
open documents. You can switch modes by right-clicking on the list and selecting
 
610
from the <guisubmenu>View Mode</guisubmenu> menu.</para>
 
611
 
 
612
<para>If two or more files with the same name (located in different
 
613
folders) are open in <guimenuitem>List Mode</guimenuitem>, the names of the second will be prepended
 
614
<quote>(2)</quote> and so on. The tool-tip for the file will
 
615
display its full name including the path, allowing you to choose the
 
616
desired one.</para> <para>To display a document in the currently
 
617
active frame, click the document name in the list.</para>
 
618
 
 
619
<!-- FIXME missing options in 4.11 context menu:
 
620
Close
 
621
Copy Filename -> full doc path to clipboard
 
622
Open With submenu
 
623
-->
 
624
<para>You can sort the list in a few different ways by rightclicking the
 
625
list and selecting from the <guisubmenu>Sort By</guisubmenu> menu.
 
626
 
 
627
The options are
 
628
<variablelist>
 
629
 
 
630
<varlistentry>
 
631
<term><guimenuitem>Opening Order</guimenuitem></term>
 
632
<listitem><para>Lists the documents in the order of opening</para></listitem>
 
633
</varlistentry>
 
634
 
 
635
<varlistentry>
 
636
<term><guimenuitem>Document Name</guimenuitem></term>
 
637
<listitem><para>Lists the documents alphabetically by their name.</para></listitem>
 
638
</varlistentry>
 
639
 
 
640
<varlistentry>
 
641
<term><guimenuitem>Document Path</guimenuitem></term>
 
642
<listitem><para>Lists the documents alphabetically by the path to them.</para></listitem>
 
643
</varlistentry>
 
644
 
 
645
</variablelist>
 
646
 
 
647
</para>
 
648
 
 
649
<para>The document list will per default visualize your history by shading the
 
650
entries for the most recent documents with a background color. If the document
 
651
was edited, an extra color is blended in. The most recent document has the
 
652
strongest color, so that you can easily find the documents you are working on.
 
653
This feature can be disabled in the
 
654
<link linkend="config-dialog-treeview">Documents</link> page
 
655
of the configuration dialog.</para>
 
656
<!-- Tree View was renamed to Documents - http://commit-digest.org/issues/2011-08-28/ -->
 
657
<para>The default location of the document list in the &kate; window is to the left of the
 
658
editing area.</para>
 
659
</sect2>
 
660
 
 
661
<!-- command line + Terminal-->
 
662
 
 
663
<sect2 id="kate-mdi-tools-konsole">
 
664
<title>The Built in Terminal Emulator</title>
 
665
 
 
666
<para><indexterm><primary>Terminal emulator</primary></indexterm>
 
667
The built in Terminal Emulator is a copy of the &kde; &konsole;
 
668
terminal application, for your convenience. It is available from the
 
669
<menuchoice><guimenu>View</guimenu><guisubmenu>Tools Views</guisubmenu>
 
670
<guimenuitem>Show Terminal</guimenuitem></menuchoice> menu item and will get the focus
 
671
whenever displayed. Additionally, if the <link
 
672
linkend="config-dialog-general-sync-konsole">Automatically synchronize
 
673
the terminal with the current document when possible</link> option is enabled, it will
 
674
change into the directory of the current document if
 
675
possible when it is displayed, or when the current document
 
676
changes.</para>
 
677
 
 
678
<para>The default location in the &kate; window is at the bottom,
 
679
below the editing area.</para>
 
680
 
 
681
<para>You can configure the &konsole; using its &RMB; menu, for more
 
682
information, see the <ulink url="help:/konsole/index.htm">&konsole; manual</ulink>.</para>
 
683
 
 
684
<para>The built-in terminal emulator is provided by the Terminal Tool View plugin,
 
685
which is enabled by default.</para>
 
686
 
 
687
</sect2>
 
688
 
 
689
</sect1>
 
690
 
513
691
<sect1 id="fundamentals-using-sessions">
514
692
<title>Using Sessions</title>
515
693
 
602
780
<listitem>
603
781
<para>Offers detailed documentation on all menu commands,
604
782
configuration options, tools, dialogs, plugins &etc; as well as
605
 
descriptions of of the &kate; window, the editor and various concepts
 
783
descriptions of the &kate; window, the editor and various concepts
606
784
used in the application.</para>
607
785
 
608
786
<para>Press <keycap>F1</keycap> or use the