bbeb book specification v1.01

1

BBeB Standard

BBeB XML Xylog File Format Specification Version 1.01

Do Not Copy Sony Corporation

2006/12/18

2003-2007 Sony Corporation

2

Table of Contents Introduction................................................................................................................................6 BBeB XML Xylog Files...............................................................................................................7 Type definition ...........................................................................................................................8 Coordinate system used in this specification .............................................................................9 Overview of the BBeB Book Format ........................................................................................10 Definitions of Terms.................................................................................................................12 Explanation of Elements ..........................................................................................................15

1. BBeBXylog .......................................................................................................................15 2. Property............................................................................................................................15 3. BookInformation ...............................................................................................................15 4. Info ...................................................................................................................................15 5. BookInfo ...........................................................................................................................16 6. Title ..................................................................................................................................16 7. Author...............................................................................................................................16 8. BookID .............................................................................................................................17 9. Publisher ..........................................................................................................................17 10. Label ..............................................................................................................................17 11. Category.........................................................................................................................18 12. Classification ..................................................................................................................18 13. FreeText.........................................................................................................................18 14. DocInfo...........................................................................................................................18 15. Cthumbnail .....................................................................................................................18 16. Language .......................................................................................................................19 17. Creator ...........................................................................................................................19 18. SumPage .......................................................................................................................19 19. Keyword .........................................................................................................................19 20. TOC................................................................................................................................19 21. TocLabel ........................................................................................................................20 22. Main ...............................................................................................................................20 23. Page...............................................................................................................................20 24. ShowOrder .....................................................................................................................27 25. Show ..............................................................................................................................27 26. Wait ................................................................................................................................28 27. TextBlock .......................................................................................................................28 28. P.....................................................................................................................................42 29. Plot .................................................................................................................................49

Do Not Copy 2003-2007 Sony Corporation

3

30. CR..................................................................................................................................51 31. PlotText ..........................................................................................................................51 32. Fill ..................................................................................................................................52 33. Space.............................................................................................................................52 34. CharButton .....................................................................................................................53 35. Rubi................................................................................................................................53 36. Oyamoji ..........................................................................................................................53 37. Gaiji ................................................................................................................................54 38. AltString..........................................................................................................................54 39. Org .................................................................................................................................55 40. Alt ...................................................................................................................................55 41. Rubimoji .........................................................................................................................55 42. Box.................................................................................................................................55 43. EmpDots ........................................................................................................................56 44. EmpLine .........................................................................................................................58 45. AutoSpacing...................................................................................................................59 46. Sub.................................................................................................................................59 47. Sup.................................................................................................................................59 48. Yoko...............................................................................................................................59 49. Tate................................................................................................................................59 50. Nekase ...........................................................................................................................60 51. NoBR..............................................................................................................................60 52. DrawChar .......................................................................................................................60 53. Span...............................................................................................................................60 54. Italic................................................................................................................................67 55. Bold................................................................................................................................67 56. SetText...........................................................................................................................67 57. div ..................................................................................................................................74 58. ImageBlock ....................................................................................................................81 59. ButtonBlock ....................................................................................................................88 60. BaseButton.....................................................................................................................93 61. FocusinButton ................................................................................................................93 62. JumpTo ..........................................................................................................................94 63. Run.................................................................................................................................95 64. SendMessage ................................................................................................................96 65. SoundStop .....................................................................................................................97 66. CloseWindow .................................................................................................................97 67. PushButton.....................................................................................................................97 68. UpButton ........................................................................................................................98 69. SimpleTextBlock ............................................................................................................98


4

70. BlockSpace ..................................................................................................................108 71. Canvas .........................................................................................................................109 72. PutObj ..........................................................................................................................112 73. MoveObj.......................................................................................................................113 74. CanvasSetting..............................................................................................................115 75. Moveto .........................................................................................................................116 76. Lineto ...........................................................................................................................117 77. DrawBox.......................................................................................................................118 78. DrawEllipse ..................................................................................................................120 79. ViewPoint .....................................................................................................................121 80. MiniPage ......................................................................................................................122 81. PageDiv........................................................................................................................125 82. RuledLine .....................................................................................................................126 83. BlockList.......................................................................................................................128 84. Text ..............................................................................................................................133 85. SimpleText ...................................................................................................................142 86. Locate ..........................................................................................................................147 87. Import ...........................................................................................................................148 88. ObjLink .........................................................................................................................148 89. FileLink.........................................................................................................................149 90. Solo..............................................................................................................................150 91. Pages ...........................................................................................................................150 92. Template ......................................................................................................................151 93. TemplateSet.................................................................................................................151 94. Style .............................................................................................................................151 95. BookStyle .....................................................................................................................152 96. SetDefault ....................................................................................................................152 97. RegistFont....................................................................................................................157 98. BookSetting..................................................................................................................158 99. TextStyle ......................................................................................................................159 100. BlockStyle ..................................................................................................................168 101. SpanStyle...................................................................................................................173 102. PageStyle...................................................................................................................180 103. Objects .......................................................................................................................186 104. Window ......................................................................................................................186 105. PopUpWin ..................................................................................................................188 106. Sound.........................................................................................................................189 107. SoundStream .............................................................................................................191 108. ImageStream..............................................................................................................192 109. Header .......................................................................................................................192


5

110. Footer.........................................................................................................................194 111. eSound.......................................................................................................................196 112. Font ............................................................................................................................197 113. Image .........................................................................................................................198 114. Button.........................................................................................................................200

BBeB XML Xylog DTD...........................................................................................................202


6

Introduction Overview This specification defines the intermediate file format based on XML to create BBeB Book contents. This specification is defined with the objective of ensuring compatibility between devices and the smooth use of contents defined in the BBeB standard. Scope The scope of this specification is the data and the devices necessary for creating BBeB Book contents based on the BBeB standard.


7

