creatingnimasfiles10.27.11

8/12/2019 CreatingNIMASFiles10.27.11

1/18

Creating NIMAS Files

1. The NIMAS fileset

2. Creating a NIMAS-conformant XML content file

a. well-formed XML docments

!. "alid NIMAS-conformant XML files

c. #AIS$ 2%%&-s'ecific items

d. !est 'ractices

e. NIMAS 1.1 #T# re(ired attri!tes

f. #T# and )*F references

+. ,alidating a NIMAS-conformant XML content file

. Character ncoding /0TF- and 0TF-13

&. *re'aring images for a NIMAS fileset

a. image files

!. organi4ation of images

c. "ale-added com'onents5 mar6-' of images

d. "ale-added com'onents5 writing alt te7t and L#s

e. images and mar6-' of math content

. *re'aring a 'ac6age file /)*F3

a. MIM /Mlti'r'ose Internet Mail 7tension3

!. MIM t8'es

c. NIMAS filesets and MIM t8'es

d. NIMAC and metadata

9. *#F 'ages

1. The NIMAS fileset

A NIMAS fileset consists of the following:

XML content file,

a package file (OPF),

a PDFfo!"at cop# of title page and IS$N an% cop#!ight info!"ationpages, an%

a f&ll set of content i"ages in S', P, o! PN fo!"at*

A NIMAS fileset is a set of so&!ce files that "a# +e !en%e!e% into a a!iet# of o&tp&t fo!"ats, incl&%ing st&%ent

!ea%# e!sions s&ch as a&%io +ooks, $!aille e%itions, etc* It is not a postp!o%&ction p!o%&ct- it is a p!ep!o%&ction p!o%&ct* NIMAS files a!e inten%e% fo! &se +# p&+lishe!s, a&tho!i.e% entities, an% othe!s to p!o%&ce

accessi+le e!sions of p!inte% inst!&ctional "ate!ials* /he# a!e not inten%e% to +e &se% asis an% sho&l% not +e

consi%e!e% finishe% p!o%&cts* XML content files in NIMAS filesets "&st +e confo!"ant to the NIMAS 0*0specification, a s&+set of the DAIS1 23342 D/D* $# %efinition, a NIMAS XML file will ali%ate to the

NIMAS 0*0 D/D*

0


2/18

A p!int wo!k5s XML content file incl&%es all of the content fo&n% in its p!int e!sion, incl&%ing f!ont"atte!,

s&ch as ta+les of contents an% p!efaces- +ack"atte!, s&ch as epilog&es an% in%ices- f!ont an% +ack coe!s, if the#incl&%e content that is not p!esente% elsewhe!e- an% +o%#"atte!, s&ch as chapte!s an% sections te6t, i"ages,

cha!ts, ta+les, etc* 7ssential info!"ation a+o&t a p!int wo!k sho&l% +e incl&%e% in its XML content file as well as

in its OPF file to ens&!e that s&ch info!"ation is aaila+le whethe! a fileset5s OPF is &tili.e% p!acticall# o! not-s&ch info!"ation t#picall# incl&%es a wo!k5s title, a&tho!(s), p&+lishe!, cop#!ight, an% IS$N, an% "a# incl&%e

othe! si"ila! ite"s* A p!int wo!k5s package file incl&%es "eta%ata a+o&t the content of the p!int wo!k, incl&%ing

its i"ages, as well as that !e8&i!e% +# the NIMA9 fo! s&+"ission to its !eposito!#* e8&i!e% PDFfo!"at pages

p!oi%e a necessa!# wa# fo! &se!s of the fileset to ens&!e it5s acc&!ac# an% co"pleteness as well as p!oi%ing awa# to e!if# the wo!k itself* I"ages p!esent in the p!int wo!k "&st +e incl&%e% in its fileset (see below for

additional information regarding images)*

See the ;isto!# an% 9o!e /echnologies%oc&"ent fo! "o!e info!"ation on the +ackg!o&n% of NIMAS an%

NIMAS files*

2. Creating a NIMAS-conformant XML content file

A NIMASconfo!"ant XML content file is an XML file that ali%ates against the NIMAS D/D* ?* /hese e%ito!s will @test5 an XML %oc&"ent fo! e!!o!s an% let #o& know whethe! a %oc&"ent iswellfo!"e% o! if it ali%ates to a specific D/D that is liste% in an XML %ecla!ation* Man# e%ito!s will also

point o&t whe!e, o! app!o6i"atel# whe!e, an e!!o! has occ&!!e%* /he la!ge! an XML %oc&"ent is, the "o!e

al&a+le this f&nction is* /he +est wa# to c!eate goo% XML files is si"pl# to +egin* /he following tips "a#

p!oe &sef&l*

Mo!e info!"ation is aaila+le th!o&gho&t this we+ site, in theNIMAS /echnical Specification, an% in the

DAIS1 St!&ct&!e &i%elines*

/o c!eate well-formed XML docments, keep the following in "in%:

All none"pt# ele"ents "&st hae +oth an opening an% a closing tag 9heck that #o& hae +oth hales of an# pai! (fo! e6a"ple, in class:;784)

