diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook --- a/doc/kate/fundamentals.docbook +++ b/doc/kate/fundamentals.docbook @@ -61,6 +61,15 @@ +To change the directory for temporary files, which defaults to /tmp +set the TMPDIR environment variable before starting &kate;, ⪚ + + +%mkdir /tmp/kate -p && export TMPDIR=/tmp/kate && kate + + + + Command Line Options &kate; accepts following command line options: @@ -168,11 +177,15 @@ deleted (if they are local files and you have sufficient permissions) when closed, unless they were modified since they were opened. - + kate filename -The base file name of the desktop entry for this application. +The base file name of the desktop entry for this application. +This is in particular useful for wrapper applications and +applications having in general multiple desktop files. Thus each desktop +file can put its own command line set for the entry. + @@ -205,6 +218,7 @@ + diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook --- a/doc/kate/index.docbook +++ b/doc/kate/index.docbook @@ -42,13 +42,13 @@ &FDLNotice; -2016-08-27 -Applications 16.08 +2018-03-23 +Applications 18.04 &kate; is a programmer's text editor by &kde;. -This handbook documents &kate; Version 16.08 +This handbook documents &kate; Version 18.04 diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook --- a/doc/kate/plugins.docbook +++ b/doc/kate/plugins.docbook @@ -52,6 +52,10 @@ Look up definitions/declarations with CTags +Document preview - +Preview the document in the target format. + + Document switcher - Quick document switching with &Alt; behavior @@ -603,6 +607,93 @@ + + + + +Document Preview Plugin + + +Introduction + +The plugin enables a live preview of the currently edited text document in the +final format in the sidebar. So when editing ⪚ a Markdown text or an SVG image, +the result is instantly visible next to the source text. + + +For the display the plugin uses that KParts plugin which is currently selected +as the preferred one for the &MIME; type of the document. +If there is no KParts plugin for that type, no preview is possible. + + +To change the preferred plugin open the File Associations +module in the &systemsettings; and edit the Services Preference Order +on the Embedding tab. + + + +Some available KParts plugins + + + +&MIME; typeKParts plugin + + +Markdown textKMarkdownWebViewPart or OkularPart + + +SVG imageSVGPart + + +&Qt; UI filesKUIViewerPart + + +Dot graph filesKGraphviewerPart + + + +
+
+ + +Menu Structure + + + + +ViewTool Views +Show Preview + + +Toggle the display of &kate;'s Document preview in a sidebar. + + + + + + +Interface +The buttons at the top of the preview window provide these actions: + + + +Lock the preview to a given document. Selecting this option ensures +that if switching the focus to the view of another document in the same &kate; +window, the preview will not follow to that document, but keep previewing +this document. + + +Enable or disable updates of the preview of the current document content + + +Manually update the preview of the current document content + + +A dropdown menu with actions from the KParts plugin + + + +