realpython / realpython/python-guide

Generated ePubs failing validation

Aperta
#413 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Batchfile
Stelle
29.8k
Fork
5.9k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Hello,

Following on from my latest pull request (#412) here are all the ePub validation failures from trying to export the guide.

That pull request should fix the first three errors. The eleven after it appear to be due to those pages having the quick search widget on them and the start button for it. The next two, along with the two at the end, are broken identifiers in the TOC (probably best to leave these until last). The last error is simply a case of an image being called from another server, but ePub needs all those objects. Fixing this last one just means uploading http://www.python.org/dev/peps/pep-0001/pep-0001-1.png to a suitable location and updating intro/community.rst to use the local version.

bash-3.2$ epubcheck.sh pythonguide.epub
Epubcheck Version 3.0

Validating against EPUB version 2.0
ERROR: pythonguide.epub/search.html(17,57): attribute "id" not allowed here; expected attribute "charset", "defer", "src" or "xml:space"
ERROR: pythonguide.epub/search.html(51,32): element "form" not allowed anywhere; expected the element end-tag, text or element "a", "abbr", "acronym", "address", "applet", "b", "bdo", "big", "blockquote", "br", "cite", "code", "del", "dfn", "div", "dl", "em", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "i", "iframe", "img", "ins", "kbd", "map", "noscript", "ns:svg", "object", "ol", "p", "pre", "q", "samp", "script", "small", "span", "strong", "sub", "sup", "table", "tt", "ul" or "var" (with xmlns:ns="http://www.w3.org/2000/svg")
ERROR: pythonguide.epub/search.html(54,66): element "form" not allowed anywhere; expected the element end-tag, text or element "a", "abbr", "acronym", "address", "applet", "b", "bdo", "big", "blockquote", "br", "cite", "code", "del", "dfn", "div", "dl", "em", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "i", "iframe", "img", "ins", "kbd", "map", "noscript", "ns:svg", "object", "ol", "p", "pre", "q", "samp", "script", "small", "span", "strong", "sub", "sup", "table", "tt", "ul" or "var" (with xmlns:ns="http://www.w3.org/2000/svg")
ERROR: pythonguide.epub/dev/virtualenvs.html(61,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/dev/virtualenvs.html(69,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/dev/virtualenvs.html(113,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/dev/virtualenvs.html(124,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/dev/virtualenvs.html(130,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/freezing.html(167,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/freezing.html(175,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/packaging.html(109,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/packaging.html(116,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/packaging.html(123,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/shipping/packaging.html(131,37): attribute "start" not allowed here; expected attribute "dir", "id", "lang", "style", "title" or "xml:lang"
ERROR: pythonguide.epub/genindex.html(22,28): '': fragment identifier is not defined in 'genindex.html'
ERROR: pythonguide.epub/index.html(25,25): '': fragment identifier is not defined in 'index.html'
ERROR: pythonguide.epub/intro/community.html(98,130): 'http://www.python.org/dev/peps/pep-0001/pep-0001-1.png': remote resource reference not allowed; resource must be placed in the OCF
ERROR: pythonguide.epub/starting/install/win.html(54,67): 'id1': fragment identifier is not defined in 'starting/install/win.html'
ERROR: pythonguide.epub/writing/tests.html(240,33): 'id6': fragment identifier is not defined in 'writing/tests.html'

Check finished with warnings or errors

bash-3.2$

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con epubcheck.sh pythonguide.epub e ricondûci i file generati segnalati alle relative sorgenti. Esamina search.html, dev/virtualenvs.html, shipping/freezing.html, shipping/packaging.html, genindex.html, index.html, starting/install/win.html, writing/tests.html e intro/community.rst. Il lavoro è completato quando gli errori di validazione EPUB 2.0 elencati, incluso il riferimento all’immagine remota, sono stati risolti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
shell
Ambito
build-system, documentation
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.