public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix markup.

pull/930/head
Marcel Klehr 2012-08-07 20:29:44 +02:00
parent 7e2820a674
commit db4ae500a1
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/api/changeset_library.md
View File

@ -48,7 +48,8 @@ There are 3 types of operators: `+`,`-` and `=`. These operators describe differ
``` ```
### APool ### APool
<pre>
```
> var AttributePoolFactory = require("./utils/AttributePoolFactory"); > var AttributePoolFactory = require("./utils/AttributePoolFactory");
> var apool = AttributePoolFactory.createAttributePool(); > var apool = AttributePoolFactory.createAttributePool();
> console.log(apool) > console.log(apool)
@ -62,9 +63,11 @@ There are 3 types of operators: `+`,`-` and `=`. These operators describe differ
eachAttrib: [Function], eachAttrib: [Function],
toJsonable: [Function], toJsonable: [Function],
fromJsonable: [Function] } fromJsonable: [Function] }
</pre> ```
This creates an empty apool. A apool saves which attributes were used during the history of a pad. There is one apool for each pad. It only saves the attributes that were really used, it doesn't save unused attributes. Lets fill this apool with some values This creates an empty apool. A apool saves which attributes were used during the history of a pad. There is one apool for each pad. It only saves the attributes that were really used, it doesn't save unused attributes. Lets fill this apool with some values
<pre>
```
> apool.fromJsonable({"numToAttrib":{"0":["author","a.kVnWeomPADAT2pn9"],"1":["bold","true"],"2":["italic","true"]},"nextNum":3}); > apool.fromJsonable({"numToAttrib":{"0":["author","a.kVnWeomPADAT2pn9"],"1":["bold","true"],"2":["italic","true"]},"nextNum":3});
> console.log(apool) > console.log(apool)
{ numToAttrib: { numToAttrib:
@ -83,23 +86,29 @@ This creates an empty apool. A apool saves which attributes were used during the
eachAttrib: [Function], eachAttrib: [Function],
toJsonable: [Function], toJsonable: [Function],
fromJsonable: [Function] } fromJsonable: [Function] }
</pre> ```
We used the fromJsonable function to fill the empty apool with values. the fromJsonable and toJsonable functions are used to serialize and deserialize an apool. You can see that it stores the relation between numbers and attributes. So for example the attribute 1 is the attribute bold and vise versa. A attribute is always a key value pair. For stuff like bold and italic its just 'italic':'true'. For authors its author:$AUTHORID. So a character can be bold and italic. But it can't belong to multiple authors We used the fromJsonable function to fill the empty apool with values. the fromJsonable and toJsonable functions are used to serialize and deserialize an apool. You can see that it stores the relation between numbers and attributes. So for example the attribute 1 is the attribute bold and vise versa. A attribute is always a key value pair. For stuff like bold and italic its just 'italic':'true'. For authors its author:$AUTHORID. So a character can be bold and italic. But it can't belong to multiple authors
<pre>
```
> apool.getAttrib(1) > apool.getAttrib(1)
[ 'bold', 'true' ] [ 'bold', 'true' ]
</pre> ```
Simple example of how to get the key value pair for the attribute 1 Simple example of how to get the key value pair for the attribute 1
### AText ### AText
<pre>
```
> var atext = {"text":"bold text\nitalic text\nnormal text\n\n","attribs":"*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2"}; > var atext = {"text":"bold text\nitalic text\nnormal text\n\n","attribs":"*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2"};
> console.log(atext) > console.log(atext)
{ text: 'bold text\nitalic text\nnormal text\n\n', { text: 'bold text\nitalic text\nnormal text\n\n',
attribs: '*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2' } attribs: '*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2' }
</pre> ```
This is an atext. An atext has two parts: text and attribs. The text is just the text of the pad as a string. We will look closer at the attribs at the next steps This is an atext. An atext has two parts: text and attribs. The text is just the text of the pad as a string. We will look closer at the attribs at the next steps
<pre>
```
> var opiterator = Changeset.opIterator(atext.attribs) > var opiterator = Changeset.opIterator(atext.attribs)
> console.log(opiterator) > console.log(opiterator)
{ next: [Function: next], { next: [Function: next],
@ -135,7 +144,8 @@ This is an atext. An atext has two parts: text and attribs. The text is just the
chars: 2, chars: 2,
lines: 2, lines: 2,
attribs: '' } attribs: '' }
</pre> ```
The attribs are again a bunch of operators like .ops in the changeset was. But these operators are only + operators. They describe which part of the text has which attributes The attribs are again a bunch of operators like .ops in the changeset was. But these operators are only + operators. They describe which part of the text has which attributes
For more information see /doc/easysync/easysync-notes.txt in the source. For more information see /doc/easysync/easysync-notes.txt in the source.