Commit ac42556a authored by Antoni Bella Pérez's avatar Antoni Bella Pérez 🚵🏻 Committed by Christoph Cullmann

Documentation fixes: Use more entities, some punctuation

parent 50e331e3
......@@ -63,7 +63,7 @@ document.</para></listitem>
left, and a configuration page corresponding to the selected topic on
the right.</para>
<para>The configuration is divided into two groups, namely
<para>The configuration is divided into two groups, namely:
<itemizedlist>
<listitem><para><link linkend="config-dialog">Application configuration</link>
</para></listitem>
......
......@@ -12,11 +12,11 @@
<para>Like any advanced text editor, &kate; offers a variety of ways to extend
its functionality. You can <link linkend="dev-scripting">write simple scripts
to add functionality with JavaScript</link>
to add functionality with &javascript;</link>
or add even more functionality to the editor itself with
<link linkend="dev-app">&kate; Application Plugins written in C++</link>.
Finally, once you have extended &kate;, you are welcome to
<ulink url="http://kate-editor.org/join-us/">join us</ulink> and share your
<ulink url="https://kate-editor.org/join-us/">join us</ulink> and share your
enhancements with the world!</para>
</sect1>
......@@ -32,10 +32,10 @@ Handbook</ulink>.</para>
</sect1>
<sect1 id="dev-scripting">
<title>Scripting with JavaScript</title>
<title>Scripting with &javascript;</title>
<para>For information about scripting with JavaScript, see the
<ulink url="help:/katepart/dev-scripting.html">Scripting with JavaScript
<para>For information about scripting with &javascript;, see the
<ulink url="help:/katepart/dev-scripting.html">Scripting with &javascript;
section of the Development chapter of the &katepart; Handbook</ulink>.</para>
</sect1>
......@@ -43,12 +43,12 @@ section of the Development chapter of the &katepart; Handbook</ulink>.</para>
<sect1 id="dev-app">
<title>&kate; (C++) Application Plugins</title>
<para><link linkend="kate-application-plugins">Kate Application Plugins</link>
<para><link linkend="kate-application-plugins">&kate; Application Plugins</link>
extend the functionality of the &kate; editor itself in any way you can imagine,
using the same programming language &kate; is written in, C++.</para>
<para>To get started, see the
<ulink url="http://kate-editor.org/2004/01/06/writing-a-kate-plugin/">Writing a
<ulink url="https://kate-editor.org/2004/01/06/writing-a-kate-plugin/">Writing a
&kate; Plugin tutorial on the &kate; website</ulink>.</para>
</sect1>
......
......@@ -57,7 +57,7 @@ of &kde;'s network transparency to open files on the internet.
<informalexample>
<screen>
<prompt>%</prompt><userinput><command>kate</command> <option><replaceable>ftp://ftp.kde.org/pub/kde/README</replaceable></option></userinput>
<prompt>%</prompt><userinput><command>kate</command> <option><replaceable>&kde-ftp;README</replaceable></option></userinput>
</screen>
</informalexample>
......@@ -89,7 +89,7 @@ This lists the options available at the command line.
<option>-s</option> <option>--start</option> <parameter>name</parameter></userinput></term>
<listitem>
<para>
Starts kate with the session <parameter>name</parameter>. The session is created
Starts &kate; with the session <parameter>name</parameter>. The session is created
if it does not exist already. If a &kate; instance running the specified session
exists, the specified files are loaded in that instance.
</para>
......@@ -160,10 +160,10 @@ if no parameters and no URLs are given at all.</para></listitem>
given to open.</para>
<para>
You can use &kate; with this option as editor for typing in commit messages for version
control systems like <application>Git</application> or <application>Subversion</application>.
control systems like &git; or <application>Subversion</application>.
These systems expect to block the editor till you have entered your
message, because they then open the temporary file, which would be empty
if kate immediately returned to the caller.
if &kate; immediately returned to the caller.
</para>
<para>This option is also needed with KIO (&kde; Input/Output), if you open a remote file (which has been
downloaded to a temporary) and should be reuploaded, after you saved it.
......@@ -226,7 +226,7 @@ Shows license information.
<title>Drag and Drop</title>
<para>
&kate; uses the &kde; Drag and Drop protocol. Files may be dragged and
dropped onto &kate; from the Desktop, the filemanager &dolphin; or some remote ftp
dropped onto &kate; from the Desktop, the filemanager &dolphin; or some remote &FTP;
site opened in one of &dolphin;'s windows.
</para>
</sect2>
......@@ -466,7 +466,7 @@ focused frame.</para>
<title>Using Sessions</title>
<para>Sessions is how &kate; lets you keep more than one list of files and
GUI configuration around. You can have as many named sessions as you want,
&GUI; configuration around. You can have as many named sessions as you want,
and you can use unnamed or anonymous sessions for files you want to use only
once. Currently &kate; can save the list of open files, and the general window
configuration in the session; future versions of &kate; may add more features
......@@ -479,7 +479,7 @@ one as it used to do as the default behavior.</para>
<itemizedlist>
<listitem><para><link linkend="command-line-options"><emphasis>Command line
options</emphasis></link> that lets you select and start sessions when launching
kate from the command line.</para>
&kate; from the command line.</para>
</listitem>
<listitem><para><link linkend="sessions-menu"><emphasis>The Sessions
menu</emphasis></link> that lets you switch, save, start and manage your
......@@ -491,7 +491,7 @@ behave.</para></listitem>
</para>
<para>When starting a new session, the GUI configuration of <guilabel>Default
<para>When starting a new session, the &GUI; configuration of <guilabel>Default
Session</guilabel> is loaded. To save window configuration in the default
session, you need to enable saving window configuration in the sessions
configuration page of the configuration dialog and then load the default
......@@ -499,14 +499,14 @@ session, set up the window as desired and save the session again.</para>
<para>When a named session is loaded, &kate; will display the session name at
the start of the window title, which then has the form
&quot;<replaceable>Session Name</replaceable>: <replaceable>Document name or
&URL;</replaceable> - &kate;&quot;</para>
<quote><replaceable>Session Name</replaceable>: <replaceable>Document name or
&URL;</replaceable> - &kate;</quote>.</para>
<para>When opening files on the command line with <option>--start
<replaceable>name</replaceable></option> or if a session is selected using the
session chooser, the specified session is loaded prior to the files specified
on the command line. To open files from the command line in a new, unnamed
session, configure kate to start a new session as default in the session page of
session, configure &kate; to start a new session as default in the session page of
the configuration dialog or use <option>--start</option> with an empty string:
<replaceable>''</replaceable>.</para>
<!--FIXME still valid for kf5 -->
......@@ -588,7 +588,7 @@ info documentation, or you can use &konqueror;.</para>
<sect2>
<title>Articles on &kate;</title>
<para>&kate;'s homepage provides some <ulink url="http://kate-editor.org/featured-articles">
<para>&kate;'s homepage provides some <ulink url="https://kate-editor.org/featured-articles">
Articles and Howtos</ulink> with further information beyond the scope of this handbook.</para>
</sect2>
......
......@@ -2,6 +2,7 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY gdb "<acronym>GDB</acronym>">
<!ENTITY kparts "<acronym>KParts</acronym>">
<!ENTITY configuring-chapter SYSTEM "configuring.docbook">
<!ENTITY fundamentals-chapter SYSTEM "fundamentals.docbook">
<!ENTITY menu-chapter SYSTEM "menus.docbook">
......@@ -178,7 +179,7 @@ documentation</para></listitem>
</varlistentry>
<varlistentry>
<term>&Michael.Koch; &Michael.Koch.mail;</term>
<listitem><para>&kwrite; port to KParts</para></listitem>
<listitem><para>&kwrite; port to &kparts;</para></listitem>
</varlistentry>
<varlistentry>
<term>&Christian.Gebauer; <email>gebauer@bigfoot.com</email></term>
......@@ -234,7 +235,7 @@ documentation</para></listitem>
</varlistentry>
<varlistentry>
<term>&Carsten.Niehaus;</term>
<listitem><para>Highlighting for LaTeX</para></listitem>
<listitem><para>Highlighting for &latex;</para></listitem>
</varlistentry>
<varlistentry>
<term>Per Wigren</term>
......
......@@ -51,7 +51,7 @@ line</replaceable></group>
the name &kwrite;.</para>
<para>Some of &kate;'s many features include configurable syntax
highlighting for languages ranging from C and C++ to
<acronym>HTML</acronym> to bash scripts, the ability to create and
&HTML; to bash scripts, the ability to create and
maintain projects, a multiple document interface
(<acronym>MDI</acronym>), and a self-contained terminal emulator.
</para>
......@@ -98,33 +98,33 @@ pid</replaceable></term>
<varlistentry>
<term><option>-e, --encoding</option> <replaceable>
name</replaceable></term>
<listitem><para>Set encoding for the file to open</para><para>You can use
<listitem><para>Set encoding for the file to open.</para><para>You can use
this to force a file opened in utf-8 format, for instance. (The command
<command>iconv -l</command> provides a list of encodings, which may be
helpful to you.)</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l, --line</option> <replaceable> line</replaceable></term>
<listitem><para>Navigate to this line</para></listitem>
<listitem><para>Navigate to this line.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c, --column</option> <replaceable>
column</replaceable></term>
<listitem><para>Navigate to this column</para></listitem>
<listitem><para>Navigate to this column.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i, --stdin</option></term>
<listitem><para>Read the contents of
<filename>stdin</filename></para></listitem>
<filename>stdin</filename>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tempfile</option></term>
<listitem><para>The files/&URL;s opened by the application will be
deleted after use</para></listitem>
deleted after use.</para></listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>file</replaceable></option></term>
<listitem><para>File to open</para></listitem>
<listitem><para>File to open.</para></listitem>
</varlistentry>
</variablelist>
......@@ -135,13 +135,13 @@ deleted after use</para></listitem>
<simplelist><member>More detailed user documentation is available from <ulink
url="help:/kate">help:/kate</ulink>
(either enter this <acronym>URL</acronym> into &konqueror;, or run
(either enter this &URL; into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>help:/kate</parameter></userinput>).</member>
<member>kf5options(7)</member>
<member>qt5options(7)</member>
<member>There is also further information available at the <ulink
url="http://kate-editor.org/">&kate; website</ulink>.</member>
url="https://kate-editor.org/">&kate; website</ulink>.</member>
</simplelist>
</refsect1>
......@@ -155,12 +155,12 @@ line 25, in an existing &kate; window, you could use:</para>
</screen>
<para>If you have an active internet connection, you can take advantage of
&kde;'s network transparency to open a file from an ftp site. If you do not
&kde;'s network transparency to open a file from an &FTP; site. If you do not
have write permission on the remote server, the file will be opened read
only and you will be prompted for a local filename to save to if you make
changes. If you do have write permission, changes will be saved
transparently over the network.</para>
<screen><userinput><command>kate</command> <option><replaceable>ftp://ftp.kde.org/pub/kde/README</replaceable></option></userinput></screen>
<screen><userinput><command>kate</command> <option><replaceable>&kde-ftp;README</replaceable></option></userinput></screen>
<!-- FIXME: Some more useful examples would be cool, how about this snagged -->
<!-- from a mail of anders (slightly edited /line/l to remove the double -->
......
......@@ -63,7 +63,7 @@ location.
</term>
<listitem>
<para>
This submenu presents a list of applications known to handle the mime type
This submenu presents a list of applications known to handle the &MIME; type
of your current document. Activating an entry will open the current document
with that application.</para>
<para>In addition, an entry <guimenuitem>Other...</guimenuitem> launches
......@@ -300,7 +300,7 @@ action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem>
<para>Undo the last editing command (typing, copying, cutting etc.)</para>
<para>Undo the last editing command (typing, copying, cutting &etc;)</para>
<note><para>This may undo several editing commands of the same type, like typing
in characters.</para></note>
</listitem>
......@@ -315,7 +315,7 @@ in characters.</para></note>
<guimenuitem>Redo</guimenuitem>
</menuchoice></term>
<listitem>
<para>This will reverse the most recent change (if any) made using Undo</para>
<para>This will reverse the most recent change (if any) made using Undo.</para>
</listitem>
</varlistentry>
......@@ -702,7 +702,7 @@ The new instance will be identical to your previous instance.
<varlistentry id="view-next-tab">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keysym>Right</keysym></keycombo>
<keycombo action="simul">&Alt;&Right;</keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Next Tab</guimenuitem>
......@@ -715,7 +715,7 @@ The new instance will be identical to your previous instance.
<varlistentry id="view-previous-tab">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keysym>Left</keysym></keycombo>
<keycombo action="simul">&Alt;&Left;</keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Previous Tab</guimenuitem>
......@@ -738,7 +738,7 @@ The new instance will be identical to your previous instance.
While entering text in the search
field the document names and document &URL;s are searched for matching text.
While entering text in the search field you can use
the cursor keys <keysym>Up</keysym> and <keysym>Down</keysym> to navigate in the
the cursor keys &Up; and &Down; to navigate in the
list view. Pressing the &Enter; key or double clicking on an item in the list switches
the view to the document selected in the list view. This makes switching between
documents easier, if there are a lot of them open.</para>
......@@ -790,7 +790,7 @@ area in more views.</para>
<para>This will split the frame (which may be the main editing area) in two equally sized frames,
the new one to the left of the current one. The new frame gets the focus, and will display the
same document as the old one.</para>
<para>See also <link linkend="kate-mdi">Working with the &kate; MDI</link></para>
<para>See also <link linkend="kate-mdi">Working with the &kate; MDI</link>.</para>
</listitem>
</varlistentry>
......@@ -1222,7 +1222,7 @@ the list of markers which is appended at the bottom of this menu item.
<varlistentry id="bookmarks-bookmarks-previous">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>PgUp</keycap></keycombo>
<keycombo action="simul">&Alt;&PgUp;</keycombo>
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Previous</guimenuitem>
......@@ -1236,7 +1236,7 @@ in a line above the cursor.</para></listitem>
<varlistentry id="bookmarks-bookmarks-next">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>PgDown</keycap></keycombo>
<keycombo action="simul">&Alt;&PgDn;</keycombo>
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Next</guimenuitem>
......@@ -1415,7 +1415,7 @@ document. This overwrites the global end of line mode set in <menuchoice>
<para>Checking this action you can explicitly add a byte order mark for unicode
encoded documents. The byte order mark (BOM) is a Unicode character used to signal
the endianness (byte order) of a text file or stream, for more information see
<ulink url="http://en.wikipedia.org/wiki/Byte_Order_Mark">Byte Order Mark</ulink>.</para>
<ulink url="https://en.wikipedia.org/wiki/Byte_order_mark">Byte Order Mark</ulink>.</para>
</listitem>
</varlistentry>
......@@ -1438,7 +1438,7 @@ scripts in the &katepart; documentation.</ulink></para>
<varlistentry id="tools-invoke-code-completition">
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo>
<keycombo action="simul">&Ctrl;&Space;</keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Invoke Code Completion</guimenuitem>
......@@ -1669,7 +1669,7 @@ a new line of text will automatically start when the current
line exceeds the length specified by the <guilabel>Wrap words at</guilabel> option
in the Editing tab in <menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Configure
Editor...</guimenuitem></menuchoice></para></listitem>
Editor...</guimenuitem></menuchoice>.</para></listitem>
</varlistentry>
</variablelist>
......
......@@ -80,7 +80,7 @@ simple &gdb; frontend</para>
- Opens the corresponding .h/[.cpp|.c] file</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-projects">Project Plugin</link> - Integration with Git and other source control systems</para>
<para><link linkend="kate-application-plugin-projects">Project Plugin</link> - Integration with &git; and other source control systems</para>
</listitem>
<listitem>
<para>Replicode - Constructivist AI language and runtime</para>
......@@ -105,7 +105,7 @@ query on SQL databases</para>
- Extract and show reference symbols from source</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-konsole">Terminal tool view</link> - Have a terminal at the ready, using KDE's Konsole widget</para>
<para><link linkend="kate-application-plugin-konsole">Terminal tool view</link> - Have a terminal at the ready, using &kde;'s &konsole; widget</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-textfilter">Text Filter</link> - Process text using terminal commands</para>
......@@ -143,7 +143,7 @@ directories where the source code is located.
<member><filename>kdepim-runtime/resources/gmail/saslplugin/config.h</filename></member>
</simplelist>
<para>To pick the right choice, the plugin picks the last two parts of the url,
<para>To pick the right choice, the plugin picks the last two parts of the &URL;,
in this case this would be</para>
<simplelist>
......@@ -173,14 +173,14 @@ in this case this would be</para>
<para>Clicking <guibutton>OK</guibutton> will start indexing.
When indexing is finished, open the toolview <guilabel>Backtrace Browser</guilabel>.</para>
<para>Now you can load a backtrace from the clipboard (&eg;, when you clicked
<guibutton>Copy to Clipboard</guibutton> in DrKonqi) or from a file.</para>
<guibutton>Copy to Clipboard</guibutton> in &drkonqi;) or from a file.</para>
</sect2>
</sect1>
<sect1 id="kate-application-plugin-build">
<!--http://kate-editor.org/2011/06/21/kate-plugin-updates-part-1/ -->
<!--https://kate-editor.org/2011/06/21/kate-plugin-updates-part-1/ -->
<sect1info>
<authorgroup>
<author><firstname>Salma</firstname> <surname>Sultana</surname></author>
......@@ -336,7 +336,7 @@ To navigate to the next error, press
<varlistentry id="build-previous-error">
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Alt;<keysym>Left</keysym></keycombo></shortcut>
<shortcut><keycombo action="simul">&Ctrl;&Alt;&Left;</keycombo></shortcut>
<guimenu>Build</guimenu><guimenuitem>Previous Error</guimenuitem>
</menuchoice></term>
<listitem><para>Moves the cursor to the location of the previous error in the
......@@ -345,7 +345,7 @@ document.</para></listitem>
<varlistentry id="build-next-error">
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Alt;<keysym>Right</keysym></keycombo></shortcut>
<shortcut><keycombo action="simul">&Ctrl;&Alt;&Right;</keycombo></shortcut>
<guimenu>Build</guimenu><guimenuitem>Next Error</guimenuitem>
</menuchoice></term>
<listitem><para>Moves the cursor to the location of the next error in the
......@@ -475,7 +475,7 @@ directories containing the source code and regenerate the common CTags database.
</para>
<para>For more information about all available options please read the CTags man page. This man page
is available in &khelpcenter; and you can also enter the &URL; <emphasis>man/:ctags</emphasis>
is available in &khelpcenter; and you can also enter the &URL; <emphasis>man:/ctags</emphasis>
directly into &konqueror;
</para>
......@@ -611,13 +611,13 @@ place the cursor at the start of the definition.</para>
<title>Introduction</title>
<para>
The plugin enables a live preview of the currently edited text document in the
final format in the sidebar. So when editing &eg; a Markdown text or an SVG image,
final format in the sidebar. So when editing &eg; a &Markdown; text or an &SVG; image,
the result is instantly visible next to the source text.
</para>
<para>For the display the plugin uses that KParts plugin which is currently selected
<para>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.
If there is no &kparts; plugin for that type, no preview is possible.
</para>
<para>To change the preferred plugin open the <guilabel>File Associations</guilabel>
......@@ -626,23 +626,23 @@ on the <guilabel>Embedding</guilabel> tab.
</para>
<table>
<title>Some available KParts plugins</title>
<title>Some available &kparts; plugins</title>
<tgroup cols="2">
<tbody>
<row>
<entry>&MIME; type</entry><entry>KParts plugin</entry>
<entry>&MIME; type</entry><entry>&kparts; plugin</entry>
</row>
<row>
<entry>Markdown text</entry><entry>KMarkdownWebViewPart or OkularPart</entry>
<entry>&Markdown; text</entry><entry>KMarkdownWebViewPart or OkularPart</entry>
</row>
<row>
<entry>SVG image</entry><entry>SVGPart</entry>
<entry>&SVG; image</entry><entry>SVGPart</entry>
</row>
<row>
<entry>&Qt; UI files</entry><entry>KUIViewerPart</entry>
</row>
<row>
<entry>Dot graph files</entry><entry>KGraphviewerPart</entry>
<entry>&DOT; graph files</entry><entry>KGraphviewerPart</entry>
</row>
</tbody>
</tgroup>
......@@ -683,7 +683,7 @@ this document.</para>
<para>Manually update the preview of the current document content</para>
</listitem>
<listitem>
<para>A dropdown menu with actions from the KParts plugin</para>
<para>A dropdown menu with actions from the &kparts; plugin</para>
</listitem>
</itemizedlist>
</sect2>
......@@ -1087,7 +1087,7 @@ View.</para></listitem>
</sect1>
<sect1 id="kate-application-plugin-gdb">
<!--http://kate-editor.org/2011/06/23/kate-plugin-updates-part-2/-->
<!--https://kate-editor.org/2011/06/23/kate-plugin-updates-part-2/-->
<sect1info>
<authorgroup>
<author><firstname>Martin</firstname> <surname>Gergov</surname></author>
......@@ -1104,7 +1104,7 @@ Project Debugger.</para>
<important>
<para>Previous experience with &gdb; is strongly recommended. For more
information on using &gdb;, visit <ulink url="http://www.gnu.org/s/gdb/">the
information on using &gdb;, visit <ulink url="https://www.gnu.org/software/gdb/">the
&gdb; website</ulink>.</para>
</important>
......@@ -1609,8 +1609,8 @@ For instance, the <quote>Kate</quote> <filename>.kateproject</filename> file loo
}
</screen>
<para>The file content is written in JSON syntax. The project name is <quote>Kate</quote>, and
the files contained in should be read from git.
<para>The file content is written in &JSON; syntax. The project name is <quote>Kate</quote>, and
the files contained in should be read from &git;.
</para>
<para>
......@@ -1970,7 +1970,7 @@ and so it may not be advisable to have both enabled at the same time.
<guisubmenu>Close all non-diagnostics tabs</guisubmenu>
</menuchoice></term>
<listitem>
<para>Close all non-diagnostics (e.g. references) tabs in plugin toolview.</para>
<para>Close all non-diagnostics (&eg; references) tabs in plugin toolview.</para>
</listitem>
</varlistentry>
......@@ -2005,7 +2005,7 @@ and so it may not be advisable to have both enabled at the same time.
<para>
The plugin's configuration page mostly allows for persistent configuration of
some of the above menu items. However, there is one additional entry
to specify the Server Configuration file. This is a JSON file that
to specify the Server Configuration file. This is a &JSON; file that
can be used to specify the LSP server to start (and then to communicate
with over stdin/stdout). For convenience, the following default configuration
is included (though alternative server implementation are equally valid
......@@ -2078,7 +2078,7 @@ considered as well (see further below).
</para>
<para>
The "highlightingModeRegex" is used to map the highlighting mode as used by Kate
The "highlightingModeRegex" is used to map the highlighting mode as used by &kate;
to the language id of the server. If no regular expression is given, the language id
itself is used.
</para>
......@@ -2129,12 +2129,12 @@ the view of many separate instances.
<para>
Each particular LSP server has its own way of customization and may use
language/tool specific means for configuration, e.g.
language/tool specific means for configuration, &eg;
<filename>tox.ini</filename> (a.o. for python),
<filename>.clang-format</filename> for C++ style format. Such configuration may
then also be used by other (non-LSP) tools (such as then
<application>tox</application> or <application>clang-format</application>). On
top of that, some LSP servers also load configuration from custom files (e.g.
top of that, some LSP servers also load configuration from custom files (&eg;
<filename>.ccls</filename>). Furthermore, custom server configuration can also
be passed through LSP (protocol), see the aforementioned
"initializationOptions" and "settings" entries in server configuration.
......@@ -2173,7 +2173,7 @@ the above example's server supports many more options in "settings".
See <ulink url="https://github.com/neoclide/coc.nvim/wiki/Language-servers">
another LSP client's documentation</ulink> for various other language server
examples and corresponding settings, which can easily and readily be
transformed to the JSON configuration that is used here and outlined above.
transformed to the &JSON; configuration that is used here and outlined above.
</para>
</sect3>
......@@ -2452,7 +2452,7 @@ are typically hidden by your &OS;. This option is only available when using
<term><guilabel>Follow symbolic links</guilabel></term>
<listitem><para>
The Search in Files plugin typically does not follow
<ulink url="http://en.wikipedia.org/wiki/Symbolic_link">symbolic links</ulink>.
<ulink url="https://en.wikipedia.org/wiki/Symbolic_link">symbolic links</ulink>.
When this option is enabled, the plugin will follow them instead and search inside
the files or folders they reference. This option is only available when using
<guilabel>Folder</guilabel> mode.
......@@ -2566,13 +2566,13 @@ plugin.</para>
<author>&TC.Hollingsworth; &TC.Hollingsworth.mail;</author>
</authorgroup>
</sect1info>
<title>Kate Snippets</title>
<title>&kate; Snippets</title>
<sect2 id="snippets-intro">
<title>Introduction</title>
<para>Kate Snippets is a plugin used to save you some time by adding support for
<para>&kate; Snippets is a plugin used to save you some time by adding support for
so-called <quote>snippets</quote> (re-usable source code, machine code or text). The plugin
also supports code completion and JavaScript.</para>
also supports code completion and &javascript;.</para>
</sect2>
<sect2 id="snippets-menu">
......@@ -2605,7 +2605,7 @@ may insert in any part of any document.</para>
<title>Snippets panel</title>
<screenshot id="screenshot-snippets-panel">
<screeninfo>Kate Snippets Panel</screeninfo>
<screeninfo>&kate; Snippets Panel</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="snippets-panel.png" format="PNG"/></imageobject>
<textobject><phrase>The &kate; snippets panel.</phrase></textobject>
......@@ -2721,12 +2721,12 @@ simple, editable field. All subsequent occurrences of the same
of the first during editing.</para>
<para><userinput>${<replaceable>field_name=default</replaceable>}</userinput>
can be used to specify a default value for the field.
<replaceable>default</replaceable> can be any JavaScript expression.</para>
<replaceable>default</replaceable> can be any &javascript; expression.</para>
<para>Use <userinput>${<replaceable>field_name</replaceable>=<replaceable>text</replaceable>}</userinput>
to specify a fixed string as default value.</para>
<para><userinput>${func(<replaceable>other_field1</replaceable>,
<replaceable>other_field2</replaceable>, ...)}</userinput> can be used to create a
field which evaluates a JavaScript function on each edit and contains its
field which evaluates a &javascript; function on each edit and contains its
contents. See the <guilabel>Scripts</guilabel> tab for more information.</para>
<para><userinput>${cursor}</userinput> can be used to mark the end position
of the cursor after everything else was filled in.</para>
......@@ -2735,8 +2735,8 @@ of the cursor after everything else was filled in.</para>
<varlistentry>
<term><guilabel>Scripts</guilabel></term>
<listitem><para>JavaScript helper functions to use in your snippets.</para>
<para>All JavaScript functions should return the contents you want to place in a
<listitem><para>&javascript; helper functions to use in your snippets.</para>
<para>All &javascript; functions should return the contents you want to place in a
template field as a string.</para>
<para>Functions are called in a scope which contains the contents of all
editable template fields as local variables. For example in a snippet
......@@ -2763,7 +2763,7 @@ documentation for more information</para>
<title>Using Snippets</title>
<screenshot id="screenshot-snippets-usage">
<screeninfo>Kate Snippets in Action</screeninfo>
<screeninfo>&kate; Snippets in Action</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="snippets-usage.png" format="PNG"/></imageobject>
<textobject><phrase>Accessing &kate; Snippets from a tool view and a drop down menu.</phrase></textobject>
......@@ -2776,7 +2776,7 @@ documentation for more information</para>
<itemizedlist>
<listitem><para>By choosing the snippet from the tool view.</para></listitem>
<listitem><para>While writing, you can press <keycombo action="simul">&Ctrl;
<keysym>Space</keysym></keycombo>, which will display all the snippets in a
&Space;</keycombo>, which will display all the snippets in a
convenient window from which you can choose. This key combination provides
functionality similar to code completion.</para></listitem>
</itemizedlist>
......@@ -2829,7 +2829,7 @@ deleting, and requesting information from databases.</para>
<title>Connecting to a Database</title>
<para>Select <guibutton>Add Connection</guibutton> from the <guimenu>SQL</guimenu>
menu or toolbar, and then select the Qt database driver you want to use (including
menu or toolbar, and then select the &Qt; database driver you want to use (including
QSQLITE, QMYSQL3, QMYSQL, QODBC3, QODBC, QPSQL7, and QPSQL). If you can't see
the desired driver, you need to install it. Then, press <guibutton>Next</guibutton>.
</para>
......@@ -2929,7 +2929,7 @@ current document in the Comma Separated Values format.</para></listitem>
<varlistentry>
<term><guibutton>Clear</guibutton></term>
<listitem><para>Removes everything from the table view</para></listitem>
<listitem><para>Removes everything from the table view.</para></listitem>
</varlistentry>
<!--FIXME Use system locale -->
......@@ -2937,7 +2937,7 @@ current document in the Comma Separated Values format.</para></listitem>
</variablelist>
<para>You can now change the colors displayed in the table in the <guilabel>SQL</guilabel>
section of <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kate;</guimenuitem>
section of <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kate;...</guimenuitem>
</menuchoice>.</para>
</sect3>
......@@ -3033,7 +3033,7 @@ writing much of this section.</para>
<para>It allows developers to view symbols (functions, macros and structures) from source code.</para>
<para>By clicking the parsed information you can easily browse the code.</para>