BBeB XML Xylog Files The extension for BBeB XML Xylog" files is .lrs. The BBeB XML Xylog" file format is based on XML 1.0, "Extensible Markup Language (XML) 1.0 Specification (Second Edition)". T. Bray, J. Paoli, C. M. Sperberg-McQueen, E. Maler, 6 October 2000. Latest version available at: http://www.w3.org/TR/REC-xml


8

Type definition This specification uses the following type definition as the XML Attribute value.

Type definition Meaning Example String Specifies a normal string of

characters. after, solid

String for sorting Only able to use the character string defined in the Character Set for Sorting Specification.

John F. Kennedy

File path Specifies the path in which the file is located.

D:/sample.jpg, ../data/white.mp3

Decimal string Specifies a decimal numeral as a character string.

10, 20

Hexadecimal string Specifies a hexadecimal numeral as a character string. 0x is placed at the start of the numeral to show it is hexadecimal.

0x12, 0x3333

Style string Specifies a character string used in style labels.

Main Block, Cover Page, Section Title Text

Object ID string Specifies a character string used in object IDs.

33, Object12

COLORREF string Specifies 32-bit hexadecimal character string signifying color. The description format is 0xaarrggbb. (aa: alpha channel [specified as 00 or ff in these specifications], rr: red value, gg: green value, bb: blue value)

0x00ff0000 (red)


9

Coordinate system used in this specification This specification uses a two-dimensional coordinate system (X,Y) that depends on the vertical layout or the horizontal layout. X

Horizontal layout Vertical layout

X Y

Y


10

Overview of the BBeB Book Format Layout The BBeB Book Format uses the Block layout concept. In the Block layout, the content to be shown is displayed in an area called a Block. The layout is composed of multiple Blocks. Each Block is in a relative location. The BBeB XML Xylog" file format defines the implementation rules of this Block layout concept. Conceptual diagram of the Block layout

nt

Block

Relative arrangeme

Page Block This specification defines the TextBlock, ImageBlock, ButtonBlock, SimpleTextBlock, MiniPage and Canvas elements. These are positioned on a Page as a Block. These are described as sub elements of the Page element with the BlockSpace element that shows the relative arrangement position. It is possible to specify background image, background color and frame in the Blocks. View As the composition of a Page is based on the Block layout concept in the BBeB Book Format", a Page is sometimes different to a visible page. For this reason, this specification uses the term View for the visible page. A single Page is more than one View.


11

Objects The BBeB Book Format uses the concept of the Object. The BBeB XML Xylog" file format also uses the same concept of the Object and specifies objid as an attribute value for Object elements. objid and objlabel The Object elements defined in this specification require the objid and objlabel. The objid is used as information to specify a particular Object element. The objlabel is used as information to be recognized by the editor in the editing process. Therefore, the content can be created even if the objlabel is changed unintentionally. However, contradiction in contents is generated when the "objid" is changed, and there is a possibility that an error occurs.


12

Definitions of Terms Page layout In this format, the page layout is as follows.

Header area

Main text area

Footer area

topmargin

headheight

headsep

oddsidemargin evensidemargin

textheight

footspace footheight

Page layout composition

textwidth

textwidth

textwidth

Screen size


13

Block layout In this format, the block layout is as follows.

Block layout composition

Block

Rendering areasidemargin

topskip

footskip

blockwidth

parindent

We o fishing at a river near here

and have a barbecue.

blockheight

Today is very fine without a cloud. Our Paragraph

Main text area

Do Not Copy 2003-2007 Sony Corpowill gparskip

family is in camp at the foot of a mountain. ration

14

Specification descriptions Explanation of Elements in this specification describes Attribute Name, Default Value, Data Type and Comments for each attribute. The terms error and warning are used in Comments, and they refer to the treatment in the content making process when an incorrect value is set.


15

Explanation of Elements 1. BBeBXylog

Attribute Name Default Value Data Type Comments

version (Required)

String Defines as 1.0.

1.1 version The version attribute specifies the relevant format version for the BBeB XML Xylog" file format. The present version is 1.0.

2. Property The Property element specifies information required by authoring tools, etc. This is a reserved element at present.

3. BookInformation The BookInformation element specifies bibliographical information and the TOC (table of content) information.

4. Info The Info element specifies the bibliographical information and the additional information of the content. Refer to BBeB Standard, BBeB Book Operational Regulations of Bibliographical Information for details.


version (Required)

String Defines as 1.0.


16

4.1 version The version attribute specifies the version of the bibliographical information format. The present version is 1.0.

5. BookInfo The BookInfo element specifies the bibliographical information of the content.

6. Title The Title element specifies the title of the content. The title is used for displaying lists and displaying book information.

Attribute Name Default Value Data Type Comments reading (Required)

String for sorting

An error occurs when a character other than those specified in Character Set for Sorting Specification is used.

6.1 reading The reading attribute specifies the string to sort the content by the title. Refer to BBeB Standard, BBeB Standard Character Set Specification Appendix: Character Set for Sorting Specification for details of the specified characters.

7. Author The Author element specifies the author name of the content. If customer want to describemore than one author's namecustomer must describe authors names serially in an element. Author is used for displaying lists and displaying book information


String for sorting



17

7.1 reading The reading attribute specifies the string to sort the content by the author. Refer to BBeB Standard, BBeB Standard Character Set Specification Appendix: Character Set for Sorting Specification for details of the specified characters.

8. BookID The BookID element specifies ID information of the content. Refer to BBeB Standard, Content ID Specification for details.

9. Publisher The Publisher element specifies the publisher name of the content.


String for sorting


9.1 reading The reading attribute specifies the string to sort the content by the publisher. Refer to BBeB Standard, BBeB Standard Character Set Specification Appendix: Character Set for Sorting Specification for details of the specified characters.

10. Label The Label element specifies the label name.


String for sorting



18