All ele"ents "&st +e p!ope!l# neste%, i*e*, with thei! opening an% closing tags within the sa"e pa!ent

ele"ent

A goo% XML %oc&"ent "&st hae a %ecla!ation (e6a"ple: =DO9/1P7 %t+ook PB$LI9

C>>NISO>>D/D %t+ook 23342>>7NC Chttp:>>www*%ais#*o!g>.EG>2334>%t+ook23342*%t%C?)

Make s&!e #o&! co""ent tags a!e co!!ectl# co%e% an% enclose the co!!ect content

2
http://aim.cast.org/learn/historyarchive/backgroundhttp://aim.cast.org/learn/historyarchive/backgroundhttp://aim.cast.org/learn/policy/federal/spec-v1_1http://aim.cast.org/learn/policy/federal/spec-v1_1http://www.daisy.org/z3986/guidelines/sg-daisy3/structguide.htmhttp://www.daisy.org/z3986/guidelines/sg-daisy3/structguide.htmhttp://aim.cast.org/learn/historyarchive/backgroundhttp://aim.cast.org/learn/policy/federal/spec-v1_1http://www.daisy.org/z3986/guidelines/sg-daisy3/structguide.htm


3/18

XML is a p!ecision co%e- check that the!e a!e no t#pos in #o&! tags


4/18

/o c!eate "alid NIMAS-conformant XML files, keep the following in "in%:

I"ages: an alt te6t placehol%e! is !e8&i!e% (incl&%ing act&al alt tag te6t is !eco""en%e%)- leaing the

al&e of the alt att!i+&te +lank is accepta+le as a placehol%e! (e6a"ple: =i"g i%H0*30*2J altHJ>?)

o alt is a !e8&i!e% chil% att!i+&te of the =i"g? ele"ent

Fo!"atting an% st#ling sho&l% not+e %one with tags in an XML file

=lic? is optional>not !e8&i!e% in =list?s

9heck that i"age filena"e !efe!ences in the XML a!eexactlythe sa"e as act&al i"age filena"es

Make s&!e that #o& hae &se% the co!!ect tag (e6a"ple: =i"g? is a ali% tag, +&t =i"age? is not) 9&!!entl#, long %esc!iptions of ele"ents a!e containe% in =p!o%note? tags

If #o& hae a wellfo!"e% XML %oc&"ent that #et won5t ali%ate to the NIMAS D/D, fi!st check that

#o& a!e not &sing an# ele"ents in the w!ong location- fo! e6a"ple, a!e all ele"ents pe!"itte% as chil%

ele"ents of the ones within which the# a!e neste%K

e"e"+e! that a NIMAS XML file is a so&!ce file- it won5t necessa!il# !en%e! in a +!owse!

Since NIMAS files align with the DAIS1 stan%a!%, the following #AIS$ 2%%&-s'ecific itemssho&l% +e kept in

"in%:

/he =si%e+a!? an% =p!o%note? ele"ents "&st incl&%e a !en%e! att!i+&te set to eithe! !e8&i!e% o! optional

(e6a"ple: =si%e+a! !en%e!HoptionalJ?) $lock ele"ents a!e not pe!"itte% as chil% ele"ents of =f!ont"atte!? =+o%#"atte!?, o! =!ea!"atte!?

A =%i? ele"ent "&st +e containe% within a leel ele"ent (e6a"ples: =leel?, =leel0?, =leel2?)

/he following ele"ents hae +een %elete% f!o" the DAIS1 23342 D/D: =h!?, =leelhea%?, =notice?,

=st#le?

/he following ele"ents hae +een a%%e%: =+!i%gehea%?, =+#line?, =coe!title?, =%ateline?,

=epig!aph?, =lineg!o&p?, =poe"?

/he following ite"s a!e s&ggeste%!est 'racticesfo! NIMAS>DAIS1 XML files:

All i"ages "&st hae a placehol%e! fo! alt te6t o!, if possi+le, alt te6t itself* I%eall#, co"ple6 i"ages,

i"ages with "o!e than one "eaning o! conte6t, an% inst!&ctionall# i"po!tant i"ages sho&l% also hae

long %esc!iptions (LDs)*

If a wo!% +!eaks +etween pages, leaing a h#phenate% wo!% at the +otto" of one page an% the top of the

ne6t, !e"oe the h#phen an% incl&%e the whole wo!% at the en% of the fi!st of the two pages*

Bse a leele% n&"+e!ing conention (e6a"ple: =p i%HCL330*332*P330C?) when p!epa!ing p!oects

whe!e all content will +e in files (te6t+ooks, etc*)* /his ena+les content to +e a%%e% to, !e"oe% f!o", o!

"oe% within XML files at an# point in thei! c!eation p!ocess* Asi%e f!o" p!eenting !en&"+e!ing ofla!ge po!tions of content, it is also &sef&l fo! st!&ct&!ing, "anaging, an% "anip&lating the content of

