AE script syntax highlighting in documentation - need list of object attributes

[Legacy User]

Hi there

I'm writing a configuration file for SyntaxHighlighter (http://alexgorbatchev.com/SyntaxHighlighter/download/). It's a Javascript that does Code - syntax highlighting for HTML formatted documentation. It's featured in many blogs as well as Confluence Wiki (for those who know it). Right now it features all common languages (C, C#, PHP, Javascript, Python and so on), however no AE Script. I'd like to change that.

I've been able to do the necessary regular expressions & been able to extract all functions from the F1-help. However I struggle with extracting all the possible attribute names. So does anyone have a complete list of attributes? I would do a special highlighting for them. Once it's done I would release it to the community.

Regards
Joel

[Anon Anon]

This sounds really cool!!!!
I haven't heard of this before, but it would be totally helpful.

I would love to help you work on this, but need to read up on the tool. Can you post a screenshot of a small snippet of what you already have and need?

[Legacy User]

Haven't forgot about the post but haven't been able to get the Wiki Team activating my change. I'm gonna do a screenshot tonight on my private wiki and possibly attach the script here.

[Legacy User]

Finally as promised. You can embed syntax highlighted AE code on every webbased solution by using http://alexgorbatchev.com/SyntaxHighlighter/ & the attached file.

I love Confluence for documentation purpose, this screenshot has been done on my local system so this is just an example how it might look like.

If you want to use it:
- Download the TXT file and rename to .JS
- Login to confluence, click the gear-wheel on the upper-right corner, settings, login with the admin account, goto code macro setup, choose "add new language" (or something like this) and upload the JS. Name the language "AEScript"

https://us.v-cdn.net/5019921/uploads/editor/ij/b6hw7qbm9489.png" width="959">

What's not yet done is to give attributes an appropriate color for PUT_ATT etc.. That's why I needed the list ;-).

Attachment(s)

shBrushAEScript.txt   4 KB 1 version

[Michael A. Lowry]

Terrific! I have already installed the file in our Confluence system. Thanks, Joel.

[Michael A. Lowry]

Hey joel_wiesmann_automic, any chance you could update this to handle predefined variables like &$SYSTEM#? Currently, the syntax highlighting seems to handle these in a strange way, rendering the ampersand as its HTML entity & instead of a literal ampersand.

I’m guessing this involves editing this line, or adding another one like it just for predefined variables.

{ regex: /&\w+#?/g, css: 'variable' },

Update: I fixed this by adding the following line:

{ regex: /&\$\w+#/g, css: 'constants' },

[nafetS]

Hi@Joel Wiesmann,

ist die txt hier noch die aktuelle, oder gibt es da schon was neues?
Würde die gern in Confluence verwenden.

Gruß

[Michael A. Lowry]

I am working on a version of joel_wiesmann_automic's syntax highlighting file updated for v12.1. I will post it soon.

[Legacy User]

Sorry that I didn't get back on that. I was not  able to use my own prepared highlighting rules as the responsible team did not want to add new highlighting modules on the production environment..... so it got out of maintenance.

[Michael A. Lowry]

I have updated the syntax highlighting file to bring it up-to-date and add missing elements.

List of changes:

• Added missing OTHER keyword for :SWITCH ... :ENDSWITCH block.
• Added the new script elements added to the AE in recent versions (e.g., GENERATE_SCRIPT_VARS).
• Added the valid alternate forms/spellings/abbreviations of many script elements.
• Added several deprecated script elements such as the the CINT and CSTR functions.
• Added regex for predefined variables such as &$SYSTEM#. Predefined variables are treated as constants.
• Added system/object attributes (e.g., ARCHIVE_KEY1). Attributes are treated as constants.
• Removed regex that made most characters bold. (This resolved a problem with entitized < and > symbols.)

This syntax highlighting file handles all of the public commands, functions, variables, and attributes listed in the highlight rules included in an AE v12.1 client trace. As such, I think it should be complete. If you identify an element that is not handled correctly, please let me know.

Ping: joel_wiesmann_automic

Attachment(s)

Automic_syntax_highlighting_v12.1.txt   10 KB 1 version

[Michael A. Lowry]

After a few days of testing, I have installed the updated AE syntax highlighting file in our production wiki server. It works like a charm.
https://us.v-cdn.net/5019921/uploads/editor/cc/bkuoqu1q30v2.png" width="869">

[nafetS]

Works fine.
Thanks!

[Matthias Schelp]

We use confluence, too. That's a nice feature. Thanks a lot.

[Legacy User]

... and just to do some advertising. With Powershell and the WorkflowCommander module it's quiet easy-peacy to read process tabs from objects and push them into Confluence using REST ;-).

[Michael A. Lowry]

@Joel Wiesmann: Have you updated your syntax highlighting file recently?

[Joel Wiesmann]

@MichaelLowry holy this is already 9 years old :-D! I never updated it since I couldn't deploy it in my working environments. 

------------------------------
☎️ Swisscom Automation Engineer & 🧙 PE Membership Creator

Automic Kurse, Tutorials, Tools und mehr auf:
https://membership.philippelmer.com/
Zwei Wochen kostenlos testen!
------------------------------

[Alain Moisy]

Hi,

I'm using for now more years that I can remember TextPad that is like Notepad++ and other text editors. It has a functionality that allows you to define your proper syntax for highlighting keywords in your select choice of file. Easy to use, maintain and already available for hundreds of file type, even for old COBOL for those who still knows what it is !!

Can be a simple solution and is available as a freeware ... 

Alain

[Aleksejs Barskovs]

CONFIDENTIALITY NOTE: This e-mail message, including any attachment(s), contains information that may be confidential, protected by the attorney-client or other legal privileges, and/or proprietary non-public information. If you are not an intended recipient of this message or an authorized assistant to an intended recipient, please notify the sender by replying to this message so that we can correct our records to avoid the mistake in the future and then delete it from your system. Use, dissemination, distribution, or reproduction of this message and/or any of its attachments (if any) by unintended recipients is not authorized and may be unlawful. Your cooperation with this request is appreciated.