github.com/slspeek/camlistore_namedsearch@v0.0.0-20140519202248-ed6f70f7721a/doc/schema/claims/attributes.txt (about)

     1  Permanode Attributes
     2  
     3  While a permanode can have any arbitrary attributes and values (and
     4  each value can be single-valued or multi-valued), the following are
     5  the conventional attributes and values used by the various tools,
     6  search, FUSE, and web UI.
     7  
     8  "tag": (multi-valued)
     9  
    10      a set of zero or more keywords (or phrases) indexed completely, for
    11      searching by tag. No HTML.
    12  
    13  "title": (single-valued)
    14  
    15      A name given to the permanode. No HTML.
    16  
    17  "description": (single-valued)
    18  
    19      An account of the permanode. It may include but is not limited to:
    20      an abstract, a table of contents, or a free-text account of the
    21      resource. No HTML.  As of 2013-12-28, not very defined yet.
    22  
    23  "camliContent": (single-valued)
    24  
    25      when a permanode is a file, the camliContent is set to the fileref
    26      (the blobref of the "file" schema blob)
    27  
    28  "camliContentImage": (single-valued)
    29  
    30      when a permanode has camliContent set, but the camliContent is of
    31      a non-image, the camliContentImage points to a "file" schema's
    32      blobref of an image representation of the content. For instance,
    33      this might be the cover art of an MP3 file or a thumbnail of a
    34      spreadsheet.
    35  
    36  "camliMember": (multi-valued)
    37  
    38      when the permanode represents a set (unordered, unkeyed), the
    39      parent permanode (the container set) has a camliMember set to the
    40      permanode of each child element.
    41  
    42  "camliPath:$dirent_name" (single-valued)
    43  
    44      when the permanode represents an associative container, each keyed
    45      child permanode blobref is pointed to by the "camliPath:$key"
    46      attribute on the parent.  This is used by the FUSE client, and
    47      respected in the UI (browser, publishing code), etc.
    48  
    49  "camliNodeType" (single-valued)
    50  
    51      when the application needs to note the type of a permanode before
    52      any other attributes (like those above) are added which would otherwise
    53      imply its type, the camliNodeType lets applications be specific.
    54      This should only be used if another attribute can't imply it.
    55      Currently only used by FUSE to indicate the difference between a new
    56      file and a new directory permanode.  Known values include:
    57  
    58          * "directory". this permanode will have "camliPath:$key"
    59            attributes later.
    60          * "file". this permanode will have a "camliContent" later. for
    61            now, it should be treated as if it's an empty, 0-byte file.
    62  
    63  "camliDefVis" (single-valued)
    64  
    65      Can be "hide". Experimental. Affects default visibility in web UI.
    66  
    67  "xattr:$attr_name" (single-valued)
    68  
    69      when a permanode represents a file or directory visible to FUSE,
    70      "xattr:$x" is used to store the value for extended attribute "x".
    71      Extended attribute data may contain any arbitrary bytes, so values
    72      are base64 encoded.
    73  
    74  "camliRoot" (single-valued)
    75  
    76      TODO: doc
    77  
    78  "camliImportRoot" (single-valued)
    79  
    80      TODO: doc