Add-ons
Check out the store for many more
Add-on

ArchieML


(0)
offered by jhuang3 users

Overview

A code formatter and dynamic preview window for ArchieML (AML), a human-friendly markup language from the New York Times.
This addon assists in using Google Docs as an editor for a human-friendly markup language called "ArchieML." 

ArchieML (or "AML") was created at The New York Times to make it easier to write and edit structured text on deadline that could be rendered in web pages, or more specifically, rendered in interactive graphics.

One of the main goals was to make it easy to tag text as data, without having type a lot of special characters. Another goal was to allow the document to contain lots of notes and draft text that would not be read into the data. And finally, because we make extensive use of Google Documents's concurrent-editing features — while working on a graphic, we can have several reporters, editors and developers all pouring information into a single document — we wanted to have a format that could survive being edited by users who may never have seen ArchieML or any other markup language at all before.

See http://archieml.org/ for more information, documentation, and links to compilers.

This addon adds two helpful menu functions for wrangling your AML document.

• The “Format Test” option automatically indents the text so that it’s easier to see nested data and colorize tags so that it is easier to see the difference between code and content.

• The “Show Preview” button opens up a pane on the right side of the window that gives you a live preview of the resulting json. It’s handy for finding errors in your data.

There are also a few useful command options, which can be invoked by including them anywhere in the document.

@format KEYWORD:VALUE
By setting the format of KEYWORD and VALUE, custom styles can be set per keyword pair. Useful for separating out repeating blocks of content.

@lowercase-keys
Rewrites all keys to lowercase on reformat.

@ignore-html 
By default, embedded HTML has smart quotes converted to plain quotes on reformat. This command disables that. 

Details

Version: 3
Updated: November 14, 2017
Language: English