Thread: (x)html ebook specification
View Single Post
Old 07-07-2009, 08:01 AM   #60
rogue_ronin
Banned
rogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-booksrogue_ronin has learned how to read e-books
 
Posts: 475
Karma: 796
Join Date: Sep 2008
Location: Honolulu
Device: Nokia 770 (fbreader)
90% Done!
Well, I think I have a final version. I'm calling it xBook.

I've written 90% of the macro/scripts, so I can semi-automate the conversion of a file. They should be complete soon. If anyone else is using NoteTab, I'd be glad to share them -- maybe I should start a new thread. (If you don't use NoteTab, you should!)

Anyhow, here is the spec:

Code:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>

	<link rel="stylesheet" type="text/css" href="xBook.css" />

	<title>TITLE</title>

	<!-- BEGIN: FILE HISTORY -->

	<!-- Created on YYYY-MM-DD -->
	<!-- Revision # 0.10 on YYYY-MM-DD -->
	<!-- Revision # 0.20 on YYYY-MM-DD -->
	<!-- Revision # ETC... on YYYY-MM-DD -->
	<!-- Current Revision # 0.80 on YYYY-MM-DD -->

	<!-- END: FILE HISTORY -->

	<!-- BEGIN: REVISION GUIDELINE -->

	<!--
	0.10 :: Initial Conversion
	0.20 :: Cover and Frontispiece
	0.30 :: Sections, Chapters and TOC
	0.40 :: Endnotes and/or Blockquotes
	0.50 :: Initial Spellcheck
	0.60 :: M-Dashes, Hyphens and Ellipses
	0.70 :: Italics, Bold, and Pre-Formatted Text
	0.80 :: Reading Proof
	0.90 :: Checked Against Canonical Source
	1.00 :: Final Version -- Optimal
	1.++ :: Minor Error Corrections
	-->

	<!-- END: REVISION GUIDELINE -->

	<!-- BEGIN: EBOOK META INFORMATION -->

	<meta name="FileName" content="FILENAME" />
	<meta name="FileID" content="UNIQUE ID" />
	<meta name="FileCreationDate" content="YYYY-MM-DD" />
	<meta name="FileVersion" content="VERSION NUMBER" />
	<meta name="FileRevisionDate" content="YYYY-MM-DD" />
	<meta name="FileSource" content="FILE SOURCE" />
	<meta name="FileScanner" content="NAME OF SCANNER (CONTACT INFO)" />
	<meta name="FileProofer" content="NAME OF PROOFER (CONTACT INFO)" />
	<meta name="FileComment" content="COMMENT" />

	<meta name="Title" content="TITLE" />
	<meta name="Subtitle" content="SUBTITLE" />
	<meta name="Series" content="SERIES NAME" />
	<meta name="SeriesNumber" content="POSITION IN SERIES" />

	<meta name="Author" content="FIRST NAME·MIDDLE NAMES·LAST NAME·" />
	<meta name="Illustrator" content="FIRST NAME·MIDDLE NAMES·LAST NAME·" />
	<meta name="Editor" content="FIRST NAME·MIDDLE NAMES·LAST NAME·" />
	<meta name="CoverDesigner" content="NAME" />

	<meta name="Genre" content="GENRE/SUBJECT" />
	<meta name="ISBN" content="ISBN NUMBER" />
	<meta name="Language" content="TWO-LETTER LOCALE CODE" />
	<meta name="Description" content="SHORT DESCRIPTION OF BOOK" />
	<meta name="keywords" content="TAGS/KEYWORDS" />

	<meta name="Publisher" content="PUBLISHER" />
	<meta name="PublicationDate" content="YYYY-MM" />
	<meta name="PublicationCity" content="CITY NAME" />

	<meta name="CopyrightHolder" content="NAME OF COPYRIGHT HOLDER" />
	<meta name="CopyrightDate" content="YEAR OF COPYRIGHT" />
	<meta name="CopyrightLicense" content="COPYRIGHT STATUS OR LICENSE" />

	<!-- END: EBOOK META INFORMATION -->

	<!-- BEGIN: STRUCTURE HINTS -->

	<!--
	ELEMENTS USED :: PURPOSE OF ELEMENT IN EBOOK
	-->

	<!-- END: STRUCTURE HINTS -->

	<!-- BEGIN: MANIFEST -->

	<!--
	xBook.css :: Style Sheet
	FILENAME OF THIS FILE :: MAIN FILE OF THIS XBOOK
	LIST OF LINKED FILES BY RELATIVE LOCATION :: DESCRIPTION OF FILE
	-->

	<!-- END: MANIFEST -->

</head>

<body>

	<div class="Spine" id="Cover">
		<a href="#TableOfContents">
			<img src="images/cover.EXT" />
		</a>
	</div>

	<div class="Spine" id="Frontispiece">
		<h2>HEADING / SERIES NAME</h2>
		<ul>
			<li>SERIES LIST TITLE #1</li>
			<li>SERIES LIST TITLE #2</li>
			<li>ETC...</li>
		</ul>
		<img src="images/frontispiece.EXT" />
	</div>

	<div class="Spine" id="FrontMatter">
		<h2>FRONT MATTER HEADING</h2>
		<p>FRONT MATTER CONTENT (BLURBS, JUNK, ADS, WHATEVER)</p>
	</div>

	<div class="Spine" id="TitlePage">
		<h1>TITLE</h1>
		<p id="SubTitle">SUBTITLE</p>
		<p id="Author">AUTHOR</p>
		<p id="Illustrator"><em>Art:</em> ILLUSTRATOR</p>
		<p id="Editor"><em>Editor:</em> EDITOR</p>
		<p id="CoverDesigner"><em>Cover Design:</em> COVER DESIGNER</p>
	</div>

	<div class="Spine" id="Verso">
		<h2>VERSO HEADING</h2>
		<a href="sounds/logo.wav">
			<img src="images/logo.png">
		</a>
		<p id="FileVersion"><em>Version:</em> VERSION NUMBER</p>
		<p id="FileRevisionDate"><em>Revision Date:</em> REVISION DATE</p>
		<p id="FileSource"><em>Original Source:</em> ORIGINAL SOURCE</p>
		<p id="FileScanner"><em>Scanner:</em> SCANNER</p>
		<p id="FileProofer"><em>Proofer(s):</em> PROOFER(S)</p>
		<p id="ISBN"><em>ISBN:</em> ISBN NUMBER</p>
		<p id="Publisher"><em>Publisher:</em> PUBLISHER NAME</p>
		<p id="PublicationDate"><em>Publication Date:</em> DATE OF PUBLICATION</p>
		<p id="PublicationCity"><em>Publication City:</em> CITY OF PUBLICATION</p>
		<p id="CopyrightDate"><em>Copyright Date:</em> YEAR OF COPYRIGHT</p>
		<p id="CopyrightHolder"><em>Copyright Holder:</em> HOLDER OF COPYRIGHT</p>
		<p id="CopyrightLicense"><em>License:</em> DISTRIBUTION RIGHTS</p>
	</div>

	<div class="Spine" id="Inscription">
		<h2>INSCRIPTION HEADING</h2>
		<p>INSCRIPTION CONTENT</p>
	</div>

	<div class="Spine" id="Acknowledgement">
		<h2>ACKNOWLEDGEMENT HEADING</h2>
		<p>ACKNOWLEDGEMENT CONTENT</p>
	</div>

	<div class="Spine" id="Preface">
		<h2>PREFACE HEADING</h2>
		<h4>SECTION HEADING</h4>
		<h5>SUBSECTION HEADING</h5>
		<p>PREFACE CONTENT</p>
			<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
		<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
		<q class="PullQuote">PULL QUOTE</q>
		<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
		<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
		<hr class="SceneBreak" />
		<hr class="PageBreak" />
		<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
		<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
		<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
	</div>

	<div class="Spine" id="TableOfIllustrations">
		<h2>TABLE OF ILLUSTRATIONS HEADING</h2>
		<ol>
			<li id="TOI_Link_To_ILLUSTRATION ID">
				<a href="#ILLUSTRATION ID">ILLUSTRATION NAME</a>
			</li>
		</ol>
	</div>

	<div class="Spine" id="TableOfMaps">
		<h2>TABLE OF MAPS HEADING</h2>
		<ol>
			<li id="TOM_Link_To_MAP ID">
				<a href="#MAP ID">MAP NAME</a>
			</li>
		</ol>
	</div>

	<div class="Spine" id="TableOfTables">
		<h2>TABLE OF TABLES HEADING</h2>
		<ol>
			<li id="TOT_Link_To_TABLE ID">
				<a href="#TABLE ID">TABLE NAME</a>
			</li>
		</ol>
	</div>

	<div class="Spine" id="TableOfContents">
		<h2>TABLE OF CONTENTS HEADING</h2>
		<img src="images/toc.png">
		<ol>
			<li id="TOC_Link_To_PART ID">
				<a href="#PART ID">PART NAME</a>
				<ol>
					<li id="TOC_Link_To_CHAPTER ID">
						<a href="#CHAPTER ID">CHAPTER NAME</a>
					</li>
				</ol>
			</li>
		</ol>
	</div>

	<div class="Spine" id="Foreword">
		<h2>FOREWORD HEADING</h2>
		<h4>SECTION HEADING</h4>
		<h5>SUBSECTION HEADING</h5>
		<p>FOREWORD CONTENT</p>
			<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
		<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
		<q class="PullQuote">PULL QUOTE</q>
		<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
		<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
		<hr class="SceneBreak" />
		<hr class="PageBreak" />
		<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
		<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
		<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
	</div>

	<div class="Spine" class="Part" id="PART ID">
		<h2>PART HEADING</h2>
		<ul class="NavLinks">
			<li>
				<a href="#PREVIOUS PART ID OR #FOREWORD ID OR #TableOfContents">
					<img src="images/part_up.png" />
				</a>
			</li>
			<li>
				<a href="#TableOfContents">
					<img src="images/toc.png" />
				</a>
			</li>
			<li>
				<a href="#NEXT PART ID">
					<img src="images/part_down.png" />
				</a>
			</li>
		</ul>
		<p>PART CONTENT, COMMENT, ETC.<p>

		<div class="Body" class="Logue" id="Prologue">
			<h3>PROLOGUE HEADING</h3>
			<ul class="NavLinks">
				<li>
					<a href="#PARENT-PART ID OR #TableOfContents">
						<img src="images/up.png" />
					</a>
				</li>
				<li>
					<a href="#TableOfContents">
						<img src="images/toc.png" />
					</a>
				</li>
				<li>
					<a href="#NEXT CHAPTER ID">
						<img src="images/down.png" />
					</a>
				</li>
			</ul>
			<h4>SECTION HEADING</h4>
			<h5>SUBSECTION HEADING</h5>
			<p>PROLOGUE CONTENT</p>
				<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
			<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
			<q class="PullQuote">PULL QUOTE</q>
			<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
			<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
			<hr class="SceneBreak" />
			<hr class="PageBreak" />
			<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
			<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
			<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
		</div>

		<div class="Body" class="Chapter" id="CHAPTER ID">
			<h3>CHAPTER HEADING</h3>
			<ul class="NavLinks">
				<li>
					<a href="#PREVIOUS CHAPTER ID OR #Prologue OR #PARENT-PART ID OR #TableOfContents OR #PARENT-PART ID">
						<img src="images/up.png" />
					</a>
				</li>
				<li>
					<a href="#TableOfContents">
						<img src="images/toc.png" />
					</a>
				</li>
				<li>
					<a href="#NEXT CHAPTER ID or #Epilogue OR #APPENDIX ID OR #Afterword OR #Colophon">
						<img src="images/down.png" />
					</a>
				</li>
			</ul>
			<h4>SECTION HEADING</h4>
			<h5>SUBSECTION HEADING</h5>
			<p>CHAPTER CONTENT</p>
				<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
			<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
			<q class="PullQuote">PULL QUOTE</q>
			<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
			<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
			<hr class="SceneBreak" />
			<hr class="PageBreak" />
			<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
			<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
			<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
		</div>

		<div class="Body" class="Logue" id="Epilogue">
			<h3>EPILOGUE HEADING</h3>
			<ul class="NavLinks">
				<li>
					<a href="#PREVIOUS CHAPTER ID">
						<img src="images/up.png" />
					</a>
				</li>
				<li>
					<a href="#TableOfContents">
						<img src="images/toc.png" />
					</a>
				</li>
				<li>
					<a href="#APPENDIX ID OR #Afterword OR #Colophon">
						<img src="images/down.png" />
					</a>
				</li>
			</ul>
			<h4>SECTION HEADING</h4>
			<h5>SUBSECTION HEADING</h5>
			<p>EPILOGUE CONTENT</p>
				<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
			<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
			<q class="PullQuote">PULL QUOTE</q>
			<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
			<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
			<hr class="SceneBreak" />
			<hr class="PageBreak" />
			<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
			<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
			<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
		</div>

		<div class="Body" class="Appendix" id="APPENDIX ID">
			<h3>APPENDIX HEADING</h3>
			<ul class="NavLinks">
				<li>
					<a href="#Epilogue OR #PREVIOUS CHAPTER ID">
						<img src="images/up.png" />
					</a>
				</li>
				<li>
					<a href="#TableOfContents">
						<img src="images/toc.png" />
					</a>
				</li>
				<li>
					<a href="#Afterword OR #Colophon">
						<img src="images/down.png" />
					</a>
				</li>
			</ul>
			<h4>SECTION HEADING</h4>
			<h5>SUBSECTION HEADING</h5>
			<p>APPENDIX CONTENT</p>
				<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
			<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
			<q class="PullQuote">PULL QUOTE</q>
			<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
			<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
			<hr class="SceneBreak" />
			<hr class="PageBreak" />
			<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
			<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
			<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
		</div>

	</div>

	<div class="Spine" id="Afterword">
		<h2>AFTERWORD HEADING</h2>
		<h4>SECTION HEADING</h4>
		<h5>SUBSECTION HEADING</h5>
		<p>AFTERWORD CONTENT</p>
			<a class="EndNoteLink" id="LINK-TO-ENDNOTE ID" href="#END NOTE ID">ENDNOTE NUMBER</a>
		<blockquote class="Epigram"><p>EPIGRAM</p></blockquote>
		<q class="PullQuote">PULL QUOTE</q>
		<blockquote class="Written"><p>LETTERS/NOTES/SIGNS</p></blockquote>
		<blockquote class="Commentary"><p>COMMENTARY</p></blockquote>
		<hr class="SceneBreak" />
		<hr class="PageBreak" />
		<img class="Map" id="MAP ID" title="CAPTION" src="images/MAPNAME.EXT" />
		<img class="Illustration" id="ILLUSTRATION ID" title="CAPTION" src="images/ILLUSTRATIONNAME.EXT" />
		<table id="TABLE ID" title="TABLE CAPTION">TABLE CONTENTS</table>
	</div>

	<div class="Spine" id="AboutTheAuthor">
		<h2>ABOUT THE AUTHOR HEADING</h2>
		<p>ABOUT THE AUTHOR CONTENT<p>
		<img id="ILLUSTRATION ID" class="Illustration" src="images/author.png" />
	</div>

	<div class="Spine" id="Colophon">
		<h2>COLOPHON HEADING</h2>
		<p>COLOPHON CONTENT<p>
		<a href="Cover">
			<img src="images/colophon.png" />
		</a>
	</div>

	<div class="Spine" id="Endnotes" title="NUMBER VALUE">
		<h2>ENDNOTES HEADING</h2>
		<ul>
			<li id="END NOTE ID">
				<p>ENDNOTE CONTENT</p>
				<a class="EndNoteBackLink" href="#LINK-TO-ENDNOTE ID">
					<img class="Return" src="images/return.png" />
				</a>
			</li>
		</ul>
	</div>

	<div class="Spine" id="Glossary">
		<h2>GLOSSARY HEADING</h2>
		<p>GLOSSARY CONTENT<p>
	</div>

	<div class="Spine" id="Index">
		<h2>INDEX HEADING</h2>
		<p>INDEX CONTENT<p>
	</div>

	<div class="Spine" id="EndMatter">
		<h2>END MATTER HEADING</h2>
		<p>END MATTER CONTENT (BLURBS, JUNK, ADS, WHATEVER)<p>
	</div>

</body>

</html>
Anything CAPITALIZED is content, or some naming convention of the file editor. None of the elements is required, most books won't have everything.

As always, I'm looking for feedback. There are undoubtedly typos, or logical errors. I still need to write up the Structure Hints section -- it should be pretty simple to do, now that the spec is done.

I will finish up the macros, and I will convert A Princess of Mars to the format. The conversion should take less than an hour, probably less than half an hour, if the macros work properly.

After that, it's going to need a basic CSS -- anyone feeling inspired?

m a r

PS: Re-reading this, I think the TOC needs entries for front matter (Verso, Acknowledgement, Preface...) and end matter (Afterword, Glossary, Index, About the Author...). Not too hard to add, but not tonight.
rogue_ronin is offline   Reply With Quote