XML files (e6a"ples: i"ple"enting a change to !ec&!!ing po!tions of content witho&t affecting othe!

content- &p%ating content witho&t haing to "ake XML "a!k&p changes to content that will !e"ain&nchange%- ena+les fastt!acking, whe!e p!o%&ction +egins +efo!e content is finali.e%)*

It is !eco""en%e% that filesets +e co"p!esse% o! .ippe% to !e%&ce thei! si.e*

Fo! "o!e specific +est p!actices !eco""en%ations +ase% on NIMAS i"ple"entation an% the NIMAS /echnical

Assistance 9ente! technical s&ppo!t, see theNIMAS Files $est P!actices%oc&"ent*
http://aim.cast.org/learn/practice/production/best_practiceshttp://aim.cast.org/learn/practice/production/best_practiceshttp://aim.cast.org/learn/practice/production/best_practiceshttp://aim.cast.org/learn/practice/production/best_practices


5/18

NIMAS 1.1 DTD Required lements

Following is a list of ele"ents that a!e !e8&i!e% (taken f!o" the NIMAS /echnical Specification)othe!ele"ents "a# +e !e8&i!e% if applica+le to content*

re(ired elements descri'tion

=%t+ook? /he !oot ele"ent in a Digital /alking $ook D/D* =%t+ook? contains"eta%ata in =hea%? an% the contents itself in =+ook?*

=hea%?

9ontains "etainfo!"ation a+o&t the +ook +&t no act&al content of the

+ook itself, which is place% in =+ook?* /his info!"ation is consonant

with the =hea%? info!"ation in X;/ML, (seeX;/ML00S/I9/)*

Othe! "iscellaneo&s ele"ents can occ&! +efo!e an% afte! the !e8&i!e%

=title?* $# conention, =title? sho&l% occ&! fi!st*

=+ook? S&!!o&n%s the act&al content of the %oc&"ent, which is %ii%e% into

=f!ont"atte!?, =+o%#"atte!?, an% =!ea!"atte!?* =hea%?, whichcontains "eta%ata, p!ece%es =+ook?*

="eta? In%icates "eta%ata a+o&t the +ook* It is an e"pt# ele"ent that "a#

appea! !epeate%l# onl# in =hea%?*Metadata may a!!ear in t"e #$%

file instead.

=title? 9ontains the title of the +ook +&t is &se% onl# as "etainfo!"ation in

=hea%?* Bse =%octitle? within =f!ont"atte!? fo! the act&al +ook title,which will &s&all# +e the sa"e*

NIMAS 1.1 DTD required attributes

Following is a list of att!i+&tes that a!e !e8&i!e% if the note% ele"ents a!e &se%*

re(ired attri!tes e7am'les

e!sion on =%t+ook? =%t+ook e!sionHC23342C?

s!c an% alt on =i"g?=i"g s!cHC*>i"ages>B3093>p3G33*pgC altHCphoto of an appleC>?

t#pe on =list? =list t#peHColC?

!en%e! on =p!o%note? an% =si%e+a!? =p!o%note !en%e!HCoptionalC?

i% on =pagen&"?, =note?, an% =annotation? =note i%HCB3093*332C?

i%!ef on =note!ef?, =anno!ef? =note!ef i%!efHC300302C?

content on ="eta? ="eta contentHC233C?

%i! on =+%o? =+%o %i!HC!tlC?

DTD and #$% references

4


6/18

>www*%ais#*o!g>%ais#nisostan%a!%%t%an%cssfiles*

/he co"ponents of a fileset sho&l% +e eal&ate% acco!%ing to the NIMAS /echnical Specification (c&!!entl#

0*0), a s&+set of the DAIS1 ANSI>NISO E*G stan%a!%* eleant lang&age !ega!%ing !efe!ences an%

ali%ation a!e as follows (the enti!e %oc&"ent is aaila+le at the AIM we+ site:http:>>ai"*cast*o!g>e6pe!ience>technologies>spec0Q0):

G
http://www.daisy.org/daisyniso-standard-dtd-and-css-fileshttp://aim.cast.org/experience/technologies/spec-v1_1http://www.daisy.org/daisyniso-standard-dtd-and-css-fileshttp://aim.cast.org/experience/technologies/spec-v1_1


7/18

CNIMASconfo!"ant content "&st +e ali% to the NIMAS 0*0 Rsee DAIS1>NISO

E*G 2334 o! s&+se8&ent !eisions*C

an%

CBse of the "ost c&!!ent stan%a!% is !eco""en%e%*C

an%

C/he package file is +ase% on the Open e$ook P&+lication St!&ct&!e 0*2 package file

specification (Fo! "ost !ecent %etail please see

http:>>www*opene+ook*o!g>oe+ps>oe+ps0*2>%ownloa%>oe+026ht"l*ht"Tsec2*) ANIMAS package file "&st +e a ali% XML Oe$PS 0*2 package file instance****C

As an e6tensi+le specification, the NIMAS /echnical Specification was w!itten to p!oi%e so"e fle6i+ilit# aswell as to state that &p%ates an% a%%itions a!e an% wo&l% +e ongoing* /he NIMAS is +ase% &pon ANSI>NISO

E*G, which, as a NISO stan%a!%, an% all NISO stan%a!%s &n%e!go a !eiew an% "aintenance c#cleJ

(http:>>www*niso*o!g>stan%a!%s>), the NIMAS "&st !e"ain confo!"ant to that stan%a!%*

+. ,alidating a NIMAS-conformant XML content file

An XML file "&st ali%ate to the NIMAS 0*0 D/D (%e!ie% f!o" DAIS1 ANSI>NISO E*G) to +e

