4706bbb · project-m36 · git.iko.soy

git.iko.soy/project-m36

update documentation to reflect new :importexample

this is important for the websocket server which cannot import from the file system

commit4706bbb9a4220c16e7c1f0704d193396283cc20a authorAgentM <agentm@themactionfaction.com> dateFri 5 Aug 2016, 17:19 (10 years ago) parent85ca65f

4 files changed+13−4

compare with master

unifiedsplit

README.markdown+1 docs/15_minute_tutorial.markdown+9−1 docs/reaching_out_of_the_tarpit.markdown+2−2 docs/tutd_tutorial.markdown+1−1

README.markdown+1

@@ -36,6 +36,7 @@ Project:M36 supports multiple frontends which target different audiences.

36361. [Using Notifications](docs/using_notifications.markdown)

37371. [Merge Transactions](docs/merge_transactions.markdown)

38381. [Reaching "Out of the Tarpit" with Project:M36](docs/reaching_out_of_the_tarpit.markdown)

39+1. [WebSocket Server](docs/websocket_server.markdown)

3940

4041## Development

4142

docs/15_minute_tutorial.markdown+9−1

@@ -26,11 +26,19 @@ Note that TutorialD is strongly-typed- no type coercions take place automaticall

2626### Load the Canonical Chris Date Example

2727

2828```

29−TutorialD (master): :importtutd "scripts/DateExamples.tutd"

29+TutorialD (master): :importexample date

30+```

31+

32+or

33+

34+```

35+TutorialD (master): :importtud "scripts/DateExamples.tutd"

3036```

3137

3238```:importtutd``` (do not skip typing the preceding colon), loads a file which contains a script written in the TutorialD dialect used by Project:M36 and executes it to change the state of the database. In this case, the relations "s" (supplier), "p" (product), and "sp" (suppliers-products) are now loaded.

3339

40+```:importexample date``` loads the date example directly without any file I/O, so it is safe to use with the websocket server.

41+

3442### Execute Relational Expressions

3543

3644```

docs/reaching_out_of_the_tarpit.markdown+2−2

@@ -58,8 +58,8 @@ Project:M36 implements multiple interfaces:

5858To understand how Project:M36 stacks up against the fictional programming language shown in the paper, we have implemented the [example from the paper](/examples/out_of_the_tarpit.tutd). The language used in the script is a dialect of Chris Date's TutorialD language. It can be loaded into an interactive ```tutd``` session like so:

5959

6060```

61−TutorialD (master): :importtutd "examples/out_of_the_tarpit.tutd"

62−TutorialD (master): :showexpr property

61+TutorialD (master): :importexample date

62+TutorialD (master): :showexpr p

6363┌───────────────────┬────────────┬───────────────────┬────────────┬────────────┐

6464│address::Address │agent::Agent│dateRegistered::Day│photo::Text │price::Price│

6565├───────────────────┼────────────┼───────────────────┼────────────┼────────────┤

docs/tutd_tutorial.markdown+1−1

@@ -68,7 +68,7 @@ products{}

6868The examples in this tutorial can be executed after loading Chris Date's sample relations using:

6969

7070```

71−:importtutd "scripts/DateExamples.tutd"

71+:importexample date

7272```

7373

7474Each section assumes a fresh instance of the Date examples. The relation variables created in the script are: