From 8160f45350b33387b2d4c73e5fb3d6b7bf80f953 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Tue, 21 Jan 2014 22:16:18 +0900 Subject: [PATCH] Kate handbook review - chapter 3 --- doc/kate/configuring.docbook | 10 +-- doc/kate/mdi.docbook | 137 ++++++++++++++++++++++------------- doc/kate/menus.docbook | 2 +- 3 files changed, 93 insertions(+), 56 deletions(-) diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook index 6e10ef67a..a6b36469e 100644 --- a/doc/kate/configuring.docbook +++ b/doc/kate/configuring.docbook @@ -102,7 +102,7 @@ current document in the window title, rather than just the file name. -Sync Konsole with Active Document +Sync terminal emulator with active document This will cause the built-in &konsole; to cd into the directory of the active document when launched and when a new document gets the focus. If not enabled, you @@ -266,13 +266,13 @@ browser with the current document by pressing the - + Remember locations Select how long a browsing history you want. The browser does only remember individual locations, duplicates are removed. - + Remember filters Select how many filters you want remembered. Only individually distinct filters are remembered, duplicates are removed. @@ -291,7 +291,7 @@ filter over sessions. -The <guilabel>Doucment List</guilabel> Page +The <guilabel>Document List</guilabel> Page @@ -299,7 +299,7 @@ filter over sessions. This section allows you to enable or disable the background shading visualization of your recent activity, and chose which colors to use if enabled. See the section about The Document List for more about +linkend="kate-mdi-tools-document-list">The Document List for more about this feature. diff --git a/doc/kate/mdi.docbook b/doc/kate/mdi.docbook index dfeb48d03..0402c4d57 100644 --- a/doc/kate/mdi.docbook +++ b/doc/kate/mdi.docbook @@ -2,6 +2,7 @@ &Anders.Lund; &Anders.Lund.mail; +&tde-authors; @@ -32,7 +33,7 @@ work with your documents. windows: -The File List +The Document List The Filesystem Browser The Built in Terminal Emulator @@ -41,13 +42,16 @@ Browser And possibly other tool views, for example provided by plugins. -Tool views can be positioned in any sidebar, to move a tool right click -its sidebar button and select from the &RMB; menu +Tool views can be positioned in any sidebar. To move a tool, right click its +sidebar button and select the destination sidebar from the Move to menu that appears. -A tool view can be marked as persistent in the &RMB; -menu for its sidebar button. The sidebar can contain -more tools at one time so that when a tool is persistant other tools can be -shown simultaneously. +A tool view can be marked as persistent. Selecting another +tool view in the same sidebar will not hide any of the persistent tool views. +To make a tool view persistent, right click its sidebar button and select the +"Make persistent" entry from the Behavior menu that appears. + +Each sidebar can contain more than one tool, so when a tool is persistant +other tools can be shown simultaneously. @@ -82,23 +86,25 @@ other will not. When splitting an editor into two frames, it is divided into two equally sized frames, both displaying the current document of that editor. The new frame will be at the bottom (in the case of a -horizontal split) or at the right (for a vertical split). The new -frame gets the focus, which is visualized by a small green led in the -focused frame. +horizontal split) or at the right (for a vertical split) and will +get the focus. + +Refer to this section +for instructions on how to split the current editor. - + The Document List -File list -The file list displays a list of all documents currently open in +Document list +The document list displays a list of all documents currently open in &kate;. Modified files will have a small floppy disk icon on their left to indicate that state. If two or more files with the same name (located in different -folders) are open, the names of the second will be prepended -<2> and so on. The tool-tip for the file will +folders) are open, the name of the second will be appended with +(2) and so on. The tool-tip for the file will display its full name including the path, allowing you to choose the desired one. To display a document in the currently active frame, click the document name in the list. @@ -106,12 +112,12 @@ active frame, click the document name in the list. You can sort the list in a few different ways by rightclicking the list and selecting from the Sort By menu. -The options are +The options are: Opening Order -Lists the documents in the order of opening +Lists the documents in the order of opening. @@ -124,11 +130,16 @@ The options are Lists the documents alphabetically by URL. + +Manual Placement +Allows you to specify the order of the documents. You can change the order by dragging files up/down the list. + + -The document list will pr default visualize your history by shading the +The document list will per default visualize your history by shading the entries for the most recent documents with a background color. If the document was edited, an extra color is blended in. The most recent document has the strongest color, so that you can easily find the documents you are working on. @@ -136,8 +147,9 @@ This feature can be disabled in The Document List Page of the configuration dialog. -The default location in the &kate; window is to the left of the +The default location of the Document List in &kate; is to the left of the editing area. + @@ -154,7 +166,8 @@ elements: A Toolbar -This contains standard navigations tool buttons: +This contains standard navigations tool buttons (refer to this section +for instructions on how to show/hide individual toolbar buttons): Home @@ -162,29 +175,49 @@ elements: Up -This will cause the folder view to cd to the immediate parent of the currently displayed -folder if possible. +This will cause the folder view to cd to the immediate parent of the currently displayed folder if possible. Back -Causes the folder view to cd to the previously displayed folder in the history. -This button is disabled, if there is no previous item. +Causes the folder view to cd to the previously displayed folder in the history. This button is disabled if there is no previous item. Forward -Causes the folder view to cd to the next folder in the history. -This button is disabled, if there is no next folder. +Causes the folder view to cd to the next folder in the history. This button is disabled if there is no next folder. + + +Reload +Causes the folder view to refresh the current view. + + +Short View +The folder view will display only the file and folder names, without further details. + + +Detailed view +The folder view will display additional file and folder details (for example size, permission, modification date). + + +Bookmarks menu +A menu displaying your favourite folders for quick access to them. -Sync +Current document folder This button will cause the folder view to cd to the folder of the currently active -document if possible. This button is disabled, if the active document -is a new, unsaved file, or the folder in which it resides can not +document if possible. This button is disabled if the active document +is a new unsaved file or the folder in which it resides can not be decided. + +New folder... +Pressing this button will create a new subfolder in the current folder. + + +Delete +Pressing this button will delete the selected files/folders. + - @@ -193,10 +226,11 @@ be decided. Here you can type the path of a folder to browse. The &URL; entry maintains a list of previously typed paths. To choose one use -the arrow button to the right of the entry. -The &URL; entry has folder auto-completion. The completion -method can be set using the &RMB; menu of the text -entry. +the arrow button to the right of the entry. Refer to this section +to change the number of URLs to remember. +The &URL; entry has folder auto-completion capability. The completion +method can be set by right clicking of the &URL; text and selecting the preferred method +from the Text Completion menu. @@ -209,19 +243,23 @@ entry. A Filter Entry The Filter entry allows you to enter a filter for the files -displayed in the folder view. The filter uses standard globs; patterns +displayed in the folder view. The filter patterns must be separated by white space. Example: *.cpp *.h *.moc To display all files, enter a single asterisk -*. +* or no filter at all. The filter entry saves the last 10 filters entered between -sessions, to use one, press the arrow button on the right of the entry -and select the desired filter string. +sessions. To use one of them, press the arrow button on the right of the entry +and select the desired filter string. Refer to this section +to change the number of filter entries to remember. +The default location of the Filesystem Browser in &kate; is to the left of the +editing area. + @@ -231,20 +269,19 @@ and select the desired filter string. Terminal emulator The built in Terminal Emulator is a copy of the &tde; &konsole; terminal application, for your convenience. It is available from the -SettingsShow Terminal -Emulator menu item or by pressing the F7 key, and will get the focus -whenever displayed. Additionally, if the Sync &konsole; with -active document option is enabled, it will -change into the directory of the current document if -possible when it is displayed, or when the current document -changes. - -The default location in the &kate; window is at the bottom, +WindowTool ViewsShow Terminal menu item or by pressing the Terminal +button in the sidebar where the Terminal Emulator is located, and will receive focus +when displayed. +Additionally, if the Sync terminal emulator with +active document option is enabled, if possible it will +cd into the directory of the current document when it is displayed +or when another document is selected. + +The default location of the Terminal Emulator in &kate; is at the bottom, below the editing area. -You can configure the &konsole; using its &RMB; menu, for more +You can configure the Terminal Emulator using its &RMB; menu. For more information, see the &konsole; manual. diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook index 4267b2bd9..92c91618a 100644 --- a/doc/kate/menus.docbook +++ b/doc/kate/menus.docbook @@ -1016,7 +1016,7 @@ all your selected text follows the indentation mode you choose. Causes a realign of the current line or selected lines using the -indentation mode and indentation settings in the doucment. +indentation mode and indentation settings in the document.