consi%e!e% NIMASconfo!"ant* /o ali%ate a NIMAS XML file, a%% the following %ecla!ation to the top of the

XML file:

=DO9/1P7 %t+ook PB$LI9 C>>NISO>>D/D %t+ook 2334>>7NC

Chttp:>>www*%ais#*o!g>.EG>2334>%t+ook2334*%t%C?

Once the XML file is co"plete%, test it to see if it ali%ates against the D/D* In an XML e%ito!, &se the ali%ate

f&nction- othe!wise, &se an online ali%ato!:

In XMLSp#, &se the 9heck wellfo!"e%ness an% 'ali%ate file f&nctions (#ellow an% g!een check"a!k

icons, o! F an% F, !espectiel#)

In D!ea"weae!, &se 'ali%ate as XML (&n%e! the File p&ll%own "en&, then &n%e! 9heck Page)

In =oX#gen?, &se the 9heck XML Fo!" an% 'ali%ate as #o& t#pe f&nctions (a%% the NIMAS D/D fi!st

&sing the M#'ali%ato! tool)

At ;/ML>X;/ML>Doc$ook XML 'ali%ato! an% /!ansfo!"e! online (http:>>www*6"l

%e*co">+log>test*php), follow the onsc!een inst!&ctions

At Schola!l# /echnolog# !o&p5s XML 'ali%ation Fo!" online

(http:>>www*stg*+!own*e%&>se!ice>6"lali%>), cop# an% paste XML into the te6t fiel% o! &se the local

file fiel% fo! la!ge %oc&"ents At the >www*wschools*co">%o">%o"Qali%ate*asp), cop# an% paste XML into

the te6t fiel% o! &se the local file fiel% fo! la!ge %oc&"ents

A ali%ato! has +een %eelope% +# the NIMA9 !eposito!# cont!acto! to ens&!e that NIMAS XML content filess&+"itte% to the national !eposito!# a!e ali% an% a client e!sion is aaila+le to 8&alifie% p&+lishe!s so that files

"a# +e teste% p!io! to s&+"ission to the NIMA9*

See the XML 7%ito!s an% 'ali%ation section of the NIMAS site5s 9ontent Deelop"ent an% Designpage fo!

"o!e info!"ation*
http://www.openebook.org/oebps/oebps1.2/download/oeb12-xhtml.htm#sec2http://www.openebook.org/oebps/oebps1.2/download/oeb12-xhtml.htm#sec2http://www.niso.org/standards/http://aim.cast.org/learn/practice/production/content_developmenthttp://aim.cast.org/learn/practice/production/content_developmenthttp://www.openebook.org/oebps/oebps1.2/download/oeb12-xhtml.htm#sec2http://www.niso.org/standards/http://aim.cast.org/learn/practice/production/content_development


8/18

In o!%e! to iew a co"plete NIMAS file an% confi!" that i"ages a!e place% in the app!op!iate se8&ence, change

the file e6tension f!o" *6"l to *ht"l an% a%% a !efe!ence to a css file within =hea%? s&ch as, =link!elHCst#lesheetC t#peHCte6t>cssC h!efHCfilena"e*cssC>?* 9lose the %oc&"ent, an% open it in a +!owse!* S&ch an

e6tensiononl# e!sion sho&l% onl# +e &se% as a is&al !ep!esentation of the XML files as an ai% to p!o%&ction:

s&ch a e!sion is not a t!&e ;/ML file, is nota st&%ent!ea%# e!sion, an% sho&l% not +e &se% in place of these*An# ;/ML e!sion of a NIMAS fileset inten%e% fo! &se +# st&%ents o! in othe! postp!o%&ction capacities

sho&l% +e t!ansfo!"e% with app!op!iate co%e to ;/ML o! X;/ML (softwa!e an% XSL/ t!ansfo!"ations fo!

%oing this a!e f!eel# aaila+le f!o" the DAIS1 conso!ti&")*

. Character ncoding /0TF- and 0TF-13

/he /echnical Assistance 9ente! has !eceie% 8&e!ies !ega!%ing enco%ing, as B/F an% B/F0G a!e st!ongl#

!eco""en%e% +&t not a+sol&tel# !e8&i!e% +# the technical specification* /o cla!if#: onl# B/F an% B/F0G

a!e !e8&i!e% to +e s&ppo!te% +# applications that p!ocess NIMAS files* Bsing anothe!, it is 8&ite possi+le thefile wo&l% +e co!!&pte% when p!ocesse% +#, fo! e6a"ple, a cone!sion tool o! pla#e!* /his co!!&ption wo&l%

"ost likel# take the fo!" of special cha!acte!s (8&otes, accente% lette!s, etc*) +eing !en%e!e% inco!!ectl#* Mo!e

