Property List
From Tapestries MUCK
(Difference between revisions)
WhiteWizard (Talk | contribs) m (List moved to Property List) |
WhiteWizard (Talk | contribs) (→Technical Syntax: Corrected the end of the lsedit, added information about the # and the line count.) |
||
(2 intermediate revisions not shown) | |||
Line 1: | Line 1: | ||
- | A '''property list''' is commonly used for storing multi-line descriptions and anything else that might need a home for a large block of text. You can create a list using [[lsedit]]. | + | str A '''property list''' is commonly used for storing multi-line descriptions and anything else that might need a home for a large block of text. You can create a list using [[lsedit]]. |
==Technical Syntax== | ==Technical Syntax== | ||
While not particularly important to know, it can be useful to know that at the core a list is just bunch of numbered props in a [[propdir]]. | While not particularly important to know, it can be useful to know that at the core a list is just bunch of numbered props in a [[propdir]]. | ||
- | + | lsedit me=example | |
- | < Welcome to the list editor. You can get help by entering '.h' > | + | < Welcome to the list editor. You can get help by entering '.h' > |
- | < '.end' will exit and save the list. '.abort' will abort any changes. > | + | < '.end' will exit and save the list. '.abort' will abort any changes. > |
- | < To save changes to the list, and continue editing, use '.save' > | + | < To save changes to the list, and continue editing, use '.save' > |
- | < Insert at line 7 > | + | < Insert at line 7 > |
- | .l | + | .l |
- | this | + | this |
- | is | + | is |
- | an | + | an |
- | example | + | example |
- | list | + | list |
- | pretty simple huh? | + | pretty simple huh? |
- | < listed 6 lines starting at line 1 > | + | < listed 6 lines starting at line 1 > |
- | . | + | .end |
- | < | + | < Editor exited. > |
- | < list | + | < list saved. > |
- | ex me=example#/ | + | |
- | str /example#/1:this | + | This will produce the following: |
- | str /example#/2:is | + | |
- | str /example#/3:an | + | ex me=example#/ |
- | str /example#/4:example | + | str /example#/1:this |
- | str /example#/5:list | + | str /example#/2:is |
- | str /example#/6:pretty simple huh? | + | str /example#/3:an |
- | 6 properties listed.</pre> | + | str /example#/4:example |
+ | str /example#/5:list | ||
+ | str /example#/6:pretty simple huh? | ||
+ | 6 properties listed.</pre> | ||
+ | ex me=example# | ||
+ | str /example#/:6 | ||
+ | |||
+ | As you can see lsedit adds a # at the end of the list name, as well as setting listname# to the number of lines in the list. Neither of these are required for a proper Property List. However, if the line count is included and is incorrect, many programs will fail to read the list correctly. | ||
+ | |||
+ | |||
+ | [[Category:MUCK Documentation]] |
Latest revision as of 03:15, 2 June 2012
str A property list is commonly used for storing multi-line descriptions and anything else that might need a home for a large block of text. You can create a list using lsedit.
Technical Syntax
While not particularly important to know, it can be useful to know that at the core a list is just bunch of numbered props in a propdir.
lsedit me=example < Welcome to the list editor. You can get help by entering '.h' > < '.end' will exit and save the list. '.abort' will abort any changes. > < To save changes to the list, and continue editing, use '.save' > < Insert at line 7 > .l this is an example list pretty simple huh? < listed 6 lines starting at line 1 > .end < Editor exited. > < list saved. >
This will produce the following:
ex me=example#/ str /example#/1:this str /example#/2:is str /example#/3:an str /example#/4:example str /example#/5:list str /example#/6:pretty simple huh? 6 properties listed.</pre> ex me=example# str /example#/:6
As you can see lsedit adds a # at the end of the list name, as well as setting listname# to the number of lines in the list. Neither of these are required for a proper Property List. However, if the line count is included and is incorrect, many programs will fail to read the list correctly.