Le fichier de navigation NCX¶
API du module¶
La fonction parse_ncx
¶
La classe Ncx
¶
- class epub.ncx.Ncx¶
Représente le fichier NCX d’un livre numérique. Un fichier NCX est un fichier xml respectant les spécifications de la norme NCX avec les modifications apportées par la spécification Epub.
- xmlns¶
Namespace utilisé pour le document NCX, dont la valeur devrait toujours être
'http://www.daisy.org/z3986/2005/ncx/'
.
- version¶
Version du fichier NCX, dont la valeur devrait toujours être
'2005-1'
.
- lang¶
Langue du contenu du fichier NCX.
- uid¶
Identifiant unique du livre.
- depth¶
Représente la meta-donnée
dtb:depth
.
- total_page_count¶
Représente la meta-donnée
dtb:totalPageCount
.
- max_page_number¶
Représente la meta-donnée
dtb:maxPageNumber
.
- generator¶
Représente la meta-donnée
dtb:generator
.
- title¶
Titre du livre.
- authors¶
Liste des auteurs du livre.
Objet de la classe
NavMap
représentant l’élément<navMap>
du fichier NCX. Cet attribut permet d’accéder à la structure de navigation principale.
Liste d’objets de la classe
NavList
représentant les éléments<navList>
du fichier NCX.Il peut n’y avoir aucun élément dans cette liste.
Ajoute un object
NavList
à la liste desNavList
.- Paramètres:
nav_list (epub.ncx.NavList) – la liste à ajouter
- as_xml_document()¶
Retourne l’élément XML Dom correspondant à la structure de l’objet.
- Type renvoyé:
xml.dom.Element
Les classes PageList
et PageTarget
¶
- class epub.ncx.PageList¶
- identifier¶
Chaîne de caractère, identifiant du
<pageList>
.
- class_name¶
Chaîne de caractère, indique la classe css proposée.
- labels¶
Liste des labels du
<navPoint>
: chaque label et un tuple de la forme(label, lang, dir)
, indiquant respectivement le titre du label, sa langue, et la direction d’écriture (ltr
ourtl
).
- infos¶
Liste des infos de la NavMap : chaque info et un tuple de la forme
(info, lang, dir)
, indiquant respectivement le contenu de l’info, sa langue, et la direction d’écriture (ltr
ourtl
).Une « info » est simplement une description de l’élément.
- page_target¶
Liste des éléments
<pageTarget>
fils directs. Chaque élément est un objet de la classePageTarget
.
- add_label(label, lang='', direction='')¶
- Paramètres:
label (string) – Texte de l’élément
navLabel
.lang (string) – Langue de l’élément.
direction (string) – Direction du texte
rtl
oultr
.
- add_info(label, lang='', direction='')¶
- Paramètres:
label (string) – Texte de l’élément
navInfo
.lang (string) – Langue de l’élément.
direction (string) – Direction du texte
rtl
oultr
.
- add_target(page_target)¶
Ajoute un élément
PageTarget
à la liste despageTarget
.- Paramètres:
page_target (epub.ncx.PageTarget) – l’élément à ajouter
- as_xml_document()¶
Retourne l’élément XML Dom correspondant à la structure de l’objet.
- Type renvoyé:
xml.dom.Element
- class epub.ncx.PageTarget¶
- identifier¶
Chaîne de caractère, identifiant du
<pageList>
.
- labels¶
Liste des labels du
<navPoint>
: chaque label et un tuple de la forme(label, lang, dir)
, indiquant respectivement le titre du label, sa langue, et la direction d’écriture (ltr
ourtl
).
- value¶
Chaîne de caractères, représente l’attribut
value
de l’élément.
- target_type¶
Chaîne de caractères.
- class_name¶
Chaîne de caractère, indique la classe css proposée.
- play_order¶
Chaîne de caractère, indique le placement dans l’ordre de lecture de l’élément. Peut être vide.
- src¶
Chaîne de caractère, indique l’url relative à l’emplacement du fichier NCX, et pouvant pointer vers des fragments de fichiers du fichier epub.
Exemple :
Text/chap1.xhtml#p36
indique le fichierText/chap1.xhtml
et plus spéficiquement à l’emplacement du fragmentp36
.
- add_label(label, lang='', direction='')¶
- Paramètres:
label (string) – Texte de l’élément
navLabel
.lang (string) – Langue de l’élément.
direction (string) – Direction du texte
rtl
oultr
.
- as_xml_document()¶
Retourne l’élément XML Dom correspondant à la structure de l’objet.
- Type renvoyé:
xml.dom.Element