Skip to content

Latest commit

 

History

History
578 lines (452 loc) · 29.8 KB

Tokens-Guide.md

File metadata and controls

578 lines (452 loc) · 29.8 KB
Raw

Skylighting Default Styles

A description of the style elements used by pandoc/skylighting themes, taken from KDE/Kate documentation:

Edited by Tristano Ajmone, June 2019.

Table of Contents

Editor's Note

Style names in the original KDE documentation were all prefixed by ds (e.g. dsNormal, dsKeyword, etc.). I've removed the ds prefix since it's not used by pandoc/skylighting. Beside the prefix difference, style elements names are the same in KDE/Kate and pandoc/skylighting, except Normal — which in pandoc/skylighting is defined via the "text-color" root key, and there's no Normal key under "text-styles".

All contents of the following tables were taken from the KDE Documentation for Kate, and beside removal of the ds prefix in style names, reformatting as tables, and adding some inline stylings, the contents are unaltered.

See the Credits and License section at the end of this document for legal information about this document.

Kate Highligting Default Styles

General Default Styles

style description
Normal when no special highlighting is required.
Keyword built-in language keywords.
Function function calls and definitions.
Variable if applicable: variable names (e.g. $someVar in PHP/Perl).
ControlFlow control flow keywords like if, else, switch, break, return, yield, ...
Operator operators like + - * / :: < >
BuiltIn built-in functions, classes, and objects.
Extension common extensions, such as Qt classes and functions/macros in C++ and Python.
Preprocessor preprocessor statements or macro definitions.
Attribute annotations such as @override and __declspec(...).

String-Related Default Styles

style description
Char single characters, such as 'x'.
SpecialChar chars with special meaning in strings such as escapes, substitutions, or regex operators.
String strings like "hello world".
VerbatimString verbatim or raw strings like 'raw \backlash' in Perl, CoffeeScript, and shells, as well as r'\raw' in Python.
SpecialString SQL, regexes, HERE docs, LaTeX math mode, ...
Import import, include, require of modules.

Number-Related Default Styles

style description
DataType built-in data types like int, void, u64.
DecVal decimal values.
BaseN values with a base other than 10.
Float floating point values.
Constant built-in and user defined constants like PI.

Comment and Documentation-Related Default Styles

style description
Comment comments.
Documentation /** Documentation comments */ or """docstrings""".
Annotation documentation commands like @param, @brief.
CommentVar the variable names used in above commands, like "foobar" in @param foobar.
RegionMarker region markers like //BEGIN, //END in comments.

Other Default Styles

style description
Information notes and tips like @note in doxygen.
Warning warnings like @warning in doxygen.
Alert special words like TODO, FIXME, XXXX.
Error error highlighting and wrong syntax.
Others when nothing else fits.

Credits and License

From the Legal Notice of The KatePart Handbook:

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.

Full copy of the GNU Free Documentation License (FDL) is included at the end of the markdown source of this document, within HTML comments.

The KatePart Handbook

The KatePart Handbook
Thad McGinnis (ctmcginnis compuserve.com)

Anne-Marie Mahfouf (annma kde.org)

Anders Lund (anders alweb.dk)

T.C. Hollingsworth (tchollingsworth gmail.com)

Developer: Christoph Cullmann
Reviewer: Lauri Watts
Revision Frameworks 5.50 (2018-08-20)
Copyright © 2000, 2001 Thad McGinnis

Copyright © 2005 Anne-Marie Mahfouf (annma kde.org), Anders Lund (anders alweb.dk)

Copyright © 2011, 2012, 2013, 2014 T.C. Hollingsworth (tchollingsworth gmail.com)

KatePart and KWrite Credits and License

KatePart and KWrite Copyright 2001-2014 by the Kate team.

Based on the original KWrite, which was Copyright 2000 by Jochen Wilhelmy (digisnap cs.tu-berlin.de)

Contributions:

  • Christoph Cullmann (cullmann kde.org)
  • Michael Bartl (michael.bartl1 chello.at)
  • Phlip (phlip_cpp my-deja.com)
  • Anders Lund (anders alweb.dk)
  • Matt Newell (newellm proaxis.com)
  • Joseph Wenninger (kde jowenn.at)
  • Jochen Wilhelmy (digisnap cs.tu-berlin.de)
  • Michael Koch (koch kde.org)
  • Christian Gebauer (gebauer kde.org)
  • Simon Hausmann (hausmann kde.org)
  • Glen Parker (glenebob nwlink.com)
  • Scott Manson (sdmanson altel.net)
  • John Firebaugh (jfirebaugh kde.org)

The KatePart documentation is based on the original KWrite documentation, modified to be relevant to all KatePart consumers.

The original KWrite documentation was written by Thad McGinnis (ctmcginnis compuserve.com), with lots of modifications from Christian Tibirna (tibirna kde.org). Converted to docbook/proofreading by Lauri Watts (lauri kde.org) and updated by Anne-Marie Mahfouf (annma kde.org) and Anders Lund (anders alweb.dk)

The current KatePart documentation is maintained by T.C. Hollingsworth (tchollingsworth gmail.com). Please send comments or suggestions to the KatePart development mailing list at (kwrite-devel kde.org) or file a bug in the KDE Bugtracking System.

This documentation is licensed under the terms of the GNU Free Documentation License.

This program is licensed under the terms of the GNU General Public License.