commit ba1668ca5586ba1785514ea5bfb147a29955082f
parent 83800593ad89e8a0adf4080ebd11b75e8a5cc475
Author: vh <vetle.haflan@gmail.com>
Date: Sun, 25 Nov 2018 00:48:16 +0100
Rename syntax.md->specification.md and add some ideas to it
Diffstat:
| A | specification.md | | | 60 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | syntax.md | | | 46 | ---------------------------------------------- |
2 files changed, 60 insertions(+), 46 deletions(-)
diff --git a/specification.md b/specification.md
@@ -0,0 +1,60 @@
+Specification for 'v1.0'
+========================
+
+Valid symbols
+-------------
+- Joints and corners: `+`
+- Lines: `-`, `|`
+- Arrows `v`, `^`, `<`, `>`
+- All symbols are allowed within a rectangle
+
+Use
+---
+- Rectangles are defined by four corners connected by lines or joints
+- Rectangles can have as many joints as fits, but these should be connected to
+ lines
+- Text is only supported inside rectangles
+- Only text is supported inside rectangles
+ (everything within the rectangle boundaries is read as the rectangle label).
+- Lines *must* start / end with a joint or an arrow
+- Lines can have as many joints as it can fit
+- Arrows *must* point away from the line that they end
+
+v2.0 (proposal)
+===============
+
+Valid symbols
+-------------
+- Dotted lines: `:` `.`
+ These don't really mix well with the rest of the symbols, so they might not
+ be useful.
+
+New features
+------------
+- Text should be allowed wherever in the figure.
+ It should simply be read from the first to the last letter.
+- Rectangles can contain everything that is allowed in the figure itself.
+ (See issue about recursive Figures / rectangles or something ) \*
+
+v3.0 (proposal)
+---------------
+- Diagonal lines `/`, `\`, for instance for diamond shapes...
+
+
+Functionality
+=============
+
+- Symbols that can be found unprocessed: ` `, `+`, `<`, `^`
+ + Nothing to do: ` `
+ + Rectangle detection: `+`
+ + Line detection: `+`, `<`, `^`
+- Symbols that can [only] \* be found during line processing:
+ + [`>`, `v`]
+ + `+`, `|`, `-`
+
+\* These are up for discussion. It might be desirable to be able to draw
+ *through* / *over* boxes, in which case lines must be allowed to cross the
+ box borders. This will in turn make it hard to implement "recursive
+ rectangles", as the rectangle contents are not necessarily isolated.
+
+
diff --git a/syntax.md b/syntax.md
@@ -1,46 +0,0 @@
-Syntax for 'v1.0'
-=================
-
-Valid symbols
--------------
-- Joints and corners: `+`
-- Lines: `-`, `|`
-- Arrows `v`, `^`, `<`, `>`
-- All symbols are allowed within a rectangle
-
-Use
----
-- Rectangles are defined by four corners connected by lines or joints
-- Rectangles can have as many joints as fits, but these should be connected to
- lines
-- Text is only supported inside rectangles
-- Only text is supported inside rectangles
- (everything within the rectangle boundaries is read as the rectangle label).
-- Lines *must* start / end with a joint or an arrow
-- Lines can have as many joints as it can fit
-- Arrows *must* point away from the line that they end
-
-v2.0 (proposal)
-===============
-- Text should be allowed wherever in the figure.
- It should simply be read from the first to the last letter.
-- Rectangles can contain everything that is allowed in the figure itself.
- (See issue about recursive Figures / rectangles or something )
-
-v3.0 (proposal)
----------------
-- Diagonal lines `/`, `\`, for instance for
-
-
-Functionality
-=============
-
-- Symbols that can be found unprocessed: ` `, `+`, `<`, `^`
- + Nothing to do: ` `
- + Rectangle detection: `+`
- + Line detection: `+`, `<`, `^`
-- Symbols that can [only] be found during line processing:
- + [`>`, `v`]
- + `+`, `|`, `-`
-
-
