mBraceSquare

representing metadata inline

Stefano Da Ros

What is it?

{[tldr: "inline metadata"]}


mBraceSquare is a markup language used to represent metadata in regular text using familiar JSON/CSON syntax

{[ key: "value" ]}

Example

> cat ~/student_essays/jimmys_superhero.txt

when I grow up, I want to be big and strong like #JohnCena.

> cat ~/student_essays/jimmys_superhero_corrections.txt

when I grow up, I want to be big and strong like John Cena {[comment: "I know it sounds
cool Jimmy, but please don't use hashtags in your essays."]}.

Design Goals

{[tldr: ['legible', 'intuitive', 'tolerant'] ]}


mBraceSquare was designed to provide a simple way of representing loosely structured metadata in regular text


Implementations of mBraceSquare should be:

  • easy to read and interpret


  • intuitive to write


  • tolerant of human laziness

Use Cases


mBraceSquare is flexible and can be used in many different contexts


Arrival Time Schatz

Use Cases

Lazy References


It is sometimes useful to be able to add references in a semi-structured fashion

Example

The proposal should be reviewed and any changes should be submitted to
the responsible party {[reference: "project's technical lead"]}.

Use Cases

Representing Microdata


Authoring in Markdown is great and being able to easily add microdata would be cool

Example

 > cat /srv/http/www.cip.li/blog/_posts/2014-06-06-ilmenau_himmel_blau.markdown

I was in Ilmenau visiting some friends on the weekend and we had a great time! We rented
some donkeys from a {[localBusiness: "Esel und Söhne"]} and rode to the top of the Kickelhahn.

Rendered HTML

I was in Ilmenau visiting some friends on the weekend and we had a great time! We rented some donkeys from a local business Esel und Söhne and rode to the top of the Kickelhahn.

{[endOfPresentation: true]}


Standards


{[comments: "let me know what you think, sd@cip.li"]}