Package gavo :: Package base :: Module meta :: Class NoteMeta
[frames] | no frames]

Class NoteMeta

source code

object --+        
         |        
 MetaMixin --+    
             |    
     MetaValue --+
                 |
                NoteMeta

A meta value representing a "note" item.

This is like a footnote, typically on tables, and is rendered in table infos.

The content is the note body. In addition, you want a tag child that gives whatever the note is references as. We recommend numbers.

Contrary to other meta items, note content defaults to rstx format.

Typically, this works with a column's note attribute.

In XML, you would usually write:

 <meta name="note" tag="1">
   Better ignore this.
 </meta>
Instance Methods
 
__init__(self, content, format='rst', tag=None)
is a constructor for standalone use.
source code

Inherited from MetaValue: __str__, __unicode__, copy, encode, getContent, getExpandedContent

Inherited from MetaMixin: addMeta, buildRepr, copyMetaFrom, delMeta, getAllMetaPairs, getMeta, getMetaKeys, getMetaParent, isEmpty, iterMeta, keys, makeOriginal, setMeta, setMetaParent, traverse

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables

Inherited from MetaValue: consecutiveWSPat, knownFormats, paragraphPat, plainWrapper

Properties

Inherited from object: __class__

Method Details

__init__(self, content, format='rst', tag=None)
(Constructor)

source code 

is a constructor for standalone use. You do *not* want to call this when mixing into a Structure.

Overrides: object.__init__
(inherited documentation)