bbzz7 / krpano-markup-language Goto Github PK

#Krpano Markup Language (KML)

Package inclides

• Syntax definition of krpano panoramic viewer settings made for SublimeText 3;
• Color theme "May Thunderstorm" for ST optimized to highlight KML code;
• Python Script to remove comments from src.

##Contents

• Installation
• Features
• Modifying

1. Clone or download this repo to some location, then copy contents of dist folder into ST User packages folder (Packages -> Browse Packages, then enter User folder);
2. Restart ST if required.

I. Syntax definition is based on official krpano documentation, plugin docs and is intended to recognize all structural entities(e.g. elements, properties or keywords) of KML.

Current list of recognized entities includes:

• Operators (( ) [ ] . , ; == === != !== < > <= >= ! AND OR LT GT LE GE). Each operator used in code must be separated from operands by spaces;
• Instruction words (see Programming logic/Flow control section of krpano docs);
• Basic functions (all other pre-defined functions);
• Global Variables;
• Named constants;
• Pre-defined elements;
• Pre-defined element properties;
• Action arguments;
• Hex numbers prefixed by 0x or #;
• Decimal numbers including % values;
• Single-line string constants;
• Single-line comments(following // until the end of the line**(1)**);
• XML tags.

1. Since comments are not supported niether in actions nor in event handlers they should be removed from source code before execution.

II. May Thunderstorm is user-defined color theme for ST3 based on Seti Monokai dark color scheme so it supports any other language.

III. removeComments.py script removes single-line comments from KML source. This operation is required for correct code exec.

Requires python environment

At one call comments from one file are removed.

Usage: python script_dir/remove_comments.py src_dir src_file output_dir1 output_dir2

See Syntax Definitions chapter of ST unofficial manual, use the same process to modify color scheme.