ca!ef&l applications "a# !ef&se to p!ocess the file an% !et&!n an U&nknown enco%ingU e!!o!* /he!e a!e see!alf!ee softwa!e packages that cone!t cha!acte! sets* /he DAIS1 Pipeline also has a UCcha!set switche!C filte!* A

p!og!a" e6pecting B/F +&t fin%ing othe! enco%ing will %efinitel# !en%e! inco!!ectl# if the file has an#cha!acte!s +e#on% the t!a%itional AS9II !ange* It see"s that &sing enco%ing othe! than B/F (o! B/F0G) is

not a goo% i%ea* i"ages>B03932>sta!icon*pgJ

altHsta! iconJ>?

P!efe!!e% i"age t#pe is S', ne6t is eithe! PN o! P fo!"at

S' i"ages sho&l% +e p!oi%e% with height an% wi%th att!i+&tes within a so&!ce XML file as g&i%ance

fo! p!o%&ce!s an% to allow i"ages to +e %ispla#e% co!!ectl#* Info!"ation a+o&t the o!iginal si.e of an

i"age, eithe! in the S' o! in the XML, is &sef&l to p!o%&ce!s fo! see!al p&!poses*

PN an% P i"ages sho&l% +e p!oi%e% at a !esol&tion of 33 %ots pe! inch (%pi), +ase% on thei! act&al

si.e in the p!inte% wo!k, so a 2J 6 0J i"age wo&l% +e G33 6 33 pi6els* 7"+e%%e% te6t in i"ages sho&l% +e incl&%e% as long %esc!iptions o! inline te6t (see t"e te6t in i"ages

section for more information)*

#rgani&ation of images

/o si"plif# i"ages o!gani.ation an% to !eco""en% an efficient wa# to han%le i"ages fo! &se with NIMAS

files, the following is !eco""en%e%:

All i"ages sho&l% +e sae% in an i"ages fol%e!:


9/18


10/18

Do not &se spaces in i"age filena"es*

9hoose an i"age5s se8&ential o!%e! n&"+e! acco!%ing to its position: na"e i"age files f!o" top to +otto" an%

f!o" left to !ight* 76a"ple:

Occasionall# it will not +e enti!el# o+io&s which la#o&t position an i"age hol%s* In s&ch cases, si"pl# choose

a logical se8&ence n&"+e! an% "ake a note of it fo! p!o%&ction*

2alue3added com!onents4 writing alternati/e text and long descri!tions

An alt te6t placehol%e! fo! i"ages is !e8&i!e% (e6a"ple: =i"g altHCC>?), an% incl&%ing act&al alt tag te6t isst!ongl# !eco""en%e% to p&+lishe!s, as is incl&%ing (when app!op!iate) long %esc!iptions* /he alt att!i+&te is

pa!t of the =i"g? ele"ent an% te6t is place% in stan%a!% att!i+&te fo!"at (e6a"ple: =i"g altHCte6tC>?)* /he

=p!o%note? ele"ent is &se% fo! i"ages long %esc!iptions in the NIMAS 0*0 D/D (e6a"ple: =p!o%note?/e6t oflong %esc!iption*=>p!o%note?)* Alt tags an% long %esc!iptions a!e especiall# i"po!tant fo! "ath e8&ations that

will +e p!oi%e% as i"ages te"po!a!il#0+&t will not +e accessi+le to sc!een !ea%e!s an% othe! %eices witho&t

incl&sion of an alte!nate !ep!esentation*

/he following is taken f!o"ditorial $rocess 7uidelines for ,reating Accessible Digital Textboos (9AS/,

Inc*, 233)*

Writing for Accessibility: Alt Tags and Long DescriptionsAn alt tag is a brief description of an image. The alt in alt tag

stands for alternative and an alt tag is alternative textanotheroption to the image. Alt tags shold state the type of image and abrief smmary of the image. They shold not have any nnecessarytext. Alt tag text shold beapproximately for to ten !ords long. Alt tag text is designed to bebrief. The point is to captre the fnction of the graphic and toexpress it in terms that ma"e sense.

#very image has an alt tag associated !ith it. An alt tag mstappear for every prposefl image. The alt tags appear on screen!ith mose$over% or !hen the mose is moved over the image.Assistive technology sch as a voice$otpt screen$reader !ill notread an image bt !ill read the alt tag instead. Text$only bro!sersdisplay alt tags over the image placeholder.

0Ma!k&p fo! "ath contente8&ations, s#"+ols, an% the likesho&l% now +e c!eate% &sing MathML whe!e feasi+le* Please see the

Images and mar6-' of math content section fo! "o!e info!"ation*

03


11/18

A long description is a detailed description of an image thatspports or adds meaning to the text. Long descriptions are context$speci&c. The details given depend on ho! the image spports orspplements the text.

Their prpose is to provide content information conveyed by theimage so that stdents !ho are nable to read the image% for!hatever reason% still have access to the information relevant to

instrction that is conveyed by the image.

