Browse Source

Added Objects example

Alois Mahdal (@azzgoat) 11 years ago
parent
commit
31ee7483d3
2 changed files with 49 additions and 0 deletions
  1. 3
    0
      TODO.md
  2. 46
    0
      examples/objects.md

+ 3
- 0
TODO.md View File

@@ -13,6 +13,9 @@
13 13
 
14 14
   [1]: examples/dependency.md
15 15
 
16
+*   elaborate Objects example[2]
17
+
18
+  [2]: examples/objects.md
16 19
 
17 20
 ### Data model ###
18 21
 

+ 46
- 0
examples/objects.md View File

@@ -0,0 +1,46 @@
1
+Name: Objects.md
2
+Description: Demo on how to handle objects to operate on.
3
+
4
+Demo: Objects
5
+=============
6
+
7
+
8
+Description
9
+-----------
10
+
11
+Sometimes, to achieve desired result, you need to perform scenario on different
12
+objects. Typically this is case in server-client scenario: you set up a server,
13
+connect client, do something with client, do something with server, connect
14
+another client observe server, you get the pint.
15
+
16
+In order to filter out repeating all the clients and servers, and allow for a
17
+more intuitive representation (e.g. an icon), we need to introduce a special
18
+markup for objects.
19
+
20
+
21
+Rules
22
+-----
23
+
24
+*   there can  be any number of objects
25
+
26
+*   there is no formal hierarchy, proper naming can be introduced if needed
27
+
28
+*   if the line body starts with `qr/(\w+):/`, `$1` is the object name
29
+
30
+*   TODO: define how to introduce style
31
+
32
+
33
+Example
34
+-------
35
+
36
+1.  server: prepare a server
37
+
38
+2.  client: connect to server
39
+
40
+3.  client: download rules
41
+
42
+4.  server: add new rules
43
+
44
+5.  client: update rules
45
+
46
+