Module: Docbook::Elements::DocbookElement

Included in:
Abbrev, Acknowledgements, Address, Alt, Annotation, Answer, Appendix, Application, Article, Att, Attribution, AudioObject, Author, Bibliography, Bibliolist, Bibliomixed, Biblioref, BlockQuote, Book, BuildTarget, Callout, CalloutList, Caution, Chapter, Citation, CiterefEntry, Citetitle, ClassName, Co, Code, Colophon, Command, ComputerOutput, Constant, Copyright, Cover, Danger, Date, Dedication, Dir, Email, Emphasis, Entry, EntryTbl, Enumvalue, Envar, Equation, Errorcode, Errortype, Example, Exceptionname, FieldSynopsis, Figure, Filename, FirstName, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FormalPara, Function, GlossDef, GlossEntry, GlossSee, GlossSeeAlso, Glossary, Glossterm, Holder, Honorific, ImageData, ImageObject, Important, Index, IndexDiv, IndexEntry, IndexTerm, Info, InformalExample, InformalFigure, InformalTable, Initializer, Inlinemediaobject, ItemizedList, KeyCap, LegalNotice, Link, ListItem, Literal, LiteralLayout, MediaObject, Msg, MsgSet, Msgexplan, Note, Option, OrderedList, OrgName, Para, Parameter, Part, PersonName, Phrase, Preface, Primary, Procedure, ProductName, ProductNumber, ProgramListing, Prompt, Property, PubDate, PublisherName, QandAEntry, QandASet, Question, Quotation, Quote, RefEntry, RefEntryTitle, RefMeta, RefMiscInfo, RefName, RefNamediv, RefPurpose, RefSect1, RefSect2, RefSect3, RefSection, Reference, ReleaseInfo, Remark, Replaceable, Row, Screen, Secondary, Sect1, Sect2, Sect3, Sect4, Sect5, Section, See, SeeAlso, Set, SetIndex, SideBar, SimPara, Simplesect, Step, SubSteps, Subscript, Subtitle, Superscript, Surname, TBody, TFoot, TGroup, THead, Table, Tag, Term, Tertiary, TextObject, Tip, Title, Toc, TocDiv, TocEntry, Topic, Trademark, Type, Uri, UserInput, Variable, VariableList, Varlistentry, Varname, Version, VideoObject, Warning, WordAsWord, Xref, Year
Defined in:
lib/docbook/elements/concerns/docbook_element.rb

Overview

Base concern included by ALL elements. Provides universal protocol methods so services use capability queries instead of type introspection. Provides universal protocol methods so services use capability queries instead of type introspection.

Instance Method Summary collapse

Instance Method Details

#callout_marker? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 127

def callout_marker?
  false
end

#colsep ⇒ Object 



87
88
89
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 87

def colsep
  nil
end

#content ⇒ Object 



107
108
109
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 107

def content
  nil
end

#element_id ⇒ Object

Consistent element ID: xml_id or synthetic.



16
17
18
19
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 16

def element_id
  id = xml_id
  id && !id.to_s.empty? ? id.to_s : "elem-#{object_id}"
end

#fileref ⇒ Object 



95
96
97
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 95

def fileref
  nil
end

#formal? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 49

def formal?
  false
end

#frame ⇒ Object 



83
84
85
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 83

def frame
  nil
end

#has_title? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 29

def has_title?
  false
end

#imagedata ⇒ Object 



99
100
101
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 99

def imagedata
  []
end

#imageobject ⇒ Object 



79
80
81
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 79

def imageobject
  []
end

#index_term? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 57

def index_term?
  false
end

#indexterm ⇒ Object 



71
72
73
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 71

def indexterm
  []
end

#info ⇒ Object 



67
68
69
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 67

def info
  nil
end

#list_of_category ⇒ Object 



53
54
55
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 53

def list_of_category
  nil
end

#media_children ⇒ Object 



119
120
121
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 119

def media_children
  []
end

#number ⇒ Object 



103
104
105
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 103

def number
  nil
end

#numberable? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 115

def numberable?
  false
end

#numbering_role ⇒ Object 



37
38
39
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 37

def numbering_role
  nil
end

#resolve_title ⇒ Object 



25
26
27
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 25

def resolve_title
  nil
end

#rowsep ⇒ Object 



91
92
93
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 91

def rowsep
  nil
end

#section_like? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 11

def section_like?
  false
end

#stats_category ⇒ Object 



45
46
47
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 45

def stats_category
  nil
end

#text ⇒ Object 



111
112
113
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 111

def text
  nil
end

#title ⇒ Object

Protocol defaults for attribute access. Overridden by Lutaml attribute declarations in the elements that have them.



63
64
65
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 63

def title
  nil
end

#titled? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 33

def titled?
  false
end

#toc_children ⇒ Object 



41
42
43
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 41

def toc_children
  []
end

#try_add_inline(_element) ⇒ Object 



131
132
133
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 131

def try_add_inline(_element)
  false
end

#videoobject ⇒ Object 



75
76
77
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 75

def videoobject
  []
end

#walk_children ⇒ Object

Yield each child Lutaml::Model::Serializable from declared attributes.



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 136

def walk_children
  self.class.attributes.each_value do |attr_def|
    value = send(attr_def.name)
    next if value.nil?

    case value
    when Array
      value.each { |v| yield v if v.is_a?(Lutaml::Model::Serializable) }
    when Lutaml::Model::Serializable
      yield value
    end
  end
end

#xml_id ⇒ Object 



21
22
23
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 21

def xml_id
  nil
end

#xref? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/docbook/elements/concerns/docbook_element.rb', line 123

def xref?
  false
end