Long descriptions are provided !henever an alt tag is nots'cient to convey the content of an image. Long descriptionsshold be !ritten for each image (map% timeline% pictre% chart%graph% photo% etc.) that spports the text or gives additional or ne!information needed to nderstand content or topic. A longdescription shold be inclded !henever an alt tag cannot provides'cient information abot the ob*ect and its prpose for inclsion.+emember that long descriptions vary according to learning goals.Try to create a balance bet!een brevity and s'cient information so

that every learner can access "ey content.

Note: /he!e is no li"it to the length of a long %esc!iption- LDs sho&l% +e as long as necessa!# to cone# i"age

info!"ation*

Images and mar3u! of mat" content

9&!!entl#, a stan%a!%, p!o+le"f!ee wa# to t!eat "athe"atical content in te!"s of NIMAS "a!k&p has not #et+een %ete!"ine%* /he XML specification MathML has +een fo!"all# accepte% +# the DAIS1 9onso!ti&" as a

"o%&la! e6tension fo! "athe"atical content* MathML is the!efo!e a pa!t of the optional ele"ent set of the

NIMAS specification* P!o%&ce!s a!e enco&!age% to +egin &sing MathML whe!e feasi+le* As an inte!i" sol&tion,

whe!e the &se of MathML is not #et possi+le, "ath e8&ations an% othe! s#"+olic content sho&l% +e p!esente% as

i"ages with alte!natie te6t an% long %esc!iptions*


12/18

See the Math!eso&!ces page fo! "o!e info!"ation*

02
http://aim.cast.org/experience/acrosscurriculum/mathhttp://aim.cast.org/experience/acrosscurriculum/math


13/18

. *re'aring a 'ac6age file /)*F3