10.1 reading The reading attribute specifies the string to sort the content by the label. Refer to BBeB Standard, BBeB Standard Character Set Specification Appendix: Character Set for Sorting Specification for details of the specified characters.

11. Category The Category element specifies the genre of the content. Up to two elements can be defined in the content.

12. Classification The Classification element specifies information on what kind of data is included in the content.

13. FreeText The FreeText element specifies free description about the content.

14. DocInfo The DocInfo element specifies the thumbnail, language information, etc.

15. Cthumbnail The Cthumbnail element specifies the file name of the thumbnail image for the content.



19

File (Required)

File path Specifies the absolute path or the accessible relative path of the file to be used as a thumbnail image. An error occurs in the event there is no file present in the specified path or the file path character string is incorrect.

15.1 file The file attribute specifies the file name and path in which the thumbnail file is located.

16. Language The Language element specifies the main language used in the content. It should use ISO 639 language codes, e.g. Japanese: ja.

17. Creator The Creator element specifies the creator or studio of the content.

18. SumPage The SumPage element specifies the number of Views (visible pages for the BookSetting element conditions) of the content.

19. Keyword The Keyword element specifies keywords necessary for searching the content.

20. TOC The TOC element specifies the table of the content information.


20

21. TocLabel The TocLabel element specifies the character string shown as the table of content list. By selecting the range defined by this string, it is possible to jump to the page showing that content.

Attribute Name Default Value Data Type Comments refobj (Required)

Object ID string

Specifies the objid of TextBlock, ImageBlock, SimpleTextBlock, ButtonBlock, Canvas and MiniPage elements. An error occurs when the specified objid does not exist or when it is the objid except for the above elements.

refpage (Required)

Object ID string

Specifies the objid of the Page element. An error occurs when the specified objid does not exist or when it is the objid except for the Page element.

21.1 refobj The refobj attribute specifies the objid of the element specified as the Jump target. The element specified as objid should be located in the Page element specified as refpage.

21.2 refpage The refpage attribute specifies the objid of the Page element including the element specifying as the Jump target.

22. Main The Main element specifies the Main content. In BBeB Book, it is possible to define independent pages other than the main text, but these are defined under Solo.

23. Page The Page element specifies the elements composed of the Page and the its layout information itself. The attribute of the Page element is recommended to describe the only


21

different information from the PageStyle element information specified by "pagestyle".


bgimagemode String Specifies fix, tile or centering. A warning is issued and the command is not assigned when any other character string is specified. In addition, an error occurs and the command is not assigned when the bgimagemode attribute is not specified at the same time.

evenfooterid Object ID string Specifies the objid of the Footer element. A warning is issued and command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element.


22

evenheaderid Object ID string Specifies the objid of

the Header element. A warning is issued and command is not assigned when the specified objid does not exist or when it is the objid except for the Header element.

evensidemargin (Unsigned integer) Decimal string [dot] footheight (Signed integer) Decimal string [dot] footspace (Signed integer) Decimal string [dot] headheight (Signed integer) Decimal string [dot] headsep (Signed integer) Decimal string [dot] layout String Specifies LrTb or

TbRl. A warning is issued and the command is not assigned when any other string is specified.

objid (Required)

String Specifies the only character string in the file.

oddfooterid Object ID string Specifies the objid of the Footer element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element.

oddheaderid Object ID string Specifies the objid of the Header element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Header element.

oddsidemargin (Unsigned integer) Decimal string [dot]


23

pageposition String Specifies upper, lower

or any. A warning is issued and the command is not assigned when a character string other than these is specified.

pagestyle (Required)

Style string An error occurs when the specified style string is not the PageStyle element.

refbgimage Object ID string Specifies the objid of the Image element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Image element. In addition, a warning is issued and the command is not assigned when the bgimagemode attribute is not specified at the same time.

setemptyview String Specifies show or empty. A warning is issued and the command is not assigned for strings other than these.

setwaitprop String Specifies replay or noreplay. A warning is issued and the command is not assigned when the specified string is not one of these.

textheight (Unsigned integer) Decimal string [dot] textwidth (Unsigned integer) Decimal string [dot]


24

topmargin (Signed integer) Decimal string [dot] objlabel string Specifies a character

string to identify this element.

23.1 pagestyle The pagestyle attribute specifies the "stylelabel" of the PageStyle element with necessary information for the "Page" layout.

23.2 refbgimage The refgbimage attribute specifies the objid of the Image element to be shown as the background of the Page element. When the "objid" is not specified, the image is not displayed.

23.3 setemptyview The setemptyview attribute specifies whether to display a View with a Header and Footer or a completely empty View when showing a blank page on the screen. The Header and Footer are shown when the show is specified, and a completely empty View is shown when the empty is specified.

23.4 setwaitprop The setwaitprop attribute specifies the Wait process within the Page element. The following table is used to specify whether the process is replayed.

Wait flag value Operation specification

replay Replay noreplay No replay

23.5 pageposition The pageposition attribute specifies whether the start position is the left page or the right page on the 2 screen display. upper is specified when it is shown on the upper side, lower is specified when it is shown on the lower side, and any is specified when it is shown after the preceding page. The bindingdirection attribute Rl (mostly vertical flow content) in the BookSetting element:

upper means the start page is the right, lower means the start page is the left.


25

The bindingdirection attribute Lr (mostly horizontal flow content) in the BookSetting element:

upper means the start page is the left, lower means the start page is the right.

23.6 oddheaderid The oddheaderid attribute specifies the objid of the Header element shown in the odd Page (upper page) on the 2 screen display .

23.7 evenheaderid The evenheaderid attribute specifies the objid of the Header element shown in the even Page (lower pages) on the 2 screen display .

23.8 oddfooterid The oddfooterid attribute specifies the objid of the Footer element shown in the odd Page (upper page) on the 2 screen display.

23.9 evenfooterid The evenfooterid attribute specifies the objid of the Footer element shown in the even Page (lower pages) on the 2 screen display.

