c60deaea19
This fixes some deprecation warnings related to Gtk.Color and restructures code and formatting according to pylint suggestions
4.2 KiB
Syntax Highlighting Plugin for Gajim
Gajim Plugin that highlights source code blocks in the chat window.
Installation
The recommended way of installing this plugin is to use Gajim's Plugin Installer.
For more information and instruction on how to install plugins manually, please refer to the Gajim Plugin Wiki site.
Usage
This plugin uses markdown-style syntax to identify which parts of a message should be formatted as code in the chat window.
Inline source code will be highlighted when placed in between `two single
back-ticks`.
The language used to highlight the syntax of inline code is selected as the default language in the plugin settings.
Multi-line code blocks are started by three back-ticks followed by a newline. Optionally, a language can be specified directly after the opening back-ticks and before the line break:
```language
Note, that the last line of a code block may only contain the closing back-ticks,
i.e. there must be a newline here.
```
In case no language is specified with the opening tag or the specified language could not be identified, the default language configured in the settings is used.
You can test it by copying and sending the following text to one of your contacts:
```python
def test():
print("Hello, world!")
```
(Note: your contact will not receive highlighted text unless she is also using the plugin.)
Relation to XEP-0393 - 'Message Styling'
https://xmpp.org/extensions/xep-0393.html#pre-block
In XEP-0393, the back-tick based syntax is defined as markup for preformatted text blocks, respectively inline preformatted text. Formatting of such text blocks with mono-spaced fonts is recommended by the XEP.
By using the same syntax as defined in XEP-0393 XMPP clients with only XEP-0393 support but without syntax highlighting can at least present their users blocks of preformatted text.
Since text in between the back-tick markers is not further formatted by this plugin, it can be considered "preformatted". Hence, this plugin is compatible to the formatting options defined by XEP-0393, section 5.1.2, "Preformatted Text" and section 5.2.5, "Preformatted Span".
Nevertheless, syntax highlighting for source code is not part of XEP but rather a non-standard extension introduced with this plugin.
Configuration
The configuration can be found via 'Gajim' > 'Plugins', then select the 'Source Code Syntax Highlight' Plugin and click the gears symbol. The configuration options let you specify many details how code is formatted, including default language, style, font settings, background color and formatting of the code markers.
In the configuration window, the current settings are displayed in an interactive preview panel. This allows you to directly check how code would look like in the message window.
Report Bugs and Feature Requests
For bug reports, please report them to the Gajim Plugin Issue tracker.
Please make sure that the issue you create contains [syntax_highlight] in the
title and information such as Gajim version, Plugin version, Operating system,
etc.
Debug
The plugin adds its own logger. It can be used to set a specific debug level for this plugin and/or filter log messages.
Run
gajim --loglevel gajim.p.syntax_highlight=DEBUG
in a terminal to display the debug messages.
Known Issues / ToDo
Gajim crashes when correcting a message containing highlighted code.(fixed in version 1.1.0)
Credits
Since I had no experience in writing Plugins for Gajim, I used the Latex Plugin written by Yves Fischer and Yann Leboulanger as an example and copied a big portion of initial code. Therefore, credits go to the authors of the Latex Plugin for providing an example.
The syntax highlighting itself is done by pygments.