Package files c!eate% fo! &se with NIMAS XML files "&st confo!" to the oe+ps 0*2 stan%a!% (the Open e$ook

P&+lication St!&ct&!e Specification 'e!sion 0*2), i*e*, ali%ate to this specification* /he following info!"ation

a+o&t the oe+ps 0*2 Specification is +ase% on info!"ation "a%e aaila+le to the p&+lic +# the Inte!nationalDigital P&+lishing Fo!&"*2NIMAS package files sho&l% ali%ate to this oe+ps stan%a!%, i*e*, these files a!e

NIMAS OPF files, not DAIS1 OPF files* A%%itional enhance"ents will +e necessa!# fo! a file to ali%ate as a

DAIS1 OPF*

9&!!entl#, NIMAS 0*0 incl&%es two "eta%ata ele"ents that we!e c!eate% fo! f&t&!e &se +&t t&!ne% o&t not to +e

nee%e% in p!actice an% that a!e inten%e% to +e phase% o&t as the technical specification is &p%ate%* ;owee!,

these two ite"s a!e pa!t of NIMAS 0*0 an% a!e the!efo!e !e8&i!e%* Fo! all OPF files confo!"ing to NIMAS 0*0,these "eta%ata ele"ents sho&l% +e incl&%e% #et left +lank:

="eta na"eHCni"asSo&!ce7%itionC contentHCC>?="eta na"eHCni"asSo&!ceDateC contentHCC>?

NIMAS filesets "&st also "eet "eta%ata s&+"ission !e8&i!e"ents fo! the National Intst!&ctional Mate!ialsAccess 9ente! (NIMA9), the national !eposito!# of NIMAS filesets* /he NIMA9 p!oi%es a co"p!ehensie

sa"ple, inst!&ctions, an% %etails at thei!NIMA9 Meta%atawe+ site page* A sa"ple NIMA9ali% OPF file isaaila+le th!o&gh a link f!o" this page, an% "a# also +e %ownloa%e% f!o" the NIMAS site5s76e"pla!spage

(e6e"pla! E)* All of the NIMAS e6e"pla! filesets incl&%e OPF files that a!e ali% to the NIMAS specificationan% to NIMA9 s&+"ission !e8&i!e"ents*

/he c&!!ent oe+ps 0*2 %ecla!ation fo! an OPF file is as follows:

=DO9/1P7 package PB$LI9 CY>>IS$N 3EG330E>>D/D O7$ 0*2 Package>>7NC

Chttp:>>opene+ook*o!g>%t%s>oe+0*2>oe+pkg02*%t%C?

/o c!eate ali% package files, keep the following in "in%:

Bse the *opf e6tension

/he package file "&st incl&%e a list of all files !elating to a single p&+lication

Package files a!e te6t>6"l files

Package files "&st +e wellfo!"e% XML

Package files "&st hae a &ni8&ei%entifie! att!i+&te (e6a"ple: =package &ni8&ei%entifie!HC02C?)

an% this is "i!!o!e% in the I%entifie! "eta%ata tag (e6a"ple: =%c:I%entifie!

i%HC02C?A$9=>%c:I%entifie!?)

Bse D&+lin 9o!e (e6a"ple: =%c:/e6t?) "eta%ata tags

%rom t"e oeb!s s!ecification !ublication4

The ma*or parts of the ,#-/ ac"age &le are:

A01A2#3D#4T3T5: A ni6e identi&er for the ,#-/ blication as a!hole.

7#TADATA:blication metadata (title% athor% pblisher% etc.).

2 http:>>www*i%pf*o!g>oe+ps>oe+ps0*2>%ownloa%>oe+02*%ocTQ/oc00G3

0
http://www.nimac.us/Metadata_doc_7-16-07.DOChttp://aim.cast.org/experience/technologies/nimas_exemplarshttp://aim.cast.org/experience/technologies/nimas_exemplarshttp://www.nimac.us/Metadata_doc_7-16-07.DOChttp://aim.cast.org/experience/technologies/nimas_exemplars


14/18

7A438#/T: A list of &les (docments% images% style sheets% etc.) thatma"e p the pblication. The manifest also incldes fallbac"declarations for &les of types not spported by this speci&cation.

/34#: An arrangement of docments providing a linear reading order.

T,9+/: A set of alternate reading se6ences throgh the pblication%sch as selective vie!s for varios reading prposes% reader

expertise levels% etc.

293D#:A set of references to fndamental strctral featres of thepblication% sch as table of contents% fore!ord% bibliography% etc.

MIM 5Multi!ur!ose Internet Mail xtension6

MIM ty!es

MIM7 t#pes a!e stan%a!% fo!"at e6tensions &se% to s&ppo!t the attaching of nonte6t files to stan%a!% Inte!net

"ail "essages* Nonte6t files incl&%e g!aphics, sp!ea%sheets, fo!"atte% wo!%p!ocesso! %oc&"ents, an% so&n%

files* /he MIM7 stan%a!% specifies the t#pe of file +eing sent an% the "etho% that sho&l% +e &se% to t&!n it +ackinto its o!iginal fo!"*

Manifest list ite"s in OPF files sho&l% incl&%e stan%a!% MIM7 t#pes in o!%e! to +e f&ll# acc&!ate* Fo! e6a"ple,

=ite" i%HCi%na"eC h!efHCfilena"e*6"lC "e%iat#peHCte6t>6"lC>? whe!e te6t in "e%iat#peHte6t>6"lJ is a

stan%a!% MIM7 t#pe an% 6"l in "e%iat#peHte6t>6"lJ is a stan%a!% s&+t#pe* Anothe! e6a"ple is=ite"i%HCi%na"eC h!efHCpath>path>filena"e*pegC "e%iat#peHCi"age>pegC>? whe!e i"age in "e%ia

t#peHCi"age>pegC is a stan%a!% MIM7 t#pe an% peg in "e%iat#peHCi"age>pegC is a stan%a!% s&+t#pe*

/he "ain t#pes a!e application, a&%io, e6a"ple, i"age, "essage, "o%el, "&ltipa!t, te6t, an% i%eo* S&+t#pes

a!e e6tensie fo! each t#pe, +&t, fo! e6a"ple, the "ost co""on ones fo! i"age a!e gif, peg, png, an% tiff- an%

fo! te6t a!e css, ht"l, plain, !ichte6t, an% 6"l* Lists of t#pes a!e aaila+le athttp:>>www*iana*o!g>assign"ents>"e%iat#pes>* Othe! MIM7 info!"ation is !ea%il# aaila+le oe! the Inte!net:t#pe MIM7 t#pesJ into a sea!ch engine*

NIMAS filesets and MIM ty!es

MIM7 t#pes fo! &se with NIMAS filesets !eflect the NIMAS5 align"ent with DAIS1 an% follow the g&i%elines

of E*G2334, section * (http:>>www*%ais#*o!g>.EG>2334>.EG2334*ht"lTManifest)* /he# a!e asfollows:

XML content files5 media-t8'e:>a''lication?7-dt!oo6@7ml>

A f&ll !efe!ence>OPF "anifest ite" wo&l% !ea% as follows:=ite" i%HC6"le6e"pla!C h!efHCcontentfilena"e*6"lC "e%iat#peHCapplication>6%t+ookY6"lC>?

*#F files5 media-t8'e:>a''lication?'df>

A f&ll !efe!ence>OPF "anifest ite" wo&l% !ea% as follows:

=ite" i%HCcop#!ightpagep%fC h!efHCcop#!ightpage*p%fC "e%iat#peHCapplication>p%fC>?

QQQQQ* O7$PS 0*2 Specification* IDPF, http:>>www*i%pf*o!g>oe+ps>oe+ps0*2>%ownloa%>oe+02*%ocTQ/oc00G3

0
http://www.iana.org/assignments/media-types/http://www.daisy.org/z3986/2005/z3986-2005.html#Manifesthttp://www.iana.org/assignments/media-types/http://www.daisy.org/z3986/2005/z3986-2005.html#Manifest


15/18

images5 media-t8'e:>image?'eg> ormedia-t8'e:>image?s"g@7ml> ormedia-t8'e:>image?'ng>

A f&ll !efe!ence>OPF "anifest ite" wo&l% !ea% as follows:=ite" i%HCi"ga!!owC h!efHCi"ages>B33933>a!!ow*pgC "e%iat#peHCi"age>pegC>?

or

=ite" i%HCi"ga!!owC h!efHCi"ages>B33933>a!!ow*sgC "e%iat#peHCi"age>sgY6"lC>?or

=ite" i%HCi"ga!!owC h!efHCi"ages>B33933>a!!ow*pngC "e%iat#peHCi"age>pngC>?

NO/7: /he DAIS1 D/D on which the NIMAS technical specification is +ase% %oes not incl&%e all possi+leMIM7 "e%ia t#pes an% s&+t#pes +eca&se official t#pes a!e not a static, pe!"anent list +&t eole th!o&gh the

coo!%ination of the Inte!net Assigne% N&"+e!s A&tho!it# (IANA Rhttp:>>www*iana*o!g)*

NIMA, and metadata

/he NIMA9 is the national !eposito!# fo! NIMAS files, "anage% +# the A"e!ican P!inting ;o&se fo! the $lin%(AP;)* /he!e a!e a%%itional "eta%ata !e8&i!e"ents fo! OPF files s&+"itte% to the NIMA9 +e#on% those

!e8&i!e% fo! NIMAS OPF files* /hose %iffe!ences facilitate the sto!age, "anage"ent, an% !et!ieal of NIMAS

files* /heNIMA9 we+ sitehas its own "eta%atapage, an% a NIMA9 sa"ple OPF file that incl&%es +othNIMA9 an% NIMAS "eta%ata !e8&i!e"ents is aaila+le the!e (f&ll e!sion with histo!# an% co""ents) an% on

9AS/5s NIMAS 76e"pla!spage (


16/18

o to 9AS/5s NIMAS 76e"pla!spage to see e6a"ples of NIMASconfo!"ant files that incl&%e app!op!iate

package files within a NIMASconfo!"ant file set*

o %i!ectl# to the oe+ps 0*2 specification at the =Oe$? Open e$ook Fo!&"*

Opening the e$ook,+# Di%ie! Ma!tin* (2333*) XML*co"* /his a!ticle e6plains the oe+ps stan%a!% &sing IDPF

content in a "o!e !ea%a+le st#le than the spec itself* Note the stan%a!% has since +een &p%ate% f!o" 0*3 to 0*2*

9hanges we!e "a%e to this %oc&"ent as of Ma!ch , 233: /O9, addition

wellfo!"e% XML %oc&"ents list, clarified

ali% NIMASconfo!"ant XML files list, clarified

DAIS1 2334specific ite"s list, clarified

+est p!actices list, addition

NIMAS 0*0 D/D !e8&i!e% ele"ents ta+le, addition

NIMAS 0*0 D/D !e8&i!e% att!i+&tes ta+le, correction

Section NIMA9 ali%ato! pa!ag!aph, u!dated

Section pa!ag!aph 0, u!dated

Section i"age files list, clarified

Section 4 pa!ag!aph 0, addition

NIMAS Filesets an% MIM7 /#pes section, addition

NIMA9 an% Meta%ata section, addition

Section G, addition

9hanges we!e "a%e to this %oc&"ent as of A&g&st 23, 233:

P!epa!ing a package file (OPF) section, addition

NIMA9 an% Meta%ata section, addition

Section , addition

9hanges we!e "a%e to this %oc&"ent as of Dece"+e! G, 233:

$est P!actices section, addition

9hanges we!e "a%e to this %oc&"ent as of an&a!# , 233:

P!epa!ingi"ages fo! a NIMAS fileset section, u!dated

'al&ea%%e% co"ponents: w!iting alte!natie te6t an% long %esc!iptions section, u!dated

I"ages an% "a!k&p of "ath content section, u!dated


9hanges we!e "a%e to this %oc&"ent as of Ma!ch 24, 233: P!epa!ing a package file (OPF) section, addition


9hanges we!e "a%e to this %oc&"ent as of Ma# 2E, 233:

/he NIMAS Fileset, addition

9hanges we!e "a%e to this %oc&"ent as of Octo+e! 04, 233:

$est P!actices section,se!arated to t"eNIMAS Files $est P!acticesdocument

0G
http://aim.cast.org/experience/technologies/nimas_exemplarshttp://www.openebook.org/oebps/oebps1.2/download/oeb12-xhtml.htmhttp://www.xml.com/pub/a/2000/10/18/ebooks/http://www.xml.com/pub/a/2000/10/18/ebooks/http://aim.cast.org/learn/practice/production/best_practiceshttp://aim.cast.org/experience/technologies/nimas_exemplarshttp://www.openebook.org/oebps/oebps1.2/download/oeb12-xhtml.htmhttp://www.xml.com/pub/a/2000/10/18/ebooks/http://aim.cast.org/learn/practice/production/best_practices


17/18

P!epa!ing i"ages fo! a NIMAS fileset, addition

9!eating a NIMASconfo!"ant XML content file, addition

0


18/18

9hanges we!e "a%e to this %oc&"ent as of Ma# 4, 233E:

P!epa!ingi"ages fo! a NIMAS fileset section, addition

9hanges we!e "a%e to this %oc&"ent as of &ne 0, 2303:

9ha!acte! 7nco%ing (B/F an% B/F0G), addition

9hanges we!e "a%e to this %oc&"ent as of Octo+e! , 2303:

D/D an% OPF!efe!ences, addition

0

creatingnimasfiles10.27.11

Documents