Doc: adjust highlighting documentation

Update text and screenshots to reflect the UI changes in the settings
made with the kSyntaxHighlighting backend change.

Change-Id: I9ba1ecfee13aedbfe15e3226e71378b5d349fbb8
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
David Schulz
2019-02-05 10:08:58 +01:00
parent f75934f297
commit e720a1f371
4 changed files with 22 additions and 39 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

View File

@@ -51,49 +51,32 @@
\section1 Generic Highlighting \section1 Generic Highlighting
Generic highlighting is based on highlight definition files that are Generic highlighting is provided by
provided by the \l{https://api.kde.org/frameworks/syntax-highlighting/html/index.html}
\l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/} {KSyntaxHighlighting}, which is the syntax highlighting engine for Kate
{Kate Editor}. You can download highlight definition files for use with \QC. syntax definitions. \QC comes with most of the commonly used syntax files,
For more information about the definition files, see and you can download additional files. For more information about the
\l{http://kde-files.org/index.php?xcontentmode=680}{KDE-Files.org}. definition files, see
\l{https://docs.kde.org/stable5/en/applications/katepart/highlight.html}
{Working with Syntax Highlighting}.
If you have a Unix installation that comes with the Kate Editor, you might If the editor cannot find the highlight definition for a file that you open
already have the definition files installed. Typically, the files are for editing, it prompts you to update the highlight definition files. Select
located in a read-only directory, and therefore, you cannot manage them. \QC \uicontrol {Update Definitions} to update the files.
can try to locate them and use them as fallback files, when the primary
location does not contain the definition for the current file type. You can
also specify the directory that contains preinstalled highlight
definition files as the primary location.
When you open a file for editing and the editor cannot find the highlight To suppress the message for a particular file pattern, select
definition for it, an alert appears. To suppress the alerts, you can specify \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor}
patterns for ignoring files. > \uicontrol {Generic Highlighter} and add the pattern to the
\uicontrol {Ignored file patterns} field.
To download highlight definition files: \image qtcreator-syntax-highlighter.png "Generic Highlighter options"
\list 1 If you have written your own syntax definition files, you
\li Select \uicontrol Tools > \uicontrol Options > can provide an additional definition search path in the
\uicontrol {Text Editor} > \uicontrol {Generic Highlighter}. \uicontrol {User Highlight Definition Files} field.
\image qtcreator-generic-highlighter.png "Generic Highlighter options"
\li In the \uicontrol Location field, specify the path to the primary To manually update the highlight definition files, select
location for highlight definition files. \uicontrol {Update Definitions}.
\li Click \uicontrol {Download Definitions} to open a list of highlight
definition files available for download.
\image qtcreator-manage-definitions.png "Download Definitions dialog"
\li Select highlight definition files in the list and click
\uicontrol {Download Selected Definitions}.
\li Select the \uicontrol {Use fallback location} check box to specify
the secondary location where the editor will look for highlight
definition files.
\li Click \uicontrol Autodetect to allow \QC to look for highlight
definition files on your system, or click \uicontrol Browse to
locate them in the file system yourself.
\li In the \uicontrol {Ignored file patterns} field, specify file
patterns to suppress alerts if the highlight definitions for the
specified files are not found.
\li Click \uicontrol OK to save your changes.
\endlist
\section1 Highlighting and Folding Blocks \section1 Highlighting and Folding Blocks