Merge branch 'master' of https://github.com/highlightjs/highlightjs-structured-text

Author: Serhioromano

61131example.png

@@ -1,21 +1,21 @@
 BSD 3-Clause License
 
-Copyright (c) 2006, Ivan Sagalaev.
+Copyright (c) 2006, Ivan Sagalaev
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
 
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

LICENSE

@@ -38,7 +38,11 @@ hljs.registerLanguage('iecst', hljsDefineIECST);
 hljs.initHighlightingOnLoad();
 ```
 
+<<<<<<< HEAD
 Mark the code you want to highlight with the ST class:
+=======
+Mark the code you want to highlight with the iecst class:
+>>>>>>> 4205d554c722c25964b06bb888ca83de43f425b0
 
 ```html
 <pre><code class="iecst">...</code></pre>
@@ -87,3 +91,26 @@ class Highlighter extends Component
 
 export default Highlighter;
 ```
+
+## Example in Markdown-Generated Presentation
+#### (using [marp](https://marp.app/))
+
+Craft the IEC 61131 code that is desired and wrap it in a code-block defined with the tripple-backtick (`` ``` ``) and language as `iecst`.
+
+````markdown
+```iecst
+VAR
+    test : BOOL := TRUE ;
+    x : REAL := 5.23;
+    lx : LREAL;
+    myString : STRING(255) := 'this is a test string';
+END_VAR
+IF test THEN
+    lx := REAL_TO_LREAL( COS(x) );
+END_IF
+```
+````
+
+This will thus render as:
+
+![IEC 61131-3 Example](./61131example.png)

README.md

@@ -0,0 +1,107 @@
+/*
+ * highlight.js Structured Text syntax highlighting definition
+ *
+ * @see https://github.com/highlightjs/highlight.js
+ *
+ * @package: highlightjs-iecst
+ * @author:  Sergey Romanov <[email protected]>
+ * @since:   2019-08-02
+ *
+ * Description: Structured Text is one of the 6 languages of IEC 61131-3
+ * standard, for developing PLC programs.
+ * Category: scripting
+ */
+
+var module = module ? module : {}; // shim for browser use
+
+function hljsDefineIECST(hljs) {
+    return {
+        aliases: ["iecst", "scl", "stl", "structured-text"],
+        name: "Structured Text",
+        case_insensitive: true,
+        keywords: {
+                keyword:
+                    "if then end_if elsif else case of end_case " +
+                    "to do by while repeat end_while end_repeat for end_for from " +
+                    "public private protected " +
+                    "or and not xor le ge eq ne ge lt constant return exit at retain non_retain task with until using extend",
+                title:
+                    "program end_program function end_function function_block end_function_block configuration " +
+                    "end_configuration action end_action transition end_transition type end_type struct end_struct step " +
+                    "end_step initial_step namespace end_namespace channel end_channel library end_library folder end_folder resource end_resource " +
+                    "var var_global end_var var_input VAR_EXTERNAL var_out var_output var_in_out var_temp var_interval var_access var_config method end_method property end_property interface end_interface",
+                literal: "false true null ",
+                built_in:
+                    "array pointer int sint dint lint usint uint udint ulint real lreal time date time_of_day date_and_time dt tod wstring string bool byte word dword lword ref_to any_num any_int any_string",
+                function:
+                    "mod abs acos asin atan cos exp expt ln log sin sqrt tan sel max min limit mux shl shr rol ror indexof sizeof adr ref adrinst bitadr add mul div sub trunc move"
+            },
+        contains: [
+            {
+                className: "string",
+                begin: "'",
+                end: "'",
+                contains: [hljs.BACKSLASH_ESCAPE, { begin: "''" }],
+                relevance: 0
+            },
+            {
+                className: "string",
+                begin: '"',
+                end: '"',
+                contains: [hljs.BACKSLASH_ESCAPE, { begin: '""' }],
+                relevance: 0
+            },
+            {
+                // Conversion Functions *_TO_**
+                className: "built_in",
+                begin: "(ANY|BOOL|BYTE|D?L?WORD|L?TIME|DATE|DT|TOD|W?CHAR|W?STRING|U?S?D?L?INT|L?REAL)_TO_(BOOL|BYTE|D?L?WORD|L?TIME|DATE|DT|TOD|W?CHAR|W?STRING|U?S?D?L?INT|L?REAL)"
+            },
+            {
+                // Conversion Functions TO_**
+                className: "built_in",
+                begin: "TO_(BOOL|BYTE|D?L?WORD|L?TIME|DATE|DT|TOD|W?CHAR|W?STRING|U?S?D?L?INT|L?REAL)"
+            },
+            {
+                className: "symbol",
+                begin: "(D|T|DT|TOD)#[0-9:\\-_shmyd]*"
+            },
+            {
+                className: "symbol",
+                begin: "[a-zA-Z_]+#[a-zA-Z]*"
+            },
+            {
+                className: "symbol",
+                begin: "[A-Za-z]{1,6}#[0-9_\\.e\\-]*",
+                relevance: 0
+            },
+            {
+                className: "number",
+                begin: "[0-9]+#\\-?[0-9_]*",
+                relevance: 0
+            },
+            {
+                className: "number",
+                begin: "[a-zA-Z_]+#\\-?[0-9_]*",
+                relevance: 0
+            },
+            {
+                className: "symbol",
+                begin: "%(I|Q|M)(X|B|W|D|L)[0-9.]*"
+            },
+            {
+                className: "symbol",
+                begin: "%(I|Q|M)[0-9.]*"
+            },
+            hljs.C_NUMBER_MODE,
+            hljs.COMMENT("//", "$"),
+            hljs.C_BLOCK_COMMENT_MODE,
+            hljs.COMMENT("\\(\\*", "\\*\\)")
+        ]
+    }
+}
+
+module.exports = function(hljs) {
+    hljs.registerLanguage("iecst", hljsDefineIECST);
+};
+
+module.exports.definer = hljsDefineIECST;

iecst.js

@@ -32,7 +32,7 @@
     },
     "homepage": "https://github.com/highlightjs/highlightjs-structured-text#readme",
     "devDependencies": {
-        "highlight.js": "^10.0.2",
+        "highlight.js": "^10.4.1",
         "jasmine": "^3.5.0"
     }
 }