Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

re::phrase

re::phrase is a shorthand convention for writing plain text blocks as strings that are friendly to array value conversion.

The convention helps content and code collaborators work together with pre-decided project-based rules on how they will use the structure.

The Convention

## for text blocks
:: for subtext items
** to mark favourites
all fields are optional
whitespace is to be ignored

Structure

pretext
## text 1
## text 2**
## text 3
	:: subtext 1**
	:: subtext 2
	:: subtext 3
	:: subtext 4**
## text 4**

or, in single line

pretext ## text 1 ## text 2** ## text 3 :: subtext 1** :: subtext 2 :: subtext 3 :: subtext 4** ## text 4**

or, even shorter

pretext##text 1##text 2**##text 3::subtext 1**::subtext 2::subtext 3::subtext 4**##text 4**

How is it different from JSON

The re::phrase convention is only for structuring values, and not key-value pairs, whereas JSON provides a robust convention for key-value pair structuring. Re::phrase can be quickly typed with less chances of mistakes, JSON is difficult to write without a JSON validator.

How is it different from Markdown

This is for plain text values not for formating text.

Examples

In a typical scenario, this can replace the use of multi-input fields from CMS dashboards / form inputs, or add additional complexity handling to them, for text or texarea input fields in HTML forms or for adding more dimensions to spreadsheet cells.

re::phrase examples

More info and contact

https://wildfiretech.co/page/our-approach
https://github.com/wil-ldf-ire

Wildfire logo

About

A shorthand convention for writing plain text blocks as strings that are friendly to array value convention.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors