Register Guidelines E-Books Search Today's Posts Mark Forums Read

Go Back   MobileRead Forums > E-Book Formats > Other formats

Notices

Reply
 
Thread Tools Search this Thread
Old 07-12-2009, 02:13 AM   #61
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)
92% Done! Plus Tools! And an Example!

Well, I've been working hard on this for the last week or so, to the detriment of my social life. But it's been a weird kind of fun!

So, I've been going through it, and actually using it to see if it works, and it seems to. But there were a bunch of bugs in my macros, so I'm glad I didn't release them earlier.

I've prepared A Princess of Mars using the tools I've made for NoteTab. If you're willing to use the best text editor ever, you can use them too!

Some minor changes to the spec:

1) I think it was Pepak that suggested that the Structural Hints section wasn't necessary, and it's been rattling around in my head since he said it. I've made the hints, but I've removed the section in the HEAD. I still want it, but it probably belongs as a comment in the CSS. It would make the HEAD even more unreasonably large!

2) The CSS file will have the same base name as the main document file, it will not be called xBook.css. So for the project below, with the name APrincessOfMars.html, the CSS is called APrincessOfMars.css. Rational, and specific, and easy to do. If there is a need for a generic CSS template, it can be called from the specific style sheet.

3) A bunch of little changes to make the spec doc more accurate, and consistent. Some errors had crept in from indiscriminate use of copy and paste...

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="PROJECTNAME.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: 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="Writing"><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="Writing"><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="Writing"><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">
						<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 OR #NEXT-PART ID">
						<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="Writing"><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="Writing"><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="Writing"><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="Writing"><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="CAPTION">TABLE CONTENTS</table>
	</div>

	<div class="Spine" id="AboutTheAuthor">
		<h2>ABOUT THE AUTHOR HEADING</h2>
		<img id="ILLUSTRATION ID" class="Illustration" src="images/author.png" />
		<p>ABOUT THE AUTHOR CONTENT<p>
	</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>
Attached are the files: A Princess of Mars (zipped) and the NoteTab macros. The macros are 2 inter-related libraries and 2 support libraries, with one toolbar; all the setup and support files for the libraries are kept in a sub-folder. Just extract the zip into your NoteTab Libraries sub-folder. The macros look there for everything, so don't get cute!

For those of you thinking that the zipped book is nearly an OEB file, you're right. It should be stupid-easy to make one from this.

I will start another thread for discussion of the NoteTab macros. [The thread is here.]

What I would really love is if someone took a swing at a CSS for the ebook -- the next thing that I have to do is learn to make something beautiful with it. If you view the file as-is, without CSS, you are going to be disappointed! (BTW, there are some nice buttons and images in the ebook file -- ornate, but not overwhelming, to suit the book.)

Thanks for reading this far!

m a r

ps: NoteTab Light is here, and it's no-nag and free! I wrote this set of macros with the Pro version, however, and it has faster Search/Replace, and Clipbars (buttons for your macros.) But it should still work.... (fingers crossed) 'Course, you could get the Pro trial version...
Attached Files
File Type: zip xBook--v1--NotetabClipLibrary.zip (206.3 KB, 203 views)
File Type: zip 01_APrincessOfMars.zip (1.13 MB, 212 views)

Last edited by rogue_ronin; 12-31-2009 at 05:05 PM. Reason: Fix NoteTab thread link.
rogue_ronin is offline   Reply With Quote
Reply

Tags
html, library, meta, structure, xhtml

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Any ongoing work on the epub specification? b.tarde ePub 10 03-18-2010 09:33 PM
ePub and top margin specification tompe Upload Help 6 01-02-2010 12:24 PM
Ask about specification bthoven PocketBook 35 11-13-2009 01:33 PM
BeBook 2 Specification keng2000 BeBook 6 11-02-2009 02:17 PM
PRS-500 lrf file specification Dave Berk Sony Reader Dev Corner 2 05-01-2007 03:12 AM


All times are GMT -4. The time now is 12:02 PM.


MobileRead.com is a privately owned, operated and funded community.