23.10 bgimagemode The bgimagemode attribute specifies how the Image specified in the refbgimage attribute should be positioned. The value is fix: The image position is at the origin of the main text area. The value is tile: The images fill the main text area from the origin. The value is center: The image position is the center of the main text area.

Example

fix tile centering


26

23.11 evensidemargin The evensidemargin attribute sets the left margin of the Page layout composition on the 2 screen display:the left page in the horizontal layout, and the right page in the vertical layout. The value of the evensidemargin attribute should be used. If evensidemargin is not specified, the value specified in oddsidemargin is used. oddsidemargin is given preference when not using a two page spread.

23.12 footheight The footheight attribute sets the footheight of the Page layout composition.

23.13 footspace The footspace attribute sets the footspace of the Page layout composition.

23.14 headheight The headheight attribute sets the headheight of the Page layout composition.

23.15 headsep The headsep attribute sets the headsep of the Page layout composition.

23.16 layout The layout attribute specifies the coordinate system of the Page element. When LrTb is specified, the origin is in the top left, the X-axis is toward the right and the is toward the bottom. When TbRl is specified, the origin is in the top right, the X-axis is toward the bottom and the Y-axis is toward the left.

LrTb TbRl

X

X Y

Y

height

width

The coordinate system varies depending on the layout specified. However, width and height remain unchanged.


27

23.17 oddsidemargin The oddsidemargin attribute sets the left margin of the Page layout composition on the 2 screen display : the right page in the horizontal layout, the left page in the vertical layout. If the "oddsidemargin" is not specified, the value specified in the "evensidemargin" is used. On the 1 screen display, the value of the "oddsidemargin" from the "evensidemargin" is used.

23.18 textheight The textheight attribute sets the textheight of the Page layout composition.

23.19 textwidth The textwidth attribute sets the textwidth of the Page layout composition.

23.20 topmargin The topmargin attribute sets the topmargin of the Page layout composition.

23.21 objid The objid attribute specifies a unique character string in the content for each element.

23.22 objlabel The objlabel attribute specifies an identifiable name for the element.

24. ShowOrder The ShowOrder element specifies the order of showing each element arranged on the Page element. The layout is not changed by controlling how it is shown.

25. Show The Show element specifies the element to be shown.


28


refobj (Required)

Object ID string Specifies the objid of the TextBlock, ImageBlock, ButtonBlock, SimpleTextBlock, Canvas and MiniPage elements. An error occurs when the specified objid does not exist or when it is the objid except for the above elements.

25.1 refobj The refobj attribute specifies the objid of the element specified as the ShowOrder target.

26. Wait The Wait element specifies the timer control operation.

Attribute Name Default Value Data Type Comments time (Required)

(Signed integer)

Decimal string

26.1 time The time attribute specifies the timer. When the time is 0, it keeps waiting even for the input operation. When the time is a positive value, nothing is done for the set time ( 100ms). When the time is a negative value, nothing is done for the shorter time of which the absolute value of the set time ( 100ms) or the input operation. Example: nothing is done for 5 seconds.

27. TextBlock The TextBlock element specifies the set up information of the "Block" and Text to express the "Block" on the screen. The attribute of the TextBlock element is recommended to describe only


29

different information from the TextStyle and BlockStyle element information specified by "textstyle" and blockstyle.


align String Specifies head, center or foot. A warning is issued and the command is not assigned when any other character string is specified.


30

baselineskip (Signed

integer) Decimal string [pt]*10

bgcolor COLORREF string bgimagemode String Specifies fix, tile or

centering. A warning is issued and the command is not assigned when any other character string is specified. In addition, an error occurs and the command is not assigned when the bgimagemode attribute is not specified at the same time.

blockheight (Unsigned integer)

Decimal string [dot]

blockrule String Specifies horz-fixed, horz-adjustable, vert-fixed or vert-adjustable as the blockrule attribute of the TextBlock element. The command is not assigned when any other character string is specified.

blockstyle (Required)

Style string An error occurs when the specified style character string is not the same as stylelabel of the BlockStyle element.

blockwidth (Unsigned integer)


charspace (Signed integer)

Decimal string [pt]*10

column Decimal string Specifies an integer between 1 and 9. A warning is issued and the command is not assigned when any other value is specified.


31

columnsep (Signed integer)


empdotscode Hexadecimal string Specifies the character code used as an emphasis dot. In addition, a warning is issued and the command is not assigned when the empdotsfontname and refempdotsfont attributes are not specified at the same time.

empdotsposition String Specifies before or after. A warning is issued and the command is not assigned when any other character string is specified.

emplinetype String Specifies none, solid, dotted, double or dashed. A warning is issued and the command is not assigned when any other character string is specified.

emplineposition String Specifies before or after. A warning is issued and the command is not assigned when any other character string is specified.

fontescapement Decimal string Specifies 0 or 2700. A warning is issued and the command is not assigned when any other character string is specified.

fontfacename String Specifies the font name.


32

fontorientation Decimal string Specifies 0 or 2700. A

warning is issued and the command is not assigned when any other character string is specified.

fontsize (Signed integer) Decimal string [pt] * 10 fontweight Decimal string Specifies a value between

1 and 1000. A warning is issued and the command is not assigned when any other value is specified.

fontwidth (Signed integer) Decimal string [pt]*10 Specifies -10 when not changing the font shape.

footskip (Unsigned integer)


framecolor COLORREF string framemode String Specifies curve or

square. A warning is issued and the command is not assigned when any other character string is specified.

framewidth (Unsigned integer)


layout String Specifies LrTb or TbRl. A warning is issued and the command is not assigned when any other character string is specified.

