ILIAS  release_4-4 Revision
HTMLPurifier_HTMLModule_Ruby Class Reference

XHTML 1.1 Ruby Annotation Module, defines elements that indicate short runs of text alongside base text for annotation or pronounciation. More...

+ Inheritance diagram for HTMLPurifier_HTMLModule_Ruby:
+ Collaboration diagram for HTMLPurifier_HTMLModule_Ruby:

Public Member Functions

 setup ($config)
 
- Public Member Functions inherited from HTMLPurifier_HTMLModule
 getChildDef ($def)
 Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class. More...
 
 addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
 Convenience function that sets up a new element. More...
 
 addBlankElement ($element)
 Convenience function that creates a totally blank, non-standalone element. More...
 
 addElementToContentSet ($element, $type)
 Convenience function that registers an element to a content set. More...
 
 parseContents ($contents)
 Convenience function that transforms single-string contents into separate content model and content model type. More...
 
 mergeInAttrIncludes (&$attr, $attr_includes)
 Convenience function that merges a list of attribute includes into an attribute array. More...
 
 makeLookup ($list)
 Convenience function that generates a lookup table with boolean true as value. More...
 
 setup ($config)
 Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available. More...
 

Data Fields

 $name = 'Ruby'
 
- Data Fields inherited from HTMLPurifier_HTMLModule
 $name
 Short unique string identifier of the module. More...
 
 $elements = array()
 Informally, a list of elements this module changes. More...
 
 $info = array()
 Associative array of element names to element definitions. More...
 
 $content_sets = array()
 Associative array of content set names to content set additions. More...
 
 $attr_collections = array()
 Associative array of attribute collection names to attribute collection additions. More...
 
 $info_tag_transform = array()
 Associative array of deprecated tag name to HTMLPurifier_TagTransform. More...
 
 $info_attr_transform_pre = array()
 List of HTMLPurifier_AttrTransform to be performed before validation. More...
 
 $info_attr_transform_post = array()
 List of HTMLPurifier_AttrTransform to be performed after validation. More...
 
 $info_injector = array()
 List of HTMLPurifier_Injector to be performed during well-formedness fixing. More...
 
 $defines_child_def = false
 Boolean flag that indicates whether or not getChildDef is implemented. More...
 
 $safe = true
 Boolean flag whether or not this module is safe. More...
 

Detailed Description

XHTML 1.1 Ruby Annotation Module, defines elements that indicate short runs of text alongside base text for annotation or pronounciation.

Definition at line 7 of file Ruby.php.

Member Function Documentation

◆ setup()

HTMLPurifier_HTMLModule_Ruby::setup (   $config)

Definition at line 12 of file Ruby.php.

References HTMLPurifier_HTMLModule\addElement().

12  {
13  $this->addElement('ruby', 'Inline',
14  'Custom: ((rb, (rt | (rp, rt, rp))) | (rbc, rtc, rtc?))',
15  'Common');
16  $this->addElement('rbc', false, 'Required: rb', 'Common');
17  $this->addElement('rtc', false, 'Required: rt', 'Common');
18  $rb = $this->addElement('rb', false, 'Inline', 'Common');
19  $rb->excludes = array('ruby' => true);
20  $rt = $this->addElement('rt', false, 'Inline', 'Common', array('rbspan' => 'Number'));
21  $rt->excludes = array('ruby' => true);
22  $this->addElement('rp', false, 'Optional: #PCDATA', 'Common');
23  }
addElement($element, $type, $contents, $attr_includes=array(), $attr=array())
Convenience function that sets up a new element.
Definition: HTMLModule.php:130
+ Here is the call graph for this function:

Field Documentation

◆ $name

HTMLPurifier_HTMLModule_Ruby::$name = 'Ruby'

Definition at line 10 of file Ruby.php.


The documentation for this class was generated from the following file: