Code Monkey home page Code Monkey logo

raft's Introduction

RAFT

RAFT (Randy's ANSI Flowchart Text)

A language for writing standardized ANSI flow charts with simple text.

Objectives

RAFT's goal is to make an easy way to create flows within text based documentation without the use of images or visual editors.

Spec

  • It needs to work alongside Markdown and not get compiled to HTML when markdown is converted
  • It needs to use non-special characters everyone has access to
  • It needs to follow a standard that would allow it to be rendered into a visual flow chart
  • It needs to be as simple as possible
  • It needs to be quickly read and understood by a human

Examples

( Server )  ->  Flowline Comment  ->  ] Handles Request [  ->  // prepares data for database insertion //  ->  ((( Database X )))

Symbols

Text representation of ANSI/ISO Standard Symbols taken from https://en.wikipedia.org/wiki/Flowchart

Common Symbols

-> Flowline -> flowlines have two white spaces before and after the -> mark

( Terminal )

] Activity or Process or Operation [

< Decision >

// Input or Output //

-[ Annotation ]-

]] Predefined Process [[

( C ) An on-page connector that uses a single letter that is tied to a definition written in a legend

{ Off-page Connector }

Other Symbols

((( Datafile or Database )))

~ Document ~

== Parallel Mode ==

^/ Manual Operation ^/

[ Physical Movement ]=>

raft's People

Contributors

ardeay avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.