letterspace (Signed integer) Decimal string [pt]*10 linecolor COLORREF string linespace (Signed integer) Decimal string [pt]*10 textlinewidth (Unsigned


objid (Required)

String Specifies the only character string in the file.


33

parindent (Signed integer) Decimal string [pt]*10 parskip (Signed integer) Decimal string [pt]*10 refbgimage Object ID string Specifies the objid of the

Image element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Image element. In addition, a warning is issued and the command is not assigned when the bgimagemode attribute is not specified at the same time.

rubyalign String Specifies start or center. A warning is issued and the command is not assigned when any other character string is specified.

rubyadjust String Specifies the line-edge or none character string. A warning is issued and the command is not assigned when any other character string is specified.

rubyoverhang String Specifies the auto or none character string. A warning is issued and the command is not assigned when any other character string is specified.

sidemargin (Unsigned integer)


textbgcolor COLORREF string textcolor COLORREF string


34

textstyle (Required)

Style string An error occurs when the specified style character string is not the same as stylelabel of the TextStyle element.

toclabel Specifies the character string used in the TOC list.

topskip (Unsigned integer)


wordspace (Signed integer) Decimal string [pt]*10 empdotsfontname String Specifies the font name of

the font used for emphasis dots. In addition, a warning is issued and the command is not assigned when the empdotscode and refempdotsfont attributes are not specified at the same time.

refempdotsfont Object ID String Specifies the objid of the Font element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element. In addition, a warning is issued and the command is not assigned when the empdotscode and empdotsfontname attributes are not specified at the same time.


35

objlabel String Specifies a character string to identify this element.

autoindex String Specifies on or off.

27.1 fontsize The fontsize attribute specifies the font size. Units are 10 times pt. Example: To specify a font size of 10.5pt.

27.2 fontwidth The fontwidth attribute specifies the width of the font. Normally, the optimal width is provided depending on the font size, but this is used when the width is changed intentionally. Units are 10 times pt.

27.3 fontescapement The fontescapement attribute specifies the character feed direction. 0 is specified for horizontal font and 2700 is specified for vertical font. Other specifications are not accepted.

27.4 fontorientation The fontorientation attribute specifies the direction of character rotation. 0 is specified for horizontal font and 2700 is specified for vertical font. Other specifications are not accepted.

27.5 fontfacename The fontfacename attribute specifies the name of the font to be used. The standard font is used if nothing is specified.

27.6 textcolor The textcolor attribute specifies the color of the text to be used. Black (0x00000000) is used if nothing is specified.

27.7 textbgcolor The textbgcolor attribute specifies the background color of the text. A transparent (0xff000000) background is normally used if nothing is specified.

27.8 wordspace The wordspace attribute specifies the width of spaces between words of Western languages. Units are 10 times pt.


36

27.9 letterspace The letterspace attribute the size of spaces between letters of Western languages. Units are 10 times pt.

27.10 charspace The charspace attribute specifies the size of spaces between Japanese characters. Units are 10 times pt.

27.11 baselineskip The baselineskip attribute specifies the space between the lines. Units are 10 times pt.

27.12 linespace The linespace attribute specifies the minimum guaranteed space for the direction of lines. Units are 10 times pt.

27.13 parindent The parindent attribute specifies the start position of the first line of the paragraph. A negative value means overhanging. The maximum value of overhanging is equal to that specified in the sidemargin attribute. Units are 10 times pt.

27.14 parskip The parskip attribute specifies the width of the spaces between paragraphs. Units are 10 times pt.

27.15 rubyalign The rubyalign attribute specifies the alignment of the Ruby characters. The alignment values are specified below.

Alignment value Start aligned

Center aligned

start center

27.16 rubyadjust The rubyadjust attribute specifies the operation of the Ruby Text at the line edge. The values of the operation are specified below. The adjustment operation is to adjust the head or end position of the Ruby Text at the line edge position line break refers to the method used to line up the starting edge or ending edge when the Ruby Text is longer than the Ruby Base.


37

Line break operation value

Operation used

Operation not used

line-edge none

27.17 rubyoverhang The rubyoverhang attribute specifies whether the overhanging operation for the Ruby character is executed or not. The operation values are specified below.

RubyOverhang Overhang Value

Overhang auto

No overhang none

27.18 empdotsposition The empdotsposition attribute specifies the position of emphasis dots. The values are specified below.

EmpDotsPosition Position value

Before (vertical layout: right, horizontal layout: top)

before

After (vertical layout: left, horizontal layout: under)

after

27.19 empdotscode The empdotscode attribute specifies the character (or symbol) code used as an emphasis dot.

27.20 emplineposition The emplineposition attribute specifies the position of the emphasis line. The values are specified below.


38

EmpLinePosition Position

value Before (vertical layout: right, horizontal layout: top)

before


after

27.21 emplinetype The emplinetype attribute specifies the type of emphasis line. The values are specified below.

27.22 column The column attribute specifies the step number of columns.

27.23 columnsep The columnsep attribute specifies the space between columns. Units are 10 times pt.

27.24 align The align attribute specifies the alignment direction of the text.

Type of line Line mode valueNone none Solid line solid

Dotted line dotted

Dashed line dashed Double line double

Direction Value Head head

Center center

Foot foot

27.25 textlinewidth The textlinewidth attribute specifies the line width for the Empline and Box elements. Units are 10 times pt.

27.26 linecolor The linecolor attribute specifies the line color for the Empline and Box elements.


39

27.27 textstyle The textstyle attribute specifies the stylelabel of the TextStyle element that specifies the information necessary for rendering the text.

27.28 fontweight The fontweight attribute specifies the weight of the text. The value 400 is normal weight and 800 is Bold.

27.29 objid The objid attribute specifies a unique character string in the content for each element.

27.30 bgcolor The bgcolor attribute specifies the background color of the Block.

27.31 bgimagemode The bgimagemode attribute specifies how the Image specified in the refbgimage attribute should be positioned. The value is fix: The image position is at the origin of the Block. The value is tile: The images fill the Block from the origin. The value is center: The image position is in the center of the Block.

Example

fix tile centering

27.32 blockheight The blockheight attribute specifies the height of the Block.

27.33 blockrule The blockrule attribute specifies how to expand the Block size when the customer is increasing character size on the viewer devices. The values for the TextBlock element are specified horz-fixed, horz-adjustable, vert-fixed and vert-adjustable.


40

Rule Value Rule horz-fixed Block width cannot be changed.

horz-adjustable Block width may be changed.

vert-fixed Block height cannot be changed.vert-adjustable Block height may be changed.

block-fixed Block width and height cannot be changed.

block-adjustable Block width and height may be changed proportionally.

27.34 blockstyle The blockstyle attribute specifies the stylelabel of the BlockStyle element specifying the information necessary for rendering the text.

27.35 blockwidth The blockwidth attribute specifies the width of the Block.

27.36 footskip The footskip attribute sets the footskip of the Block layout composition.

27.37 framecolor The framecolor attribute specifies the frame color of the Block.

27.38 framemode The framemode attribute specifies the frame type of the Block. It is possible to specify two types of frame: square means right angles in four corners and curve means rounded corners.

27.39 framewidth The framewidth attribute specifies the frame line width of the Block. When this value is 0 or not specified, no frame is rendered.

27.40 layout The layout attribute specifies the coordinate system of the TextBlock element. When LrTb is specified, the origin is in the top left, the X-axis is toward the right and the Y-axis is toward the bottom. When TbRl is specified, the origin is in the top right, the X-axis is toward the bottom and the Y-axis is toward the left.


41

LrTb TbRl

X

X Y

Y

height

width

The coordinate system varies depending on the layout specified. However, width and height remain unchanged.

27.41 refbgimage The refgbimage attribute specifies the objid of the Image element to be shown as the background of the TextBlock element. No image is shown if the objid is not specified.

27.42 sidemargin The sidemargin attribute sets the sidemargin of the Block layout composition.

27.43 toclabel The toclabel attribute specifies the character string to be shown as the TOC list on the viewer devices. If the toclabel is specified, the Authoring tool picks up this labels information and sets this label into the TOC element information in auto TOC creation mode.

27.44 topskip The topskip attribute specifies the topskip of the Block layout composition.

27.45 empdotsfontname The empdotsfontname attribute specifies the font name of the character (or symbol) used as emphasis dots.

27.46 refempdotsfont The refempdotsfont attribute specifies the objid of the Font element used as emphasis dots. When the value is 0, the font of the main text is used.

27.47 objlabel The objlabel attribute specifies an identifiable name for the element.


42

27.48 autoindex The autoindex attribute specifies whether the same character string from the text content (the first P element)is used as toclabel or not. The value on means to use it automatically at content creation process. The value off means not to use it.

28. P The P element specifies the minimum unit in the document. In a general novel, this means Paragraph. This P element is handled as the smallest unit that can be specified as an electronic expression.

Attribute Name Default Value Data Type Comments baselineskip (Signed


charspace (Signed integer)



43

empdotscode Hexadecimal string Specifies the character

code used as an emphasis dot. In addition, a warning is issued and the command is not assigned when the empdotsfontname and refempdotsfont attributes are not specified at the same time.


emplinetype String Specifies none, solid, dotted, double or dashed as the line mode value. A warning is issued and the command is not assigned when any other character string is specified.


fontfacename String Specify the font name. fontsize (Signed


fontweight Decimal string Specify a value between 1 and 1000. A warning is issued and the command is not assigned when any other value is specified.


44

fontwidth (Signed integer)

Decimal string [pt]*10 Specifies -10 when not changing the font shape.

letterspace (Signed integer)


linecolor COLORREF string linespace (Signed


textlinewidth (Signed integer)


parindent (Signed integer)


parskip (Signed integer)


refesound 0 Decimal string Specifies the objid of the eSound element. An error occurs when the object for the specified objid does not exist or the specified objid is not for the eSound element.

rubyalign String Specifies the start or center character string. A warning is issued and the command is not assigned when any other character string is specified.



45

rubyoverhang String Specifies the auto or

none character string. A warning is issued and the command is not assigned when any other character string is specified.

textbgcolor COLORREF string textcolor COLORREF string wordspace (Signed


empdotsfontname String Specifies the font name of the font used for emphasis dots. In addition, a warning is issued and the command is not assigned when the empdotscode and refempdotsfont attributes are not specified at the same time.

refempdotsfont Object ID string Specifies the objid of the Font element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element. In addition, a warning is issued and the command is not assigned when the empdotscode and empdotsfontname attributes are not specified at the same time.


46




28.4 fontfacename The fontfacename attribute specifies the name of the font to be used.

28.5 textcolor The textcolor attribute specifies the color of the text to be used. Black (0x00000000) is used if nothing is specified. 28.6 textbgcolor The textbgcolor attribute specifies the background color of the text. A transparent (0xff000000) background is normally used if nothing is specified.



28.9 letterspace The letterspace attribute specifies the size of spaces between letters of Western languages. Units are 10 times pt.

28.10 baselineskip The baselineskip attribute specifies the space between the lines. Units are 10 times pt.


47

28.11 linespace The linespace attribute specifies the minimum guaranteed space for the direction of lines. Units are 10 times pt.



28.14 rubyalign The rubyalign attribute specifies the alignment of the Ruby Text. The alignment values are specified below.

Alignment value Start aligned

Center aligned

start center

28.15 rubyadjust The rubyadjust attribute specifies the operation of the Ruby Text at the line edge. The values of the operation are specified below. The adjustment operation is to adjust the head or end position of the Ruby Text at the line edge position when the Ruby Text is longer than the Ruby Base.

Line break operation value

Operation used

Operation not used

line-edge none



48

RubyOverhang Overhang Value

Overhang auto No overhang none




before


after

28.18 empdotscode The empdotscode attribute specifies the character (or symbol) code used as an emphasis dot. 28.19 emplineposition The emplineposition attribute specifies the position of the emphasis line. The values are specified below.

EmpLinePosition Position value


before


after

28.20 emplinetype The emplinetype attribute specifies the type of the emphasis line. The values are specified below.


49

Type of line

Line mode value

None none Solid line solid

Dotted line dotted

Dashed line

dashed

Double line

double


28.22 textlinewidth The textlinewidth attribute specifies the line width for the Empline and Box elements. Units are 10 times pt.

28.23 refesound The refesound attribute specifies the objid of the eSound element used as the embedded sound playback. If an embedded sound is specified here, the sound is played back at the same time of the P element showing.



29. Plot The Plot element specifies the inline image and button.


50

Attribute Name Default Value Data Type Comments adjustment bottom String Specifies center, baseline,

top or bottom. A warning is issued and bottom is assigned when a character string other than these is specified.

refobj (Required)

Object ID string Specifies the objid of the Image or Button element. An error occurs when the object for the objid does not exist or the specified objid is not for the Image or Button element.

xsize (Required)

(Unsigned integer)


ysize (Required)

(Unsigned integer)


29.1 xsize The xsize attribute specifies the X direction size of the inline image or inline button. Units are 10 times pt.

29.2 ysize The ysize attribute specifies the Y direction size of the inline image or inline button. Units are 10 times pt.

29.3 refobj The refobj attribute specifies the objid of the element (the Image and Button elements) specified as the inline target.

29.4 adjustment The adjustment attribute specifies the position of the inline image or inline button for the text line. In case of the horizontal layout; The value top is to match the top edge of both the inline image and botton, and the text line. The value center is to match the centerline of both. The value baseline means to match the baseline of both. The value bottom means to match the bottom edge of both. In case of the vertical layout; The value top is to match the right edge of both the inline


51

image and botton, and the text line. The value center is to match the centerline of both. The value baseline means to match the baseline of both. The value bottom means to match the left edge of both.

30. CR The CR element specifies a compulsory line break. When this is specified immediately after the P element, the baseline space is the sum of the baselineskip and parskip.

31. PlotText The PlotText element specifies the inline text . If the length of the inline text is longer than the length specified as the xsize attribute, the inline text is rendered in the plural lines.


adjustment bottom String Specifies center, baseline, top, and bottom. A warning is issued and bottom is assigned when a character string other than these is specified.

refobj (Required)

Object ID string Specifies the objid of the Text or SimpleText element. An error occurs when the object for the objid does not exist or the specified objid is not for the Text element.

xsize (Required)

(Unsigned integer)


31.1 refobj The refobj attribute specifies the objid of the element (the Text and SimpleText elements) specified as inline text target.


52

31.2 adjustment The adjustment attribute specifies the position of the inline image or inline button for the text line. In case of the horizontal layout; The value top is to match the top edge of both the inline image or inline button and the text line. The value center is to match the centerline of both. The value baseline means to match the baseline of both. The value bottom means to match the bottom edge of both. In case of the vertical layout; The value top is to match the right edge of both the inline image and botton, and the text line. The value center is to match the centerline of both. The value baseline means to match the baseline of both. The value bottom means to match the left edge of both.

31.3 xsize The xsize attribute specifies the X direction size of the inline text. Units are 10 times pt.

32. Fill The Fill element specifies the lead character, which has variable length.


code (Required)

Hexadecimal string

Can be specified between 0x0020 and 0xffff.

32.1 code The code attribute specifies the character code number (UTF-16) that is used in the Fill element.

33. Space The Space element specifies the spacing and kerning between characters.


53

Attribute Name Default Value Data Type Comments xsize (Required)

(Signed integer)

Decimal string

[dot]

33.1 xsize The xsize attribute specifies the space in the X-axis direction. The kerning is performed when a negative value is specified.

34. CharButton The CharButton element specifies the text button set some actions.


refobj (Required)

Object ID string Specifies the objid of the Button element. An error occurs when the object for the specified objid does not exist or the specified objid is not for the Button element.

34.1 refobj The refobj attribute specifies the objid of the element (the Button element) specified as the Button character target.

35. Rubi The Rubi element specifies the Ruby Text and the Ruby Base.

36. Oyamoji The Oyamoji element specifies the Ruby Base. The character string specified in the Rubimoji element defined immediately afterwards is drawn with the ruby base specified here.


54

37. Gaiji The Gaiji element specifies the character code (UTF-16) of the external character and the alternative character string in case the external character cannot be rendered.

Attribute Name Default Value Data Type Comments Code (Required)

Hexadecimal string Can be specified between 0x0020 and 0xffff.

fontfacename (Required)

String Specifies the font name.

Refobj (Required)

Object ID string Specifies the objid of the Font element. An error occurs when the object for the specified objid does not exist or the specified objid is not for the Font element.

37.1 refobj The refobj attribute specifies the objid of the element (the Font element) specified as the Gaiji character target.


37.3 code The code attribute specifies the character code that is used as the external character.

38. AltString The AltString element specifies the alternative character string. The alternative character string is used when the display device cannot render the original character string.


55

39. Org The Org element specifies the original character string that customer want.

40. Alt The Alt element specifies the alternative character string instead of the Org element.

41. Rubimoji The Rubimoji element specifies the Ruby Text for the Ruby Base specified in the Oyamoji element.

42. Box The Box element specifies the character string to be surrounded by a box line.


linetype (Required)

String solid, dotted, dashed or double is selected.

42.1 linetype The linetype attribute specifies the line type of the box. The values are specified below.

Type of line Line mode valueSolid line Solid Dotted line Dotted

Dashed line Dashed

Double line Double


56

43. EmpDots The EmpDots element specifies the character string that is added the emphasis dots.


Empdotscode Hexadecimal string Specifies the character code used as an emphasis dot. In addition, a warning is issued and the command is not assigned when the empdotsfontname and refempdotsfont attributes are not specified at the same time.

Empdotsposition String Specifies before or after. A warning is issued and the command is not assigned when any other character string is specified.

Empdotsfontname String Specifies the font name used as the emphasis dots. In addition, a warning is issued and the command is not assigned when the empdotscode and refempdotsfont attributes are not specified at the same time.


57

Refempdotsfont Object ID string Specifies the objid of the

Font element. A warning is issued and command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element. In addition, a warning is issued and the command is not assigned when the empdotscode and empdotsfontname attributes are not specified at the same time.




before


after





58

44. EmpLine The Empline element specifies the character string that is added the emphasis line.


emplinetype String Specifies none, solid, dotted, dashed or double. A warning is issued and the command is not assigned when any other character string is specified.



EmpLinePosition Position

value Before (vertical layout: right, horizontal layout: top)

before


after


Type of line

Line mode value

None none

Solid line solid

Dotted line dotted Dashed line

dashed

Double line

double


59

45. AutoSpacing The AutoSpacing element specifies the character string to equalize space. The width of the equalized space is set by the space attribute.

Attribute Name Default Value Data Type Comments space (Required)

(Unsigned integer)

Decimal string

Specifies the number of characters.

45.1 space The space attribute specifies the secured length as the AutoSpacing element.

46. Sub The Sub element specifies a subscript character string.

47. Sup The Sub element specifies a superscript character string.

48. Yoko The Yoko element specifies the character string that is changed the baseline direction to horizontal in the vertical layout.

49. Tate The Tate element specifies the Western character string that is rotated 90 degrees counter clockwise in the vertical layout.


60

50. Nekase The Nekase element specifies the vertical character string that is rotated 90 degrees clockwise in the vertical layout.

51. NoBR The NoBR element specifies the character string that is not allowed to divide.

52. DrawChar The DrawChar element specifies the drop caption character.


line (Required)

(Unsigned integer)

Decimal string

Specifies the number of lines. An error occurs when not specified.

52.1 line The line attribute specifies the number of lines for the characters specified as drop caption.

53. Span The Span element specifies the particular portion of the text where the text attributes are needed to change.


61

emplinetype CDATA #IMPLIED linecolor CDATA #IMPLIED textlinewidth CDATA #IMPLIED spanstyle CDATA #IMPLIED fontfacename CDATA #IMPLIED empdotsfontname CDATA #IMPLIED refempdotsfont CDATA #IMPLIED rubyadjust CDATA #IMPLIED >

Attribute Name Default Value Data Type Comments charspace (Signed

integer) Decimal s [pt]*10


empdotsposition String Specifies before or after. A warning is issued and the command is not assigned when a character string other than these is specified.

emplinetype String Specifies none, solid, dashed, dotted or double as the line mode value. A warning is issued and the command is not assigned when any other character string is specified.



62

fontfacename String Specifies the font name. fontsize (Signed


fontweight Decimal string Specifies a value between 1 and 1000. A warning is issued and the command is not assigned when any other value is specified..


Decimal string [pt]*10 Specifies -10 when not changing the font shape.



linecolor COLORREF string textlinewidth (Unsigned

integer) Decimal character string [pt]*10




textbgcolor COLORREF string textcolor COLORREF string


63

wordspace (Signed integer)



refempdotsfont Object ID string Specifies the objid of the Font element. A warning is issued and command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element. In addition, a warning is issued and the command is not assigned when the empdotscode and empdotsfontname attributes are not specified at the same time.

spanstyle Style string An error occurs when the specified style character string is not the same as stylelabel of the SpanStyle element.



64








53.9 letterspace The letterspace attribute specifies the size of spaces between letters of Western languages. Units are 10 times pt.




65

53.12 rubyalign The rubyalign attribute specifies the alignment of the Ruby Text. The alignment values are specified below.

Alignment value

Start aligned

Center aligned

start center

53.13 rubyadjust The rubyadjust attribute specifies the operation of the Ruby Text at the line edge. The values of the operation are specified below. The adjustment operation is to adjust the head or end position of the Ruby Text at the line edge position when the Ruby Text is longer than the Ruby Base.

Line break operation

value Operation used

Operation not used

line-edge none


RubyOverhang Overhang

Value Overhang auto

No overhang none




before


after


66



EmpLinePosition Position value


before


after


Type of line

Line mode value

None none Solid line solid

Dotted line dotted

Dashed line

dashed

Double line

double


53.20 textlinewidth The textlinewidth attribute specifies the lines width for the Empline and Box elements. Units are 10 times pt.

53.21 spanstyle The spanstyle attribute specifies the stylelabel of the SpanStyle element specifying the information necessary for rendering the text.


67



54. Italic The Italic element specifies the character string in italics.

55. Bold The Bold element specifies the character string in bold.

56. SetText The SetText element specifies the attribute change for the text.


68

Attribute Name Default Value Data Type Comments charspace (Signed




emplinetype String Specifies none, solid, dotted, dashed or double as the line mode value. A warning is issued and the command is not assigned when any other character string is specified.


fontfacename String Specifies the font name. fontsize (Signed



69

fontweight Decimal string Specify a value between

"1" and "1000". A warning is issued and the command is not assigned when any other value is specified.


Decimal string [pt]*10 Specifies "-10" when not changing the font shape.



linecolor COLORREF string textlinewidth (Unsigned


parindent (Signed integer)


parskip (Signed integer)





textbgcolor COLORREF string


70

textcolor COLORREF string wordspace (Signed



refempdotsfont Object ID string Specifies the objid of the Font element. A warning is issued and the command is not assigned when the specified objid does not exist or when it is the objid except for the Footer element. In addition, a warning is issued and the command is not assigned when the empdotscode and empdotsfontname attributes are not specified at the same time.

baselineskip (Signed integer)


linespace (Signed integer)




71







56.8 letterspace

bbeb book specification v1.01

Documents