sample Spec

[alikindsys]

the lack of an actual spec will literally drive me crazy. current code is a piece of garbage and will be re-written with a better backend (megaparsec).

this issue will contain the spec i wish to reimplement on the next rewrite.

• Character escaping c04a888
• String Literals c04a888
• String Interpolation c04a888
• Variable declaration 2d49c79
• Variable exporting 9344445
• Pragmas e6c9ee9
• • Include 58ca34a
• • Import 5191f7c
• • Begin f8f4c6f
• • Class f513e39
• • End d48fdf6
• • Init db91519
• Lists e628edf
• Blocks 6af41d1

[alikindsys]

Pragmas

# - Reserved char for marking any pragma
INCLUDE - C-like include pragma

#include "file.sample"
#include "file.tex"

IMPORT - haskell-like import pragma

#import package /* \usepackage{package} */
#import package ("function") /* \usepackage[function]{package} */
#import package (function, function2)/*  \usepackage[function, function2]{package} */
#import package (option=value) /*  \usepackage[option=value]{package} */
#import package (option=value, function) /* \usepackage[option=value, function]{package} */

CLASS - documentclass pragma

#class package (function) /* \documentclass[function]{package} */
#class package ([...])
/*
*  See `IMPORT` for other options
*/

BEGIN - begin pragma

#begin list

• must be followed by an END.

END - end pragma

#end

INIT - same as #BEGIN DOCUMENT

#init

• can only exist once
• literally the same as Begin "document" the existence of either will become a DocumentInit, only one of those elements must exist inside of a Document Entity.
• needed for direct pdf compilation

[alikindsys]

Character Escaping

\ - reserved char for character escape sequences
has the highest priority on the spec.

Implemented as of c04a888

[alikindsys]

Strings

continuous stream of characters marked by " on the starting and end.
second highest priority on the spec.

Implemented as of c04a888

[alikindsys]

fstrings/String Interpolation

• kotlin style.
  when $ is located the string next to it will be interpreted as the identifier
  eg:

$"asdjkasldjas $value" //string interpolation

Implemented as of 5c807ac
Reworked at a1ce280

[alikindsys]

Variable declaration

var - reserved keyword for variable declaration
var <identifier> = value

value can be an string.
internal to sampletex unless exported

var x = "value"

Implemented as of 2d49c79

[alikindsys]

Variable exporting

out - reserved keyword.
useful for talking to the latex world.

out x
out x,y,z

Implemented as of 9344445

[alikindsys]

Inline Lists

<text>:[ - named list creation
[ - unnamed list creation
u[ - unordered list creation
<text>:u[ - named unordered list creation
yes, those are composable
] - list termination
, - item separation

Rules

cannot be created inside of strings - this fixes citations crashing sampletex eg : ["asdasdasd[3]"]
these are inline lists for composite multi line stuff syntax will be different

Examples

["this is a list with only one item"]
"avocado types":["bacon", "hass", "joey"]
"todo list":u["bullet lists", "they now exist", $"wait i need a colen in the, middle of the $item"]

Implemented as of e628edf

[alikindsys]

Blocks (old li...il "lists")

{ - block start
<text>:{ - named block
u{ - unordered block
- <entry> - entry
} - block end

they are by all means equivalent to inline lists. they even compile to the same code.
the only difference is that lists are inline, while blocks are multiline.

Rules

Last item on a list must end with a SEMICOLON ;

Example

"this is an example of blocks":{
    - "hi there"
    - "this is another entry"
    - $"look cool composition $value"
    u{
        - "here is another block"
        - "and now a list":["a","b","c"];
    };
}

Implemented as of 6af41d1