how to use jaged an introduction to the jaguar editor by bowerbird intelligentleman you can "view source" for this document here: http://zenmagiclove.com/jaged.zml table of contents how to use jaged table of contents review paragraphs review sections text "styling" plain ascii versus unicode poetry and other silly things tables in your e-texts centered text pictures in your book footnotes and endnotes hotlinks in your e-texts hyphens and dashes hyphenation stinks unlucky number 13 two spaces after a sentence multi-purpose block-quotes the play is the thing epigraphs and epitaphs lists in your book the meta-data chapter a demo for zen markup language the end of this test-suite the notes section meta-data for this book review paragraphs review paragraphs first. this is a document intended to demonstrate the range of features common throughout the e-texts in the project gutenberg library, and indeed to the majority of printed books. project gutenberg is a volunteer effort for digitizing the text of public-domain books, for viewing and distribution in cyberspace. http://gutenberg.org it was begun by michael hart back in 1971, with the goal of creating 10,000 e-texts, a milestone achieved in 2003, thanks to a big boost from distributed proofreaders, which allows people to proofread online -- thousands of them doing a page at a time, volunteering bits and pieces of their time. http://pgdp.net if you want to support the p.g. library with software, a markup system, or so on, you should be able to handle its features, and you can use this file as a "test-suite" to verify that your system is fully capable. this document should be self-explanatory. tabs have been substituted with "~tab~", so that they will become visible to you, so they could be changed back for your testing. other than that, no changes should be needed. this is the test of a link in the middle of a normal paragraph, jumping to pgdp.net, to see if it works correctly... ?? if you find inconsistencies in this test-suite, do please let me know immediately. thank you. review sections first, you should be able to handle headings of different levels, such as the book, chapters, and subsections. you may label the levels as you like. html can support 6 different levels, so that's a good number to shoot for. one of the things that users find handy is a _table_ _of_ _contents_ for the e-book, so you must be capable of generating one, in cases where an e-text doesn't have one. because of their experience with the web, people often expect this table of contents to be hotlinked to the appropriate sections, so your markup system should facilitate that. a nice touch is then to have chapter headings then link _back_ to the table of contents... text "styling" this word will be in _italics._ this phrase _will_be_in_italics._ this phrase _will also be in intalics._ this word will be in *bold.* this phrase *will*be*bold.* this phrase *will also be bold.* plain ascii versus unicode skip this. poetry and other silly things use a space in the first column to get a centered chunk. t.v. will eat you (a haiku by bowerbird intelligentleman) t.v. will eat you out of a satellite dish with a tuning fork use multiple spaces (5 or more) to get a left-justified chunk. a haiku for you (by bowerbird intelligentleman) haiku have three lines and seventeen syllables five, seven, and five you can vary the spacing, as some poems like to do. six spaces at the start of this line 12 spaces at the start of this line six spaces at the start of this line 12 spaces at the start of this line six spaces at the start of this line 12 spaces at the start of this line six spaces at the start of this line 12 spaces at the start of this line you can even get downright fweaky! six spaces at the start of this line ten spaces at the start of this line 14 spaces at the start of this line 18 spaces at the start of this line 22 spaces at the start of this line 26 spaces at the start of this line 22 spaces at the start of this line 18 spaces at the start of this line 14 spaces at the start of this line ten spaces at the start of this line six spaces at the start of this line tables in your e-texts | table 1 column 1 column 2 | plain-text yes yes | x.m.l. no yes | html yes no | .rtf no yes | .pdf no no centered text we already did this. pictures in your book to include a picture, just enter its u.r.l. http://z-m-l.com/go/alice/checking_watch.png "what is the use of a book," thought alice, "without pictures or conversation?" http://z-m-l.com/go/alice/alice_cramped.png footnotes and endnotes some of the e-texts have footnotes.[1] your system must be able to handle them. how it might do that is up to you, captain. this is just a dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. this is another dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. this is a third dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. and a fourth dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. here's dummy paragraph #5, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. this is a sixth dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. and the seventh dummy paragraph, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. here's dummy paragraph #8, to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. i hope 9 dummy paragraphs is enough to get some separation between the footnote referent up above and the actual footnote below, so you can see the jump when you click between the two of them. [1] you can put the footnote right underneath the paragraph which contains it, or at the end of the chapter containing it, or in a section at the end of the book with all the other footnotes. hotlinks in your e-texts remember how, in chapter 2, we said that the table of contents should be hot-linked to the appropriate spots? that is one type of link you'll need. there are several other types as well. your system should also be able to make the jump to an internet site. most of the e-texts are quite old, so of course it's not like they have a bunch of internet url's in them; but every e-text will indeed contain a link to project gutenberg's website, so you must be able to execute links... quite often there are places in an e-text that reference other parts of the e-text. in these cases, it's nice to have a hotlink close to (or on) that reference point that transports the reader directly to the place that is being referenced; it is convenient. your system should facilitate such linking, preferably making it happen automatically. for instance, the beginning of this chapter has a reference to chapter 2. if a reader clicked on those words -- "chapter 2" -- they should automatically go to chapter 2. (and likewise with each of the references to "chapter 2" here in this paragraph too.) hyphens and dashes use a double-dash -- like these here -- to get an em-dash in your .html output. it's best to put spaces around your double-dashes, or else they can sometimes cause word-wrap problems... don't use a single-dash - like this bad example - where you want an em-dash, or it will look _bad_. even http://medium.com and http://kottke.org make that mistake. hyphenation stinks do not hyphenate your text. e-books don't need it. unlucky number 13 there is no 13th floor in most buildings. two spaces after a sentence can probably eliminate this. multi-purpose block-quotes you can get a blockquote like this. : four score and seven years ago, our : forefathers set forth upon this continent : a new nation, conceived in liberty and : dedicated to the proposition that : all men[2] are created equal. or like this: > four score and seven years ago, our > forefathers set forth upon this continent > a new nation, conceived in liberty and > dedicated to the proposition that > all men[2] are created equal. you should notice that the first method (using the colon) rewraps the lines, and the second (using the right-angle-bracket) does not rewrap the lines. so use the one which meets your needs better in each case. the play is the thing you auto-bold the first word of a paragraph if you follow it with a colon. this is handy when you are doing the dialog for a play. dale:~tab~ that's not what p.g. is all about. bowerbird:~tab~ i think it's important to give people a good e-book experience. dale:~tab~ that's your opinion. bowerbird:~tab~ yes it is. steve:~tab~ (weakly) i can't... dale:~tab~ no it isn't. steve:~tab~ (weakly) get a... bowerbird:~tab~ is too. steve:~tab~ (weakly) word in edgewise... dale:~tab~ is not. lurkers:~tab~ will you two cut it out? bowerbird:~tab~ is so. dale:~tab~ is not... fade to black.[3] epigraphs and epitaphs better way to handle left-center-right paragraphs. ~tab~~tab~~tab~ _there's_ _an_ _old_ _proverb_ ~tab~ ~tab~~tab~~tab~ _that_ _says_ _just_ _about_ ~tab~ ~tab~~tab~~tab~ _whatever_ _you_ _want_ _it_ _to..._ ~tab~ ~tab~~tab~~tab~ _--_ _slashdot_ ~tab~ sometimes a chapter starts with a nice pithy quote, which is usually _italicized,_ and often right-justified. so you wanna be able to handle that kind of thing.[4] lists in your book you can use " * " to make a list. * one * two * three * four * five * six * seven * i forget what 8 was for. * number 9, number 9... you can also use " o " to make a list. o one o two o three o four o five o six o seven o i forget what 8 was for. o number 9, number 9... you can also use " - " to make a list. - one - two - three - four - five - six - seven - i forget what 8 was for. - number 9, number 9... you can also use " + " to make a list. + one + two + three + four + five + six + seven + i forget what 8 was for. + number 9, number 9... you can also use " = " to make a list. = one = two = three = four = five = six = seven = i forget what 8 was for. = number 9, number 9... you can also use " x " to make a list. x one x two x three x four x five x six x seven x i forget what 8 was for. x number 9, number 9... sometimes you want a numbered list... here's an example of a numbered list, with the number specifically included. x 1. one x 2. two x 3. three x 4. four x 5. five x 6. six x 7. seven x 8. i still forget what 8 was for. x 9. number 9, number 9... here's another numbered list, again with the number specifically included, where we mix things up a bit... x 101. one x 202. two x 333. three x 4444. four x 55555. five x 6. six x 77. seven x 88. i still forget what 8 was for. x 9. number 9, number 9... here's another numbered list, except this time it's an "ordered list", which means the browser does the numbering... # one # two # three # four # five # six # seven # i still forget what 8 was for. # number 9, number 9... still gotta be able to handle lists... here's another example of a list: o mercury o venus o earth o mars o jupiter o saturn o uranus o neptune o pluto here's another example of a plus-sign list: + mercury + venus + earth + mars + jupiter + saturn + uranus + neptune + pluto here's another example of a minus-sign list: - mercury - venus - earth - mars - jupiter - saturn - uranus - neptune - pluto here's another example of an equals-sign list: = mercury = venus = earth = mars = jupiter = saturn = uranus = neptune = pluto like poems, items in a list generally want to stick together on the same page, if possible. still gotta be able to handle lists... the meta-data chapter skip this. a demo for zen markup language skip this. the end of this test-suite skip this. the notes section [1] personally, i don't think we need to make a distinction between footnotes and endnotes any more, i believe that all the types of notes should be stored at the end of the file, like these notes, but i think the person should be able to _display_ them at the point of reference in the actual body of the text. therefore, they are actually a sort of hybrid between footnotes _and_ endnotes, combining the strengths and convenience of both types. [2] in later years, it was made clear that lincoln was referring to all "people", and not just men, that women are equally equal. [3] this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. look, it even has a second paragraph! this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. oh no! a third paragraph. way too long! this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. this is a test footnote. because of that, it's going to go on and on and on. [4] this is another test footnote. but it will be short. meta-data for this book here's the meta-data... o title = a 2013 test-suite for project gutenberg o author = bowerbird intelligentleman o purpose = a test-suite o for = project gutenberg o markup = zen markup language (.zml) o isbn = urn:isbn:0000000000000 o publisher = jaguar(ps) o subject = doing the test-suite thing o rights = copyright 2013 -- all rights reserved http://gutenberg.org here's a test of some of the formatting commands. ~tab~left-justified~tab~~tab~~tab~ ~tab~~tab~centered~tab~~tab~ ~tab~~tab~~tab~right-justified~tab~ ~tab~this just has one tab... http://google.com http://zenmagiclove.com/test-suite-2013.zml http://zenmagiclove.com/zml/suite/suite.zml http://pgdp.net http://gutenberg.org http://z-m-l.com/go/alice/checking_watch.png http://z-m-l.com/go/alice/cat_fades.png http://z-m-l.com/go/alice/alice_cramped.png http://z-m-l.com/go/alice/alice_holding.png