From 6b48ef26eebc891aa50d441c83dff1cbe9faa2c5 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Sun, 12 Apr 2020 00:30:43 +0900 Subject: Kate: added documentation for sessions panel. This relates to bug 2491. Signed-off-by: Michele Calgaro --- doc/kate/configuring.docbook | 4 +- doc/kate/fundamentals.docbook | 55 +++++++++------------- doc/kate/mdi.docbook | 84 ++++++++++++++++++++++++++++++++-- doc/kate/menus.docbook | 104 +++++++++++++++++++++++++----------------- 4 files changed, 165 insertions(+), 82 deletions(-) diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook index 7cac74751..51ad5ee97 100644 --- a/doc/kate/configuring.docbook +++ b/doc/kate/configuring.docbook @@ -341,11 +341,11 @@ filter over sessions. -Backgound Shading +Background Shading 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-documents-list">The Document List for more about this feature. diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook index 05a56eac6..221e35450 100644 --- a/doc/kate/fundamentals.docbook +++ b/doc/kate/fundamentals.docbook @@ -258,7 +258,7 @@ site opened in one of &konqueror;'s windows. Working with &kate; Quick Start will show you how to -toggle four simple options that will let you configure some of &kate;'s +toggle simple options that will let you configure some of &kate;'s more powerful features right away. Shortcuts lays out some of the default keystroke shortcuts for those who can't or don't want to use a mouse. @@ -279,8 +279,8 @@ usual labeled icons. And above that, a menubar. -The left-hand window is a side bar. It combines the Documents -and Filesystem Browser windows. Switch between the two by clicking on the tabs +The left-hand window is a side bar. It combines the Documents panel, +Filesystem Browser and Sessions panel. Switch among the three by clicking on the tabs to the left of the window. @@ -290,10 +290,10 @@ name of the file. Use the Filesystem Browser window to open files. -You can toggle the Documents and Filesystem Browser window on and off in +You can toggle the Documents, Filesystem Browser and Sessions window on and off in WindowTool Views menu. This menu offers you your first glimpse into &kate;'s power and -flexibility. In this section we'll look at three items: +flexibility. In this section we'll look at four items: @@ -306,19 +306,30 @@ flexibility. In this section we'll look at three items: -Toggles the Documents on and off. If the Documents/Filesystem Browser side bar -window is not open, &kate; will open the side bar window. - +Toggles the Documents panel on and off. It will display the Documents panel in the side bar +if another panel was shown or will toggle the side bar open or closed otherwise. + + Show/Hide Filesystem Browser -Toggles the Filesystem Browser on and off. This menu item is the same as -Show Documents with one difference. Toggling -it on launches the window with the Filesystem Browser on top. +Toggles the Filesystem Browser on and off. It will display the Filesystem Browser in the side bar +if another panel was shown or will toggle the side bar open or closed otherwise. + + + + + +Show/Hide +Sessions + + +Toggles the Sessions panel on and off. It will display the Sessions panel in the side bar +if another panel was shown or will toggle the side bar open or closed otherwise. @@ -529,28 +540,6 @@ exported to the environment variable KATE_PID. When opening files from the built in terminal, Kate will automatically select the current instance if nothing else is indicated on the command line. - -Restoring old style &kate; behavior - -When you get used to using sessions you will hopefully see that they -provide a very simple and efficient tool for working in different areas. -However, if you prefer the old &kate; behavior (one instance opens all files), -you can easily achieve that by following this simple strategy: - - -Make &kate; always start with the -parameter by adding that to the command in the application preferences, -and additionally using a shell alias. -Configure &kate; to load the last used session at startup. - -Configure &kate; to save the file list when closing a session. - -Load the default session once - - - - - diff --git a/doc/kate/mdi.docbook b/doc/kate/mdi.docbook index 6a8020747..6920adfa3 100644 --- a/doc/kate/mdi.docbook +++ b/doc/kate/mdi.docbook @@ -33,9 +33,10 @@ work with your documents. windows: -The Document List +The Document List The Filesystem Browser +The Sessions panel The Built in Terminal Emulator @@ -94,11 +95,11 @@ for instructions on how to split the current editor. - + The Document List -Document list -The document list displays a list of all documents currently open in +Documents list +The Documents 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. @@ -262,6 +263,81 @@ editing area. + +The Sessions panel + +Sessions Panel +The Sessions panel displays a list of all existing &kate; sessions and +allows to manage them easily. + +The Sessions panel consists of a toolbar at the top followed by the list of known sessions. +The active session is marked by an icon on its right. +Please note that the active session and the currently selected session in the list may not be the same. +The difference is important because most of the session commands work on the currently selected session +and not on the active session. + + + +The session toolbar + +It contains the following toolbar buttons: + + +New +Creates a new session and switch to it. + + +Save +Save the current session. + + +Save as +Save the selected session as a new session. A checkbox allows to choose whether to switch +to the new session after saving or not. + + +Rename +Rename the selected session. + + +Delete +Delete the selected session. If the active session is deleted, a new session will +be automatically created. + + +Reload +Reload the active session from the last saved state. + + +Activate +Close the active session and switch to the selected one. The same action can be +performed by activating the selected session entry in the list using the mouse of the Enter key. + + +Toggle read only +Allows to set whether the selected session is read only or not. A read only session will not change +its properties and can't be saved, although documents can be edited and saved as normal. This option is great for +creating template sessions. + + +Move up +Move the selected session one position up in the list. + + +Move down +Move the selected session one position down in the list. + + + + + + +The session list +A list of all existing sessions. + + + + The Built in Terminal Emulator diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook index c25ef6d04..e238bc380 100644 --- a/doc/kate/menus.docbook +++ b/doc/kate/menus.docbook @@ -1126,55 +1126,60 @@ Editor... The <guimenu>Sessions</guimenu> Menu This menu contains entries for using and managing &kate; sessions. -For more information, read Using Sessions. +For more information, read +Using Sessions and the +Sessions panel. - - -Sessions -New -Creates a new empty session. All currently open files will -be closed. - + +SessionsSelect session +This submenu allows to select and switch to a given session. - - -SessionsOpen... - -Open an existing session. The Session Chooser dialog is -displayed to let you choose one. + +SessionsNew +Creates a new session and switch to it. - - -SessionsQuick Open - -This submenu lets you open an existing session. - + +SessionsSave +Save the current session. - - -SessionsSave - -Save the current session. If the session is anonymous, you will -be prompted for a session name. + +SessionsSave as +Save the selected session as a new session. A checkbox allows to choose whether to switch +to the new session after saving or not. - - -SessionsSave -As... -Save the current session under a new name. You are prompted for -a name to use. + +SessionsRename +Rename the selected session. - - -SessionsManage... - -Displays the Session Manager dialog which allows you to rename -and delete sessions. + +SessionsDelete +Delete the selected session. If the active session is deleted, a new session will +be automatically created. + + +SessionsReload +Reload the active session from the last saved state. + + +SessionsActivate +Close the active session and switch to the selected one. The same action can be +performed by activating the selected session entry in the list using the mouse of the Enter key. + + +SessionsToggle read only +Allows to set whether the selected session is read only or not. A read only session will not change +its properties and can't be saved, although documents can be edited and saved as normal. This option is great for +creating template sessions. + + +SessionsMove up +Move the selected session one position up in the list. + + +SessionsMove down +Move the selected session one position down in the list. - - @@ -1258,7 +1263,7 @@ Dialog. -the <guimenu>Window</guimenu> Menu +The <guimenu>Window</guimenu> Menu @@ -1366,7 +1371,7 @@ commands those will of course continue to work. WindowTool Views -Show Documents +Show/Hide Documents @@ -1387,6 +1392,19 @@ commands those will of course continue to work. + + + + +WindowTool Views +Show/Hide Sessions + + + +Toggle the display of &kate;'s Sessions panel + + + -- cgit v1.2.3