Bukkit

Notes Formatting

^{____________________________}

Permissions

The notes have two type of permissions, the read permission and the write permission. The read permission define who can read the note, if the note is part of the resume, and if the owner can read this overriding the level permission. The write permission define who can edit this note, and if the owner can edit this overriding the level permission.
The read permission can be composed of three part:

private. : if the permission contain this part the owner would be able to read his note even if his permission level is too low.
resume. : if the permission contain this part the note would be display with the "/notes resume <...>" command, respecting the permission level and the "private.".
0-9 : The level permission is comprised between 0 and 9, the permission level should be at the end of the permission string, 0 means all player who has the "notes.read" permission can read the note.

The write permission can be composed of two part:

personal. : if the permission contain this part the owner would be able to edit his note even if his permission level is too low.
0-9 : The level permission is comprised between 0 and 9, the permission level should be at the end of the permission string, 0 means only ops can edit the note.

Examples

Notes:
  Birth:
    read: resume.0
    write: personal.0
    def: Birthdate
    data: "06/13/95"
  Info:
    read: resume.private.4
    write: '5'
    def: Comment of staff
    data: Like helping to build public building

The note "Birth" will be readable by everyone and display in the resume; the note will be writable by the owner and the Ops.
The note "Info" will be readable by player which have permission "notes.read.4" and more, and by the owner, the note will be display in the resume in respect to the read permission; the note will be writable by the players which habe the permission "notes.read.5" and more.
Note that the permission for player are comprised between 1 and 9 (ex: notes.read.0, notes.read.1, notes.write.0, notes.write.9)
^{____________________________}

Data

There is 4 type of note, the String, the List, the Number and the Toggle. The String is a simple sentence/word. The List is a serie of many String. The Number is... a Number. But comprised between -2147483648 and 2147483647, so you have what to do. The Toggle is simply "True" or "False", nothing more.

Examples

Notes:
  ExampleString:
    read: '0'
    write: '1'
    def: Example of String with special character
    data: "I like go to Caf\xe9"
  ExampleList:
    read: '0'
    write: '1'
    def: Example of List
    data:
    - Line 1
    - Line 2
    - Line 3
    - ...
  ExampleNumber:
    read: '0'
    write: '1'
    def: Example of Number
    data: 42
  ExampleToggle:
    read: '0'
    write: '1'
    def: Example of Toggle
    data: true

The String are surrounded by quotations only when special character are use or when the String is only a Number or true/false. The List is like the String but each String are preceded by '-' and next String is to the next line. The Number is simply a number without quotations. The Toggle is either true or false.

Respect the syntax/formatting, you can verify your formatting with a YamlChecker, the special characters are formatted in Unicode preceded by '\x'. Found Unicode value in UnicodeTable.