param.xml 386 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308
  1. <?xml version="1.0" encoding="ASCII"?>
  2. <book version="5.0">
  3. <info>
  4. <title>HTML Parameter Reference</title>
  5. <releaseinfo role="meta">
  6. $Id: param.xweb 9658 2012-10-29 22:28:34Z bobstayton $
  7. </releaseinfo>
  8. <author>
  9. <personname>
  10. <surname>Walsh</surname>
  11. <firstname>Norman</firstname>
  12. </personname>
  13. </author>
  14. <copyright>
  15. <year>1999</year>
  16. <year>2000</year>
  17. <year>2001</year>
  18. <year>2002</year>
  19. <year>2003</year>
  20. <year>2004</year>
  21. <year>2005</year>
  22. <year>2006</year>
  23. <year>2007</year>
  24. <year>2008</year>
  25. <year>2009</year>
  26. <year>2010</year>
  27. <year>2011</year>
  28. <holder>Norman Walsh</holder>
  29. </copyright>
  30. <abstract>
  31. <para>This is reference documentation for all user-configurable
  32. parameters in the DocBook XSL HTML stylesheets (for generating
  33. HTML output).</para>
  34. </abstract>
  35. </info>
  36. <reference xml:id="admons"><title>Admonitions</title>
  37. <refentry version="5.0" xml:id="admon.graphics.extension">
  38. <refmeta>
  39. <refentrytitle>admon.graphics.extension</refentrytitle>
  40. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  41. </refmeta>
  42. <refnamediv>
  43. <refname>admon.graphics.extension</refname>
  44. <refpurpose>Filename extension for admonition graphics</refpurpose>
  45. </refnamediv>
  46. <refsynopsisdiv>
  47. <programlisting xml:id="admon.graphics.extension.frag">
  48. &lt;xsl:param name="admon.graphics.extension"&gt;.png&lt;/xsl:param&gt;
  49. </programlisting>
  50. </refsynopsisdiv>
  51. <refsection><info><title>Description</title></info>
  52. <para>Sets the filename extension to use on admonition graphics.</para>
  53. <itemizedlist>
  54. <para>The DocBook XSL distribution provides admonition graphics in the following formats:</para>
  55. <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
  56. <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
  57. <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
  58. <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)</para></listitem>
  59. </itemizedlist>
  60. </refsection>
  61. </refentry>
  62. <refentry version="5.0" xml:id="admon.graphics.path">
  63. <refmeta>
  64. <refentrytitle>admon.graphics.path</refentrytitle>
  65. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  66. </refmeta>
  67. <refnamediv>
  68. <refname>admon.graphics.path</refname>
  69. <refpurpose>Path to admonition graphics</refpurpose>
  70. </refnamediv>
  71. <refsynopsisdiv>
  72. <programlisting xml:id="admon.graphics.path.frag">&lt;xsl:param name="admon.graphics.path"&gt;images/&lt;/xsl:param&gt;</programlisting>
  73. </refsynopsisdiv>
  74. <refsection><info><title>Description</title></info>
  75. <para>Sets the path to the directory containing the admonition graphics
  76. (caution.png, important.png etc). This location is normally relative
  77. to the output html directory. See <parameter>base.dir</parameter></para>
  78. </refsection>
  79. </refentry>
  80. <refentry version="5.0" xml:id="admon.graphics">
  81. <refmeta>
  82. <refentrytitle>admon.graphics</refentrytitle>
  83. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  84. </refmeta>
  85. <refnamediv>
  86. <refname>admon.graphics</refname>
  87. <refpurpose>Use graphics in admonitions?</refpurpose>
  88. </refnamediv>
  89. <refsynopsisdiv>
  90. <programlisting xml:id="admon.graphics.frag">
  91. &lt;xsl:param name="admon.graphics" select="0"&gt;&lt;/xsl:param&gt;
  92. </programlisting>
  93. </refsynopsisdiv>
  94. <refsection><info><title>Description</title></info>
  95. <para>If true (non-zero), admonitions are presented in an alternate style that uses
  96. a graphic. Default graphics are provided in the distribution.
  97. </para>
  98. </refsection>
  99. </refentry>
  100. <refentry version="5.0" xml:id="admon.textlabel">
  101. <refmeta>
  102. <refentrytitle>admon.textlabel</refentrytitle>
  103. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  104. </refmeta>
  105. <refnamediv>
  106. <refname>admon.textlabel</refname>
  107. <refpurpose>Use text label in admonitions?</refpurpose>
  108. </refnamediv>
  109. <refsynopsisdiv>
  110. <programlisting xml:id="admon.textlabel.frag">
  111. &lt;xsl:param name="admon.textlabel" select="1"&gt;&lt;/xsl:param&gt;
  112. </programlisting>
  113. </refsynopsisdiv>
  114. <refsection><info><title>Description</title></info>
  115. <para>If true (non-zero), admonitions are presented with a generated
  116. text label such as Note or Warning in the appropriate language.
  117. If zero, such labels are turned off, but any title child
  118. of the admonition element are still output.
  119. The default value is 1.
  120. </para>
  121. </refsection>
  122. </refentry>
  123. <refentry version="5.0" xml:id="admon.style">
  124. <refmeta>
  125. <refentrytitle>admon.style</refentrytitle>
  126. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  127. </refmeta>
  128. <refnamediv>
  129. <refname>admon.style</refname>
  130. <refpurpose>Specifies the CSS style attribute that should be added to
  131. admonitions.</refpurpose>
  132. </refnamediv>
  133. <refsynopsisdiv>
  134. <programlisting xml:id="admon.style.frag">&lt;xsl:param name="admon.style"&gt;
  135. &lt;xsl:value-of select="concat('margin-', $direction.align.start, ': 0.5in; margin-', $direction.align.end, ': 0.5in;')"&gt;&lt;/xsl:value-of&gt;
  136. &lt;/xsl:param&gt;</programlisting>
  137. </refsynopsisdiv>
  138. <refsection><info><title>Description</title></info>
  139. <para>Specifies the value of the CSS <tag class="attribute">style</tag>
  140. attribute that should be added to admonitions.
  141. </para>
  142. </refsection>
  143. </refentry>
  144. </reference>
  145. <reference xml:id="callouts"><title>Callouts</title>
  146. <refentry version="5.0" xml:id="callout.defaultcolumn">
  147. <refmeta>
  148. <refentrytitle>callout.defaultcolumn</refentrytitle>
  149. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  150. </refmeta>
  151. <refnamediv>
  152. <refname>callout.defaultcolumn</refname>
  153. <refpurpose>Indicates what column callouts appear in by default</refpurpose>
  154. </refnamediv>
  155. <refsynopsisdiv>
  156. <programlisting xml:id="callout.defaultcolumn.frag">
  157. &lt;xsl:param name="callout.defaultcolumn"&gt;60&lt;/xsl:param&gt;
  158. </programlisting>
  159. </refsynopsisdiv>
  160. <refsection><info><title>Description</title></info>
  161. <para>If a callout does not identify a column (for example, if it uses
  162. the <literal>linerange</literal> <tag class="attribute">unit</tag>),
  163. it will appear in the default column.
  164. </para>
  165. </refsection>
  166. </refentry>
  167. <refentry version="5.0" xml:id="callout.graphics.extension">
  168. <refmeta>
  169. <refentrytitle>callout.graphics.extension</refentrytitle>
  170. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  171. </refmeta>
  172. <refnamediv>
  173. <refname>callout.graphics.extension</refname>
  174. <refpurpose>Filename extension for callout graphics</refpurpose>
  175. </refnamediv>
  176. <refsynopsisdiv>
  177. <programlisting xml:id="callout.graphics.extension.frag">
  178. &lt;xsl:param name="callout.graphics.extension"&gt;.png&lt;/xsl:param&gt;
  179. </programlisting>
  180. </refsynopsisdiv>
  181. <refsection><info><title>Description</title></info>
  182. <para>Sets the filename extension to use on callout graphics. </para>
  183. <itemizedlist>
  184. <para>The Docbook XSL distribution provides callout graphics in the following formats:</para>
  185. <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</para></listitem>
  186. <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</para></listitem>
  187. <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</para></listitem>
  188. </itemizedlist>
  189. </refsection>
  190. </refentry>
  191. <refentry version="5.0" xml:id="callout.graphics.number.limit">
  192. <refmeta>
  193. <refentrytitle>callout.graphics.number.limit</refentrytitle>
  194. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  195. </refmeta>
  196. <refnamediv>
  197. <refname>callout.graphics.number.limit</refname>
  198. <refpurpose>Number of the largest callout graphic</refpurpose>
  199. </refnamediv>
  200. <refsynopsisdiv>
  201. <programlisting xml:id="callout.graphics.number.limit.frag">
  202. &lt;xsl:param name="callout.graphics.number.limit"&gt;15&lt;/xsl:param&gt;
  203. </programlisting>
  204. </refsynopsisdiv>
  205. <refsection><info><title>Description</title></info>
  206. <para>If <parameter>callout.graphics</parameter> is non-zero, graphics
  207. are used to represent callout numbers instead of plain text. The value
  208. of <parameter>callout.graphics.number.limit</parameter> is the largest
  209. number for which a graphic exists. If the callout number exceeds this
  210. limit, the default presentation "(plain text instead of a graphic)"
  211. will be used.
  212. </para>
  213. </refsection>
  214. </refentry>
  215. <refentry version="5.0" xml:id="callout.graphics.path">
  216. <refmeta>
  217. <refentrytitle>callout.graphics.path</refentrytitle>
  218. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  219. </refmeta>
  220. <refnamediv>
  221. <refname>callout.graphics.path</refname>
  222. <refpurpose>Path to callout graphics</refpurpose>
  223. </refnamediv>
  224. <refsynopsisdiv>
  225. <programlisting xml:id="callout.graphics.path.frag">
  226. &lt;xsl:param name="callout.graphics.path"&gt;images/callouts/&lt;/xsl:param&gt;
  227. </programlisting>
  228. </refsynopsisdiv>
  229. <refsection><info><title>Description</title></info>
  230. <para>Sets the path to the directory holding the callout graphics. his
  231. location is normally relative to the output html directory. see
  232. base.dir. Always terminate the directory with / since the graphic file
  233. is appended to this string, hence needs the separator.
  234. </para>
  235. </refsection>
  236. </refentry>
  237. <refentry version="5.0" xml:id="callout.graphics">
  238. <refmeta>
  239. <refentrytitle>callout.graphics</refentrytitle>
  240. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  241. </refmeta>
  242. <refnamediv>
  243. <refname>callout.graphics</refname>
  244. <refpurpose>Use graphics for callouts?</refpurpose>
  245. </refnamediv>
  246. <refsynopsisdiv>
  247. <programlisting xml:id="callout.graphics.frag">
  248. &lt;xsl:param name="callout.graphics" select="1"&gt;&lt;/xsl:param&gt;
  249. </programlisting>
  250. </refsynopsisdiv>
  251. <refsection><info><title>Description</title></info>
  252. <para>If non-zero, callouts are presented with graphics (e.g., reverse-video
  253. circled numbers instead of "(1)", "(2)", etc.).
  254. Default graphics are provided in the distribution.
  255. </para>
  256. </refsection>
  257. </refentry>
  258. <refentry version="5.0" xml:id="callout.list.table">
  259. <refmeta>
  260. <refentrytitle>callout.list.table</refentrytitle>
  261. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  262. </refmeta>
  263. <refnamediv>
  264. <refname>callout.list.table</refname>
  265. <refpurpose>Present callout lists using a table?</refpurpose>
  266. </refnamediv>
  267. <refsynopsisdiv>
  268. <programlisting xml:id="callout.list.table.frag">
  269. &lt;xsl:param name="callout.list.table" select="1"&gt;&lt;/xsl:param&gt;
  270. </programlisting>
  271. </refsynopsisdiv>
  272. <refsection><info><title>Description</title></info>
  273. <para>The default presentation of <tag>calloutlist</tag>s uses
  274. an HTML <tag>DL</tag> element. Some browsers don't align DLs very well
  275. if <parameter>callout.graphics</parameter> is used. With this option
  276. turned on, <tag>calloutlist</tag>s are presented in an HTML
  277. <tag>TABLE</tag>, which usually results in better alignment
  278. of the callout number with the callout description.</para>
  279. </refsection>
  280. </refentry>
  281. <refentry version="5.0" xml:id="callout.unicode.number.limit">
  282. <refmeta>
  283. <refentrytitle>callout.unicode.number.limit</refentrytitle>
  284. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  285. </refmeta>
  286. <refnamediv>
  287. <refname>callout.unicode.number.limit</refname>
  288. <refpurpose>Number of the largest unicode callout character</refpurpose>
  289. </refnamediv>
  290. <refsynopsisdiv>
  291. <programlisting xml:id="callout.unicode.number.limit.frag">
  292. &lt;xsl:param name="callout.unicode.number.limit"&gt;10&lt;/xsl:param&gt;
  293. </programlisting>
  294. </refsynopsisdiv>
  295. <refsection><info><title>Description</title></info>
  296. <para>If <parameter>callout.unicode</parameter>
  297. is non-zero, unicode characters are used to represent
  298. callout numbers. The value of
  299. <parameter>callout.unicode.number.limit</parameter>
  300. is
  301. the largest number for which a unicode character exists. If the callout number
  302. exceeds this limit, the default presentation "(nnn)" will always
  303. be used.
  304. </para>
  305. </refsection>
  306. </refentry>
  307. <refentry version="5.0" xml:id="callout.unicode.start.character">
  308. <refmeta>
  309. <refentrytitle>callout.unicode.start.character</refentrytitle>
  310. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  311. </refmeta>
  312. <refnamediv>
  313. <refname>callout.unicode.start.character</refname>
  314. <refpurpose>First Unicode character to use, decimal value.</refpurpose>
  315. </refnamediv>
  316. <refsynopsisdiv>
  317. <programlisting xml:id="callout.unicode.start.character.frag">
  318. &lt;xsl:param name="callout.unicode.start.character"&gt;10102&lt;/xsl:param&gt;
  319. </programlisting>
  320. </refsynopsisdiv>
  321. <refsection><info><title>Description</title></info>
  322. <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.unicode</parameter>
  323. is non-zero, unicode characters are used to represent
  324. callout numbers. The value of
  325. <parameter>callout.unicode.start.character</parameter>
  326. is the decimal unicode value used for callout number one. Currently,
  327. only values 9312 and 10102 are supported in the stylesheets for this parameter.
  328. </para>
  329. </refsection>
  330. </refentry>
  331. <refentry version="5.0" xml:id="callout.unicode">
  332. <refmeta>
  333. <refentrytitle>callout.unicode</refentrytitle>
  334. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  335. </refmeta>
  336. <refnamediv>
  337. <refname>callout.unicode</refname>
  338. <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
  339. </refnamediv>
  340. <refsynopsisdiv>
  341. <programlisting xml:id="callout.unicode.frag">&lt;xsl:param name="callout.unicode" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  342. </refsynopsisdiv>
  343. <refsection><info><title>Description</title></info>
  344. <para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option.
  345. </para>
  346. </refsection>
  347. </refentry>
  348. <refentry version="5.0" xml:id="callouts.extension">
  349. <refmeta>
  350. <refentrytitle>callouts.extension</refentrytitle>
  351. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  352. </refmeta>
  353. <refnamediv>
  354. <refname>callouts.extension</refname>
  355. <refpurpose>Enable the callout extension</refpurpose>
  356. </refnamediv>
  357. <refsynopsisdiv>
  358. <programlisting xml:id="callouts.extension.frag">
  359. &lt;xsl:param name="callouts.extension" select="1"&gt;&lt;/xsl:param&gt;
  360. </programlisting>
  361. </refsynopsisdiv>
  362. <refsection><info><title>Description</title></info>
  363. <para>The callouts extension processes <tag>areaset</tag>
  364. elements in <tag>programlistingco</tag> and other text-based
  365. callout elements.
  366. </para>
  367. </refsection>
  368. </refentry>
  369. </reference>
  370. <reference xml:id="ebnf"><title>EBNF</title>
  371. <refentry version="5.0" xml:id="ebnf.table.bgcolor">
  372. <refmeta>
  373. <refentrytitle>ebnf.table.bgcolor</refentrytitle>
  374. <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
  375. </refmeta>
  376. <refnamediv>
  377. <refname>ebnf.table.bgcolor</refname>
  378. <refpurpose>Background color for EBNF tables</refpurpose>
  379. </refnamediv>
  380. <refsynopsisdiv>
  381. <programlisting xml:id="ebnf.table.bgcolor.frag">
  382. &lt;xsl:param name="ebnf.table.bgcolor"&gt;#F5DCB3&lt;/xsl:param&gt;
  383. </programlisting>
  384. </refsynopsisdiv>
  385. <refsection><info><title>Description</title></info>
  386. <para>Sets the background color for EBNF tables (a pale brown). No
  387. <tag>bgcolor</tag> attribute is output if
  388. <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para>
  389. </refsection>
  390. </refentry>
  391. <refentry version="5.0" xml:id="ebnf.table.border">
  392. <refmeta>
  393. <refentrytitle>ebnf.table.border</refentrytitle>
  394. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  395. </refmeta>
  396. <refnamediv>
  397. <refname>ebnf.table.border</refname>
  398. <refpurpose>Selects border on EBNF tables</refpurpose>
  399. </refnamediv>
  400. <refsynopsisdiv>
  401. <programlisting xml:id="ebnf.table.border.frag">&lt;xsl:param name="ebnf.table.border" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  402. </refsynopsisdiv>
  403. <refsection><info><title>Description</title></info>
  404. <para>Selects the border on EBNF tables. If non-zero, the tables have
  405. borders, otherwise they don't.</para>
  406. </refsection>
  407. </refentry>
  408. <refentry version="5.0" xml:id="ebnf.assignment">
  409. <refmeta>
  410. <refentrytitle>ebnf.assignment</refentrytitle>
  411. <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
  412. </refmeta>
  413. <refnamediv>
  414. <refname>ebnf.assignment</refname>
  415. <refpurpose>The EBNF production assignment operator</refpurpose>
  416. </refnamediv>
  417. <refsynopsisdiv>
  418. <programlisting xml:id="ebnf.assignment.frag">
  419. &lt;xsl:param name="ebnf.assignment"&gt;
  420. &lt;code&gt;::=&lt;/code&gt;
  421. &lt;/xsl:param&gt;
  422. </programlisting>
  423. </refsynopsisdiv>
  424. <refsection><info><title>Description</title></info>
  425. <para>The <parameter>ebnf.assignment</parameter> parameter determines what
  426. text is used to show <quote>assignment</quote> in <tag>production</tag>s
  427. in <tag>productionset</tag>s.</para>
  428. <para>While <quote><literal>::=</literal></quote> is common, so are several
  429. other operators.</para>
  430. </refsection>
  431. </refentry>
  432. <refentry version="5.0" xml:id="ebnf.statement.terminator">
  433. <refmeta>
  434. <refentrytitle>ebnf.statement.terminator</refentrytitle>
  435. <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>
  436. </refmeta>
  437. <refnamediv>
  438. <refname>ebnf.statement.terminator</refname>
  439. <refpurpose>Punctuation that ends an EBNF statement.</refpurpose>
  440. </refnamediv>
  441. <refsynopsisdiv>
  442. <programlisting xml:id="ebnf.statement.terminator.frag">
  443. &lt;xsl:param name="ebnf.statement.terminator"&gt;&lt;/xsl:param&gt;
  444. </programlisting>
  445. </refsynopsisdiv>
  446. <refsection><info><title>Description</title></info>
  447. <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines what
  448. text is used to terminate each <tag>production</tag>
  449. in <tag>productionset</tag>.</para>
  450. <para>Some notations end each statement with a period.</para>
  451. </refsection>
  452. </refentry>
  453. </reference>
  454. <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title>
  455. <refentry version="5.0" xml:id="annotate.toc">
  456. <refmeta>
  457. <refentrytitle>annotate.toc</refentrytitle>
  458. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  459. </refmeta>
  460. <refnamediv>
  461. <refname>annotate.toc</refname>
  462. <refpurpose>Annotate the Table of Contents?</refpurpose>
  463. </refnamediv>
  464. <refsynopsisdiv>
  465. <programlisting xml:id="annotate.toc.frag">&lt;xsl:param name="annotate.toc" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  466. </refsynopsisdiv>
  467. <refsection><info><title>Description</title></info>
  468. <para>If true, TOCs will be annotated. At present, this just means
  469. that the <tag>refpurpose</tag> of <tag>refentry</tag>
  470. TOC entries will be displayed.
  471. </para>
  472. </refsection>
  473. </refentry>
  474. <refentry version="5.0" xml:id="autotoc.label.separator">
  475. <refmeta>
  476. <refentrytitle>autotoc.label.separator</refentrytitle>
  477. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  478. </refmeta>
  479. <refnamediv>
  480. <refname>autotoc.label.separator</refname>
  481. <refpurpose>Separator between labels and titles in the ToC</refpurpose>
  482. </refnamediv>
  483. <refsynopsisdiv>
  484. <programlisting xml:id="autotoc.label.separator.frag">
  485. &lt;xsl:param name="autotoc.label.separator"&gt;. &lt;/xsl:param&gt;
  486. </programlisting>
  487. </refsynopsisdiv>
  488. <refsection><info><title>Description</title></info>
  489. <para>String used to separate labels and titles in a table of contents.</para>
  490. </refsection>
  491. </refentry>
  492. <refentry version="5.0" xml:id="autotoc.label.in.hyperlink">
  493. <refmeta>
  494. <refentrytitle>autotoc.label.in.hyperlink</refentrytitle>
  495. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  496. </refmeta>
  497. <refnamediv>
  498. <refname>autotoc.label.in.hyperlink</refname>
  499. <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose>
  500. </refnamediv>
  501. <refsynopsisdiv>
  502. <programlisting xml:id="autotoc.label.in.hyperlink.frag">&lt;xsl:param name="autotoc.label.in.hyperlink" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  503. </refsynopsisdiv>
  504. <refsection><info><title>Description</title></info>
  505. <para>If the value of
  506. <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels
  507. are included in hyperlinked titles in the TOC. If it is instead zero,
  508. labels are still displayed prior to the hyperlinked titles, but
  509. are not hyperlinked along with the titles.</para>
  510. </refsection>
  511. </refentry>
  512. <refentry version="5.0" xml:id="process.source.toc">
  513. <refmeta>
  514. <refentrytitle>process.source.toc</refentrytitle>
  515. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  516. </refmeta>
  517. <refnamediv>
  518. <refname>process.source.toc</refname>
  519. <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
  520. </refnamediv>
  521. <refsynopsisdiv>
  522. <programlisting xml:id="process.source.toc.frag">&lt;xsl:param name="process.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  523. </refsynopsisdiv>
  524. <refsection><info><title>Description</title></info>
  525. <para>Specifies that the contents of a non-empty "hard-coded"
  526. <tag>toc</tag> element in a source document are processed to
  527. generate a TOC in output.
  528. <note>
  529. <para>This parameter has no effect on automated generation of
  530. TOCs. An automated TOC may still be generated along with the
  531. "hard-coded" TOC. To suppress automated TOC generation, adjust the
  532. value of the <parameter>generate.toc</parameter> paramameter.</para>
  533. <para>The <tag>process.source.toc</tag> parameter also has
  534. no effect if the <tag>toc</tag> element is empty; handling
  535. for empty <tag>toc</tag> is controlled by the
  536. <parameter>process.empty.source.toc</parameter> parameter.</para>
  537. </note>
  538. </para>
  539. </refsection>
  540. </refentry>
  541. <refentry version="5.0" xml:id="process.empty.source.toc">
  542. <refmeta>
  543. <refentrytitle>process.empty.source.toc</refentrytitle>
  544. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  545. </refmeta>
  546. <refnamediv>
  547. <refname>process.empty.source.toc</refname>
  548. <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
  549. </refnamediv>
  550. <refsynopsisdiv>
  551. <programlisting xml:id="process.empty.source.toc.frag">&lt;xsl:param name="process.empty.source.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  552. </refsynopsisdiv>
  553. <refsection><info><title>Description</title></info>
  554. <para>Specifies that if an empty <tag>toc</tag> element is found in a
  555. source document, an automated TOC is generated at this point in the
  556. document.
  557. <note>
  558. <para>Depending on what the value of the
  559. <parameter>generate.toc</parameter> parameter is, setting this
  560. parameter to <literal>1</literal> could result in generation of
  561. duplicate automated TOCs. So the
  562. <parameter>process.empty.source.toc</parameter> is primarily useful
  563. as an "override": by placing an empty <tag>toc</tag> in your
  564. document and setting this parameter to <literal>1</literal>, you can
  565. force a TOC to be generated even if <tag>generate.toc</tag>
  566. says not to.</para>
  567. </note>
  568. </para>
  569. </refsection>
  570. </refentry>
  571. <refentry version="5.0" xml:id="bridgehead.in.toc">
  572. <refmeta>
  573. <refentrytitle>bridgehead.in.toc</refentrytitle>
  574. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  575. </refmeta>
  576. <refnamediv>
  577. <refname>bridgehead.in.toc</refname>
  578. <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose>
  579. </refnamediv>
  580. <refsynopsisdiv>
  581. <programlisting xml:id="bridgehead.in.toc.frag">&lt;xsl:param name="bridgehead.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  582. </refsynopsisdiv>
  583. <refsection><info><title>Description</title></info>
  584. <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that
  585. this option is not fully supported and may be removed in a future
  586. version of the stylesheets.
  587. </para>
  588. </refsection>
  589. </refentry>
  590. <refentry version="5.0" xml:id="simplesect.in.toc">
  591. <refmeta>
  592. <refentrytitle>simplesect.in.toc</refentrytitle>
  593. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  594. </refmeta>
  595. <refnamediv>
  596. <refname>simplesect.in.toc</refname>
  597. <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose>
  598. </refnamediv>
  599. <refsynopsisdiv>
  600. <programlisting xml:id="simplesect.in.toc.frag">&lt;xsl:param name="simplesect.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  601. </refsynopsisdiv>
  602. <refsection><info><title>Description</title></info>
  603. <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC.
  604. </para>
  605. </refsection>
  606. </refentry>
  607. <refentry version="5.0" xml:id="manual.toc">
  608. <refmeta>
  609. <refentrytitle>manual.toc</refentrytitle>
  610. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  611. </refmeta>
  612. <refnamediv>
  613. <refname>manual.toc</refname>
  614. <refpurpose>An explicit TOC to be used for the TOC</refpurpose>
  615. </refnamediv>
  616. <refsynopsisdiv>
  617. <programlisting xml:id="manual.toc.frag">
  618. &lt;xsl:param name="manual.toc"&gt;&lt;/xsl:param&gt;
  619. </programlisting>
  620. </refsynopsisdiv>
  621. <refsection><info><title>Description</title></info>
  622. <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that
  623. will be used for building the printed TOC.
  624. </para>
  625. </refsection>
  626. </refentry>
  627. <refentry version="5.0" xml:id="toc.list.type">
  628. <refmeta>
  629. <refentrytitle>toc.list.type</refentrytitle>
  630. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  631. <refmiscinfo class="other" otherclass="value">dl</refmiscinfo>
  632. <refmiscinfo class="other" otherclass="value">ul</refmiscinfo>
  633. <refmiscinfo class="other" otherclass="value">ol</refmiscinfo>
  634. </refmeta>
  635. <refnamediv>
  636. <refname>toc.list.type</refname>
  637. <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose>
  638. </refnamediv>
  639. <refsynopsisdiv>
  640. <programlisting xml:id="toc.list.type.frag">&lt;xsl:param name="toc.list.type"&gt;dl&lt;/xsl:param&gt;</programlisting>
  641. </refsynopsisdiv>
  642. <refsection><info><title>Description</title></info>
  643. <para>When an automatically generated Table of Contents (or List of Titles)
  644. is produced, this HTML element will be used to make the list.
  645. </para>
  646. </refsection>
  647. </refentry>
  648. <refentry version="5.0" xml:id="toc.section.depth">
  649. <refmeta>
  650. <refentrytitle>toc.section.depth</refentrytitle>
  651. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  652. </refmeta>
  653. <refnamediv>
  654. <refname>toc.section.depth</refname>
  655. <refpurpose>How deep should recursive <tag>section</tag>s appear
  656. in the TOC?</refpurpose>
  657. </refnamediv>
  658. <refsynopsisdiv>
  659. <programlisting xml:id="toc.section.depth.frag">&lt;xsl:param name="toc.section.depth"&gt;2&lt;/xsl:param&gt;</programlisting>
  660. </refsynopsisdiv>
  661. <refsection><info><title>Description</title></info>
  662. <para>Specifies the depth to which recursive sections should appear in the
  663. TOC.
  664. </para>
  665. </refsection>
  666. </refentry>
  667. <refentry version="5.0" xml:id="toc.max.depth">
  668. <refmeta>
  669. <refentrytitle>toc.max.depth</refentrytitle>
  670. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  671. </refmeta>
  672. <refnamediv>
  673. <refname>toc.max.depth</refname>
  674. <refpurpose>How many levels should be created for each TOC?</refpurpose>
  675. </refnamediv>
  676. <refsynopsisdiv>
  677. <programlisting xml:id="toc.max.depth.frag">&lt;xsl:param name="toc.max.depth"&gt;8&lt;/xsl:param&gt;</programlisting>
  678. </refsynopsisdiv>
  679. <refsection><info><title>Description</title></info>
  680. <para>Specifies the maximal depth of TOC on all levels.</para>
  681. </refsection>
  682. </refentry>
  683. <refentry version="5.0" xml:id="generate.toc">
  684. <refmeta>
  685. <refentrytitle>generate.toc</refentrytitle>
  686. <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
  687. </refmeta>
  688. <refnamediv>
  689. <refname>generate.toc</refname>
  690. <refpurpose>Control generation of ToCs and LoTs</refpurpose>
  691. </refnamediv>
  692. <refsynopsisdiv>
  693. <programlisting xml:id="generate.toc.frag">
  694. &lt;xsl:param name="generate.toc"&gt;
  695. appendix toc,title
  696. article/appendix nop
  697. article toc,title
  698. book toc,title,figure,table,example,equation
  699. chapter toc,title
  700. part toc,title
  701. preface toc,title
  702. qandadiv toc
  703. qandaset toc
  704. reference toc,title
  705. sect1 toc
  706. sect2 toc
  707. sect3 toc
  708. sect4 toc
  709. sect5 toc
  710. section toc
  711. set toc,title
  712. &lt;/xsl:param&gt;
  713. </programlisting>
  714. </refsynopsisdiv>
  715. <refsection><info><title>Description</title></info>
  716. <para>This parameter has a structured value. It is a table of space-delimited
  717. path/value pairs. Each path identifies some element in the source document
  718. using a restricted subset of XPath (only the implicit child axis, no wildcards,
  719. no predicates). Paths can be either relative or absolute.</para>
  720. <para>When processing a particular element, the stylesheets consult this table to
  721. determine if a ToC (or LoT(s)) should be generated.</para>
  722. <para>For example, consider the entry:</para>
  723. <screen>book toc,figure</screen>
  724. <para>This indicates that whenever a <tag>book</tag> is formatted, a
  725. Table Of Contents and a List of Figures should be generated. Similarly,</para>
  726. <screen>/chapter toc</screen>
  727. <para>indicates that whenever a document <emphasis>that has a root
  728. of</emphasis> <tag>chapter</tag> is formatted, a Table of
  729. Contents should be generated. The entry <literal>chapter</literal> would match
  730. all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>
  731. document elements.</para>
  732. <para>Generally, the longest match wins. So, for example, if you want to distinguish
  733. articles in books from articles in parts, you could use these two entries:</para>
  734. <screen>book/article toc,figure
  735. part/article toc</screen>
  736. <para>Note that an article in a part can never match a <literal>book/article</literal>,
  737. so if you want nothing to be generated for articles in parts, you can simply leave
  738. that rule out.</para>
  739. <para>If you want to leave the rule in, to make it explicit that you're turning
  740. something off, use the value <quote>nop</quote>. For example, the following
  741. entry disables ToCs and LoTs for articles:</para>
  742. <screen>article nop</screen>
  743. <para>Do not simply leave the word <quote>article</quote> in the file
  744. without a matching value. That'd be just begging the silly little
  745. path/value parser to get confused.</para>
  746. <para>Section ToCs are further controlled by the
  747. <parameter>generate.section.toc.level</parameter> parameter.
  748. For a given section level to have a ToC, it must have both an entry in
  749. <parameter>generate.toc</parameter> and be within the range enabled by
  750. <parameter>generate.section.toc.level</parameter>.</para>
  751. </refsection>
  752. </refentry>
  753. <refentry version="5.0" xml:id="generate.section.toc.level">
  754. <refmeta>
  755. <refentrytitle>generate.section.toc.level</refentrytitle>
  756. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  757. </refmeta>
  758. <refnamediv>
  759. <refname>generate.section.toc.level</refname>
  760. <refpurpose>Control depth of TOC generation in sections</refpurpose>
  761. </refnamediv>
  762. <refsynopsisdiv>
  763. <programlisting xml:id="generate.section.toc.level.frag">
  764. &lt;xsl:param name="generate.section.toc.level" select="0"&gt;&lt;/xsl:param&gt;
  765. </programlisting>
  766. </refsynopsisdiv>
  767. <refsection><info><title>Description</title></info>
  768. <para>The <parameter>generate.section.toc.level</parameter> parameter
  769. controls the depth of <tag>section</tag> in which TOCs will be generated. Note
  770. that this is related to, but not the same as
  771. <parameter>toc.section.depth</parameter>, which controls the depth to
  772. which TOC entries will be generated in a given TOC.</para>
  773. <para>If, for example, <parameter>generate.section.toc.level</parameter>
  774. is <literal>3</literal>, TOCs will be generated in first, second, and third
  775. level sections, but not in fourth level sections.
  776. </para>
  777. </refsection>
  778. </refentry>
  779. <refentry version="5.0" xml:id="generate.index">
  780. <refmeta>
  781. <refentrytitle>generate.index</refentrytitle>
  782. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  783. </refmeta>
  784. <refnamediv>
  785. <refname>generate.index</refname>
  786. <refpurpose>Do you want an index?</refpurpose>
  787. </refnamediv>
  788. <refsynopsisdiv>
  789. <programlisting xml:id="generate.index.frag">&lt;xsl:param name="generate.index" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  790. </refsynopsisdiv>
  791. <refsection><info><title>Description</title></info>
  792. <para>Specify if an index should be generated. </para>
  793. </refsection>
  794. </refentry>
  795. <refentry version="5.0" xml:id="index.method">
  796. <refmeta>
  797. <refentrytitle>index.method</refentrytitle>
  798. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  799. <refmiscinfo class="other" otherclass="value">basic</refmiscinfo>
  800. <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>
  801. <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>
  802. </refmeta>
  803. <refnamediv>
  804. <refname>index.method</refname>
  805. <refpurpose>Select method used to group index entries in an index</refpurpose>
  806. </refnamediv>
  807. <refsynopsisdiv>
  808. <programlisting xml:id="index.method.frag">
  809. &lt;xsl:param name="index.method"&gt;basic&lt;/xsl:param&gt;
  810. </programlisting>
  811. </refsynopsisdiv>
  812. <refsection><info><title>Description</title></info>
  813. <para>This parameter lets you select which method to use for sorting and grouping
  814. index entries in an index.
  815. Indexes in Latin-based languages that have accented characters typically
  816. sort together accented words and unaccented words.
  817. Thus <quote>&#193;</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together
  818. with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>
  819. section of the index.
  820. Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)
  821. and languages using ideographic chararacters (such as Japanese)
  822. require grouping specific to the languages and alphabets.
  823. </para>
  824. <para>The default indexing method is limited.
  825. It can group accented characters in Latin-based languages only.
  826. It cannot handle non-Latin alphabets or ideographic languages.
  827. The other indexing methods require extensions of one type or
  828. another, and do not work with
  829. all XSLT processors, which is why they are not used by default.</para>
  830. <para>The three choices for indexing method are:</para>
  831. <variablelist>
  832. <varlistentry>
  833. <term><literal>basic</literal></term>
  834. <listitem>
  835. <para>
  836. (default) Sort and groups words based only on the Latin alphabet.
  837. Words with accented Latin letters will group and sort with
  838. their respective primary letter, but
  839. words in non-Latin alphabets will be
  840. put in the <quote>Symbols</quote> section of the index.
  841. </para>
  842. </listitem>
  843. </varlistentry>
  844. <varlistentry>
  845. <term><literal>kosek</literal></term>
  846. <listitem>
  847. <para>
  848. This method sorts and groups words based on letter groups configured in
  849. the DocBook locale file for the given language.
  850. See, for example, the French locale file <filename>common/fr.xml</filename>.
  851. This method requires that the XSLT processor
  852. supports the EXSLT extensions (most do).
  853. It also requires support for using
  854. user-defined functions in xsl:key (xsltproc does not).
  855. </para>
  856. <para>This method is suitable for any language for which you can
  857. list all the individual characters that should appear
  858. in each letter group in an index.
  859. It is probably not practical to use it for ideographic languages
  860. such as Chinese that have hundreds or thousands of characters.
  861. </para>
  862. <para>To use the kosek method, you must:</para>
  863. <orderedlist>
  864. <listitem>
  865. <para>Use a processor that supports its extensions, such as
  866. Saxon 6 or Xalan (xsltproc and Saxon 8 do not).
  867. </para>
  868. </listitem>
  869. <listitem>
  870. <para>Set the index.method parameter's value to <quote>kosek</quote>.
  871. </para>
  872. </listitem>
  873. <listitem>
  874. <para>Import the appropriate index extensions stylesheet module
  875. <filename>fo/autoidx-kosek.xsl</filename> or
  876. <filename>html/autoidx-kosek.xsl</filename> into your
  877. customization.
  878. </para>
  879. </listitem>
  880. </orderedlist>
  881. </listitem>
  882. </varlistentry>
  883. <varlistentry>
  884. <term><literal>kimber</literal></term>
  885. <listitem>
  886. <para>
  887. This method uses extensions to the Saxon processor to implement
  888. sophisticated indexing processes. It uses its own
  889. configuration file, which can include information for any number of
  890. languages. Each language's configuration can group
  891. words using one of two processes. In the
  892. enumerated process similar to that used in the kosek method,
  893. you indicate the groupings character-by-character.
  894. In the between-key process, you specify the
  895. break-points in the sort order that should start a new group.
  896. The latter configuration is useful for ideographic languages
  897. such as Chinese, Japanese, and Korean.
  898. You can also define your own collation algorithms and how you
  899. want mixed Latin-alphabet words sorted.</para>
  900. <itemizedlist>
  901. <listitem>
  902. <para>For a whitepaper describing the extensions, see:
  903. <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.
  904. </para>
  905. </listitem>
  906. <listitem>
  907. <para>To download the extension library, see
  908. <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.
  909. </para>
  910. </listitem>
  911. </itemizedlist>
  912. <para>To use the kimber method, you must:</para>
  913. <orderedlist>
  914. <listitem>
  915. <para>Use Saxon (version 6 or 8) as your XSLT processor.
  916. </para>
  917. </listitem>
  918. <listitem>
  919. <para>Install and configure the Innodata Isogen library, using
  920. the documentation that comes with it.
  921. </para>
  922. </listitem>
  923. <listitem>
  924. <para>Set the index.method parameter's value to <quote>kimber</quote>.
  925. </para>
  926. </listitem>
  927. <listitem>
  928. <para>Import the appropriate index extensions stylesheet module
  929. <filename>fo/autoidx-kimber.xsl</filename> or
  930. <filename>html/autoidx-kimber.xsl</filename> into your
  931. customization.
  932. </para>
  933. </listitem>
  934. </orderedlist>
  935. </listitem>
  936. </varlistentry>
  937. </variablelist>
  938. </refsection>
  939. </refentry>
  940. <refentry version="5.0" xml:id="index.on.type">
  941. <refmeta>
  942. <refentrytitle>index.on.type</refentrytitle>
  943. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  944. </refmeta>
  945. <refnamediv>
  946. <refname>index.on.type</refname>
  947. <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
  948. attribute value</refpurpose>
  949. </refnamediv>
  950. <refsynopsisdiv>
  951. <programlisting xml:id="index.on.type.frag">
  952. &lt;xsl:param name="index.on.type" select="0"&gt;&lt;/xsl:param&gt;
  953. </programlisting>
  954. </refsynopsisdiv>
  955. <refsection><info><title>Description</title></info>
  956. <para>
  957. If non-zero,
  958. then an <tag>index</tag> element that has a
  959. <tag class="attribute">type</tag> attribute
  960. value will contain only those <tag>indexterm</tag>
  961. elements with a matching <tag class="attribute">type</tag> attribute value.
  962. If an <tag>index</tag> has no <tag class="attribute">type</tag>
  963. attribute or it is blank, then the index will contain
  964. all <tag>indexterm</tag>s in the current scope.
  965. </para>
  966. <para>
  967. If <literal>index.on.type</literal> is zero, then the
  968. <tag class="attribute">type</tag> attribute has no effect
  969. on selecting indexterms for an index.
  970. </para>
  971. <para>For those using DocBook version 4.2 or earlier,
  972. the <tag class="attribute">type</tag> attribute is not available
  973. for index terms. However, you can achieve the same
  974. effect by using the <tag class="attribute">role</tag> attribute
  975. in the same manner on <tag>indexterm</tag>
  976. and <tag>index</tag>, and setting the stylesheet parameter
  977. <parameter>index.on.role</parameter> to a nonzero value.
  978. </para>
  979. </refsection>
  980. </refentry>
  981. <refentry version="5.0" xml:id="index.on.role">
  982. <refmeta>
  983. <refentrytitle>index.on.role</refentrytitle>
  984. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  985. </refmeta>
  986. <refnamediv>
  987. <refname>index.on.role</refname>
  988. <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
  989. </refnamediv>
  990. <refsynopsisdiv>
  991. <programlisting xml:id="index.on.role.frag">
  992. &lt;xsl:param name="index.on.role" select="0"&gt;&lt;/xsl:param&gt;
  993. </programlisting>
  994. </refsynopsisdiv>
  995. <refsection><info><title>Description</title></info>
  996. <para>
  997. If non-zero,
  998. then an <tag>index</tag> element that has a
  999. <tag class="attribute">role</tag> attribute
  1000. value will contain only those <tag>indexterm</tag>
  1001. elements with a matching role value.
  1002. If an <tag>index</tag> has no <tag class="attribute">role</tag>
  1003. attribute or it is blank, then the index will contain
  1004. all <tag>indexterm</tag>s in the current scope.
  1005. </para>
  1006. <para>
  1007. If <literal>index.on.role</literal> is zero, then the
  1008. <tag class="attribute">role</tag> attribute has no effect
  1009. on selecting indexterms for an index.
  1010. </para>
  1011. <para>If you are using DocBook version 4.3 or later, you should
  1012. use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
  1013. on <tag>indexterm</tag> and <tag>index</tag>,
  1014. and set the <parameter>index.on.type</parameter> to a nonzero
  1015. value.
  1016. </para>
  1017. </refsection>
  1018. </refentry>
  1019. <refentry version="5.0" xml:id="index.links.to.section">
  1020. <refmeta>
  1021. <refentrytitle>index.links.to.section</refentrytitle>
  1022. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1023. </refmeta>
  1024. <refnamediv>
  1025. <refname>index.links.to.section</refname>
  1026. <refpurpose>HTML index entries link to container section title</refpurpose>
  1027. </refnamediv>
  1028. <refsynopsisdiv>
  1029. <programlisting xml:id="index.links.to.section.frag">
  1030. &lt;xsl:param name="index.links.to.section" select="1"&gt;&lt;/xsl:param&gt;
  1031. </programlisting>
  1032. </refsynopsisdiv>
  1033. <refsection><info><title>Description</title></info>
  1034. <para>If zero, then an index entry in an index links
  1035. directly to the location of the
  1036. generated <tag>anchor</tag> that is output
  1037. for the indexterm. If two identical indexterm elements
  1038. exist in the same section, then both entries appear
  1039. in the index with the same title but link to different
  1040. locations.</para>
  1041. <para>If non-zero, then an index entry in an index links to the
  1042. section title containing the <tag>indexterm</tag>, rather than
  1043. directly to the <tag>anchor</tag> output for the indexterm.
  1044. Duplicate indexterm entries in the same section are dropped.
  1045. </para>
  1046. <para>The default value is 1, so index entries link to
  1047. section titles by default.</para>
  1048. <para>In both cases, the link text in an index entry is the
  1049. title of the section containing the indexterm.
  1050. That is because HTML does not have numbered pages.
  1051. It also provides the reader with context information
  1052. for each link.</para>
  1053. <para>This parameter lets you choose which style of
  1054. index linking you want. </para>
  1055. <itemizedlist>
  1056. <listitem>
  1057. <para>When set to 0, an index entry takes you
  1058. to the precise location of its corresponding indexterm.
  1059. However, if you have a lot of duplicate
  1060. entries in sections, then you have a lot of duplicate
  1061. titles in the index, which makes it more cluttered.
  1062. The reader may not recognize why duplicate titles
  1063. appear until they follow the links. Also, the links
  1064. may land the reader in the middle of a section where the
  1065. section title is not visible, which may also be
  1066. confusing to the reader.</para>
  1067. </listitem>
  1068. <listitem>
  1069. <para>When set to 1, an index entry link is
  1070. less precise, but duplicate titles in the
  1071. index entries are eliminated.
  1072. Landing on the section title location may confirm the reader's
  1073. expectation that a link that
  1074. shows a section title will take them to that section title,
  1075. not a location within the section.
  1076. </para>
  1077. </listitem>
  1078. </itemizedlist>
  1079. </refsection>
  1080. </refentry>
  1081. <refentry version="5.0" xml:id="index.prefer.titleabbrev">
  1082. <refmeta>
  1083. <refentrytitle>index.prefer.titleabbrev</refentrytitle>
  1084. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1085. </refmeta>
  1086. <refnamediv>
  1087. <refname>index.prefer.titleabbrev</refname>
  1088. <refpurpose>Should abbreviated titles be used as back references?</refpurpose>
  1089. </refnamediv>
  1090. <refsynopsisdiv>
  1091. <programlisting xml:id="index.prefer.titleabbrev.frag">
  1092. &lt;xsl:param name="index.prefer.titleabbrev" select="0"&gt;&lt;/xsl:param&gt;
  1093. </programlisting>
  1094. </refsynopsisdiv>
  1095. <refsection><info><title>Description</title></info>
  1096. <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
  1097. is used as the link text of a back reference in the index.
  1098. </para>
  1099. </refsection>
  1100. </refentry>
  1101. <refentry version="5.0" xml:id="index.term.separator">
  1102. <refmeta>
  1103. <refentrytitle>index.term.separator</refentrytitle>
  1104. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1105. </refmeta>
  1106. <refnamediv>
  1107. <refname>index.term.separator</refname>
  1108. <refpurpose>Override for punctuation separating an index term
  1109. from its list of page references in an index</refpurpose>
  1110. </refnamediv>
  1111. <refsynopsisdiv>
  1112. <programlisting xml:id="index.term.separator.frag">
  1113. &lt;xsl:param name="index.term.separator"&gt;&lt;/xsl:param&gt;
  1114. </programlisting>
  1115. </refsynopsisdiv>
  1116. <refsection><info><title>Description</title></info>
  1117. <para>This parameter permits you to override
  1118. the text to insert between
  1119. the end of an index term and its list of page references.
  1120. Typically that might be a comma and a space.
  1121. </para>
  1122. <para>Because this text may be locale dependent,
  1123. this parameter's value is normally taken from a gentext
  1124. template named 'term-separator' in the
  1125. context 'index' in the stylesheet
  1126. locale file for the language
  1127. of the current document.
  1128. This parameter can be used to override the gentext string,
  1129. and would typically be used on the command line.
  1130. This parameter would apply to all languages.
  1131. </para>
  1132. <para>So this text string can be customized in two ways.
  1133. You can reset the default gentext string using
  1134. the <parameter>local.l10n.xml</parameter> parameter, or you can
  1135. fill in the content for this normally empty
  1136. override parameter.
  1137. The content can be a simple string, or it can be
  1138. something more complex such as a call-template.
  1139. For fo output, it could be an <tag>fo:leader</tag>
  1140. element to provide space of a specific length, or a dot leader.
  1141. </para>
  1142. </refsection>
  1143. </refentry>
  1144. <refentry version="5.0" xml:id="index.number.separator">
  1145. <refmeta>
  1146. <refentrytitle>index.number.separator</refentrytitle>
  1147. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1148. </refmeta>
  1149. <refnamediv>
  1150. <refname>index.number.separator</refname>
  1151. <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
  1152. </refnamediv>
  1153. <refsynopsisdiv>
  1154. <programlisting xml:id="index.number.separator.frag">
  1155. &lt;xsl:param name="index.number.separator"&gt;&lt;/xsl:param&gt;
  1156. </programlisting>
  1157. </refsynopsisdiv>
  1158. <refsection><info><title>Description</title></info>
  1159. <para>This parameter permits you to override the text to insert between
  1160. page references in a formatted index entry. Typically
  1161. that would be a comma and a space.
  1162. </para>
  1163. <para>Because this text may be locale dependent,
  1164. this parameter's value is normally taken from a gentext
  1165. template named 'number-separator' in the
  1166. context 'index' in the stylesheet
  1167. locale file for the language
  1168. of the current document.
  1169. This parameter can be used to override the gentext string,
  1170. and would typically be used on the command line.
  1171. This parameter would apply to all languages.
  1172. </para>
  1173. <para>So this text string can be customized in two ways.
  1174. You can reset the default gentext string using
  1175. the <parameter>local.l10n.xml</parameter> parameter, or you can
  1176. override the gentext with the content of this parameter.
  1177. The content can be a simple string, or it can be
  1178. something more complex such as a call-template.
  1179. </para>
  1180. <para>In HTML index output, section title references are used instead of
  1181. page number references. This punctuation appears between
  1182. such section titles in an HTML index.
  1183. </para>
  1184. </refsection>
  1185. </refentry>
  1186. <refentry version="5.0" xml:id="index.range.separator">
  1187. <refmeta>
  1188. <refentrytitle>index.range.separator</refentrytitle>
  1189. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1190. </refmeta>
  1191. <refnamediv>
  1192. <refname>index.range.separator</refname>
  1193. <refpurpose>Override for punctuation separating the two numbers
  1194. in a page range in index</refpurpose>
  1195. </refnamediv>
  1196. <refsynopsisdiv>
  1197. <programlisting xml:id="index.range.separator.frag">
  1198. &lt;xsl:param name="index.range.separator"&gt;&lt;/xsl:param&gt;
  1199. </programlisting>
  1200. </refsynopsisdiv>
  1201. <refsection><info><title>Description</title></info>
  1202. <para>This parameter permits you
  1203. to override the text to insert between
  1204. the two numbers of a page range in an index.
  1205. This parameter is only used by those XSL-FO processors
  1206. that support an extension for generating such page ranges
  1207. (such as XEP).</para>
  1208. <para>Because this text may be locale dependent,
  1209. this parameter's value is normally taken from a gentext
  1210. template named 'range-separator' in the
  1211. context 'index' in the stylesheet
  1212. locale file for the language
  1213. of the current document.
  1214. This parameter can be used to override the gentext string,
  1215. and would typically be used on the command line.
  1216. This parameter would apply to all languages.
  1217. </para>
  1218. <para>So this text string can be customized in two ways.
  1219. You can reset the default gentext string using
  1220. the <parameter>local.l10n.xml</parameter> parameter, or you can
  1221. override the gentext with the content of this parameter.
  1222. The content can be a simple string, or it can be
  1223. something more complex such as a call-template.
  1224. </para>
  1225. <para>In HTML index output, section title references are used instead of
  1226. page number references. So there are no page ranges
  1227. and this parameter has no effect.
  1228. </para>
  1229. </refsection>
  1230. </refentry>
  1231. </reference>
  1232. <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title>
  1233. <refentry version="5.0" xml:id="linenumbering.everyNth">
  1234. <refmeta>
  1235. <refentrytitle>linenumbering.everyNth</refentrytitle>
  1236. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  1237. </refmeta>
  1238. <refnamediv>
  1239. <refname>linenumbering.everyNth</refname>
  1240. <refpurpose>Indicate which lines should be numbered</refpurpose>
  1241. </refnamediv>
  1242. <refsynopsisdiv>
  1243. <programlisting xml:id="linenumbering.everyNth.frag">
  1244. &lt;xsl:param name="linenumbering.everyNth"&gt;5&lt;/xsl:param&gt;
  1245. </programlisting>
  1246. </refsynopsisdiv>
  1247. <refsection><info><title>Description</title></info>
  1248. <para>If line numbering is enabled, everyNth line will be
  1249. numbered. Note that numbering is one based, not zero based.
  1250. </para>
  1251. <para>See also <parameter>linenumbering.extension</parameter>,
  1252. <parameter>linenumbering.separator</parameter>,
  1253. <parameter>linenumbering.width</parameter> and
  1254. <parameter>use.extensions</parameter></para>
  1255. </refsection>
  1256. </refentry>
  1257. <refentry version="5.0" xml:id="linenumbering.extension">
  1258. <refmeta>
  1259. <refentrytitle>linenumbering.extension</refentrytitle>
  1260. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1261. </refmeta>
  1262. <refnamediv>
  1263. <refname>linenumbering.extension</refname>
  1264. <refpurpose>Enable the line numbering extension</refpurpose>
  1265. </refnamediv>
  1266. <refsynopsisdiv>
  1267. <programlisting xml:id="linenumbering.extension.frag">
  1268. &lt;xsl:param name="linenumbering.extension" select="1"&gt;&lt;/xsl:param&gt;
  1269. </programlisting>
  1270. </refsynopsisdiv>
  1271. <refsection><info><title>Description</title></info>
  1272. <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout</tag>,
  1273. <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify line numbering will
  1274. have line numbers.
  1275. </para>
  1276. </refsection>
  1277. </refentry>
  1278. <refentry version="5.0" xml:id="linenumbering.separator">
  1279. <refmeta>
  1280. <refentrytitle>linenumbering.separator</refentrytitle>
  1281. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1282. </refmeta>
  1283. <refnamediv>
  1284. <refname>linenumbering.separator</refname>
  1285. <refpurpose>Specify a separator between line numbers and lines</refpurpose>
  1286. </refnamediv>
  1287. <refsynopsisdiv>
  1288. <programlisting xml:id="linenumbering.separator.frag">
  1289. &lt;xsl:param name="linenumbering.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;
  1290. </programlisting>
  1291. </refsynopsisdiv>
  1292. <refsection><info><title>Description</title></info>
  1293. <para>The separator is inserted between line numbers and lines in the
  1294. verbatim environment. The default value is a single white space.
  1295. Note the interaction with <parameter>linenumbering.width</parameter>
  1296. </para>
  1297. </refsection>
  1298. </refentry>
  1299. <refentry version="5.0" xml:id="linenumbering.width">
  1300. <refmeta>
  1301. <refentrytitle>linenumbering.width</refentrytitle>
  1302. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  1303. </refmeta>
  1304. <refnamediv>
  1305. <refname>linenumbering.width</refname>
  1306. <refpurpose>Indicates the width of line numbers</refpurpose>
  1307. </refnamediv>
  1308. <refsynopsisdiv>
  1309. <programlisting xml:id="linenumbering.width.frag">
  1310. &lt;xsl:param name="linenumbering.width"&gt;3&lt;/xsl:param&gt;
  1311. </programlisting>
  1312. </refsynopsisdiv>
  1313. <refsection><info><title>Description</title></info>
  1314. <para>If line numbering is enabled, line numbers will appear right
  1315. justified in a field "width" characters wide.
  1316. </para>
  1317. </refsection>
  1318. </refentry>
  1319. <refentry version="5.0" xml:id="tablecolumns.extension">
  1320. <refmeta>
  1321. <refentrytitle>tablecolumns.extension</refentrytitle>
  1322. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1323. </refmeta>
  1324. <refnamediv>
  1325. <refname>tablecolumns.extension</refname>
  1326. <refpurpose>Enable the table columns extension function</refpurpose>
  1327. </refnamediv>
  1328. <refsynopsisdiv>
  1329. <programlisting xml:id="tablecolumns.extension.frag">
  1330. &lt;xsl:param name="tablecolumns.extension" select="1"&gt;&lt;/xsl:param&gt;
  1331. </programlisting>
  1332. </refsynopsisdiv>
  1333. <refsection><info><title>Description</title></info>
  1334. <para>The table columns extension function adjusts the widths of table
  1335. columns in the HTML result to more accurately reflect the specifications
  1336. in the CALS table.
  1337. </para>
  1338. </refsection>
  1339. </refentry>
  1340. <refentry version="5.0" xml:id="textinsert.extension">
  1341. <refmeta>
  1342. <refentrytitle>textinsert.extension</refentrytitle>
  1343. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1344. </refmeta>
  1345. <refnamediv>
  1346. <refname>textinsert.extension</refname>
  1347. <refpurpose>Enables the textinsert extension element</refpurpose>
  1348. </refnamediv>
  1349. <refsynopsisdiv>
  1350. <programlisting xml:id="textinsert.extension.frag">
  1351. &lt;xsl:param name="textinsert.extension" select="1"&gt;&lt;/xsl:param&gt;
  1352. </programlisting>
  1353. </refsynopsisdiv>
  1354. <refsection><info><title>Description</title></info>
  1355. <para>The textinsert extension element inserts the contents of
  1356. a file into the result tree (as text).</para>
  1357. <note>
  1358. <para>To use the textinsert extension element, you must use
  1359. either Saxon or Xalan as your XSLT processor (it doesn&#8217;t
  1360. work with xsltproc), along with either the DocBook Saxon
  1361. extensions or DocBook Xalan extensions (for more
  1362. information about those extensions, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions">DocBook Saxon Extensions</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBook Xalan Extensions</link>), and you must set both
  1363. the <parameter>use.extensions</parameter> and
  1364. <parameter>textinsert.extension</parameter> parameters to
  1365. <literal>1</literal>.</para>
  1366. <para>As an alternative to using the textinsert element,
  1367. consider using an Xinclude element with the
  1368. <literal>parse="text"</literal> attribute and value
  1369. specified, as detailed in <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for text inclusions</link>.</para>
  1370. </note>
  1371. </refsection>
  1372. <refsection><info><title>See Also</title></info>
  1373. <para>You can also use the <tag class="xmlpi">dbhtml-include&#160;href</tag> processing
  1374. instruction to insert external files &#8212; both files containing
  1375. plain text and files with markup content (including HTML
  1376. content).</para>
  1377. </refsection>
  1378. <refsection><info><title>More information</title></info>
  1379. <para>For how-to documentation on inserting contents of
  1380. external code files and other text files into output, see
  1381. <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="ExternalCode.html">External code files</link>.</para>
  1382. <para>For guidelines on inserting contents of
  1383. HTML files into output, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link>.</para>
  1384. </refsection>
  1385. </refentry>
  1386. <refentry version="5.0" xml:id="textdata.default.encoding">
  1387. <refmeta>
  1388. <refentrytitle>textdata.default.encoding</refentrytitle>
  1389. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1390. </refmeta>
  1391. <refnamediv>
  1392. <refname>textdata.default.encoding</refname>
  1393. <refpurpose>Default encoding of external text files which are included
  1394. using textdata element</refpurpose>
  1395. </refnamediv>
  1396. <refsynopsisdiv>
  1397. <programlisting xml:id="textdata.default.encoding.frag">
  1398. &lt;xsl:param name="textdata.default.encoding"&gt;&lt;/xsl:param&gt;
  1399. </programlisting>
  1400. </refsynopsisdiv>
  1401. <refsection><info><title>Description</title></info>
  1402. <para>Specifies the encoding of any external text files included using
  1403. <tag>textdata</tag> element. This value is used only when you do
  1404. not specify encoding by the appropriate attribute
  1405. directly on textdata. An empty string is interpreted as the system
  1406. default encoding.</para>
  1407. </refsection>
  1408. </refentry>
  1409. <refentry version="5.0" xml:id="graphicsize.extension">
  1410. <refmeta>
  1411. <refentrytitle>graphicsize.extension</refentrytitle>
  1412. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1413. </refmeta>
  1414. <refnamediv>
  1415. <refname>graphicsize.extension</refname>
  1416. <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose>
  1417. </refnamediv>
  1418. <refsynopsisdiv>
  1419. <programlisting xml:id="graphicsize.extension.frag">
  1420. &lt;xsl:param name="graphicsize.extension" select="1"&gt;&lt;/xsl:param&gt;
  1421. </programlisting>
  1422. </refsynopsisdiv>
  1423. <refsection><info><title>Description</title></info>
  1424. <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero
  1425. and if you're using a processor that supports extension functions), the
  1426. <function>getWidth</function> and <function>getDepth</function> functions
  1427. will be used to extract image sizes from graphics.</para>
  1428. <para>The main supported image formats are GIF, JPEG, and PNG. Somewhat cruder
  1429. support for EPS and PDF images is also available.</para>
  1430. </refsection>
  1431. </refentry>
  1432. <refentry version="5.0" xml:id="graphicsize.use.img.src.path">
  1433. <refmeta>
  1434. <refentrytitle>graphicsize.use.img.src.path</refentrytitle>
  1435. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1436. </refmeta>
  1437. <refnamediv>
  1438. <refname>graphicsize.use.img.src.path</refname>
  1439. <refpurpose>Prepend <parameter>img.src.path</parameter> before
  1440. filenames passed to extension functions</refpurpose>
  1441. </refnamediv>
  1442. <refsynopsisdiv>
  1443. <programlisting xml:id="graphicsize.use.img.src.path.frag">
  1444. &lt;xsl:param name="graphicsize.use.img.src.path" select="0"&gt;&lt;/xsl:param&gt;
  1445. </programlisting>
  1446. </refsynopsisdiv>
  1447. <refsection><info><title>Description</title></info>
  1448. <para>If non-zero <parameter>img.src.path</parameter> parameter will
  1449. be appended before filenames passed to extension functions for
  1450. measuring image dimensions.</para>
  1451. </refsection>
  1452. </refentry>
  1453. <refentry version="5.0" xml:id="use.extensions">
  1454. <refmeta>
  1455. <refentrytitle>use.extensions</refentrytitle>
  1456. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1457. </refmeta>
  1458. <refnamediv>
  1459. <refname>use.extensions</refname>
  1460. <refpurpose>Enable extensions</refpurpose>
  1461. </refnamediv>
  1462. <refsynopsisdiv>
  1463. <programlisting xml:id="use.extensions.frag">
  1464. &lt;xsl:param name="use.extensions" select="0"&gt;&lt;/xsl:param&gt;
  1465. </programlisting>
  1466. </refsynopsisdiv>
  1467. <refsection><info><title>Description</title></info>
  1468. <para>If non-zero, extensions may be used. Each extension is
  1469. further controlled by its own parameter. But if
  1470. <parameter>use.extensions</parameter> is zero, no extensions will
  1471. be used.
  1472. </para>
  1473. </refsection>
  1474. </refentry>
  1475. </reference>
  1476. <reference xml:id="labels"><title>Automatic labelling</title>
  1477. <refentry version="5.0" xml:id="chapter.autolabel">
  1478. <refmeta>
  1479. <refentrytitle>chapter.autolabel</refentrytitle>
  1480. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  1481. <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
  1482. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  1483. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  1484. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  1485. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  1486. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  1487. </refmeta>
  1488. <refnamediv>
  1489. <refname>chapter.autolabel</refname>
  1490. <refpurpose>Specifies the labeling format for Chapter titles</refpurpose>
  1491. </refnamediv>
  1492. <refsynopsisdiv>
  1493. <programlisting xml:id="chapter.autolabel.frag">
  1494. &lt;xsl:param name="chapter.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  1495. </refsynopsisdiv>
  1496. <refsection><info><title>Description</title></info>
  1497. <para>If non-zero, then chapters will be numbered using the parameter
  1498. value as the number format if the value matches one of the following:
  1499. </para>
  1500. <variablelist>
  1501. <varlistentry>
  1502. <term>1 or arabic</term>
  1503. <listitem>
  1504. <para>Arabic numeration (1, 2, 3 ...).</para>
  1505. </listitem>
  1506. </varlistentry>
  1507. <varlistentry>
  1508. <term>A or upperalpha</term>
  1509. <listitem>
  1510. <para>Uppercase letter numeration (A, B, C ...).</para>
  1511. </listitem>
  1512. </varlistentry>
  1513. <varlistentry>
  1514. <term>a or loweralpha</term>
  1515. <listitem>
  1516. <para>Lowercase letter numeration (a, b, c ...).</para>
  1517. </listitem>
  1518. </varlistentry>
  1519. <varlistentry>
  1520. <term>I or upperroman</term>
  1521. <listitem>
  1522. <para>Uppercase roman numeration (I, II, III ...).</para>
  1523. </listitem>
  1524. </varlistentry>
  1525. <varlistentry>
  1526. <term>i or lowerroman</term>
  1527. <listitem>
  1528. <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
  1529. </listitem>
  1530. </varlistentry>
  1531. </variablelist>
  1532. <para>Any nonzero value other than the above will generate
  1533. the default number format (arabic).
  1534. </para>
  1535. </refsection>
  1536. </refentry>
  1537. <refentry version="5.0" xml:id="appendix.autolabel">
  1538. <refmeta>
  1539. <refentrytitle>appendix.autolabel</refentrytitle>
  1540. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  1541. <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
  1542. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  1543. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  1544. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  1545. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  1546. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  1547. </refmeta>
  1548. <refnamediv>
  1549. <refname>appendix.autolabel</refname>
  1550. <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
  1551. </refnamediv>
  1552. <refsynopsisdiv>
  1553. <programlisting xml:id="appendix.autolabel.frag">
  1554. &lt;xsl:param name="appendix.autolabel"&gt;A&lt;/xsl:param&gt;
  1555. </programlisting>
  1556. </refsynopsisdiv>
  1557. <refsection><info><title>Description</title></info>
  1558. <para>If non-zero, then appendices will be numbered using the
  1559. parameter value as the number format if the value matches one of the
  1560. following:
  1561. </para>
  1562. <variablelist>
  1563. <varlistentry>
  1564. <term>1 or arabic</term>
  1565. <listitem>
  1566. <para>Arabic numeration (1, 2, 3 ...).</para>
  1567. </listitem>
  1568. </varlistentry>
  1569. <varlistentry>
  1570. <term>A or upperalpha</term>
  1571. <listitem>
  1572. <para>Uppercase letter numeration (A, B, C ...).</para>
  1573. </listitem>
  1574. </varlistentry>
  1575. <varlistentry>
  1576. <term>a or loweralpha</term>
  1577. <listitem>
  1578. <para>Lowercase letter numeration (a, b, c ...).</para>
  1579. </listitem>
  1580. </varlistentry>
  1581. <varlistentry>
  1582. <term>I or upperroman</term>
  1583. <listitem>
  1584. <para>Uppercase roman numeration (I, II, III ...).</para>
  1585. </listitem>
  1586. </varlistentry>
  1587. <varlistentry>
  1588. <term>i or lowerroman</term>
  1589. <listitem>
  1590. <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
  1591. </listitem>
  1592. </varlistentry>
  1593. </variablelist>
  1594. <para>Any nonzero value other than the above will generate
  1595. the default number format (upperalpha).
  1596. </para>
  1597. </refsection>
  1598. </refentry>
  1599. <refentry version="5.0" xml:id="part.autolabel">
  1600. <refmeta>
  1601. <refentrytitle>part.autolabel</refentrytitle>
  1602. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  1603. <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
  1604. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  1605. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  1606. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  1607. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  1608. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  1609. </refmeta>
  1610. <refnamediv>
  1611. <refname>part.autolabel</refname>
  1612. <refpurpose>Specifies the labeling format for Part titles</refpurpose>
  1613. </refnamediv>
  1614. <refsynopsisdiv>
  1615. <programlisting xml:id="part.autolabel.frag">
  1616. &lt;xsl:param name="part.autolabel"&gt;I&lt;/xsl:param&gt;
  1617. </programlisting>
  1618. </refsynopsisdiv>
  1619. <refsection><info><title>Description</title></info>
  1620. <para>If non-zero, then parts will be numbered using the parameter
  1621. value as the number format if the value matches one of the following:
  1622. </para>
  1623. <variablelist>
  1624. <varlistentry>
  1625. <term>1 or arabic</term>
  1626. <listitem>
  1627. <para>Arabic numeration (1, 2, 3 ...).</para>
  1628. </listitem>
  1629. </varlistentry>
  1630. <varlistentry>
  1631. <term>A or upperalpha</term>
  1632. <listitem>
  1633. <para>Uppercase letter numeration (A, B, C ...).</para>
  1634. </listitem>
  1635. </varlistentry>
  1636. <varlistentry>
  1637. <term>a or loweralpha</term>
  1638. <listitem>
  1639. <para>Lowercase letter numeration (a, b, c ...).</para>
  1640. </listitem>
  1641. </varlistentry>
  1642. <varlistentry>
  1643. <term>I or upperroman</term>
  1644. <listitem>
  1645. <para>Uppercase roman numeration (I, II, III ...).</para>
  1646. </listitem>
  1647. </varlistentry>
  1648. <varlistentry>
  1649. <term>i or lowerroman</term>
  1650. <listitem>
  1651. <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
  1652. </listitem>
  1653. </varlistentry>
  1654. </variablelist>
  1655. <para>Any nonzero value other than the above will generate
  1656. the default number format (upperroman).
  1657. </para>
  1658. </refsection>
  1659. </refentry>
  1660. <refentry version="5.0" xml:id="reference.autolabel">
  1661. <refmeta>
  1662. <refentrytitle>reference.autolabel</refentrytitle>
  1663. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  1664. <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
  1665. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  1666. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  1667. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  1668. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  1669. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  1670. </refmeta>
  1671. <refnamediv>
  1672. <refname>reference.autolabel</refname>
  1673. <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
  1674. </refnamediv>
  1675. <refsynopsisdiv>
  1676. <programlisting xml:id="reference.autolabel.frag">
  1677. &lt;xsl:param name="reference.autolabel"&gt;I&lt;/xsl:param&gt;
  1678. </programlisting>
  1679. </refsynopsisdiv>
  1680. <refsection><info><title>Description</title></info>
  1681. <para>If non-zero, references will be numbered using the parameter
  1682. value as the number format if the value matches one of the
  1683. following:
  1684. </para>
  1685. <variablelist>
  1686. <varlistentry>
  1687. <term>1 or arabic</term>
  1688. <listitem>
  1689. <para>Arabic numeration (1, 2, 3 ...).</para>
  1690. </listitem>
  1691. </varlistentry>
  1692. <varlistentry>
  1693. <term>A or upperalpha</term>
  1694. <listitem>
  1695. <para>Uppercase letter numeration (A, B, C ...).</para>
  1696. </listitem>
  1697. </varlistentry>
  1698. <varlistentry>
  1699. <term>a or loweralpha</term>
  1700. <listitem>
  1701. <para>Lowercase letter numeration (a, b, c ...).</para>
  1702. </listitem>
  1703. </varlistentry>
  1704. <varlistentry>
  1705. <term>I or upperroman</term>
  1706. <listitem>
  1707. <para>Uppercase roman numeration (I, II, III ...).</para>
  1708. </listitem>
  1709. </varlistentry>
  1710. <varlistentry>
  1711. <term>i or lowerroman</term>
  1712. <listitem>
  1713. <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
  1714. </listitem>
  1715. </varlistentry>
  1716. </variablelist>
  1717. <para>Any non-zero value other than the above will generate
  1718. the default number format (upperroman).
  1719. </para>
  1720. </refsection>
  1721. </refentry>
  1722. <refentry version="5.0" xml:id="preface.autolabel">
  1723. <refmeta>
  1724. <refentrytitle>preface.autolabel</refentrytitle>
  1725. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  1726. <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
  1727. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  1728. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  1729. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  1730. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  1731. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  1732. </refmeta>
  1733. <refnamediv>
  1734. <refname>preface.autolabel</refname>
  1735. <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
  1736. </refnamediv>
  1737. <refsynopsisdiv>
  1738. <programlisting xml:id="preface.autolabel.frag">&lt;xsl:param name="preface.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  1739. </refsynopsisdiv>
  1740. <refsection><info><title>Description</title></info>
  1741. <para>If non-zero then prefaces will be numbered using the parameter
  1742. value as the number format if the value matches one of the following:
  1743. </para>
  1744. <variablelist>
  1745. <varlistentry>
  1746. <term>1 or arabic</term>
  1747. <listitem>
  1748. <para>Arabic numeration (1, 2, 3 ...).</para>
  1749. </listitem>
  1750. </varlistentry>
  1751. <varlistentry>
  1752. <term>A or upperalpha</term>
  1753. <listitem>
  1754. <para>Uppercase letter numeration (A, B, C ...).</para>
  1755. </listitem>
  1756. </varlistentry>
  1757. <varlistentry>
  1758. <term>a or loweralpha</term>
  1759. <listitem>
  1760. <para>Lowercase letter numeration (a, b, c ...).</para>
  1761. </listitem>
  1762. </varlistentry>
  1763. <varlistentry>
  1764. <term>I or upperroman</term>
  1765. <listitem>
  1766. <para>Uppercase roman numeration (I, II, III ...).</para>
  1767. </listitem>
  1768. </varlistentry>
  1769. <varlistentry>
  1770. <term>i or lowerroman</term>
  1771. <listitem>
  1772. <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
  1773. </listitem>
  1774. </varlistentry>
  1775. </variablelist>
  1776. <para>Any nonzero value other than the above will generate
  1777. the default number format (arabic).
  1778. </para>
  1779. </refsection>
  1780. </refentry>
  1781. <refentry version="5.0" xml:id="qandadiv.autolabel">
  1782. <refmeta>
  1783. <refentrytitle>qandadiv.autolabel</refentrytitle>
  1784. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1785. </refmeta>
  1786. <refnamediv>
  1787. <refname>qandadiv.autolabel</refname>
  1788. <refpurpose>Are divisions in QAndASets enumerated?</refpurpose>
  1789. </refnamediv>
  1790. <refsynopsisdiv>
  1791. <programlisting xml:id="qandadiv.autolabel.frag">&lt;xsl:param name="qandadiv.autolabel" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  1792. </refsynopsisdiv>
  1793. <refsection><info><title>Description</title></info>
  1794. <para>If non-zero, unlabeled qandadivs will be enumerated.
  1795. </para>
  1796. </refsection>
  1797. </refentry>
  1798. <refentry version="5.0" xml:id="section.autolabel">
  1799. <refmeta>
  1800. <refentrytitle>section.autolabel</refentrytitle>
  1801. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1802. </refmeta>
  1803. <refnamediv>
  1804. <refname>section.autolabel</refname>
  1805. <refpurpose>Are sections enumerated?</refpurpose>
  1806. </refnamediv>
  1807. <refsynopsisdiv>
  1808. <programlisting xml:id="section.autolabel.frag">&lt;xsl:param name="section.autolabel" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  1809. </refsynopsisdiv>
  1810. <refsection><info><title>Description</title></info>
  1811. <para>If true (non-zero), unlabeled sections will be enumerated.
  1812. </para>
  1813. </refsection>
  1814. </refentry>
  1815. <refentry version="5.0" xml:id="section.autolabel.max.depth">
  1816. <refmeta>
  1817. <refentrytitle>section.autolabel.max.depth</refentrytitle>
  1818. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  1819. </refmeta>
  1820. <refnamediv>
  1821. <refname>section.autolabel.max.depth</refname>
  1822. <refpurpose>The deepest level of sections that are numbered.</refpurpose>
  1823. </refnamediv>
  1824. <refsynopsisdiv>
  1825. <programlisting xml:id="section.autolabel.max.depth.frag">
  1826. &lt;xsl:param name="section.autolabel.max.depth"&gt;8&lt;/xsl:param&gt;
  1827. </programlisting>
  1828. </refsynopsisdiv>
  1829. <refsection><info><title>Description</title></info>
  1830. <para>When section numbering is turned on by the
  1831. <parameter>section.autolabel</parameter> parameter, then this
  1832. parameter controls the depth of <tag>section</tag> nesting that is
  1833. numbered. Sections nested to a level deeper than this value will not
  1834. be numbered.
  1835. </para>
  1836. </refsection>
  1837. </refentry>
  1838. <refentry version="5.0" xml:id="section.label.includes.component.label">
  1839. <refmeta>
  1840. <refentrytitle>section.label.includes.component.label</refentrytitle>
  1841. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1842. </refmeta>
  1843. <refnamediv>
  1844. <refname>section.label.includes.component.label</refname>
  1845. <refpurpose>Do section labels include the component label?</refpurpose>
  1846. </refnamediv>
  1847. <refsynopsisdiv>
  1848. <programlisting xml:id="section.label.includes.component.label.frag">&lt;xsl:param name="section.label.includes.component.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  1849. </refsynopsisdiv>
  1850. <refsection><info><title>Description</title></info>
  1851. <para>If non-zero, section labels are prefixed with the label of the
  1852. component that contains them.
  1853. </para>
  1854. </refsection>
  1855. </refentry>
  1856. <refentry version="5.0" xml:id="label.from.part">
  1857. <refmeta>
  1858. <refentrytitle>label.from.part</refentrytitle>
  1859. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1860. </refmeta>
  1861. <refnamediv>
  1862. <refname>label.from.part</refname>
  1863. <refpurpose>Renumber components in each part?</refpurpose>
  1864. </refnamediv>
  1865. <refsynopsisdiv>
  1866. <programlisting xml:id="label.from.part.frag">
  1867. &lt;xsl:param name="label.from.part" select="0"&gt;&lt;/xsl:param&gt;
  1868. </programlisting>
  1869. </refsynopsisdiv>
  1870. <refsection><info><title>Description</title></info>
  1871. <para>If <parameter>label.from.part</parameter> is non-zero, then
  1872. numbering of components &#8212; <tag>preface</tag>,
  1873. <tag>chapter</tag>, <tag>appendix</tag>, and
  1874. <tag>reference</tag> (when <tag>reference</tag> occurs at the
  1875. component level) &#8212; is re-started within each
  1876. <tag>part</tag>.</para>
  1877. <para>If <parameter>label.from.part</parameter> is zero (the
  1878. default), numbering of components is <emphasis>not</emphasis>
  1879. re-started within each <tag>part</tag>; instead, components are
  1880. numbered sequentially throughout each <tag>book</tag>,
  1881. regardless of whether or not they occur within <tag>part</tag>
  1882. instances.</para>
  1883. </refsection>
  1884. </refentry>
  1885. <refentry version="5.0" xml:id="component.label.includes.part.label">
  1886. <refmeta>
  1887. <refentrytitle>component.label.includes.part.label</refentrytitle>
  1888. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1889. </refmeta>
  1890. <refnamediv>
  1891. <refname>component.label.includes.part.label</refname>
  1892. <refpurpose>Do component labels include the part label?</refpurpose>
  1893. </refnamediv>
  1894. <refsynopsisdiv>
  1895. <programlisting xml:id="component.label.includes.part.label.frag">&lt;xsl:param name="component.label.includes.part.label" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  1896. </refsynopsisdiv>
  1897. <refsection><info><title>Description</title></info>
  1898. <para>If non-zero, number labels for <tag>chapter</tag>,
  1899. <tag>appendix</tag>, and other component elements are prefixed with
  1900. the label of the part element that contains them. So you might see
  1901. Chapter II.3 instead of Chapter 3. Also, the labels for formal
  1902. elements such as <tag>table</tag> and <tag>figure</tag> will include
  1903. the part label. If there is no part element container, then no prefix
  1904. is generated.
  1905. </para>
  1906. <para>
  1907. This feature is most useful when the
  1908. <parameter>label.from.part</parameter> parameter is turned on.
  1909. In that case, there would be more than one <tag>chapter</tag>
  1910. <quote>1</quote>, and the extra part label prefix will identify
  1911. each chapter unambiguously.
  1912. </para>
  1913. </refsection>
  1914. </refentry>
  1915. </reference>
  1916. <reference xml:id="html"><title>HTML</title>
  1917. <refentry version="5.0" xml:id="html.base">
  1918. <refmeta>
  1919. <refentrytitle>html.base</refentrytitle>
  1920. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  1921. </refmeta>
  1922. <refnamediv>
  1923. <refname>html.base</refname>
  1924. <refpurpose>An HTML base URI</refpurpose>
  1925. </refnamediv>
  1926. <refsynopsisdiv>
  1927. <programlisting xml:id="html.base.frag">
  1928. &lt;xsl:param name="html.base"&gt;&lt;/xsl:param&gt;</programlisting>
  1929. </refsynopsisdiv>
  1930. <refsection><info><title>Description</title></info>
  1931. <para>If html.base is set, it is used for the <tag>base</tag> element
  1932. in the <tag>head</tag> of the html documents. The parameter specifies
  1933. the base URL for all relative URLs in the document. This is useful
  1934. for dynamically served html where the base URI needs to be
  1935. shifted.</para>
  1936. </refsection>
  1937. </refentry>
  1938. <refentry version="5.0" xml:id="html.stylesheet">
  1939. <refmeta>
  1940. <refentrytitle>html.stylesheet</refentrytitle>
  1941. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1942. </refmeta>
  1943. <refnamediv>
  1944. <refname>html.stylesheet</refname>
  1945. <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose>
  1946. </refnamediv>
  1947. <refsynopsisdiv>
  1948. <programlisting xml:id="html.stylesheet.frag">
  1949. &lt;xsl:param name="html.stylesheet"&gt;&lt;/xsl:param&gt;
  1950. </programlisting>
  1951. </refsynopsisdiv>
  1952. <refsection><info><title>Description</title></info>
  1953. <para>The <parameter>html.stylesheet</parameter> parameter is either
  1954. empty, indicating that no stylesheet <tag>link</tag> tag should be
  1955. generated in the html output, or it is a list of one or more
  1956. stylesheet files.</para>
  1957. <para>Multiple stylesheets are space-delimited. If you need to
  1958. reference a stylesheet URI that includes a space, encode it with
  1959. <literal>%20</literal>. A separate html <literal>link</literal> element will
  1960. be generated for each stylesheet in the order they are listed in the
  1961. parameter.</para>
  1962. </refsection>
  1963. </refentry>
  1964. <refentry version="5.0" xml:id="html.stylesheet.type">
  1965. <refmeta>
  1966. <refentrytitle>html.stylesheet.type</refentrytitle>
  1967. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  1968. </refmeta>
  1969. <refnamediv>
  1970. <refname>html.stylesheet.type</refname>
  1971. <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose>
  1972. </refnamediv>
  1973. <refsynopsisdiv>
  1974. <programlisting xml:id="html.stylesheet.type.frag">&lt;xsl:param name="html.stylesheet.type"&gt;text/css&lt;/xsl:param&gt;</programlisting>
  1975. </refsynopsisdiv>
  1976. <refsection><info><title>Description</title></info>
  1977. <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag.
  1978. </para>
  1979. </refsection>
  1980. </refentry>
  1981. <refentry version="5.0" xml:id="css.decoration">
  1982. <refmeta>
  1983. <refentrytitle>css.decoration</refentrytitle>
  1984. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  1985. </refmeta>
  1986. <refnamediv>
  1987. <refname>css.decoration</refname>
  1988. <refpurpose>Enable CSS decoration of elements</refpurpose>
  1989. </refnamediv>
  1990. <refsynopsisdiv>
  1991. <programlisting xml:id="css.decoration.frag">
  1992. &lt;xsl:param name="css.decoration" select="1"&gt;&lt;/xsl:param&gt;
  1993. </programlisting>
  1994. </refsynopsisdiv>
  1995. <refsection><info><title>Description</title></info>
  1996. <para>
  1997. If non-zero, then html elements produced by the stylesheet may be
  1998. decorated with <literal>style</literal> attributes. For example, the
  1999. <literal>li</literal> tags produced for list items may include a
  2000. fragment of CSS in the <literal>style</literal> attribute which sets
  2001. the CSS property "list-style-type".
  2002. </para>
  2003. </refsection>
  2004. </refentry>
  2005. <refentry version="5.0" xml:id="html.script">
  2006. <refmeta>
  2007. <refentrytitle>html.script</refentrytitle>
  2008. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2009. </refmeta>
  2010. <refnamediv>
  2011. <refname>html.script</refname>
  2012. <refpurpose>Name of the script(s) to use in the generated HTML</refpurpose>
  2013. </refnamediv>
  2014. <refsynopsisdiv>
  2015. <programlisting xml:id="html.script.frag">
  2016. &lt;xsl:param name="html.script"&gt;&lt;/xsl:param&gt;
  2017. </programlisting>
  2018. </refsynopsisdiv>
  2019. <refsection><info><title>Description</title></info>
  2020. <para>The <parameter>html.script</parameter> parameter is either
  2021. empty (default), indicating that no <tag>script</tag> element should be
  2022. generated in the html output, or it is a list of one or more
  2023. script locations.</para>
  2024. <para>Multiple script locations are space-delimited. If you need to
  2025. reference a script URI that includes a space, encode it with
  2026. <literal>%20</literal>. A separate html <literal>script</literal> element will
  2027. be generated for each script in the order they are listed in the
  2028. parameter.</para>
  2029. </refsection>
  2030. </refentry>
  2031. <refentry version="5.0" xml:id="html.script.type">
  2032. <refmeta>
  2033. <refentrytitle>html.script.type</refentrytitle>
  2034. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2035. </refmeta>
  2036. <refnamediv>
  2037. <refname>html.script.type</refname>
  2038. <refpurpose>The type of script used in the generated HTML</refpurpose>
  2039. </refnamediv>
  2040. <refsynopsisdiv>
  2041. <programlisting xml:id="html.script.type.frag">&lt;xsl:param name="html.script.type"&gt;text/javascript&lt;/xsl:param&gt;</programlisting>
  2042. </refsynopsisdiv>
  2043. <refsection><info><title>Description</title></info>
  2044. <para>The type of script to place in the HTML <tag>script</tag> element.
  2045. Specifically, the value of the <tag>script</tag> element's <tag>type</tag>
  2046. attribute.
  2047. The default value is <literal>text/javascript</literal>.
  2048. This param is used only when the stylesheet parameter
  2049. <tag>html.script</tag> is non-blank and specifies the location of a script.</para>
  2050. </refsection>
  2051. </refentry>
  2052. <refentry version="5.0" xml:id="spacing.paras">
  2053. <refmeta>
  2054. <refentrytitle>spacing.paras</refentrytitle>
  2055. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2056. </refmeta>
  2057. <refnamediv>
  2058. <refname>spacing.paras</refname>
  2059. <refpurpose>Insert additional &lt;p&gt; elements for spacing?</refpurpose>
  2060. </refnamediv>
  2061. <refsynopsisdiv>
  2062. <programlisting xml:id="spacing.paras.frag">
  2063. &lt;xsl:param name="spacing.paras" select="0"&gt;&lt;/xsl:param&gt;
  2064. </programlisting>
  2065. </refsynopsisdiv>
  2066. <refsection><info><title>Description</title></info>
  2067. <para>When non-zero, additional, empty paragraphs are inserted in
  2068. several contexts (for example, around informal figures), to create a
  2069. more pleasing visual appearance in many browsers.
  2070. </para>
  2071. </refsection>
  2072. </refentry>
  2073. <refentry version="5.0" xml:id="emphasis.propagates.style">
  2074. <refmeta>
  2075. <refentrytitle>emphasis.propagates.style</refentrytitle>
  2076. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2077. </refmeta>
  2078. <refnamediv>
  2079. <refname>emphasis.propagates.style</refname>
  2080. <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose>
  2081. </refnamediv>
  2082. <refsynopsisdiv>
  2083. <programlisting xml:id="emphasis.propagates.style.frag">
  2084. &lt;xsl:param name="emphasis.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
  2085. </programlisting>
  2086. </refsynopsisdiv>
  2087. <refsection><info><title>Description</title></info>
  2088. <para>If non-zero, the <literal>role</literal> attribute of
  2089. <tag>emphasis</tag> elements will be passed through to the HTML as a
  2090. class attribute on a <literal>span</literal> that surrounds the
  2091. emphasis.</para>
  2092. </refsection>
  2093. </refentry>
  2094. <refentry version="5.0" xml:id="para.propagates.style">
  2095. <refmeta>
  2096. <refentrytitle>para.propagates.style</refentrytitle>
  2097. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2098. </refmeta>
  2099. <refnamediv>
  2100. <refname>para.propagates.style</refname>
  2101. <refpurpose>Pass para role attribute through to HTML?</refpurpose>
  2102. </refnamediv>
  2103. <refsynopsisdiv>
  2104. <programlisting xml:id="para.propagates.style.frag">
  2105. &lt;xsl:param name="para.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
  2106. </programlisting>
  2107. </refsynopsisdiv>
  2108. <refsection><info><title>Description</title></info>
  2109. <para>If true, the role attribute of <tag>para</tag> elements
  2110. will be passed through to the HTML as a class attribute on the
  2111. <tag>p</tag> generated for the paragraph.</para>
  2112. </refsection>
  2113. </refentry>
  2114. <refentry version="5.0" xml:id="phrase.propagates.style">
  2115. <refmeta>
  2116. <refentrytitle>phrase.propagates.style</refentrytitle>
  2117. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2118. </refmeta>
  2119. <refnamediv>
  2120. <refname>phrase.propagates.style</refname>
  2121. <refpurpose>Pass phrase role attribute through to HTML?</refpurpose>
  2122. </refnamediv>
  2123. <refsynopsisdiv>
  2124. <programlisting xml:id="phrase.propagates.style.frag">
  2125. &lt;xsl:param name="phrase.propagates.style" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  2126. </refsynopsisdiv>
  2127. <refsection><info><title>Description</title></info>
  2128. <para>If non-zero, the role attribute of <tag>phrase</tag> elements
  2129. will be passed through to the HTML as a <literal>class</literal>
  2130. attribute on a <literal>span</literal> that surrounds the
  2131. phrase.</para>
  2132. </refsection>
  2133. </refentry>
  2134. <refentry version="5.0" xml:id="entry.propagates.style">
  2135. <refmeta>
  2136. <refentrytitle>entry.propagates.style</refentrytitle>
  2137. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2138. </refmeta>
  2139. <refnamediv>
  2140. <refname>entry.propagates.style</refname>
  2141. <refpurpose>Pass entry role attribute through to HTML?</refpurpose>
  2142. </refnamediv>
  2143. <refsynopsisdiv>
  2144. <programlisting xml:id="entry.propagates.style.frag">
  2145. &lt;xsl:param name="entry.propagates.style" select="1"&gt;&lt;/xsl:param&gt;
  2146. </programlisting>
  2147. </refsynopsisdiv>
  2148. <refsection><info><title>Description</title></info>
  2149. <para>If true, the role attribute of <tag>entry</tag> elements
  2150. will be passed through to the HTML as a class attribute on the
  2151. <tag>td</tag> or <tag>th</tag> generated for the table
  2152. cell.</para>
  2153. </refsection>
  2154. </refentry>
  2155. <refentry version="5.0" xml:id="html.longdesc">
  2156. <refmeta>
  2157. <refentrytitle>html.longdesc</refentrytitle>
  2158. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2159. </refmeta>
  2160. <refnamediv>
  2161. <refname>html.longdesc</refname>
  2162. <refpurpose>Should longdesc URIs be created?</refpurpose>
  2163. </refnamediv>
  2164. <refsynopsisdiv>
  2165. <programlisting xml:id="html.longdesc.frag">
  2166. &lt;xsl:param name="html.longdesc" select="1"&gt;&lt;/xsl:param&gt;
  2167. </programlisting>
  2168. </refsynopsisdiv>
  2169. <refsection><info><title>Description</title></info>
  2170. <para>If non-zero, HTML files will be created for the
  2171. <literal>longdesc</literal> attribute. These files
  2172. are created from the <tag>textobject</tag>s in
  2173. <tag>mediaobject</tag>s and
  2174. <tag>inlinemediaobject</tag>.
  2175. </para>
  2176. </refsection>
  2177. </refentry>
  2178. <refentry version="5.0" xml:id="html.longdesc.link">
  2179. <refmeta>
  2180. <refentrytitle>html.longdesc.link</refentrytitle>
  2181. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2182. </refmeta>
  2183. <refnamediv>
  2184. <refname>html.longdesc.link</refname>
  2185. <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose>
  2186. </refnamediv>
  2187. <refsynopsisdiv>
  2188. <programlisting xml:id="html.longdesc.link.frag">
  2189. &lt;xsl:param name="html.longdesc.link" select="$html.longdesc"&gt;&lt;/xsl:param&gt;
  2190. </programlisting>
  2191. </refsynopsisdiv>
  2192. <refsection><info><title>Description</title></info>
  2193. <para>If non-zero, links will be created to the
  2194. HTML files created for the
  2195. <literal>longdesc</literal> attribute. It makes no
  2196. sense to enable this option without also enabling the
  2197. <parameter>html.longdesc</parameter> parameter.</para>
  2198. </refsection>
  2199. </refentry>
  2200. <refentry version="5.0" xml:id="make.valid.html">
  2201. <refmeta>
  2202. <refentrytitle>make.valid.html</refentrytitle>
  2203. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2204. </refmeta>
  2205. <refnamediv>
  2206. <refname>make.valid.html</refname>
  2207. <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose>
  2208. </refnamediv>
  2209. <refsynopsisdiv>
  2210. <programlisting xml:id="make.valid.html.frag">
  2211. &lt;xsl:param name="make.valid.html" select="0"&gt;&lt;/xsl:param&gt;
  2212. </programlisting>
  2213. </refsynopsisdiv>
  2214. <refsection><info><title>Description</title></info>
  2215. <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take
  2216. extra effort to ensure that the resulting HTML is valid. This may mean that some
  2217. <tag>para</tag> tags are translated into HTML <tag>div</tag>s or
  2218. that other substitutions occur.</para>
  2219. <para>This parameter is different from <parameter>html.cleanup</parameter>
  2220. because it changes the resulting markup; it does not use extension functions
  2221. to manipulate result-tree-fragments and is therefore applicable to any
  2222. XSLT processor.</para>
  2223. </refsection>
  2224. </refentry>
  2225. <refentry version="5.0" xml:id="html.cleanup">
  2226. <refmeta>
  2227. <refentrytitle>html.cleanup</refentrytitle>
  2228. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2229. </refmeta>
  2230. <refnamediv>
  2231. <refname>html.cleanup</refname>
  2232. <refpurpose>Attempt to clean up the resulting HTML?</refpurpose>
  2233. </refnamediv>
  2234. <refsynopsisdiv>
  2235. <programlisting xml:id="html.cleanup.frag">
  2236. &lt;xsl:param name="html.cleanup" select="1"&gt;&lt;/xsl:param&gt;
  2237. </programlisting>
  2238. </refsynopsisdiv>
  2239. <refsection><info><title>Description</title></info>
  2240. <para>If non-zero, and if the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.exslt.org/">EXSLT</link>
  2241. extensions are supported by your processor, the resulting HTML will be
  2242. <quote>cleaned up</quote>. This improves the chances that the
  2243. resulting HTML will be valid. It may also improve the formatting of
  2244. some elements.</para>
  2245. <para>This parameter is different from <parameter>make.valid.html</parameter>
  2246. because it uses extension functions to manipulate result-tree-fragments.</para>
  2247. </refsection>
  2248. </refentry>
  2249. <refentry version="5.0" xml:id="html.append">
  2250. <refmeta>
  2251. <refentrytitle>html.append</refentrytitle>
  2252. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2253. </refmeta>
  2254. <refnamediv>
  2255. <refname>html.append</refname>
  2256. <refpurpose>Specifies content to append to HTML output</refpurpose>
  2257. </refnamediv>
  2258. <refsynopsisdiv>
  2259. <programlisting xml:id="html.append.frag">&lt;xsl:param name="html.append"&gt;&lt;/xsl:param&gt;</programlisting>
  2260. </refsynopsisdiv>
  2261. <refsection><info><title>Description</title></info>
  2262. <para>Specifies content to append to the end of HTML files output by
  2263. the <filename>html/docbook.xsl</filename> stylesheet, after the
  2264. closing <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any
  2265. value for this parameter; but if you do, the only value it should ever
  2266. be set to is a newline character: <code>&amp;#x0a;</code> or
  2267. <code>&amp;#10;</code></para>
  2268. </refsection>
  2269. </refentry>
  2270. <refentry version="5.0" xml:id="draft.mode">
  2271. <refmeta>
  2272. <refentrytitle>draft.mode</refentrytitle>
  2273. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  2274. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  2275. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  2276. <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
  2277. </refmeta>
  2278. <refnamediv>
  2279. <refname>draft.mode</refname>
  2280. <refpurpose>Select draft mode</refpurpose>
  2281. </refnamediv>
  2282. <refsynopsisdiv>
  2283. <programlisting xml:id="draft.mode.frag">
  2284. &lt;xsl:param name="draft.mode"&gt;no&lt;/xsl:param&gt;
  2285. </programlisting>
  2286. </refsynopsisdiv>
  2287. <refsection><info><title>Description</title></info>
  2288. <para>Selects draft mode. If <parameter>draft.mode</parameter> is
  2289. <quote><literal>yes</literal></quote>, the entire document will be treated
  2290. as a draft. If it is <quote><literal>no</literal></quote>, the entire document
  2291. will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
  2292. individual sections will be treated as draft or final independently, depending
  2293. on how their <literal>status</literal> attribute is set.
  2294. </para>
  2295. </refsection>
  2296. </refentry>
  2297. <refentry version="5.0" xml:id="draft.watermark.image">
  2298. <refmeta>
  2299. <refentrytitle>draft.watermark.image</refentrytitle>
  2300. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  2301. </refmeta>
  2302. <refnamediv>
  2303. <refname>draft.watermark.image</refname>
  2304. <refpurpose>The URI of the image to be used for draft watermarks</refpurpose>
  2305. </refnamediv>
  2306. <refsynopsisdiv>
  2307. <programlisting xml:id="draft.watermark.image.frag">
  2308. &lt;xsl:param name="draft.watermark.image"&gt;images/draft.png&lt;/xsl:param&gt;
  2309. </programlisting>
  2310. </refsynopsisdiv>
  2311. <refsection><info><title>Description</title></info>
  2312. <para>The image to be used for draft watermarks.</para>
  2313. </refsection>
  2314. </refentry>
  2315. <refentry version="5.0" xml:id="generate.id.attributes">
  2316. <refmeta>
  2317. <refentrytitle>generate.id.attributes</refentrytitle>
  2318. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2319. </refmeta>
  2320. <refnamediv>
  2321. <refname>generate.id.attributes</refname>
  2322. <refpurpose>Generate ID attributes on container elements?</refpurpose>
  2323. </refnamediv>
  2324. <refsynopsisdiv>
  2325. <programlisting xml:id="generate.id.attributes.frag">
  2326. &lt;xsl:param name="generate.id.attributes" select="0"&gt;&lt;/xsl:param&gt;
  2327. </programlisting>
  2328. </refsynopsisdiv>
  2329. <refsection><info><title>Description</title></info>
  2330. <para>If non-zero, the HTML stylesheet will generate ID attributes on
  2331. containers. For example, the markup:</para>
  2332. <screen>&lt;section id="foo"&gt;&lt;title&gt;Some Title&lt;/title&gt;
  2333. &lt;para&gt;Some para.&lt;/para&gt;
  2334. &lt;/section&gt;</screen>
  2335. <para>might produce:</para>
  2336. <screen>&lt;div class="section" id="foo"&gt;
  2337. &lt;h2&gt;Some Title&lt;/h2&gt;
  2338. &lt;p&gt;Some para.&lt;/p&gt;
  2339. &lt;/div&gt;</screen>
  2340. <para>The alternative is to generate anchors:</para>
  2341. <screen>&lt;div class="section"&gt;
  2342. &lt;h2&gt;&lt;a name="foo"&gt;&lt;/a&gt;Some Title&lt;/h2&gt;
  2343. &lt;p&gt;Some para.&lt;/p&gt;
  2344. &lt;/div&gt;</screen>
  2345. <para>Because the <tag class="attribute">name</tag> attribute of
  2346. the <tag>a</tag> element and the <tag class="attribute">id</tag>
  2347. attribute of other tags are both of type <quote>ID</quote>, producing both
  2348. generates invalid documents.</para>
  2349. <para>As of version 1.50, you can use this switch to control which type of
  2350. identifier is generated. For backwards-compatibility, generating
  2351. <tag>a</tag> anchors is preferred.</para>
  2352. <para>Note: at present, this switch is incompletely implemented.
  2353. Disabling ID attributes will suppress them, but enabling ID attributes
  2354. will not suppress the anchors.</para>
  2355. </refsection>
  2356. </refentry>
  2357. <refentry version="5.0" xml:id="generate.consistent.ids">
  2358. <refmeta>
  2359. <refentrytitle>generate.consistent.ids</refentrytitle>
  2360. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2361. </refmeta>
  2362. <refnamediv>
  2363. <refname>generate.consistent.ids</refname>
  2364. <refpurpose>Generate consistent id values if document is unchanged</refpurpose>
  2365. </refnamediv>
  2366. <refsynopsisdiv>
  2367. <programlisting xml:id="generate.consistent.ids.frag">
  2368. &lt;xsl:param name="generate.consistent.ids" select="0"&gt;&lt;/xsl:param&gt;
  2369. </programlisting>
  2370. </refsynopsisdiv>
  2371. <refsection><info><title>Description</title></info>
  2372. <para>When the stylesheet assigns an id value to an output element,
  2373. the generate-id() function may be used. That function may not
  2374. produce consistent values between runs. Version control
  2375. systems may misidentify the changing id values as changes
  2376. to the document.</para>
  2377. <para>If you set this parameter's value to 1, then the
  2378. template named <literal>object.id</literal> will replace
  2379. the use of the function generate-id() with
  2380. <literal>&lt;xsl:number level="multiple" count="*"/&gt;</literal>.
  2381. This counts preceding elements to generate a unique number for
  2382. the id value.</para>
  2383. <caution>
  2384. <para>This param does not associate permanent unique id values
  2385. with particular elements.
  2386. The id values are consistent only as long as the document
  2387. structure does not change.
  2388. If the document structure changes, then the counting
  2389. of elements changes, and all id values after
  2390. the first such change may be different, even when there is
  2391. no change to the element itself or its output.
  2392. </para>
  2393. </caution>
  2394. <para>The default value of this parameter is zero, so generate-id() is used
  2395. by default.</para>
  2396. </refsection>
  2397. </refentry>
  2398. <refentry version="5.0" xml:id="generate.meta.abstract">
  2399. <refmeta>
  2400. <refentrytitle>generate.meta.abstract</refentrytitle>
  2401. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2402. </refmeta>
  2403. <refnamediv>
  2404. <refname>generate.meta.abstract</refname>
  2405. <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</refpurpose>
  2406. </refnamediv>
  2407. <refsynopsisdiv>
  2408. <programlisting xml:id="generate.meta.abstract.frag">
  2409. &lt;xsl:param name="generate.meta.abstract" select="1"&gt;&lt;/xsl:param&gt;
  2410. </programlisting>
  2411. </refsynopsisdiv>
  2412. <refsection><info><title>Description</title></info>
  2413. <para>If non-zero, document abstracts will be reproduced in the HTML
  2414. <literal>head</literal>, with <literal>&gt;meta name="description" content="..."</literal></para>
  2415. </refsection>
  2416. </refentry>
  2417. <refentry version="5.0" xml:id="make.clean.html">
  2418. <refmeta>
  2419. <refentrytitle>make.clean.html</refentrytitle>
  2420. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2421. </refmeta>
  2422. <refnamediv>
  2423. <refname>make.clean.html</refname>
  2424. <refpurpose>Make HTML conform to modern coding standards</refpurpose>
  2425. </refnamediv>
  2426. <refsynopsisdiv>
  2427. <programlisting xml:id="make.clean.html.frag">
  2428. &lt;xsl:param name="make.clean.html" select="0"&gt;&lt;/xsl:param&gt;
  2429. </programlisting>
  2430. </refsynopsisdiv>
  2431. <refsection><info><title>Description</title></info>
  2432. <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take
  2433. extra effort to ensure that the resulting HTML is conforms to
  2434. modern HTML coding standards. In addition to eliminating
  2435. excessive and noncompliant coding, it moves presentation
  2436. HTML coding to a CSS stylesheet.</para>
  2437. <para>The resulting HTML is dependent on
  2438. CSS for formatting, and so the stylesheet is capable of
  2439. generating a supporting CSS file. The <parameter>docbook.css.source</parameter>
  2440. and <parameter>custom.css.source</parameter> parameters control
  2441. how a CSS file is generated.</para>
  2442. <para>If you require your CSS to reside in the HTML
  2443. <tag>head</tag> element, then the <parameter>generate.css.header</parameter>
  2444. can be used to do that.</para>
  2445. <para>The <parameter>make.clean.html</parameter> parameter is
  2446. different from <parameter>html.cleanup</parameter>
  2447. because the former changes the resulting markup; it does not use extension functions
  2448. like the latter to manipulate result-tree-fragments,
  2449. and is therefore applicable to any XSLT processor.</para>
  2450. <para>If <parameter>make.clean.html</parameter> is set to zero (the default),
  2451. then the stylesheet retains its original
  2452. <quote>old style</quote>
  2453. HTML formatting features.</para>
  2454. </refsection>
  2455. </refentry>
  2456. <refentry version="5.0" xml:id="docbook.css.source">
  2457. <refmeta>
  2458. <refentrytitle>docbook.css.source</refentrytitle>
  2459. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2460. </refmeta>
  2461. <refnamediv>
  2462. <refname>docbook.css.source</refname>
  2463. <refpurpose>Name of the default CSS input file</refpurpose>
  2464. </refnamediv>
  2465. <refsynopsisdiv>
  2466. <programlisting xml:id="docbook.css.source.frag">&lt;xsl:param name="docbook.css.source"&gt;docbook.css.xml&lt;/xsl:param&gt;</programlisting>
  2467. </refsynopsisdiv>
  2468. <refsection><info><title>Description</title></info>
  2469. <para>The <parameter>docbook.css.source</parameter> parameter
  2470. specifies the name of the file containing the default DocBook
  2471. CSS styles. Those styles are necessary when the
  2472. <parameter>make.clean.html</parameter> parameter is nonzero.</para>
  2473. <para>The file is a well-formed XML file that
  2474. must consist of a single <tag>style</tag> root
  2475. element that contains CSS styles as its text content.
  2476. The default value of the parameter (and filename)
  2477. is <literal>docbook.css.xml</literal>.
  2478. The stylesheets ship with the default file. You can substitute
  2479. your own and specify its path in this parameter.</para>
  2480. <para>If <parameter>docbook.css.source</parameter> is not blank,
  2481. and <parameter>make.clean.html</parameter> is nonzero, then
  2482. the stylesheet takes the following actions:</para>
  2483. <orderedlist>
  2484. <listitem>
  2485. <para>The stylesheet uses the XSLT <literal>document()</literal>
  2486. function to open the file specified by the parameter and
  2487. load it into a variable.</para>
  2488. </listitem>
  2489. <listitem>
  2490. <para>The stylesheet forms an output pathname consisting of the
  2491. value of the <parameter>base.dir</parameter> parameter (if it is set)
  2492. and the value of <parameter>docbook.css.source</parameter>,
  2493. with the <literal>.xml</literal> suffix stripped off.
  2494. </para>
  2495. </listitem>
  2496. <listitem>
  2497. <para>The stylesheet removes the <tag>style</tag>
  2498. wrapper element and writes just the CSS text content to the output file.</para>
  2499. </listitem>
  2500. <listitem>
  2501. <para>The stylesheet adds a <tag>link</tag> element to the
  2502. HTML <tag>HEAD</tag> element to reference the external CSS stylesheet.
  2503. For example:</para>
  2504. <programlisting>&lt;link rel="stylesheet" href="docbook.css" type="text/css"&gt;
  2505. </programlisting>
  2506. <para>However, if the <parameter>docbook.css.link</parameter>
  2507. parameter is set to zero, then no <tag>link</tag> is written
  2508. for the default CSS file. That is useful if a custom
  2509. CSS file will import the default CSS stylesheet to ensure
  2510. proper cascading of styles.</para>
  2511. </listitem>
  2512. </orderedlist>
  2513. <para>If the <parameter>docbook.css.source</parameter> parameter
  2514. is changed from its default <literal>docbook.css.xml</literal> to blank,
  2515. then no default CSS is generated. Likewise if the
  2516. <parameter>make.clean.html</parameter> parameter is set to zero,
  2517. then no default CSS is generated. The
  2518. <parameter>custom.css.source</parameter> parameter can be used
  2519. instead to generate a complete custom CSS file.</para>
  2520. <para>You can use the <parameter>generate.css.header</parameter>
  2521. parameter to instead write the CSS to each HTML <tag>HEAD</tag>
  2522. element in a <tag>style</tag> tag instead of an external CSS file.</para>
  2523. </refsection>
  2524. </refentry>
  2525. <refentry version="5.0" xml:id="docbook.css.link">
  2526. <refmeta>
  2527. <refentrytitle>docbook.css.link</refentrytitle>
  2528. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2529. </refmeta>
  2530. <refnamediv>
  2531. <refname>docbook.css.link</refname>
  2532. <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose>
  2533. </refnamediv>
  2534. <refsynopsisdiv>
  2535. <programlisting xml:id="docbook.css.link.frag">
  2536. &lt;xsl:param name="docbook.css.link" select="1"&gt;&lt;/xsl:param&gt;
  2537. </programlisting>
  2538. </refsynopsisdiv>
  2539. <refsection><info><title>Description</title></info>
  2540. <para>The stylesheets are capable of generating a default
  2541. CSS stylesheet file. The parameters
  2542. <parameter>make.clean.html</parameter> and
  2543. <parameter>docbook.css.source</parameter> control that feature.</para>
  2544. <para>Normally if a default CSS file is generated, then
  2545. the stylesheet inserts a <tag>link</tag> tag in the HTML
  2546. <tag>HEAD</tag> element to reference it.
  2547. However, you can omit that <tag>link</tag> reference if
  2548. you set the <parameter>docbook.css.link</parameter> to zero
  2549. (1 is the default).</para>
  2550. <para>This parameter is useful when you want to import the
  2551. default CSS into a custom CSS file generated using the
  2552. <parameter>custom.css.source</parameter> parameter.
  2553. </para>
  2554. </refsection>
  2555. </refentry>
  2556. <refentry version="5.0" xml:id="custom.css.source">
  2557. <refmeta>
  2558. <refentrytitle>custom.css.source</refentrytitle>
  2559. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2560. </refmeta>
  2561. <refnamediv>
  2562. <refname>custom.css.source</refname>
  2563. <refpurpose>Name of a custom CSS input file</refpurpose>
  2564. </refnamediv>
  2565. <refsynopsisdiv>
  2566. <programlisting xml:id="custom.css.source.frag">&lt;xsl:param name="custom.css.source"&gt;&lt;/xsl:param&gt;</programlisting>
  2567. </refsynopsisdiv>
  2568. <refsection><info><title>Description</title></info>
  2569. <para>The <parameter>custom.css.source</parameter>
  2570. parameter enables you to add CSS styles to DocBook's
  2571. HTML output.</para>
  2572. <para>The parameter
  2573. specifies the name of a file containing custom
  2574. CSS styles. The file must be a well-formed XML file that
  2575. consists of a single <tag>style</tag> root
  2576. element that contains CSS styles as its text content.
  2577. For example:</para>
  2578. <programlisting>&lt;?xml version="1.0"?&gt;
  2579. &lt;style&gt;
  2580. h2 {
  2581. font-weight: bold;
  2582. color: blue;
  2583. }
  2584. ...
  2585. &lt;/style&gt;
  2586. </programlisting>
  2587. <para>The filename specified by the parameter
  2588. should have a <literal>.xml</literal>
  2589. filename suffix, although that is not required.
  2590. The default value of this parameter is blank.</para>
  2591. <para>If <parameter>custom.css.source</parameter> is not blank, then
  2592. the stylesheet takes the following actions.
  2593. These actions take place regardless of the value of
  2594. the <parameter>make.clean.html</parameter> parameter.</para>
  2595. <orderedlist>
  2596. <listitem>
  2597. <para>The stylesheet uses the XSLT <literal>document()</literal>
  2598. function to open the file specified by the parameter and
  2599. load it into a variable.</para>
  2600. </listitem>
  2601. <listitem>
  2602. <para>The stylesheet forms an output pathname consisting of the
  2603. value of the <parameter>base.dir</parameter> parameter (if it is set)
  2604. and the value of <parameter>custom.css.source</parameter>,
  2605. with the <literal>.xml</literal> suffix stripped off.
  2606. </para>
  2607. </listitem>
  2608. <listitem>
  2609. <para>The stylesheet removes the <tag>style</tag>
  2610. wrapper element and writes just the CSS text content to the output file.</para>
  2611. </listitem>
  2612. <listitem>
  2613. <para>The stylesheet adds a <tag>link</tag> element to the
  2614. HTML <tag>HEAD</tag> element to reference this external CSS stylesheet.
  2615. For example:
  2616. <programlisting>&lt;link rel="stylesheet" href="custom.css" type="text/css"&gt;
  2617. </programlisting>
  2618. </para>
  2619. </listitem>
  2620. </orderedlist>
  2621. <para>If the <parameter>make.clean.html</parameter> parameter is nonzero
  2622. (the default is zero),
  2623. and if the <parameter>docbook.css.source</parameter> parameter
  2624. is not blank (the default is not blank),
  2625. then the stylesheet will also generate a default CSS file
  2626. and add a <tag>link</tag> tag to reference it.
  2627. The <tag>link</tag> to the custom CSS comes after the
  2628. <tag>link</tag> to the default, so it should cascade properly
  2629. in most browsers.
  2630. If you do not want two <tag>link</tag> tags, and
  2631. instead want your custom CSS to import the default generated
  2632. CSS file, then do the following:
  2633. </para>
  2634. <orderedlist>
  2635. <listitem>
  2636. <para>Add a line like the following to your custom CSS source file:</para>
  2637. <programlisting>@import url("docbook.css")
  2638. </programlisting>
  2639. </listitem>
  2640. <listitem>
  2641. <para>Set the <parameter>docbook.css.link</parameter> parameter
  2642. to zero. This will omit the <tag>link</tag> tag
  2643. that references the default CSS file.</para>
  2644. </listitem>
  2645. </orderedlist>
  2646. <para>If you set <parameter>make.clean.html</parameter> to nonzero but
  2647. you do not want the default CSS generated, then also set
  2648. the <parameter>docbook.css.source</parameter> parameter to blank.
  2649. Then no default CSS will be generated, and so
  2650. all CSS styles must come from your custom CSS file.</para>
  2651. <para>You can use the <parameter>generate.css.header</parameter>
  2652. parameter to instead write the CSS to each HTML <tag>HEAD</tag>
  2653. element in a <tag>style</tag> tag instead of an external CSS file.</para>
  2654. </refsection>
  2655. </refentry>
  2656. <refentry version="5.0" xml:id="generate.css.header">
  2657. <refmeta>
  2658. <refentrytitle>generate.css.header</refentrytitle>
  2659. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2660. </refmeta>
  2661. <refnamediv>
  2662. <refname>generate.css.header</refname>
  2663. <refpurpose>Insert generated CSS styles in HEAD element</refpurpose>
  2664. </refnamediv>
  2665. <refsynopsisdiv>
  2666. <programlisting xml:id="generate.css.header.frag">
  2667. &lt;xsl:param name="generate.css.header" select="0"&gt;&lt;/xsl:param&gt;
  2668. </programlisting>
  2669. </refsynopsisdiv>
  2670. <refsection><info><title>Description</title></info>
  2671. <para>The stylesheets are capable of generating both default
  2672. and custom CSS stylesheet files. The parameters
  2673. <parameter>make.clean.html</parameter>,
  2674. <parameter>docbook.css.source</parameter>, and
  2675. <parameter>custom.css.source</parameter> control that feature.</para>
  2676. <para>If you require that CSS styles reside in the HTML
  2677. <tag>HEAD</tag> element instead of external CSS files,
  2678. then set the <parameter>generate.css.header</parameter>
  2679. parameter to nonzero (it is zero by default).
  2680. Then instead of generating the CSS in external files,
  2681. they are wrapped in <tag>style</tag> elements in
  2682. the <tag>HEAD</tag> element of each HTML output file.
  2683. </para>
  2684. </refsection>
  2685. </refentry>
  2686. </reference>
  2687. <reference xml:id="xslt"><title>XSLT Processing</title>
  2688. <refentry version="5.0" xml:id="rootid">
  2689. <refmeta>
  2690. <refentrytitle>rootid</refentrytitle>
  2691. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  2692. </refmeta>
  2693. <refnamediv>
  2694. <refname>rootid</refname>
  2695. <refpurpose>Specify the root element to format</refpurpose>
  2696. </refnamediv>
  2697. <refsynopsisdiv>
  2698. <programlisting xml:id="rootid.frag">
  2699. &lt;xsl:param name="rootid"&gt;&lt;/xsl:param&gt;</programlisting>
  2700. </refsynopsisdiv>
  2701. <refsection><info><title>Description</title></info>
  2702. <para>If <parameter>rootid</parameter> is not empty, it must be the
  2703. value of an ID that occurs in the document being formatted. The entire
  2704. document will be loaded and parsed, but formatting will begin at the
  2705. element identified, rather than at the root. For example, this allows
  2706. you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
  2707. <para>Because the entire document is available to the processor, automatic
  2708. numbering, cross references, and other dependencies are correctly
  2709. resolved.</para>
  2710. </refsection>
  2711. </refentry>
  2712. <refentry version="5.0" xml:id="suppress.navigation">
  2713. <refmeta>
  2714. <refentrytitle>suppress.navigation</refentrytitle>
  2715. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2716. </refmeta>
  2717. <refnamediv>
  2718. <refname>suppress.navigation</refname>
  2719. <refpurpose>Disable header and footer navigation</refpurpose>
  2720. </refnamediv>
  2721. <refsynopsisdiv>
  2722. <programlisting xml:id="suppress.navigation.frag">
  2723. &lt;xsl:param name="suppress.navigation" select="0"&gt;&lt;/xsl:param&gt;
  2724. </programlisting>
  2725. </refsynopsisdiv>
  2726. <refsection><info><title>Description</title></info>
  2727. <para>
  2728. If non-zero, header and footer navigation will be suppressed.</para>
  2729. </refsection>
  2730. </refentry>
  2731. <refentry version="5.0" xml:id="suppress.header.navigation">
  2732. <refmeta>
  2733. <refentrytitle>suppress.header.navigation</refentrytitle>
  2734. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2735. </refmeta>
  2736. <refnamediv>
  2737. <refname>suppress.header.navigation</refname>
  2738. <refpurpose>Disable header navigation</refpurpose>
  2739. </refnamediv>
  2740. <refsynopsisdiv>
  2741. <programlisting xml:id="suppress.header.navigation.frag">
  2742. &lt;xsl:param name="suppress.header.navigation" select="0"&gt;&lt;/xsl:param&gt;
  2743. </programlisting>
  2744. </refsynopsisdiv>
  2745. <refsection><info><title>Description</title></info>
  2746. <para>If non-zero, header navigation will be suppressed.</para>
  2747. </refsection>
  2748. </refentry>
  2749. <refentry version="5.0" xml:id="suppress.footer.navigation">
  2750. <refmeta>
  2751. <refentrytitle>suppress.footer.navigation</refentrytitle>
  2752. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2753. </refmeta>
  2754. <refnamediv>
  2755. <refname>suppress.footer.navigation</refname>
  2756. <refpurpose>Disable footer navigation</refpurpose>
  2757. </refnamediv>
  2758. <refsynopsisdiv>
  2759. <programlisting xml:id="suppress.footer.navigation.frag">&lt;xsl:param name="suppress.footer.navigation"&gt;0&lt;/xsl:param&gt;</programlisting>
  2760. </refsynopsisdiv>
  2761. <refsection><info><title>Description</title></info>
  2762. <para>
  2763. If non-zero, footer navigation will be suppressed.</para>
  2764. </refsection>
  2765. </refentry>
  2766. <refentry version="5.0" xml:id="header.rule">
  2767. <refmeta>
  2768. <refentrytitle>header.rule</refentrytitle>
  2769. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2770. </refmeta>
  2771. <refnamediv>
  2772. <refname>header.rule</refname>
  2773. <refpurpose>Rule under headers?</refpurpose>
  2774. </refnamediv>
  2775. <refsynopsisdiv>
  2776. <programlisting xml:id="header.rule.frag">
  2777. &lt;xsl:param name="header.rule" select="1"&gt;&lt;/xsl:param&gt;
  2778. </programlisting>
  2779. </refsynopsisdiv>
  2780. <refsection><info><title>Description</title></info>
  2781. <para>If non-zero, a rule will be drawn below the page headers.</para>
  2782. </refsection>
  2783. </refentry>
  2784. <refentry version="5.0" xml:id="footer.rule">
  2785. <refmeta>
  2786. <refentrytitle>footer.rule</refentrytitle>
  2787. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2788. </refmeta>
  2789. <refnamediv>
  2790. <refname>footer.rule</refname>
  2791. <refpurpose>Rule over footers?</refpurpose>
  2792. </refnamediv>
  2793. <refsynopsisdiv>
  2794. <programlisting xml:id="footer.rule.frag">
  2795. &lt;xsl:param name="footer.rule" select="1"&gt;&lt;/xsl:param&gt;
  2796. </programlisting>
  2797. </refsynopsisdiv>
  2798. <refsection><info><title>Description</title></info>
  2799. <para>If non-zero, a rule will be drawn above the page footers.</para>
  2800. </refsection>
  2801. </refentry>
  2802. <refentry version="5.0" xml:id="id.warnings">
  2803. <refmeta>
  2804. <refentrytitle>id.warnings</refentrytitle>
  2805. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2806. </refmeta>
  2807. <refnamediv>
  2808. <refname>id.warnings</refname>
  2809. <refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
  2810. </refnamediv>
  2811. <refsynopsisdiv>
  2812. <programlisting xml:id="id.warnings.frag">
  2813. &lt;xsl:param name="id.warnings" select="0"&gt;&lt;/xsl:param&gt;
  2814. </programlisting>
  2815. </refsynopsisdiv>
  2816. <refsection><info><title>Description</title></info>
  2817. <para>If non-zero, the stylesheet will issue a warning for any element
  2818. (other than the root element) which has a <tag>title</tag> but does not have an
  2819. ID.</para>
  2820. </refsection>
  2821. </refentry>
  2822. </reference>
  2823. <reference xml:id="meta"><title>Meta/*Info and Titlepages</title>
  2824. <refentry version="5.0" xml:id="inherit.keywords">
  2825. <refmeta>
  2826. <refentrytitle>inherit.keywords</refentrytitle>
  2827. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2828. </refmeta>
  2829. <refnamediv>
  2830. <refname>inherit.keywords</refname>
  2831. <refpurpose>Inherit keywords from ancestor elements?</refpurpose>
  2832. </refnamediv>
  2833. <refsynopsisdiv>
  2834. <programlisting xml:id="inherit.keywords.frag">
  2835. &lt;xsl:param name="inherit.keywords" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  2836. </refsynopsisdiv>
  2837. <refsection><info><title>Description</title></info>
  2838. <para>If <parameter>inherit.keywords</parameter>
  2839. is non-zero, the keyword <literal>meta</literal> for each HTML
  2840. <literal>head</literal> element will include all of the keywords from
  2841. ancestor elements. Otherwise, only the keywords from the current section
  2842. will be used.
  2843. </para>
  2844. </refsection>
  2845. </refentry>
  2846. <refentry version="5.0" xml:id="make.single.year.ranges">
  2847. <refmeta>
  2848. <refentrytitle>make.single.year.ranges</refentrytitle>
  2849. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2850. </refmeta>
  2851. <refnamediv>
  2852. <refname>make.single.year.ranges</refname>
  2853. <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose>
  2854. </refnamediv>
  2855. <refsynopsisdiv>
  2856. <programlisting xml:id="make.single.year.ranges.frag">
  2857. &lt;xsl:param name="make.single.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  2858. </refsynopsisdiv>
  2859. <refsection><info><title>Description</title></info>
  2860. <para>If non-zero, year ranges that span a single year will be printed
  2861. in range notation (1998-1999) instead of discrete notation
  2862. (1998, 1999).</para>
  2863. </refsection>
  2864. </refentry>
  2865. <refentry version="5.0" xml:id="make.year.ranges">
  2866. <refmeta>
  2867. <refentrytitle>make.year.ranges</refentrytitle>
  2868. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2869. </refmeta>
  2870. <refnamediv>
  2871. <refname>make.year.ranges</refname>
  2872. <refpurpose>Collate copyright years into ranges?</refpurpose>
  2873. </refnamediv>
  2874. <refsynopsisdiv>
  2875. <programlisting xml:id="make.year.ranges.frag">&lt;xsl:param name="make.year.ranges" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  2876. </refsynopsisdiv>
  2877. <refsection><info><title>Description</title></info>
  2878. <para>If non-zero, multiple copyright <tag>year</tag> elements will be
  2879. collated into ranges.
  2880. This works only if each year number is put into a separate
  2881. year element. The copyright element permits multiple
  2882. year elements. If a year element contains a dash or
  2883. a comma, then that year element will not be merged into
  2884. any range.
  2885. </para>
  2886. </refsection>
  2887. </refentry>
  2888. <refentry version="5.0" xml:id="author.othername.in.middle">
  2889. <refmeta>
  2890. <refentrytitle>author.othername.in.middle</refentrytitle>
  2891. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2892. </refmeta>
  2893. <refnamediv>
  2894. <refname>author.othername.in.middle</refname>
  2895. <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a
  2896. middle name?</refpurpose>
  2897. </refnamediv>
  2898. <refsynopsisdiv>
  2899. <programlisting xml:id="author.othername.in.middle.frag">
  2900. &lt;xsl:param name="author.othername.in.middle" select="1"&gt;&lt;/xsl:param&gt;</programlisting>
  2901. </refsynopsisdiv>
  2902. <refsection><info><title>Description</title></info>
  2903. <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag>
  2904. appears between the <tag>firstname</tag> and
  2905. <tag>surname</tag>. Otherwise, <tag>othername</tag>
  2906. is suppressed.
  2907. </para>
  2908. </refsection>
  2909. </refentry>
  2910. <refentry version="5.0" xml:id="blurb.on.titlepage.enabled">
  2911. <refmeta>
  2912. <refentrytitle>blurb.on.titlepage.enabled</refentrytitle>
  2913. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2914. </refmeta>
  2915. <refnamediv>
  2916. <refname>blurb.on.titlepage.enabled</refname>
  2917. <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose>
  2918. </refnamediv>
  2919. <refsynopsisdiv>
  2920. <programlisting xml:id="blurb.on.titlepage.enabled.frag">
  2921. &lt;xsl:param name="blurb.on.titlepage.enabled" select="0"&gt;&lt;/xsl:param&gt;
  2922. </programlisting>
  2923. </refsynopsisdiv>
  2924. <refsection><info><title>Description</title></info>
  2925. <para>If non-zero, output from <tag>authorblurb</tag> and
  2926. <tag>personblurb</tag> elements is displayed on title pages. If zero
  2927. (the default), output from those elements is suppressed on title pages
  2928. (unless you are using a <literal>titlepage</literal> customization
  2929. that causes them to be included).</para>
  2930. </refsection>
  2931. </refentry>
  2932. <refentry version="5.0" xml:id="contrib.inline.enabled">
  2933. <refmeta>
  2934. <refentrytitle>contrib.inline.enabled</refentrytitle>
  2935. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2936. </refmeta>
  2937. <refnamediv>
  2938. <refname>contrib.inline.enabled</refname>
  2939. <refpurpose>Display contrib output inline?</refpurpose>
  2940. </refnamediv>
  2941. <refsynopsisdiv>
  2942. <programlisting xml:id="contrib.inline.enabled.frag">&lt;xsl:param name="contrib.inline.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
  2943. </refsynopsisdiv>
  2944. <refsection><info><title>Description</title></info>
  2945. <para>If non-zero (the default), output of the <tag>contrib</tag> element is
  2946. displayed as inline content rather than as block content.</para>
  2947. </refsection>
  2948. </refentry>
  2949. <refentry version="5.0" xml:id="editedby.enabled">
  2950. <refmeta>
  2951. <refentrytitle>editedby.enabled</refentrytitle>
  2952. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2953. </refmeta>
  2954. <refnamediv>
  2955. <refname>editedby.enabled</refname>
  2956. <refpurpose>Display &#8220;Edited by&#8221; heading above editor name?</refpurpose>
  2957. </refnamediv>
  2958. <refsynopsisdiv>
  2959. <programlisting xml:id="editedby.enabled.frag">&lt;xsl:param name="editedby.enabled"&gt;1&lt;/xsl:param&gt;</programlisting>
  2960. </refsynopsisdiv>
  2961. <refsection><info><title>Description</title></info>
  2962. <para>If non-zero, a localized <emphasis role="bold">Edited
  2963. by</emphasis> heading is displayed above editor names in output of the
  2964. <tag>editor</tag> element.</para>
  2965. </refsection>
  2966. </refentry>
  2967. <refentry version="5.0" xml:id="abstract.notitle.enabled">
  2968. <refmeta>
  2969. <refentrytitle>abstract.notitle.enabled</refentrytitle>
  2970. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2971. </refmeta>
  2972. <refnamediv>
  2973. <refname>abstract.notitle.enabled</refname>
  2974. <refpurpose>Suppress display of abstract titles?</refpurpose>
  2975. </refnamediv>
  2976. <refsynopsisdiv>
  2977. <programlisting xml:id="abstract.notitle.enabled.frag">&lt;xsl:param name="abstract.notitle.enabled" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  2978. </refsynopsisdiv>
  2979. <refsection><info><title>Description</title></info>
  2980. <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages,
  2981. display of the abstract title is suppressed.</para>
  2982. </refsection>
  2983. </refentry>
  2984. <refentry version="5.0" xml:id="othercredit.like.author.enabled">
  2985. <refmeta>
  2986. <refentrytitle>othercredit.like.author.enabled</refentrytitle>
  2987. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  2988. </refmeta>
  2989. <refnamediv>
  2990. <refname>othercredit.like.author.enabled</refname>
  2991. <refpurpose>Display othercredit in same style as author?</refpurpose>
  2992. </refnamediv>
  2993. <refsynopsisdiv>
  2994. <programlisting xml:id="othercredit.like.author.enabled.frag">&lt;xsl:param name="othercredit.like.author.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>
  2995. </refsynopsisdiv>
  2996. <refsection><info><title>Description</title></info>
  2997. <para>If non-zero, output of the
  2998. <tag>othercredit</tag> element on titlepages is displayed in
  2999. the same style as <tag>author</tag> and
  3000. <tag>editor</tag> output. If zero then
  3001. <tag>othercredit</tag> output is displayed using a style
  3002. different than that of <tag>author</tag> and
  3003. <tag>editor</tag>.</para>
  3004. </refsection>
  3005. </refentry>
  3006. <refentry version="5.0" xml:id="generate.legalnotice.link">
  3007. <refmeta>
  3008. <refentrytitle>generate.legalnotice.link</refentrytitle>
  3009. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3010. </refmeta>
  3011. <refnamediv>
  3012. <refname>generate.legalnotice.link</refname>
  3013. <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
  3014. </refnamediv>
  3015. <refsynopsisdiv>
  3016. <programlisting xml:id="generate.legalnotice.link.frag">&lt;xsl:param name="generate.legalnotice.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  3017. </refsynopsisdiv>
  3018. <refsection><info><title>Description</title></info>
  3019. <para>If the value of <parameter>generate.legalnotice.link</parameter>
  3020. is non-zero, the stylesheet:
  3021. <itemizedlist>
  3022. <listitem>
  3023. <para>writes the contents of <tag>legalnotice</tag> to a separate
  3024. HTML file</para>
  3025. </listitem>
  3026. <listitem>
  3027. <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
  3028. </listitem>
  3029. <listitem>
  3030. <para>adds (in the HTML <literal>head</literal>) either a single
  3031. <literal>link</literal> or element or multiple
  3032. <literal>link</literal> elements (depending on the value of the
  3033. <parameter>html.head.legalnotice.link.multiple</parameter>
  3034. parameter), with the value or values derived from the
  3035. <parameter>html.head.legalnotice.link.types</parameter>
  3036. parameter</para>
  3037. </listitem>
  3038. </itemizedlist>
  3039. Otherwise, if <parameter>generate.legalnotice.link</parameter> is
  3040. zero, <tag>legalnotice</tag> contents are rendered on the title
  3041. page.</para>
  3042. <para>The name of the separate HTML file is computed as follows:
  3043. <orderedlist>
  3044. <listitem>
  3045. <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
  3046. processing instruction, that filename is used.</para>
  3047. </listitem>
  3048. <listitem>
  3049. <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  3050. attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
  3051. is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
  3052. parameter.</para>
  3053. </listitem>
  3054. <listitem>
  3055. <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  3056. attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
  3057. auto-generated id value, and <parameter>html.ext</parameter> value.
  3058. </para>
  3059. </listitem>
  3060. </orderedlist>
  3061. </para>
  3062. </refsection>
  3063. </refentry>
  3064. <refentry version="5.0" xml:id="generate.revhistory.link">
  3065. <refmeta>
  3066. <refentrytitle>generate.revhistory.link</refentrytitle>
  3067. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3068. </refmeta>
  3069. <refnamediv>
  3070. <refname>generate.revhistory.link</refname>
  3071. <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
  3072. </refnamediv>
  3073. <refsynopsisdiv>
  3074. <programlisting xml:id="generate.revhistory.link.frag">&lt;xsl:param name="generate.revhistory.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  3075. </refsynopsisdiv>
  3076. <refsection><info><title>Description</title></info>
  3077. <para>If non-zero, the contents of <tag>revhistory</tag> are written
  3078. to a separate HTML file and a link to the file is
  3079. generated. Otherwise, <tag>revhistory</tag> contents are rendered on
  3080. the title page.</para>
  3081. <para>The name of the separate HTML file is computed as follows:
  3082. <orderedlist>
  3083. <listitem>
  3084. <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
  3085. that filename is used.</para>
  3086. </listitem>
  3087. <listitem>
  3088. <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  3089. attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
  3090. the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
  3091. </listitem>
  3092. <listitem>
  3093. <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  3094. attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
  3095. auto-generated id value, and <parameter>html.ext</parameter> value.
  3096. </para>
  3097. </listitem>
  3098. </orderedlist>
  3099. </para>
  3100. </refsection>
  3101. </refentry>
  3102. <refentry version="5.0" xml:id="html.head.legalnotice.link.types">
  3103. <refmeta>
  3104. <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
  3105. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  3106. </refmeta>
  3107. <refnamediv>
  3108. <refname>html.head.legalnotice.link.types</refname>
  3109. <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
  3110. </refnamediv>
  3111. <refsynopsisdiv>
  3112. <programlisting xml:id="html.head.legalnotice.link.types.frag">
  3113. &lt;xsl:param name="html.head.legalnotice.link.types"&gt;copyright&lt;/xsl:param&gt;
  3114. </programlisting>
  3115. </refsynopsisdiv>
  3116. <refsection><info><title>Description</title></info>
  3117. <para>The value of
  3118. <parameter>html.head.legalnotice.link.types</parameter> is a
  3119. space-separated list of link types, as described in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
  3120. of the HTML 4.01 specification</link>. If the value of the
  3121. <parameter>generate.legalnotice.link</parameter> parameter is
  3122. non-zero, then the stylesheet generates (in the
  3123. <literal>head</literal> section of the HTML source) either a single
  3124. HTML <literal>link</literal> element or, if the value of the
  3125. <parameter>html.head.legalnotice.link.multiple</parameter> is
  3126. non-zero, one <literal>link</literal> element for each link type
  3127. specified. Each <literal>link</literal> has the following attributes:
  3128. <itemizedlist>
  3129. <listitem>
  3130. <para>a <tag class="attribute">rel</tag> attribute whose
  3131. value is derived from the value of
  3132. <parameter>html.head.legalnotice.link.types</parameter></para>
  3133. </listitem>
  3134. <listitem>
  3135. <para>an <tag class="attribute">href</tag> attribute whose
  3136. value is set to the URL of the file containing the
  3137. <tag>legalnotice</tag></para>
  3138. </listitem>
  3139. <listitem>
  3140. <para>a <tag class="attribute">title</tag> attribute whose
  3141. value is set to the title of the corresponding
  3142. <tag>legalnotice</tag> (or a title programatically
  3143. determined by the stylesheet)</para>
  3144. </listitem>
  3145. </itemizedlist>
  3146. For example:
  3147. <screen> &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
  3148. </para>
  3149. <refsection><info><title>About the default value</title></info>
  3150. <para>In an ideal world, the default value of
  3151. <parameter>html.head.legalnotice.link.types</parameter> would
  3152. probably be &#8220;<literal>license</literal>&#8221;, since the content of the
  3153. DocBook <tag>legalnotice</tag> is typically license
  3154. information, not copyright information. However, the default value
  3155. is &#8220;<literal>copyright</literal>&#8221; for pragmatic reasons: because
  3156. that&#8217;s among the set of &#8220;recognized link types&#8221; listed in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
  3157. 6.12 of the HTML 4.01 specification</link>, and because certain
  3158. browsers and browser extensions are preconfigured to recognize that
  3159. value.</para>
  3160. </refsection>
  3161. </refsection>
  3162. </refentry>
  3163. <refentry version="5.0" xml:id="html.head.legalnotice.link.multiple">
  3164. <refmeta>
  3165. <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle>
  3166. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3167. </refmeta>
  3168. <refnamediv>
  3169. <refname>html.head.legalnotice.link.multiple</refname>
  3170. <refpurpose>Generate multiple link instances in html head for legalnotice?</refpurpose>
  3171. </refnamediv>
  3172. <refsynopsisdiv>
  3173. <programlisting xml:id="html.head.legalnotice.link.multiple.frag">
  3174. &lt;xsl:param name="html.head.legalnotice.link.multiple" select="1"&gt;&lt;/xsl:param&gt;
  3175. </programlisting>
  3176. </refsynopsisdiv>
  3177. <refsection><info><title>Description</title></info>
  3178. <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is
  3179. non-zero and the value of
  3180. <parameter>html.head.legalnotice.link.types</parameter> contains
  3181. multiple link types, then the stylesheet generates (in the
  3182. <literal>head</literal> section of the HTML source) one
  3183. <literal>link</literal> element for each link type specified. For
  3184. example, if the value of
  3185. <parameter>html.head.legalnotice.link.types</parameter> is
  3186. &#8220;<literal>copyright license</literal>&#8221;:
  3187. <screen> &lt;link rel="copyright" href="ln-id2524073.html" title="Legal Notice"&gt;
  3188. &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
  3189. Otherwise, the stylesheet generates generates a single
  3190. <literal>link</literal> instance; for example:
  3191. <screen> &lt;link rel="copyright license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
  3192. </para>
  3193. </refsection>
  3194. </refentry>
  3195. </reference>
  3196. <reference xml:id="refentry"><title>Reference Pages</title>
  3197. <refentry version="5.0" xml:id="funcsynopsis.decoration">
  3198. <refmeta>
  3199. <refentrytitle>funcsynopsis.decoration</refentrytitle>
  3200. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3201. </refmeta>
  3202. <refnamediv>
  3203. <refname>funcsynopsis.decoration</refname>
  3204. <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose>
  3205. </refnamediv>
  3206. <refsynopsisdiv>
  3207. <programlisting xml:id="funcsynopsis.decoration.frag">
  3208. &lt;xsl:param name="funcsynopsis.decoration" select="1"&gt;&lt;/xsl:param&gt;
  3209. </programlisting>
  3210. </refsynopsisdiv>
  3211. <refsection><info><title>Description</title></info>
  3212. <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be
  3213. decorated (e.g. rendered as bold or italic text). The decoration is controlled by
  3214. templates that can be redefined in a customization layer.
  3215. </para>
  3216. </refsection>
  3217. </refentry>
  3218. <refentry version="5.0" xml:id="funcsynopsis.style">
  3219. <refmeta>
  3220. <refentrytitle>funcsynopsis.style</refentrytitle>
  3221. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  3222. <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>
  3223. <refmiscinfo class="other" otherclass="value">kr</refmiscinfo>
  3224. </refmeta>
  3225. <refnamediv>
  3226. <refname>funcsynopsis.style</refname>
  3227. <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>
  3228. </refnamediv>
  3229. <refsynopsisdiv>
  3230. <programlisting xml:id="funcsynopsis.style.frag">&lt;xsl:param name="funcsynopsis.style"&gt;kr&lt;/xsl:param&gt;</programlisting>
  3231. </refsynopsisdiv>
  3232. <refsection><info><title>Description</title></info>
  3233. <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>,
  3234. ANSI-style function synopses are generated for a
  3235. <tag>funcsynopsis</tag>, otherwise K&amp;R-style
  3236. function synopses are generated.
  3237. </para>
  3238. </refsection>
  3239. </refentry>
  3240. <refentry version="5.0" xml:id="function.parens">
  3241. <refmeta>
  3242. <refentrytitle>function.parens</refentrytitle>
  3243. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3244. </refmeta>
  3245. <refnamediv>
  3246. <refname>function.parens</refname>
  3247. <refpurpose>Generate parens after a function?</refpurpose>
  3248. </refnamediv>
  3249. <refsynopsisdiv>
  3250. <programlisting xml:id="function.parens.frag">
  3251. &lt;xsl:param name="function.parens" select="0"&gt;&lt;/xsl:param&gt;
  3252. </programlisting>
  3253. </refsynopsisdiv>
  3254. <refsection><info><title>Description</title></info>
  3255. <para>If non-zero, the formatting of a <tag>function</tag> element
  3256. will include generated parentheses.
  3257. </para>
  3258. </refsection>
  3259. </refentry>
  3260. <refentry version="5.0" xml:id="refentry.generate.name">
  3261. <refmeta>
  3262. <refentrytitle>refentry.generate.name</refentrytitle>
  3263. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3264. </refmeta>
  3265. <refnamediv>
  3266. <refname>refentry.generate.name</refname>
  3267. <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose>
  3268. </refnamediv>
  3269. <refsynopsisdiv>
  3270. <programlisting xml:id="refentry.generate.name.frag">
  3271. &lt;xsl:param name="refentry.generate.name" select="1"&gt;&lt;/xsl:param&gt;
  3272. </programlisting>
  3273. </refsynopsisdiv>
  3274. <refsection><info><title>Description</title></info>
  3275. <para>If non-zero, a "NAME" section title is output before the list
  3276. of <tag>refname</tag>s. This parameter and
  3277. <parameter>refentry.generate.title</parameter> are mutually
  3278. exclusive. This means that if you change this parameter to zero, you
  3279. should set <parameter>refentry.generate.title</parameter> to non-zero unless
  3280. you want get quite strange output.
  3281. </para>
  3282. </refsection>
  3283. </refentry>
  3284. <refentry version="5.0" xml:id="refentry.generate.title">
  3285. <refmeta>
  3286. <refentrytitle>refentry.generate.title</refentrytitle>
  3287. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3288. </refmeta>
  3289. <refnamediv>
  3290. <refname>refentry.generate.title</refname>
  3291. <refpurpose>Output title before <tag>refname</tag>s?</refpurpose>
  3292. </refnamediv>
  3293. <refsynopsisdiv>
  3294. <programlisting xml:id="refentry.generate.title.frag">
  3295. &lt;xsl:param name="refentry.generate.title" select="0"&gt;&lt;/xsl:param&gt;
  3296. </programlisting>
  3297. </refsynopsisdiv>
  3298. <refsection><info><title>Description</title></info>
  3299. <para>If non-zero, the reference page title or first name is
  3300. output before the list of <tag>refname</tag>s. This parameter and
  3301. <parameter>refentry.generate.name</parameter> are mutually exclusive.
  3302. This means that if you change this parameter to non-zero, you
  3303. should set <parameter>refentry.generate.name</parameter> to zero unless
  3304. you want get quite strange output.</para>
  3305. </refsection>
  3306. </refentry>
  3307. <refentry version="5.0" xml:id="refentry.xref.manvolnum">
  3308. <refmeta>
  3309. <refentrytitle>refentry.xref.manvolnum</refentrytitle>
  3310. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3311. </refmeta>
  3312. <refnamediv>
  3313. <refname>refentry.xref.manvolnum</refname>
  3314. <refpurpose>Output <tag>manvolnum</tag> as part of
  3315. <tag>refentry</tag> cross-reference?</refpurpose>
  3316. </refnamediv>
  3317. <refsynopsisdiv>
  3318. <programlisting xml:id="refentry.xref.manvolnum.frag">
  3319. &lt;xsl:param name="refentry.xref.manvolnum" select="1"&gt;&lt;/xsl:param&gt;
  3320. </programlisting>
  3321. </refsynopsisdiv>
  3322. <refsection><info><title>Description</title></info>
  3323. <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing
  3324. <tag>refentry</tag>s, either with <tag>xref</tag>
  3325. or <tag>citerefentry</tag>.
  3326. </para>
  3327. </refsection>
  3328. </refentry>
  3329. <refentry version="5.0" xml:id="citerefentry.link">
  3330. <refmeta>
  3331. <refentrytitle>citerefentry.link</refentrytitle>
  3332. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3333. </refmeta>
  3334. <refnamediv>
  3335. <refname>citerefentry.link</refname>
  3336. <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose>
  3337. </refnamediv>
  3338. <refsynopsisdiv>
  3339. <programlisting xml:id="citerefentry.link.frag">
  3340. &lt;xsl:param name="citerefentry.link" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  3341. </refsynopsisdiv>
  3342. <refsection><info><title>Description</title></info>
  3343. <para>If non-zero, a web link will be generated, presumably
  3344. to an online man-&gt;HTML gateway. The text of the link is
  3345. generated by the <literal>generate.citerefentry.link</literal> template.
  3346. </para>
  3347. </refsection>
  3348. </refentry>
  3349. <refentry version="5.0" xml:id="refentry.separator">
  3350. <refmeta>
  3351. <refentrytitle>refentry.separator</refentrytitle>
  3352. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3353. </refmeta>
  3354. <refnamediv>
  3355. <refname>refentry.separator</refname>
  3356. <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurpose>
  3357. </refnamediv>
  3358. <refsynopsisdiv>
  3359. <programlisting xml:id="refentry.separator.frag">
  3360. &lt;xsl:param name="refentry.separator" select="1"&gt;&lt;/xsl:param&gt;
  3361. </programlisting>
  3362. </refsynopsisdiv>
  3363. <refsection><info><title>Description</title></info>
  3364. <para>If true, a separator will be generated between consecutive
  3365. reference pages.
  3366. </para>
  3367. </refsection>
  3368. </refentry>
  3369. <refentry version="5.0" xml:id="refclass.suppress">
  3370. <refmeta>
  3371. <refentrytitle>refclass.suppress</refentrytitle>
  3372. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3373. </refmeta>
  3374. <refnamediv>
  3375. <refname>refclass.suppress</refname>
  3376. <refpurpose>Suppress display of refclass contents?</refpurpose>
  3377. </refnamediv>
  3378. <refsynopsisdiv>
  3379. <programlisting xml:id="refclass.suppress.frag">
  3380. &lt;xsl:param name="refclass.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  3381. </refsynopsisdiv>
  3382. <refsection><info><title>Description</title></info>
  3383. <para>If the value of <parameter>refclass.suppress</parameter> is
  3384. non-zero, then display of <tag>refclass</tag> contents is
  3385. suppressed in output.</para>
  3386. </refsection>
  3387. </refentry>
  3388. </reference>
  3389. <reference xml:id="tables"><title>Tables</title>
  3390. <refentry version="5.0" xml:id="default.table.width">
  3391. <refmeta>
  3392. <refentrytitle>default.table.width</refentrytitle>
  3393. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  3394. </refmeta>
  3395. <refnamediv>
  3396. <refname>default.table.width</refname>
  3397. <refpurpose>The default width of tables</refpurpose>
  3398. </refnamediv>
  3399. <refsynopsisdiv>
  3400. <programlisting xml:id="default.table.width.frag">
  3401. &lt;xsl:param name="default.table.width"&gt;&lt;/xsl:param&gt;
  3402. </programlisting>
  3403. </refsynopsisdiv>
  3404. <refsection><info><title>Description</title></info>
  3405. <para>If non-zero, this value will be used for the
  3406. <literal>width</literal> attribute on <tag>table</tag>s that do not specify an
  3407. alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or
  3408. <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para>
  3409. </refsection>
  3410. </refentry>
  3411. <refentry version="5.0" xml:id="nominal.table.width">
  3412. <refmeta>
  3413. <refentrytitle>nominal.table.width</refentrytitle>
  3414. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  3415. </refmeta>
  3416. <refnamediv>
  3417. <refname>nominal.table.width</refname>
  3418. <refpurpose>The (absolute) nominal width of tables</refpurpose>
  3419. </refnamediv>
  3420. <refsynopsisdiv>
  3421. <programlisting xml:id="nominal.table.width.frag">
  3422. &lt;xsl:param name="nominal.table.width"&gt;6in&lt;/xsl:param&gt;
  3423. </programlisting>
  3424. </refsynopsisdiv>
  3425. <refsection><info><title>Description</title></info>
  3426. <para>In order to convert CALS column widths into HTML column widths, it
  3427. is sometimes necessary to have an absolute table width to use for conversion
  3428. of mixed absolute and relative widths. This value must be an absolute
  3429. length (not a percentage).</para>
  3430. </refsection>
  3431. </refentry>
  3432. <refentry version="5.0" xml:id="table.borders.with.css">
  3433. <refmeta>
  3434. <refentrytitle>table.borders.with.css</refentrytitle>
  3435. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3436. </refmeta>
  3437. <refnamediv>
  3438. <refname>table.borders.with.css</refname>
  3439. <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose>
  3440. </refnamediv>
  3441. <refsynopsisdiv>
  3442. <programlisting xml:id="table.borders.with.css.frag">
  3443. &lt;xsl:param name="table.borders.with.css" select="0"&gt;&lt;/xsl:param&gt;
  3444. </programlisting>
  3445. </refsynopsisdiv>
  3446. <refsection><info><title>Description</title></info>
  3447. <para>If non-zero, CSS will be used to draw table borders.
  3448. </para>
  3449. </refsection>
  3450. </refentry>
  3451. <refentry version="5.0" xml:id="table.cell.border.style">
  3452. <refmeta>
  3453. <refentrytitle>table.cell.border.style</refentrytitle>
  3454. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  3455. <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
  3456. <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
  3457. <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
  3458. <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
  3459. <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
  3460. <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
  3461. <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
  3462. <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
  3463. <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
  3464. <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
  3465. </refmeta>
  3466. <refnamediv>
  3467. <refname>table.cell.border.style</refname>
  3468. <refpurpose>Specifies the border style of table cells</refpurpose>
  3469. </refnamediv>
  3470. <refsynopsisdiv>
  3471. <programlisting xml:id="table.cell.border.style.frag">
  3472. &lt;xsl:param name="table.cell.border.style"&gt;solid&lt;/xsl:param&gt;
  3473. </programlisting>
  3474. </refsynopsisdiv>
  3475. <refsection><info><title>Description</title></info>
  3476. <para>Specifies the border style of table cells.</para>
  3477. <note>
  3478. <para>To control properties of cell borders in HTML output, you must also turn on the
  3479. <parameter>table.borders.with.css</parameter> parameter.</para>
  3480. </note>
  3481. </refsection>
  3482. </refentry>
  3483. <refentry version="5.0" xml:id="table.cell.border.thickness">
  3484. <refmeta>
  3485. <refentrytitle>table.cell.border.thickness</refentrytitle>
  3486. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  3487. </refmeta>
  3488. <refnamediv>
  3489. <refname>table.cell.border.thickness</refname>
  3490. <refpurpose>Specifies the thickness of table cell borders</refpurpose>
  3491. </refnamediv>
  3492. <refsynopsisdiv>
  3493. <programlisting xml:id="table.cell.border.thickness.frag">
  3494. &lt;xsl:param name="table.cell.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
  3495. </programlisting>
  3496. </refsynopsisdiv>
  3497. <refsection><info><title>Description</title></info>
  3498. <para>If non-zero, specifies the thickness of borders on table
  3499. cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties">
  3500. CSS</link></para>
  3501. <note>
  3502. <para>To control properties of cell borders in HTML output, you must also turn on the
  3503. <parameter>table.borders.with.css</parameter> parameter.</para>
  3504. </note>
  3505. </refsection>
  3506. </refentry>
  3507. <refentry version="5.0" xml:id="table.cell.border.color">
  3508. <refmeta>
  3509. <refentrytitle>table.cell.border.color</refentrytitle>
  3510. <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
  3511. </refmeta>
  3512. <refnamediv>
  3513. <refname>table.cell.border.color</refname>
  3514. <refpurpose>Specifies the border color of table cells</refpurpose>
  3515. </refnamediv>
  3516. <refsynopsisdiv>
  3517. <programlisting xml:id="table.cell.border.color.frag">
  3518. &lt;xsl:param name="table.cell.border.color"&gt;&lt;/xsl:param&gt;
  3519. </programlisting>
  3520. </refsynopsisdiv>
  3521. <refsection><info><title>Description</title></info>
  3522. <para>Set the color of table cell borders. If non-zero, the value is used
  3523. for the border coloration. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>. A
  3524. <literal>color</literal> is either a keyword or a numerical RGB specification.
  3525. Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon,
  3526. navy, olive, orange, purple, red, silver, teal, white, and
  3527. yellow.</para>
  3528. <note>
  3529. <para>To control properties of cell borders in HTML output, you must also turn on the
  3530. <parameter>table.borders.with.css</parameter> parameter.</para>
  3531. </note>
  3532. </refsection>
  3533. </refentry>
  3534. <refentry version="5.0" xml:id="table.frame.border.style">
  3535. <refmeta>
  3536. <refentrytitle>table.frame.border.style</refentrytitle>
  3537. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  3538. <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
  3539. <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
  3540. <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo>
  3541. <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo>
  3542. <refmiscinfo class="other" otherclass="value">double</refmiscinfo>
  3543. <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
  3544. <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo>
  3545. <refmiscinfo class="other" otherclass="value">inset</refmiscinfo>
  3546. <refmiscinfo class="other" otherclass="value">outset</refmiscinfo>
  3547. <refmiscinfo class="other" otherclass="value">solid</refmiscinfo>
  3548. </refmeta>
  3549. <refnamediv>
  3550. <refname>table.frame.border.style</refname>
  3551. <refpurpose>Specifies the border style of table frames</refpurpose>
  3552. </refnamediv>
  3553. <refsynopsisdiv>
  3554. <programlisting xml:id="table.frame.border.style.frag">
  3555. &lt;xsl:param name="table.frame.border.style"&gt;solid&lt;/xsl:param&gt;
  3556. </programlisting>
  3557. </refsynopsisdiv>
  3558. <refsection><info><title>Description</title></info>
  3559. <para>Specifies the border style of table frames.</para>
  3560. </refsection>
  3561. </refentry>
  3562. <refentry version="5.0" xml:id="table.frame.border.thickness">
  3563. <refmeta>
  3564. <refentrytitle>table.frame.border.thickness</refentrytitle>
  3565. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  3566. </refmeta>
  3567. <refnamediv>
  3568. <refname>table.frame.border.thickness</refname>
  3569. <refpurpose>Specifies the thickness of the frame border</refpurpose>
  3570. </refnamediv>
  3571. <refsynopsisdiv>
  3572. <programlisting xml:id="table.frame.border.thickness.frag">
  3573. &lt;xsl:param name="table.frame.border.thickness"&gt;0.5pt&lt;/xsl:param&gt;
  3574. </programlisting>
  3575. </refsynopsisdiv>
  3576. <refsection><info><title>Description</title></info>
  3577. <para>Specifies the thickness of the border on the table's frame.</para>
  3578. </refsection>
  3579. </refentry>
  3580. <refentry version="5.0" xml:id="table.frame.border.color">
  3581. <refmeta>
  3582. <refentrytitle>table.frame.border.color</refentrytitle>
  3583. <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo>
  3584. </refmeta>
  3585. <refnamediv>
  3586. <refname>table.frame.border.color</refname>
  3587. <refpurpose>Specifies the border color of table frames</refpurpose>
  3588. </refnamediv>
  3589. <refsynopsisdiv>
  3590. <programlisting xml:id="table.frame.border.color.frag">
  3591. &lt;xsl:param name="table.frame.border.color"&gt;&lt;/xsl:param&gt;
  3592. </programlisting>
  3593. </refsynopsisdiv>
  3594. <refsection><info><title>Description</title></info>
  3595. <para>Specifies the border color of table frames.</para>
  3596. </refsection>
  3597. </refentry>
  3598. <refentry version="5.0" xml:id="default.table.frame">
  3599. <refmeta>
  3600. <refentrytitle>default.table.frame</refentrytitle>
  3601. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  3602. </refmeta>
  3603. <refnamediv>
  3604. <refname>default.table.frame</refname>
  3605. <refpurpose>The default framing of tables</refpurpose>
  3606. </refnamediv>
  3607. <refsynopsisdiv>
  3608. <programlisting xml:id="default.table.frame.frag">
  3609. &lt;xsl:param name="default.table.frame"&gt;all&lt;/xsl:param&gt;
  3610. </programlisting>
  3611. </refsynopsisdiv>
  3612. <refsection><info><title>Description</title></info>
  3613. <para>This value will be used when there is no frame attribute on the
  3614. table. </para>
  3615. </refsection>
  3616. </refentry>
  3617. <refentry version="5.0" xml:id="html.cellspacing">
  3618. <refmeta>
  3619. <refentrytitle>html.cellspacing</refentrytitle>
  3620. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  3621. </refmeta>
  3622. <refnamediv>
  3623. <refname>html.cellspacing</refname>
  3624. <refpurpose>Default value for cellspacing in HTML tables</refpurpose>
  3625. </refnamediv>
  3626. <refsynopsisdiv>
  3627. <programlisting xml:id="html.cellspacing.frag">
  3628. &lt;xsl:param name="html.cellspacing"&gt;&lt;/xsl:param&gt;
  3629. </programlisting>
  3630. </refsynopsisdiv>
  3631. <refsection><info><title>Description</title></info>
  3632. <para>If non-zero, this value will be used as the default cellspacing
  3633. value in HTML tables. nn for pixels or nn% for percentage
  3634. length. E.g. 5 or 5%</para>
  3635. </refsection>
  3636. </refentry>
  3637. <refentry version="5.0" xml:id="html.cellpadding">
  3638. <refmeta>
  3639. <refentrytitle>html.cellpadding</refentrytitle>
  3640. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  3641. </refmeta>
  3642. <refnamediv>
  3643. <refname>html.cellpadding</refname>
  3644. <refpurpose>Default value for cellpadding in HTML tables</refpurpose>
  3645. </refnamediv>
  3646. <refsynopsisdiv>
  3647. <programlisting xml:id="html.cellpadding.frag">
  3648. &lt;xsl:param name="html.cellpadding"&gt;&lt;/xsl:param&gt;
  3649. </programlisting>
  3650. </refsynopsisdiv>
  3651. <refsection><info><title>Description</title></info>
  3652. <para>If non-zero, this value will be used as the default cellpadding value
  3653. in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or
  3654. 5%</para>
  3655. </refsection>
  3656. </refentry>
  3657. </reference>
  3658. <reference xml:id="qa"><title>QAndASet</title>
  3659. <refentry version="5.0" xml:id="qanda.defaultlabel">
  3660. <refmeta>
  3661. <refentrytitle>qanda.defaultlabel</refentrytitle>
  3662. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  3663. <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
  3664. <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo>
  3665. <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
  3666. </refmeta>
  3667. <refnamediv>
  3668. <refname>qanda.defaultlabel</refname>
  3669. <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
  3670. </refnamediv>
  3671. <refsynopsisdiv>
  3672. <programlisting xml:id="qanda.defaultlabel.frag">
  3673. &lt;xsl:param name="qanda.defaultlabel"&gt;number&lt;/xsl:param&gt;
  3674. </programlisting>
  3675. </refsynopsisdiv>
  3676. <refsection><info><title>Description</title></info>
  3677. <para>If no <literal>defaultlabel</literal> attribute is specified on
  3678. a <tag>qandaset</tag>, this value is used. It is generally one of the legal
  3679. values for the defaultlabel attribute (<literal>none</literal>,
  3680. <literal>number</literal> or
  3681. <literal>qanda</literal>), or one of the additional stylesheet-specific values
  3682. (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
  3683. The default value is 'number'.
  3684. </para>
  3685. <para>The values are rendered as follows:</para>
  3686. <variablelist>
  3687. <varlistentry><term><literal>qanda</literal></term>
  3688. <listitem>
  3689. <para><tag>question</tag>s are labeled "Q:" and
  3690. <tag>answer</tag>s are labeled "A:". </para>
  3691. </listitem>
  3692. </varlistentry>
  3693. <varlistentry><term><literal>number</literal></term>
  3694. <listitem>
  3695. <para>The questions are enumerated and the answers
  3696. are not labeled. </para>
  3697. </listitem>
  3698. </varlistentry>
  3699. <varlistentry><term><literal>qnumber</literal></term>
  3700. <listitem>
  3701. <para>The questions are labeled "Q:" followed by a number, and answers are not
  3702. labeled.
  3703. When sections are numbered, adding a label
  3704. to the number distinguishes the question numbers
  3705. from the section numbers.
  3706. This value is not allowed in the
  3707. <tag class="attribute">defaultlabel</tag> attribute
  3708. of a <tag>qandaset</tag> element.</para>
  3709. </listitem>
  3710. </varlistentry>
  3711. <varlistentry><term><literal>qnumberanda</literal></term>
  3712. <listitem>
  3713. <para>The questions are labeled "Q:" followed by a number, and
  3714. the answers are labeled "A:".
  3715. When sections are numbered, adding a label
  3716. to the number distinguishes the question numbers
  3717. from the section numbers.
  3718. This value is not allowed in the
  3719. <tag class="attribute">defaultlabel</tag> attribute
  3720. of a <tag>qandaset</tag> element.</para>
  3721. </listitem>
  3722. </varlistentry>
  3723. <varlistentry><term><literal>none</literal></term>
  3724. <listitem>
  3725. <para>No distinguishing label precedes Questions or Answers.
  3726. </para>
  3727. </listitem>
  3728. </varlistentry>
  3729. </variablelist>
  3730. </refsection>
  3731. </refentry>
  3732. <refentry version="5.0" xml:id="qanda.inherit.numeration">
  3733. <refmeta>
  3734. <refentrytitle>qanda.inherit.numeration</refentrytitle>
  3735. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3736. </refmeta>
  3737. <refnamediv>
  3738. <refname>qanda.inherit.numeration</refname>
  3739. <refpurpose>Does enumeration of QandASet components inherit the numeration of parent elements?</refpurpose>
  3740. </refnamediv>
  3741. <refsynopsisdiv>
  3742. <programlisting xml:id="qanda.inherit.numeration.frag">
  3743. &lt;xsl:param name="qanda.inherit.numeration" select="1"&gt;&lt;/xsl:param&gt;
  3744. </programlisting>
  3745. </refsynopsisdiv>
  3746. <refsection><info><title>Description</title></info>
  3747. <para>If non-zero, numbered <tag>qandadiv</tag> elements and
  3748. <tag>question</tag> and <tag>answer</tag> inherit the enumeration of
  3749. the ancestors of the <tag>qandaset</tag>.
  3750. </para>
  3751. </refsection>
  3752. </refentry>
  3753. <refentry version="5.0" xml:id="qanda.in.toc">
  3754. <refmeta>
  3755. <refentrytitle>qanda.in.toc</refentrytitle>
  3756. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3757. </refmeta>
  3758. <refnamediv>
  3759. <refname>qanda.in.toc</refname>
  3760. <refpurpose>Should qandaentry questions appear in
  3761. the document table of contents?</refpurpose>
  3762. </refnamediv>
  3763. <refsynopsisdiv>
  3764. <programlisting xml:id="qanda.in.toc.frag">&lt;xsl:param name="qanda.in.toc" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  3765. </refsynopsisdiv>
  3766. <refsection><info><title>Description</title></info>
  3767. <para>If true (non-zero), then the generated table of contents
  3768. for a document will include <tag>qandaset</tag> titles,
  3769. <tag>qandadiv</tag> titles,
  3770. and <tag>question</tag> elements. The default value (zero) excludes
  3771. them from the TOC.
  3772. </para>
  3773. <para>This parameter does not affect any tables of contents
  3774. that may be generated inside a qandaset or qandadiv.
  3775. </para>
  3776. </refsection>
  3777. </refentry>
  3778. <refentry version="5.0" xml:id="qanda.nested.in.toc">
  3779. <refmeta>
  3780. <refentrytitle>qanda.nested.in.toc</refentrytitle>
  3781. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3782. </refmeta>
  3783. <refnamediv>
  3784. <refname>qanda.nested.in.toc</refname>
  3785. <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose>
  3786. </refnamediv>
  3787. <refsynopsisdiv>
  3788. <programlisting xml:id="qanda.nested.in.toc.frag">
  3789. &lt;xsl:param name="qanda.nested.in.toc" select="0"&gt;&lt;/xsl:param&gt;
  3790. </programlisting>
  3791. </refsynopsisdiv>
  3792. <refsection><info><title>Description</title></info>
  3793. <para>If non-zero, instances of <tag>qandaentry</tag>
  3794. that are children of <tag>answer</tag> elements are shown in
  3795. the TOC.</para>
  3796. </refsection>
  3797. </refentry>
  3798. </reference>
  3799. <reference xml:id="links"><title>Linking</title>
  3800. <refentry version="5.0" xml:id="target.database.document">
  3801. <refmeta>
  3802. <refentrytitle>target.database.document</refentrytitle>
  3803. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  3804. </refmeta>
  3805. <refnamediv>
  3806. <refname>target.database.document</refname>
  3807. <refpurpose>Name of master database file for resolving
  3808. olinks</refpurpose>
  3809. </refnamediv>
  3810. <refsynopsisdiv>
  3811. <programlisting xml:id="target.database.document.frag">
  3812. &lt;xsl:param name="target.database.document"&gt;olinkdb.xml&lt;/xsl:param&gt;
  3813. </programlisting>
  3814. </refsynopsisdiv>
  3815. <refsection><info><title>Description</title></info>
  3816. <para>
  3817. To resolve olinks between documents, the stylesheets use a master
  3818. database document that identifies the target datafiles for all the
  3819. documents within the scope of the olinks. This parameter value is the
  3820. URI of the master document to be read during processing to resolve
  3821. olinks. The default value is <filename>olinkdb.xml</filename>.</para>
  3822. <para>The data structure of the file is defined in the
  3823. <filename>targetdatabase.dtd</filename> DTD. The database file
  3824. provides the high level elements to record the identifiers, locations,
  3825. and relationships of documents. The cross reference data for
  3826. individual documents is generally pulled into the database using
  3827. system entity references or XIncludes. See also
  3828. <parameter>targets.filename</parameter>. </para> </refsection>
  3829. </refentry>
  3830. <refentry version="5.0" xml:id="targets.filename">
  3831. <refmeta>
  3832. <refentrytitle>targets.filename</refentrytitle>
  3833. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  3834. </refmeta>
  3835. <refnamediv>
  3836. <refname>targets.filename</refname>
  3837. <refpurpose>Name of cross reference targets data file</refpurpose>
  3838. </refnamediv>
  3839. <refsynopsisdiv> <programlisting xml:id="targets.filename.frag">
  3840. &lt;xsl:param name="targets.filename"&gt;target.db&lt;/xsl:param&gt;
  3841. </programlisting>
  3842. </refsynopsisdiv>
  3843. <refsection><info><title>Description</title></info>
  3844. <para>
  3845. In order to resolve olinks efficiently, the stylesheets can
  3846. generate an external data file containing information about
  3847. all potential cross reference endpoints in a document.
  3848. This parameter lets you change the name of the generated
  3849. file from the default name <filename>target.db</filename>.
  3850. The name must agree with that used in the target database
  3851. used to resolve olinks during processing.
  3852. See also <parameter>target.database.document</parameter>.
  3853. </para>
  3854. </refsection>
  3855. </refentry>
  3856. <refentry version="5.0" xml:id="olink.base.uri">
  3857. <refmeta>
  3858. <refentrytitle>olink.base.uri</refentrytitle>
  3859. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  3860. </refmeta>
  3861. <refnamediv>
  3862. <refname>olink.base.uri</refname>
  3863. <refpurpose>Base URI used in olink hrefs</refpurpose>
  3864. </refnamediv>
  3865. <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag">
  3866. &lt;xsl:param name="olink.base.uri"&gt;&lt;/xsl:param&gt;
  3867. </programlisting>
  3868. </refsynopsisdiv>
  3869. <refsection><info><title>Description</title></info>
  3870. <para>When cross reference data is collected for resolving olinks, it
  3871. may be necessary to prepend a base URI to each target's href. This
  3872. parameter lets you set that base URI when cross reference data is
  3873. collected. This feature is needed when you want to link to a document
  3874. that is processed without chunking. The output filename for such a
  3875. document is not known to the XSL stylesheet; the only target
  3876. information consists of fragment identifiers such as
  3877. <literal>#idref</literal>. To enable the resolution of olinks between
  3878. documents, you should pass the name of the HTML output file as the
  3879. value of this parameter. Then the hrefs recorded in the cross
  3880. reference data collection look like
  3881. <literal>outfile.html#idref</literal>, which can be reached as links
  3882. from other documents.</para>
  3883. </refsection>
  3884. </refentry>
  3885. <refentry version="5.0" xml:id="use.local.olink.style">
  3886. <refmeta>
  3887. <refentrytitle>use.local.olink.style</refentrytitle>
  3888. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  3889. </refmeta>
  3890. <refnamediv>
  3891. <refname>use.local.olink.style</refname>
  3892. <refpurpose>Process olinks using xref style of current
  3893. document</refpurpose>
  3894. </refnamediv>
  3895. <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag">
  3896. &lt;xsl:param name="use.local.olink.style" select="0"&gt;&lt;/xsl:param&gt; </programlisting>
  3897. </refsynopsisdiv>
  3898. <refsection><info><title>Description</title></info>
  3899. <para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross
  3900. reference string is formed again from the target title, number, and
  3901. element name, using the stylesheet processing the targeting document.
  3902. Then olinks will match the xref style in the targeting document
  3903. rather than in the target document. If both documents are processed
  3904. with the same stylesheet, then the results will be the same.</para>
  3905. </refsection>
  3906. </refentry>
  3907. <refentry version="5.0" xml:id="current.docid">
  3908. <refmeta>
  3909. <refentrytitle>current.docid</refentrytitle>
  3910. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  3911. </refmeta>
  3912. <refnamediv>
  3913. <refname>current.docid</refname>
  3914. <refpurpose>targetdoc identifier for the document being
  3915. processed</refpurpose>
  3916. </refnamediv>
  3917. <refsynopsisdiv> <programlisting xml:id="current.docid.frag">
  3918. &lt;xsl:param name="current.docid"&gt;&lt;/xsl:param&gt;
  3919. </programlisting>
  3920. </refsynopsisdiv>
  3921. <refsection><info><title>Description</title></info>
  3922. <para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet
  3923. the targetdoc identifier of the current document, since that
  3924. identifier does not appear in the document itself. </para>
  3925. <para>This parameter can also be used for print output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para>
  3926. </refsection>
  3927. </refentry>
  3928. <refentry version="5.0" xml:id="olink.doctitle">
  3929. <refmeta>
  3930. <refentrytitle>olink.doctitle</refentrytitle>
  3931. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  3932. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  3933. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  3934. <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
  3935. </refmeta>
  3936. <refnamediv>
  3937. <refname>olink.doctitle</refname>
  3938. <refpurpose>show the document title for external olinks?</refpurpose>
  3939. </refnamediv>
  3940. <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag">
  3941. &lt;xsl:param name="olink.doctitle"&gt;no&lt;/xsl:param&gt;
  3942. </programlisting>
  3943. </refsynopsisdiv>
  3944. <refsection><info><title>Description</title></info>
  3945. <para>When olinks between documents are resolved, the generated text
  3946. may not make it clear that the reference is to another document.
  3947. It is possible for the stylesheets to append the other document's
  3948. title to external olinks. For this to happen, two parameters must
  3949. be set.</para>
  3950. <itemizedlist>
  3951. <listitem>
  3952. <para>This <parameter>olink.doctitle</parameter> parameter
  3953. should be set to either <literal>yes</literal> or <literal>maybe</literal>
  3954. to enable this feature.
  3955. </para>
  3956. </listitem>
  3957. <listitem>
  3958. <para>And you should also set the <parameter>current.docid</parameter>
  3959. parameter to the document id for the document currently
  3960. being processed for output.
  3961. </para>
  3962. </listitem>
  3963. </itemizedlist>
  3964. <para>
  3965. Then if an olink's <literal>targetdoc</literal> id differs from
  3966. the <literal>current.docid</literal> value, the stylesheet knows
  3967. that it is a reference to another document and can
  3968. append the target document's
  3969. title to the generated olink text. </para>
  3970. <para>The text for the target document's title is copied from the
  3971. olink database from the <tag>ttl</tag> element
  3972. of the top-level <tag>div</tag> for that document.
  3973. If that <tag>ttl</tag> element is missing or empty,
  3974. no title is output.
  3975. </para>
  3976. <para>The supported values for <parameter>olink.doctitle</parameter> are:
  3977. </para>
  3978. <variablelist>
  3979. <varlistentry>
  3980. <term><literal>yes</literal></term>
  3981. <listitem>
  3982. <para>
  3983. Always insert the title to the target document if it is not
  3984. the current document.
  3985. </para>
  3986. </listitem>
  3987. </varlistentry>
  3988. <varlistentry>
  3989. <term><literal>no</literal></term>
  3990. <listitem>
  3991. <para>
  3992. Never insert the title to the target document, even if requested
  3993. in an <tag class="attribute">xrefstyle</tag> attribute.
  3994. </para>
  3995. </listitem>
  3996. </varlistentry>
  3997. <varlistentry>
  3998. <term><literal>maybe</literal></term>
  3999. <listitem>
  4000. <para>
  4001. Only insert the title to the target document, if requested
  4002. in an <tag class="attribute">xrefstyle</tag> attribute.
  4003. </para>
  4004. </listitem>
  4005. </varlistentry>
  4006. </variablelist>
  4007. <para>An <tag class="attribute">xrefstyle</tag> attribute
  4008. may override the global setting for individual olinks.
  4009. The following values are supported in an
  4010. <tag class="attribute">xrefstyle</tag>
  4011. attribute using the <literal>select:</literal> syntax:
  4012. </para>
  4013. <variablelist>
  4014. <varlistentry>
  4015. <term><literal>docname</literal></term>
  4016. <listitem>
  4017. <para>
  4018. Insert the target document name for this olink using the
  4019. <literal>docname</literal> gentext template, but only
  4020. if the value of <parameter>olink.doctitle</parameter>
  4021. is not <literal>no</literal>.
  4022. </para>
  4023. </listitem>
  4024. </varlistentry>
  4025. <varlistentry>
  4026. <term><literal>docnamelong</literal></term>
  4027. <listitem>
  4028. <para>
  4029. Insert the target document name for this olink using the
  4030. <literal>docnamelong</literal> gentext template, but only
  4031. if the value of <parameter>olink.doctitle</parameter>
  4032. is not <literal>no</literal>.
  4033. </para>
  4034. </listitem>
  4035. </varlistentry>
  4036. <varlistentry>
  4037. <term><literal>nodocname</literal></term>
  4038. <listitem>
  4039. <para>
  4040. Omit the target document name even if
  4041. the value of <parameter>olink.doctitle</parameter>
  4042. is <literal>yes</literal>.
  4043. </para>
  4044. </listitem>
  4045. </varlistentry>
  4046. </variablelist>
  4047. <para>Another way of inserting the target document name
  4048. for a single olink is to employ an
  4049. <tag class="attribute">xrefstyle</tag>
  4050. attribute using the <literal>template:</literal> syntax.
  4051. The <literal>%o</literal> placeholder (the letter o, not zero)
  4052. in such a template
  4053. will be filled in with the target document's title when it is processed.
  4054. This will occur regardless of
  4055. the value of <parameter>olink.doctitle</parameter>.
  4056. </para>
  4057. <para>Note that prior to version 1.66 of the XSL stylesheets,
  4058. the allowed values for this parameter were 0 and 1. Those
  4059. values are still supported and mapped to 'no' and 'yes', respectively.
  4060. </para>
  4061. </refsection>
  4062. </refentry>
  4063. <refentry version="5.0" xml:id="activate.external.olinks">
  4064. <refmeta>
  4065. <refentrytitle>activate.external.olinks</refentrytitle>
  4066. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4067. </refmeta>
  4068. <refnamediv>
  4069. <refname>activate.external.olinks</refname>
  4070. <refpurpose>Make external olinks into active links</refpurpose>
  4071. </refnamediv>
  4072. <refsynopsisdiv>
  4073. <programlisting xml:id="activate.external.olinks.frag">
  4074. &lt;xsl:param name="activate.external.olinks" select="1"&gt;&lt;/xsl:param&gt;
  4075. </programlisting>
  4076. </refsynopsisdiv>
  4077. <refsection><info><title>Description</title></info>
  4078. <para>If <parameter>activate.external.olinks</parameter> is nonzero
  4079. (the default), then any olinks that reference another document
  4080. become active links that can be clicked on to follow the link.
  4081. If the parameter is set to zero, then external olinks
  4082. will have the appropriate link text generated, but the link is
  4083. not made active. Olinks to destinations in
  4084. the current document remain active.</para>
  4085. <para>To make an external olink active for HTML
  4086. outputs, the link text is wrapped in an <tag>a</tag>
  4087. element with an <tag>href</tag> attribute. To
  4088. make an external olink active for FO outputs, the link text is
  4089. wrapped in an <tag>fo:basic-link</tag> element with an
  4090. <tag>external-destination</tag> attribute.</para>
  4091. <para>This parameter is useful when you need external olinks
  4092. to resolve but not be clickable. For example, if documents
  4093. in a collection are available independently of each other,
  4094. then having active links between them could lead to
  4095. unresolved links when a given target document is missing.</para>
  4096. <para>The epub stylesheets set this parameter to zero by default
  4097. because there is no standard linking mechanism between Epub documents.</para>
  4098. <para>If external links are made inactive, you should
  4099. consider setting the
  4100. stylesheet parameter <parameter>olink.doctitle</parameter>
  4101. to <literal>yes</literal>. That will append the external document's
  4102. title to the link text, making it easier for the user to
  4103. locate the other document.</para>
  4104. <para>An olink is considered external when the
  4105. <parameter>current.docid</parameter> stylesheet parameter
  4106. is set to some value, and the olink's <tag>targetdoc</tag>
  4107. attribute has a different value. If the two values
  4108. match, then the link is considered internal. If the
  4109. <parameter>current.docid</parameter> parameter is blank, or
  4110. the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute,
  4111. then the link is considered to be internal and will become
  4112. an active link.</para>
  4113. <para>See also <parameter>olink.doctitle</parameter>,
  4114. <parameter>prefer.internal.olink</parameter>.</para>
  4115. </refsection>
  4116. </refentry>
  4117. <refentry version="5.0" xml:id="olink.debug">
  4118. <refmeta>
  4119. <refentrytitle>olink.debug</refentrytitle>
  4120. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4121. </refmeta>
  4122. <refnamediv>
  4123. <refname>olink.debug</refname>
  4124. <refpurpose>Turn on debugging messages for olinks</refpurpose>
  4125. </refnamediv>
  4126. <refsynopsisdiv>
  4127. <programlisting xml:id="olink.debug.frag">
  4128. &lt;xsl:param name="olink.debug" select="0"&gt;&lt;/xsl:param&gt;
  4129. </programlisting>
  4130. </refsynopsisdiv>
  4131. <refsection><info><title>Description</title></info>
  4132. <para>If non-zero, then each olink will generate several
  4133. messages about how it is being resolved during processing.
  4134. This is useful when an olink does not resolve properly
  4135. and the standard error messages are not sufficient to
  4136. find the problem.
  4137. </para>
  4138. <para>You may need to read through the olink XSL templates
  4139. to understand the context for some of the debug messages.
  4140. </para>
  4141. </refsection>
  4142. </refentry>
  4143. <refentry version="5.0" xml:id="olink.properties">
  4144. <refmeta>
  4145. <refentrytitle>olink.properties</refentrytitle>
  4146. <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
  4147. </refmeta>
  4148. <refnamediv>
  4149. <refname>olink.properties</refname>
  4150. <refpurpose>Properties associated with the cross-reference
  4151. text of an olink.</refpurpose>
  4152. </refnamediv>
  4153. <refsynopsisdiv>
  4154. <programlisting xml:id="olink.properties.frag">
  4155. &lt;xsl:attribute-set name="olink.properties"&gt;
  4156. &lt;xsl:attribute name="show-destination"&gt;replace&lt;/xsl:attribute&gt;
  4157. &lt;/xsl:attribute-set&gt;
  4158. </programlisting>
  4159. </refsynopsisdiv>
  4160. <refsection><info><title>Description</title></info>
  4161. <para>This <literal>attribute set</literal> is applied to the
  4162. <literal>fo:basic-link</literal> element of an olink. It is not applied to the
  4163. optional page number or optional title of the external
  4164. document.</para>
  4165. </refsection>
  4166. </refentry>
  4167. <refentry version="5.0" xml:id="olink.lang.fallback.sequence">
  4168. <refmeta>
  4169. <refentrytitle>olink.lang.fallback.sequence</refentrytitle>
  4170. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4171. </refmeta>
  4172. <refnamediv>
  4173. <refname>olink.lang.fallback.sequence</refname>
  4174. <refpurpose>look up translated documents if olink not found?</refpurpose>
  4175. </refnamediv>
  4176. <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag">
  4177. &lt;xsl:param name="olink.lang.fallback.sequence"&gt;&lt;/xsl:param&gt;
  4178. </programlisting>
  4179. </refsynopsisdiv>
  4180. <refsection><info><title>Description</title></info>
  4181. <para>This parameter defines a list of lang values
  4182. to search among to resolve olinks.
  4183. </para>
  4184. <para>Normally an olink tries to resolve to a document in the same
  4185. language as the olink itself. The language of an olink
  4186. is determined by its nearest ancestor element with a
  4187. <tag class="attribute">lang</tag> attribute, otherwise the
  4188. value of the <parameter>l10n.gentext.default.lang</parameter>
  4189. parameter.
  4190. </para>
  4191. <para>An olink database can contain target data for the same
  4192. document in multiple languages. Each set of data has the
  4193. same value for the <tag>targetdoc</tag> attribute in
  4194. the <tag>document</tag> element in the database, but with a
  4195. different <tag>lang</tag> attribute value.
  4196. </para>
  4197. <para>When an olink is being resolved, the target is first
  4198. sought in the document with the same language as the olink.
  4199. If no match is found there, then this parameter is consulted
  4200. for additional languages to try.</para>
  4201. <para>The <parameter>olink.lang.fallback.sequence</parameter>
  4202. must be a whitespace separated list of lang values to
  4203. try. The first one with a match in the olink database is used.
  4204. The default value is empty.</para>
  4205. <para>For example, a document might be written in German
  4206. and contain an olink with
  4207. <literal>targetdoc="adminguide"</literal>.
  4208. When the document is processed, the processor
  4209. first looks for a target dataset in the
  4210. olink database starting with:</para>
  4211. <literallayout><literal>&lt;document targetdoc="adminguide" lang="de"&gt;</literal>.
  4212. </literallayout>
  4213. <para>If there is no such element, then the
  4214. <parameter>olink.lang.fallback.sequence</parameter>
  4215. parameter is consulted.
  4216. If its value is, for example, <quote>fr en</quote>, then the processor next
  4217. looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and
  4218. then for <literal>targetdoc="adminguide" lang="en"</literal>.
  4219. If there is still no match, it looks for
  4220. <literal>targetdoc="adminguide"</literal> with no
  4221. lang attribute.
  4222. </para>
  4223. <para>This parameter is useful when a set of documents is only
  4224. partially translated, or is in the process of being translated.
  4225. If a target of an olink has not yet been translated, then this
  4226. parameter permits the processor to look for the document in
  4227. other languages. This assumes the reader would rather have
  4228. a link to a document in a different language than to have
  4229. a broken link.
  4230. </para>
  4231. </refsection>
  4232. </refentry>
  4233. <refentry version="5.0" xml:id="insert.olink.page.number">
  4234. <refmeta>
  4235. <refentrytitle>insert.olink.page.number</refentrytitle>
  4236. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  4237. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  4238. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  4239. <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
  4240. </refmeta>
  4241. <refnamediv>
  4242. <refname>insert.olink.page.number</refname>
  4243. <refpurpose>Turns page numbers in olinks on and off</refpurpose>
  4244. </refnamediv>
  4245. <refsynopsisdiv>
  4246. <programlisting xml:id="insert.olink.page.number.frag">
  4247. &lt;xsl:param name="insert.olink.page.number"&gt;no&lt;/xsl:param&gt;
  4248. </programlisting>
  4249. </refsynopsisdiv>
  4250. <refsection><info><title>Description</title></info>
  4251. <para>The value of this parameter determines if
  4252. cross references made between documents with
  4253. <tag>olink</tag> will
  4254. include page number citations.
  4255. In most cases this is only applicable to references in printed output.
  4256. </para>
  4257. <para>The parameter has three possible values.
  4258. </para>
  4259. <variablelist>
  4260. <varlistentry>
  4261. <term>no</term>
  4262. <listitem><para>No page number references will be generated for olinks.
  4263. </para></listitem>
  4264. </varlistentry>
  4265. <varlistentry>
  4266. <term>yes</term>
  4267. <listitem><para>Page number references will be generated
  4268. for all <tag>olink</tag> references.
  4269. The style of page reference may be changed
  4270. if an <tag class="attribute">xrefstyle</tag>
  4271. attribute is used.
  4272. </para></listitem>
  4273. </varlistentry>
  4274. <varlistentry>
  4275. <term>maybe</term>
  4276. <listitem><para>Page number references will not be generated
  4277. for an <tag>olink</tag> element unless
  4278. it has an
  4279. <tag class="attribute">xrefstyle</tag>
  4280. attribute whose value specifies a page reference.
  4281. </para></listitem>
  4282. </varlistentry>
  4283. </variablelist>
  4284. <para>Olinks that point to targets within the same document
  4285. are treated as <tag>xref</tag>s, and controlled by
  4286. the <parameter>insert.xref.page.number</parameter> parameter.
  4287. </para>
  4288. <para>Page number references for olinks to
  4289. external documents can only be inserted if the
  4290. information exists in the olink database.
  4291. This means each olink target element
  4292. (<tag>div</tag> or <tag>obj</tag>)
  4293. must have a <tag class="attribute">page</tag> attribute
  4294. whose value is its page number in the target document.
  4295. The XSL stylesheets are not able to extract that information
  4296. during processing because pages have not yet been created in
  4297. XSLT transformation. Only the XSL-FO processor knows what
  4298. page each element is placed on.
  4299. Therefore some postprocessing must take place to populate
  4300. page numbers in the olink database.
  4301. </para>
  4302. </refsection>
  4303. </refentry>
  4304. <refentry version="5.0" xml:id="insert.olink.pdf.frag">
  4305. <refmeta>
  4306. <refentrytitle>insert.olink.pdf.frag</refentrytitle>
  4307. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4308. </refmeta>
  4309. <refnamediv>
  4310. <refname>insert.olink.pdf.frag</refname>
  4311. <refpurpose>Add fragment identifiers for links into PDF files</refpurpose>
  4312. </refnamediv>
  4313. <refsynopsisdiv>
  4314. <programlisting xml:id="insert.olink.pdf.frag.frag">
  4315. &lt;xsl:param name="insert.olink.pdf.frag" select="0"&gt;&lt;/xsl:param&gt;
  4316. </programlisting>
  4317. </refsynopsisdiv>
  4318. <refsection><info><title>Description</title></info>
  4319. <para>The value of this parameter determines whether
  4320. the cross reference URIs to PDF documents made with
  4321. <tag>olink</tag> will
  4322. include fragment identifiers.
  4323. </para>
  4324. <para>When forming a URI to link to a PDF document,
  4325. a fragment identifier (typically a '#' followed by an
  4326. id value) appended to the PDF filename can be used by
  4327. the PDF viewer to open
  4328. the PDF file to a location within the document instead of
  4329. the first page.
  4330. However, not all PDF files have id
  4331. values embedded in them, and not all PDF viewers can
  4332. handle fragment identifiers.
  4333. </para>
  4334. <para>If <parameter>insert.olink.pdf.frag</parameter> is set
  4335. to a non-zero value, then any olink targeting a
  4336. PDF file will have the fragment identifier appended to the URI.
  4337. The URI is formed by concatenating the value of the
  4338. <parameter>olink.base.uri</parameter> parameter, the
  4339. value of the <tag class="attribute">baseuri</tag>
  4340. attribute from the <tag class="element">document</tag>
  4341. element in the olink database with the matching
  4342. <tag class="attribute">targetdoc</tag> value,
  4343. and the value of the <tag class="attribute">href</tag>
  4344. attribute for the targeted element in the olink database.
  4345. The <tag class="attribute">href</tag> attribute
  4346. contains the fragment identifier.
  4347. </para>
  4348. <para>If <parameter>insert.olink.pdf.frag</parameter> is set
  4349. to zero (the default value), then
  4350. the <tag class="attribute">href</tag> attribute
  4351. from the olink database
  4352. is not appended to PDF olinks, so the fragment identifier is left off.
  4353. A PDF olink is any olink for which the
  4354. <tag class="attribute">baseuri</tag> attribute
  4355. from the matching <tag class="element">document</tag>
  4356. element in the olink database ends with '.pdf'.
  4357. Any other olinks will still have the fragment identifier added.
  4358. </para>
  4359. </refsection>
  4360. </refentry>
  4361. <refentry version="5.0" xml:id="prefer.internal.olink">
  4362. <refmeta>
  4363. <refentrytitle>prefer.internal.olink</refentrytitle>
  4364. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4365. </refmeta>
  4366. <refnamediv>
  4367. <refname>prefer.internal.olink</refname>
  4368. <refpurpose>Prefer a local olink reference to an external reference</refpurpose>
  4369. </refnamediv>
  4370. <refsynopsisdiv>
  4371. <programlisting xml:id="prefer.internal.olink.frag">
  4372. &lt;xsl:param name="prefer.internal.olink" select="0"&gt;&lt;/xsl:param&gt;
  4373. </programlisting>
  4374. </refsynopsisdiv>
  4375. <refsection><info><title>Description</title></info>
  4376. <para>If you are re-using XML content modules in multiple documents,
  4377. you may want to redirect some of your olinks. This parameter
  4378. permits you to redirect an olink to the current document.
  4379. </para>
  4380. <para>For example: you are writing documentation for a product,
  4381. which includes 3 manuals: a little installation
  4382. booklet (booklet.xml), a user
  4383. guide (user.xml), and a reference manual (reference.xml).
  4384. All 3 documents begin with the same introduction section (intro.xml) that
  4385. contains a reference to the customization section (custom.xml) which is
  4386. included in both user.xml and reference.xml documents.
  4387. </para>
  4388. <para>How do you write the link to custom.xml in intro.xml
  4389. so that it is interpreted correctly in all 3 documents?</para>
  4390. <itemizedlist>
  4391. <listitem><para>If you use xref, it will fail in user.xml.</para>
  4392. </listitem>
  4393. <listitem><para>If you use olink (pointing to reference.xml),
  4394. the reference in user.xml
  4395. will point to the customization section of the reference manual, while it is
  4396. actually available in user.xml.</para>
  4397. </listitem>
  4398. </itemizedlist>
  4399. <para>If you set the <parameter>prefer.internal.olink</parameter>
  4400. parameter to a non-zero value, then the processor will
  4401. first look in the olink database
  4402. for the olink's <tag>targetptr</tag> attribute value
  4403. in document matching the <parameter>current.docid</parameter>
  4404. parameter value. If it isn't found there, then
  4405. it tries the document in the database
  4406. with the <tag>targetdoc</tag>
  4407. value that matches the olink's <tag>targetdoc</tag>
  4408. attribute.
  4409. </para>
  4410. <para>This feature permits an olink reference to resolve to
  4411. the current document if there is an element
  4412. with an id matching the olink's <tag>targetptr</tag>
  4413. value. The current document's olink data must be
  4414. included in the target database for this to work.</para>
  4415. <caution>
  4416. <para>There is a potential for incorrect links if
  4417. the same <tag>id</tag> attribute value is used for different
  4418. content in different documents.
  4419. Some of your olinks may be redirected to the current document
  4420. when they shouldn't be. It is not possible to control
  4421. individual olink instances.</para>
  4422. </caution>
  4423. </refsection>
  4424. </refentry>
  4425. <refentry version="5.0" xml:id="link.mailto.url">
  4426. <refmeta>
  4427. <refentrytitle>link.mailto.url</refentrytitle>
  4428. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4429. </refmeta>
  4430. <refnamediv>
  4431. <refname>link.mailto.url</refname>
  4432. <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose>
  4433. </refnamediv>
  4434. <refsynopsisdiv>
  4435. <programlisting xml:id="link.mailto.url.frag">
  4436. &lt;xsl:param name="link.mailto.url"&gt;&lt;/xsl:param&gt;
  4437. </programlisting>
  4438. </refsynopsisdiv>
  4439. <refsection><info><title>Description</title></info>
  4440. <para>If not the empty string, this address will be used for the
  4441. rel=made <literal>link</literal> element in the html <literal>head</literal>
  4442. </para>
  4443. </refsection>
  4444. </refentry>
  4445. <refentry version="5.0" xml:id="ulink.target">
  4446. <refmeta>
  4447. <refentrytitle>ulink.target</refentrytitle>
  4448. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4449. </refmeta>
  4450. <refnamediv>
  4451. <refname>ulink.target</refname>
  4452. <refpurpose>The HTML anchor target for ULinks</refpurpose>
  4453. </refnamediv>
  4454. <refsynopsisdiv>
  4455. <programlisting xml:id="ulink.target.frag">
  4456. &lt;xsl:param name="ulink.target"&gt;_top&lt;/xsl:param&gt;
  4457. </programlisting>
  4458. </refsynopsisdiv>
  4459. <refsection><info><title>Description</title></info>
  4460. <para>If <parameter>ulink.target</parameter> is non-zero, its value will
  4461. be used for the <literal>target</literal> attribute
  4462. on anchors generated for <tag>ulink</tag>s.</para>
  4463. </refsection>
  4464. </refentry>
  4465. </reference>
  4466. <reference xml:id="xrefs"><title>Cross References</title>
  4467. <refentry version="5.0" xml:id="collect.xref.targets">
  4468. <refmeta>
  4469. <refentrytitle>collect.xref.targets</refentrytitle>
  4470. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  4471. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  4472. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  4473. <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
  4474. </refmeta>
  4475. <refnamediv>
  4476. <refname>collect.xref.targets</refname>
  4477. <refpurpose>Controls whether cross reference data is
  4478. collected</refpurpose>
  4479. </refnamediv>
  4480. <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag">
  4481. &lt;xsl:param name="collect.xref.targets"&gt;no&lt;/xsl:param&gt;
  4482. </programlisting>
  4483. </refsynopsisdiv>
  4484. <refsection><info><title>Description</title></info>
  4485. <para>
  4486. In order to resolve olinks efficiently, the stylesheets can
  4487. generate an external data file containing information about
  4488. all potential cross reference endpoints in a document.
  4489. This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output.
  4490. See also <parameter>targets.filename</parameter>.
  4491. </para>
  4492. </refsection>
  4493. </refentry>
  4494. <refentry version="5.0" xml:id="insert.xref.page.number">
  4495. <refmeta>
  4496. <refentrytitle>insert.xref.page.number</refentrytitle>
  4497. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  4498. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  4499. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  4500. <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
  4501. </refmeta>
  4502. <refnamediv>
  4503. <refname>insert.xref.page.number</refname>
  4504. <refpurpose>Turns page numbers in xrefs on and off</refpurpose>
  4505. </refnamediv>
  4506. <refsynopsisdiv>
  4507. <programlisting xml:id="insert.xref.page.number.frag">
  4508. &lt;xsl:param name="insert.xref.page.number"&gt;no&lt;/xsl:param&gt;
  4509. </programlisting>
  4510. </refsynopsisdiv>
  4511. <refsection><info><title>Description</title></info>
  4512. <para>The value of this parameter determines if
  4513. cross references (<tag>xref</tag>s) in
  4514. printed output will
  4515. include page number citations.
  4516. It has three possible values.
  4517. </para>
  4518. <variablelist>
  4519. <varlistentry>
  4520. <term>no</term>
  4521. <listitem><para>No page number references will be generated.
  4522. </para></listitem>
  4523. </varlistentry>
  4524. <varlistentry>
  4525. <term>yes</term>
  4526. <listitem><para>Page number references will be generated
  4527. for all <tag>xref</tag> elements.
  4528. The style of page reference may be changed
  4529. if an <tag class="attribute">xrefstyle</tag>
  4530. attribute is used.
  4531. </para></listitem>
  4532. </varlistentry>
  4533. <varlistentry>
  4534. <term>maybe</term>
  4535. <listitem><para>Page number references will not be generated
  4536. for an <tag>xref</tag> element unless
  4537. it has an
  4538. <tag class="attribute">xrefstyle</tag>
  4539. attribute whose value specifies a page reference.
  4540. </para></listitem>
  4541. </varlistentry>
  4542. </variablelist>
  4543. </refsection>
  4544. </refentry>
  4545. <refentry version="5.0" xml:id="use.role.as.xrefstyle">
  4546. <refmeta>
  4547. <refentrytitle>use.role.as.xrefstyle</refentrytitle>
  4548. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4549. </refmeta>
  4550. <refnamediv>
  4551. <refname>use.role.as.xrefstyle</refname>
  4552. <refpurpose>Use <tag class="attribute">role</tag> attribute for
  4553. <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
  4554. </refnamediv>
  4555. <refsynopsisdiv>
  4556. <programlisting xml:id="use.role.as.xrefstyle.frag">
  4557. &lt;xsl:param name="use.role.as.xrefstyle" select="1"&gt;&lt;/xsl:param&gt;
  4558. </programlisting>
  4559. </refsynopsisdiv>
  4560. <refsection><info><title>Description</title></info>
  4561. <para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
  4562. <tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
  4563. <para>If non-zero, the <tag class="attribute">role</tag> attribute on
  4564. <tag>xref</tag> will be used to select the cross reference style.
  4565. In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
  4566. If the <tag class="attribute">xrefstyle</tag> attribute is present,
  4567. <tag class="attribute">role</tag> will be ignored, regardless of the setting
  4568. of this parameter.</para>
  4569. </refsection>
  4570. <refsection><info><title>Example</title></info>
  4571. <para>The following small stylesheet shows how to configure the
  4572. stylesheets to make use of the cross reference style:</para>
  4573. <programlisting>&lt;?xml version="1.0"?&gt;
  4574. &lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  4575. version="1.0"&gt;
  4576. &lt;xsl:import href="../xsl/html/docbook.xsl"/&gt;
  4577. &lt;xsl:output method="html"/&gt;
  4578. &lt;xsl:param name="local.l10n.xml" select="document('')"/&gt;
  4579. &lt;l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"&gt;
  4580. &lt;l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"&gt;
  4581. &lt;l:context name="xref"&gt;
  4582. &lt;l:template name="chapter" style="title" text="Chapter %n, %t"/&gt;
  4583. &lt;l:template name="chapter" text="Chapter %n"/&gt;
  4584. &lt;/l:context&gt;
  4585. &lt;/l:l10n&gt;
  4586. &lt;/l:i18n&gt;
  4587. &lt;/xsl:stylesheet&gt;</programlisting>
  4588. <para>With this stylesheet, the cross references in the following document:</para>
  4589. <programlisting>&lt;?xml version="1.0" encoding="utf-8"?&gt;
  4590. &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  4591. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
  4592. &lt;book id="book"&gt;&lt;title&gt;Book&lt;/title&gt;
  4593. &lt;preface&gt;
  4594. &lt;title&gt;Preface&lt;/title&gt;
  4595. &lt;para&gt;Normal: &lt;xref linkend="ch1"/&gt;.&lt;/para&gt;
  4596. &lt;para&gt;Title: &lt;xref xrefstyle="title" linkend="ch1"/&gt;.&lt;/para&gt;
  4597. &lt;/preface&gt;
  4598. &lt;chapter id="ch1"&gt;
  4599. &lt;title&gt;First Chapter&lt;/title&gt;
  4600. &lt;para&gt;Irrelevant.&lt;/para&gt;
  4601. &lt;/chapter&gt;
  4602. &lt;/book&gt;</programlisting>
  4603. <para>will appear as:</para>
  4604. <informalexample>
  4605. <para>Normal: Chapter 1.</para>
  4606. <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
  4607. </informalexample>
  4608. </refsection>
  4609. </refentry>
  4610. <refentry version="5.0" xml:id="xref.with.number.and.title">
  4611. <refmeta>
  4612. <refentrytitle>xref.with.number.and.title</refentrytitle>
  4613. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4614. </refmeta>
  4615. <refnamediv>
  4616. <refname>xref.with.number.and.title</refname>
  4617. <refpurpose>Use number and title in cross references</refpurpose>
  4618. </refnamediv>
  4619. <refsynopsisdiv>
  4620. <programlisting xml:id="xref.with.number.and.title.frag">
  4621. &lt;xsl:param name="xref.with.number.and.title" select="1"&gt;&lt;/xsl:param&gt;
  4622. </programlisting>
  4623. </refsynopsisdiv>
  4624. <refsection><info><title>Description</title></info>
  4625. <para>A cross reference may include the number (for example, the number of
  4626. an example or figure) and the <tag>title</tag> which is a required child of some
  4627. targets. This parameter inserts both the relevant number as well as
  4628. the title into the link. </para>
  4629. </refsection>
  4630. </refentry>
  4631. <refentry version="5.0" xml:id="xref.label-page.separator">
  4632. <refmeta>
  4633. <refentrytitle>xref.label-page.separator</refentrytitle>
  4634. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4635. </refmeta>
  4636. <refnamediv>
  4637. <refname>xref.label-page.separator</refname>
  4638. <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
  4639. </refnamediv>
  4640. <refsynopsisdiv>
  4641. <programlisting xml:id="xref.label-page.separator.frag">&lt;xsl:param name="xref.label-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
  4642. </refsynopsisdiv>
  4643. <refsection><info><title>Description</title></info>
  4644. <para>
  4645. This parameter allows you to control the punctuation of certain
  4646. types of generated cross reference text.
  4647. When cross reference text is generated for an
  4648. <tag class="element">xref</tag> or
  4649. <tag class="element">olink</tag> element
  4650. using an <tag class="attribute">xrefstyle</tag> attribute
  4651. that makes use of the <literal>select:</literal> feature,
  4652. and the selected components include both label and page
  4653. but no title,
  4654. then the value of this parameter is inserted between
  4655. label and page number in the output.
  4656. If a title is included, then other separators are used.
  4657. </para>
  4658. </refsection>
  4659. </refentry>
  4660. <refentry version="5.0" xml:id="xref.label-title.separator">
  4661. <refmeta>
  4662. <refentrytitle>xref.label-title.separator</refentrytitle>
  4663. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4664. </refmeta>
  4665. <refnamediv>
  4666. <refname>xref.label-title.separator</refname>
  4667. <refpurpose>Punctuation or space separating label from title in xref</refpurpose>
  4668. </refnamediv>
  4669. <refsynopsisdiv>
  4670. <programlisting xml:id="xref.label-title.separator.frag">&lt;xsl:param name="xref.label-title.separator"&gt;: &lt;/xsl:param&gt;</programlisting>
  4671. </refsynopsisdiv>
  4672. <refsection><info><title>Description</title></info>
  4673. <para>
  4674. This parameter allows you to control the punctuation of certain
  4675. types of generated cross reference text.
  4676. When cross reference text is generated for an
  4677. <tag class="element">xref</tag> or
  4678. <tag class="element">olink</tag> element
  4679. using an <tag class="attribute">xrefstyle</tag> attribute
  4680. that makes use of the <literal>select:</literal> feature,
  4681. and the selected components include both label and title,
  4682. then the value of this parameter is inserted between
  4683. label and title in the output.
  4684. </para>
  4685. </refsection>
  4686. </refentry>
  4687. <refentry version="5.0" xml:id="xref.title-page.separator">
  4688. <refmeta>
  4689. <refentrytitle>xref.title-page.separator</refentrytitle>
  4690. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4691. </refmeta>
  4692. <refnamediv>
  4693. <refname>xref.title-page.separator</refname>
  4694. <refpurpose>Punctuation or space separating title from page number in xref</refpurpose>
  4695. </refnamediv>
  4696. <refsynopsisdiv>
  4697. <programlisting xml:id="xref.title-page.separator.frag">&lt;xsl:param name="xref.title-page.separator"&gt;&lt;xsl:text&gt; &lt;/xsl:text&gt;&lt;/xsl:param&gt;</programlisting>
  4698. </refsynopsisdiv>
  4699. <refsection><info><title>Description</title></info>
  4700. <para>
  4701. This parameter allows you to control the punctuation of certain
  4702. types of generated cross reference text.
  4703. When cross reference text is generated for an
  4704. <tag class="element">xref</tag> or
  4705. <tag class="element">olink</tag> element
  4706. using an <tag class="attribute">xrefstyle</tag> attribute
  4707. that makes use of the <literal>select:</literal> feature,
  4708. and the selected components include both title and page number,
  4709. then the value of this parameter is inserted between
  4710. title and page number in the output.
  4711. </para>
  4712. </refsection>
  4713. </refentry>
  4714. </reference>
  4715. <reference xml:id="lists"><title>Lists</title>
  4716. <refentry version="5.0" xml:id="segmentedlist.as.table">
  4717. <refmeta>
  4718. <refentrytitle>segmentedlist.as.table</refentrytitle>
  4719. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4720. </refmeta>
  4721. <refnamediv>
  4722. <refname>segmentedlist.as.table</refname>
  4723. <refpurpose>Format segmented lists as tables?</refpurpose>
  4724. </refnamediv>
  4725. <refsynopsisdiv>
  4726. <programlisting xml:id="segmentedlist.as.table.frag">
  4727. &lt;xsl:param name="segmentedlist.as.table" select="0"&gt;&lt;/xsl:param&gt;
  4728. </programlisting>
  4729. </refsynopsisdiv>
  4730. <refsection><info><title>Description</title></info>
  4731. <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as
  4732. tables.</para>
  4733. </refsection>
  4734. </refentry>
  4735. <refentry version="5.0" xml:id="variablelist.as.table">
  4736. <refmeta>
  4737. <refentrytitle>variablelist.as.table</refentrytitle>
  4738. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4739. </refmeta>
  4740. <refnamediv>
  4741. <refname>variablelist.as.table</refname>
  4742. <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose>
  4743. </refnamediv>
  4744. <refsynopsisdiv>
  4745. <programlisting xml:id="variablelist.as.table.frag">
  4746. &lt;xsl:param name="variablelist.as.table" select="0"&gt;&lt;/xsl:param&gt;
  4747. </programlisting>
  4748. </refsynopsisdiv>
  4749. <refsection><info><title>Description</title></info>
  4750. <para>If non-zero, <tag>variablelist</tag>s will be formatted as
  4751. tables. A processing instruction exists to specify a particular width for the
  4752. column containing the <tag>term</tag>s:
  4753. <tag class="xmlpi">dbhtml term-width=".25in"</tag></para>
  4754. <para>You can override this setting with a processing instruction as the
  4755. child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml
  4756. list-presentation="table"</tag> or <tag class="xmlpi">dbhtml
  4757. list-presentation="list"</tag>.</para>
  4758. <para>This parameter only applies to the HTML transformations. In the
  4759. FO case, proper list markup is robust enough to handle the formatting.
  4760. But see also <parameter>variablelist.as.blocks</parameter>.</para>
  4761. <programlisting> &lt;variablelist&gt;
  4762. &lt;?dbhtml list-presentation="table"?&gt;
  4763. &lt;?dbhtml term-width="1.5in"?&gt;
  4764. &lt;?dbfo list-presentation="list"?&gt;
  4765. &lt;?dbfo term-width="1in"?&gt;
  4766. &lt;varlistentry&gt;
  4767. &lt;term&gt;list&lt;/term&gt;
  4768. &lt;listitem&gt;
  4769. &lt;para&gt;
  4770. Formatted as a table even if variablelist.as.table is set to 0.
  4771. &lt;/para&gt;
  4772. &lt;/listitem&gt;
  4773. &lt;/varlistentry&gt;
  4774. &lt;/variablelist&gt;</programlisting>
  4775. </refsection>
  4776. </refentry>
  4777. <refentry version="5.0" xml:id="variablelist.term.separator">
  4778. <refmeta>
  4779. <refentrytitle>variablelist.term.separator</refentrytitle>
  4780. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4781. </refmeta>
  4782. <refnamediv>
  4783. <refname>variablelist.term.separator</refname>
  4784. <refpurpose>Text to separate <tag>term</tag>s within a multi-term
  4785. <tag>varlistentry</tag></refpurpose>
  4786. </refnamediv>
  4787. <refsynopsisdiv>
  4788. <programlisting xml:id="variablelist.term.separator.frag">
  4789. &lt;xsl:param name="variablelist.term.separator"&gt;, &lt;/xsl:param&gt;</programlisting>
  4790. </refsynopsisdiv>
  4791. <refsection><info><title>Description</title></info>
  4792. <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
  4793. elements, the string specified in the value of the
  4794. <parameter>variablelist.term.separator</parameter> parameter is placed
  4795. after each <tag>term</tag> except the last.</para>
  4796. <note>
  4797. <para>To generate a line break between multiple <tag>term</tag>s in
  4798. a <tag>varlistentry</tag>, set a non-zero value for the
  4799. <parameter>variablelist.term.break.after</parameter> parameter. If
  4800. you do so, you may also want to set the value of the
  4801. <parameter>variablelist.term.separator</parameter> parameter to an
  4802. empty string (to suppress rendering of the default comma and space
  4803. after each <tag>term</tag>).</para>
  4804. </note>
  4805. </refsection>
  4806. </refentry>
  4807. <refentry version="5.0" xml:id="variablelist.term.break.after">
  4808. <refmeta>
  4809. <refentrytitle>variablelist.term.break.after</refentrytitle>
  4810. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4811. </refmeta>
  4812. <refnamediv>
  4813. <refname>variablelist.term.break.after</refname>
  4814. <refpurpose>Generate line break after each <tag>term</tag> within a
  4815. multi-term <tag>varlistentry</tag>?</refpurpose>
  4816. </refnamediv>
  4817. <refsynopsisdiv>
  4818. <programlisting xml:id="variablelist.term.break.after.frag">
  4819. &lt;xsl:param name="variablelist.term.break.after"&gt;0&lt;/xsl:param&gt;</programlisting>
  4820. </refsynopsisdiv>
  4821. <refsection><info><title>Description</title></info>
  4822. <para>Set a non-zero value for the
  4823. <parameter>variablelist.term.break.after</parameter> parameter to
  4824. generate a line break between <tag>term</tag>s in a
  4825. multi-term <tag>varlistentry</tag>.</para>
  4826. <note>
  4827. <para>If you set a non-zero value for
  4828. <parameter>variablelist.term.break.after</parameter>, you may also
  4829. want to set the value of the
  4830. <parameter>variablelist.term.separator</parameter> parameter to an
  4831. empty string (to suppress rendering of the default comma and space
  4832. after each <tag>term</tag>).</para>
  4833. </note>
  4834. </refsection>
  4835. </refentry>
  4836. </reference>
  4837. <reference xml:id="biblio"><title>Bibliography</title>
  4838. <refentry version="5.0" xml:id="bibliography.style">
  4839. <refmeta>
  4840. <refentrytitle>bibliography.style</refentrytitle>
  4841. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  4842. <refmiscinfo class="other" otherclass="value">normal</refmiscinfo>
  4843. <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo>
  4844. </refmeta>
  4845. <refnamediv>
  4846. <refname>bibliography.style</refname>
  4847. <refpurpose>Style used for formatting of biblioentries.</refpurpose>
  4848. </refnamediv>
  4849. <refsynopsisdiv>
  4850. <programlisting xml:id="bibliography.style.frag">
  4851. &lt;xsl:param name="bibliography.style"&gt;normal&lt;/xsl:param&gt;
  4852. </programlisting>
  4853. </refsynopsisdiv>
  4854. <refsection><info><title>Description</title></info>
  4855. <para>Currently only <literal>normal</literal> and
  4856. <literal>iso690</literal> styles are supported.</para>
  4857. <para>In order to use ISO690 style to the full extent you might need
  4858. to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the
  4859. following WiKi page</link>.</para>
  4860. </refsection>
  4861. </refentry>
  4862. <refentry version="5.0" xml:id="biblioentry.item.separator">
  4863. <refmeta>
  4864. <refentrytitle>biblioentry.item.separator</refentrytitle>
  4865. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4866. </refmeta>
  4867. <refnamediv>
  4868. <refname>biblioentry.item.separator</refname>
  4869. <refpurpose>Text to separate bibliography entries</refpurpose>
  4870. </refnamediv>
  4871. <refsynopsisdiv>
  4872. <programlisting xml:id="biblioentry.item.separator.frag">&lt;xsl:param name="biblioentry.item.separator"&gt;. &lt;/xsl:param&gt;</programlisting>
  4873. </refsynopsisdiv>
  4874. <refsection><info><title>Description</title></info>
  4875. <para>Text to separate bibliography entries
  4876. </para>
  4877. </refsection>
  4878. </refentry>
  4879. <refentry version="5.0" xml:id="bibliography.collection">
  4880. <refmeta>
  4881. <refentrytitle>bibliography.collection</refentrytitle>
  4882. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  4883. </refmeta>
  4884. <refnamediv>
  4885. <refname>bibliography.collection</refname>
  4886. <refpurpose>Name of the bibliography collection file</refpurpose>
  4887. </refnamediv>
  4888. <refsynopsisdiv>
  4889. <programlisting xml:id="bibliography.collection.frag">
  4890. &lt;xsl:param name="bibliography.collection"&gt;http://docbook.sourceforge.net/release/bibliography/bibliography.xml&lt;/xsl:param&gt;
  4891. </programlisting>
  4892. </refsynopsisdiv>
  4893. <refsection><info><title>Description</title></info>
  4894. <para>Maintaining bibliography entries across a set of documents is tedious, time
  4895. consuming, and error prone. It makes much more sense, usually, to store all of
  4896. the bibliography entries in a single place and simply <quote>extract</quote>
  4897. the ones you need in each document.</para>
  4898. <para>That's the purpose of the
  4899. <parameter>bibliography.collection</parameter> parameter. To setup a global
  4900. bibliography <quote>database</quote>, follow these steps:</para>
  4901. <para>First, create a stand-alone bibliography document that contains all of
  4902. the documents that you wish to reference. Make sure that each bibliography
  4903. entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)
  4904. has an ID.</para>
  4905. <para>My global bibliography, <filename>~/bibliography.xml</filename> begins
  4906. like this:</para>
  4907. <informalexample>
  4908. <programlisting>&lt;!DOCTYPE bibliography
  4909. PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  4910. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
  4911. &lt;bibliography&gt;&lt;title&gt;References&lt;/title&gt;
  4912. &lt;bibliomixed id="xml-rec"&gt;&lt;abbrev&gt;XML 1.0&lt;/abbrev&gt;Tim Bray,
  4913. Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.
  4914. &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml"&gt;Extensible Markup
  4915. Language (XML) 1.0 Second Edition&lt;/ulink&gt;&lt;/citetitle&gt;.
  4916. World Wide Web Consortium, 2000.
  4917. &lt;/bibliomixed&gt;
  4918. &lt;bibliomixed id="xml-names"&gt;&lt;abbrev&gt;Namespaces&lt;/abbrev&gt;Tim Bray,
  4919. Dave Hollander,
  4920. and Andrew Layman, editors.
  4921. &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml-names/"&gt;Namespaces in
  4922. XML&lt;/ulink&gt;&lt;/citetitle&gt;.
  4923. World Wide Web Consortium, 1999.
  4924. &lt;/bibliomixed&gt;
  4925. &lt;!-- ... --&gt;
  4926. &lt;/bibliography&gt;
  4927. </programlisting>
  4928. </informalexample>
  4929. <para>When you create a bibliography in your document, simply
  4930. provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>
  4931. entries for each document that you wish to cite. Make sure that these
  4932. elements have the same ID as the corresponding <quote>real</quote>
  4933. entry in your global bibliography.</para>
  4934. <para>For example:</para>
  4935. <informalexample>
  4936. <programlisting>&lt;bibliography&gt;&lt;title&gt;Bibliography&lt;/title&gt;
  4937. &lt;bibliomixed id="xml-rec"/&gt;
  4938. &lt;bibliomixed id="xml-names"/&gt;
  4939. &lt;bibliomixed id="DKnuth86"&gt;Donald E. Knuth. &lt;citetitle&gt;Computers and
  4940. Typesetting: Volume B, TeX: The Program&lt;/citetitle&gt;. Addison-Wesley,
  4941. 1986. ISBN 0-201-13437-3.
  4942. &lt;/bibliomixed&gt;
  4943. &lt;bibliomixed id="relaxng"/&gt;
  4944. &lt;/bibliography&gt;</programlisting>
  4945. </informalexample>
  4946. <para>Note that it's perfectly acceptable to mix entries from your
  4947. global bibliography with <quote>normal</quote> entries. You can use
  4948. <tag>xref</tag> or other elements to cross-reference your
  4949. bibliography entries in exactly the same way you do now.</para>
  4950. <para>Finally, when you are ready to format your document, simply set the
  4951. <parameter>bibliography.collection</parameter> parameter (in either a
  4952. customization layer or directly through your processor's interface) to
  4953. point to your global bibliography.</para>
  4954. <para>A relative path in the parameter is interpreted in one
  4955. of two ways:</para>
  4956. <orderedlist numeration="loweralpha">
  4957. <listitem>
  4958. <para>If your document contains no links to empty bibliographic elements,
  4959. then the path is relative to the file containing
  4960. the first <tag>bibliomixed</tag> element in the document.</para>
  4961. </listitem>
  4962. <listitem>
  4963. <para>If your document does contain links to empty bibliographic elements,
  4964. then the path is relative to the file containing
  4965. the first such link element in the document.</para>
  4966. </listitem>
  4967. </orderedlist>
  4968. <para>Once the collection file is opened by the first instance described
  4969. above, it stays open for the current document
  4970. and the relative path is not reinterpreted again.</para>
  4971. <para>The stylesheets will format the bibliography in your document as if
  4972. all of the entries referenced appeared there literally.</para>
  4973. </refsection>
  4974. </refentry>
  4975. <refentry version="5.0" xml:id="bibliography.numbered">
  4976. <refmeta>
  4977. <refentrytitle>bibliography.numbered</refentrytitle>
  4978. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4979. </refmeta>
  4980. <refnamediv>
  4981. <refname>bibliography.numbered</refname>
  4982. <refpurpose>Should bibliography entries be numbered?</refpurpose>
  4983. </refnamediv>
  4984. <refsynopsisdiv>
  4985. <programlisting xml:id="bibliography.numbered.frag">
  4986. &lt;xsl:param name="bibliography.numbered" select="0"&gt;&lt;/xsl:param&gt;
  4987. </programlisting>
  4988. </refsynopsisdiv>
  4989. <refsection><info><title>Description</title></info>
  4990. <para>If non-zero bibliography entries will be numbered</para>
  4991. </refsection>
  4992. </refentry>
  4993. </reference>
  4994. <reference xml:id="glossary"><title>Glossary</title>
  4995. <refentry version="5.0" xml:id="glossterm.auto.link">
  4996. <refmeta>
  4997. <refentrytitle>glossterm.auto.link</refentrytitle>
  4998. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  4999. </refmeta>
  5000. <refnamediv>
  5001. <refname>glossterm.auto.link</refname>
  5002. <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpose>
  5003. </refnamediv>
  5004. <refsynopsisdiv>
  5005. <programlisting xml:id="glossterm.auto.link.frag">
  5006. &lt;xsl:param name="glossterm.auto.link" select="0"&gt;&lt;/xsl:param&gt;
  5007. </programlisting>
  5008. </refsynopsisdiv>
  5009. <refsection><info><title>Description</title></info>
  5010. <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding
  5011. <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag>
  5012. will be automatically generated. This is useful when your glossterms are consistent
  5013. and you don't want to add links manually.</para>
  5014. <para>The automatic link generation feature is not used on <tag>glossterm</tag> elements
  5015. that have a <tag class="attribute">linkend</tag> attribute.</para>
  5016. </refsection>
  5017. </refentry>
  5018. <refentry version="5.0" xml:id="firstterm.only.link">
  5019. <refmeta>
  5020. <refentrytitle>firstterm.only.link</refentrytitle>
  5021. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5022. </refmeta>
  5023. <refnamediv>
  5024. <refname>firstterm.only.link</refname>
  5025. <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpose>
  5026. </refnamediv>
  5027. <refsynopsisdiv>
  5028. <programlisting xml:id="firstterm.only.link.frag">
  5029. &lt;xsl:param name="firstterm.only.link" select="0"&gt;&lt;/xsl:param&gt;
  5030. </programlisting>
  5031. </refsynopsisdiv>
  5032. <refsection><info><title>Description</title></info>
  5033. <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked
  5034. to the glossary. If glossary linking is not enabled, this parameter
  5035. has no effect.</para>
  5036. </refsection>
  5037. </refentry>
  5038. <refentry version="5.0" xml:id="glossary.collection">
  5039. <refmeta>
  5040. <refentrytitle>glossary.collection</refentrytitle>
  5041. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5042. </refmeta>
  5043. <refnamediv>
  5044. <refname>glossary.collection</refname>
  5045. <refpurpose>Name of the glossary collection file</refpurpose>
  5046. </refnamediv>
  5047. <refsynopsisdiv>
  5048. <programlisting xml:id="glossary.collection.frag">
  5049. &lt;xsl:param name="glossary.collection"&gt;&lt;/xsl:param&gt;
  5050. </programlisting>
  5051. </refsynopsisdiv>
  5052. <refsection><info><title>Description</title></info>
  5053. <para>Glossaries maintained independently across a set of documents
  5054. are likely to become inconsistent unless considerable effort is
  5055. expended to keep them in sync. It makes much more sense, usually, to
  5056. store all of the glossary entries in a single place and simply
  5057. <quote>extract</quote> the ones you need in each document.</para>
  5058. <para>That's the purpose of the
  5059. <parameter>glossary.collection</parameter> parameter. To setup a global
  5060. glossary <quote>database</quote>, follow these steps:</para>
  5061. <refsection><info><title>Setting Up the Glossary Database</title></info>
  5062. <para>First, create a stand-alone glossary document that contains all of
  5063. the entries that you wish to reference. Make sure that each glossary
  5064. entry has an ID.</para>
  5065. <para>Here's an example glossary:</para>
  5066. <informalexample>
  5067. <programlisting>
  5068. &lt;?xml version="1.0" encoding="utf-8"?&gt;
  5069. &lt;!DOCTYPE glossary
  5070. PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  5071. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;
  5072. &lt;glossary&gt;
  5073. &lt;glossaryinfo&gt;
  5074. &lt;editor&gt;&lt;firstname&gt;Eric&lt;/firstname&gt;&lt;surname&gt;Raymond&lt;/surname&gt;&lt;/editor&gt;
  5075. &lt;title&gt;Jargon File 4.2.3 (abridged)&lt;/title&gt;
  5076. &lt;releaseinfo&gt;Just some test data&lt;/releaseinfo&gt;
  5077. &lt;/glossaryinfo&gt;
  5078. &lt;glossdiv&gt;&lt;title&gt;0&lt;/title&gt;
  5079. &lt;glossentry&gt;
  5080. &lt;glossterm&gt;0&lt;/glossterm&gt;
  5081. &lt;glossdef&gt;
  5082. &lt;para&gt;Numeric zero, as opposed to the letter `O' (the 15th letter of
  5083. the English alphabet). In their unmodified forms they look a lot
  5084. alike, and various kluges invented to make them visually distinct have
  5085. compounded the confusion. If your zero is center-dotted and letter-O
  5086. is not, or if letter-O looks almost rectangular but zero looks more
  5087. like an American football stood on end (or the reverse), you're
  5088. probably looking at a modern character display (though the dotted zero
  5089. seems to have originated as an option on IBM 3270 controllers). If
  5090. your zero is slashed but letter-O is not, you're probably looking at
  5091. an old-style ASCII graphic set descended from the default typewheel on
  5092. the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter,
  5093. curse this arrangement). (Interestingly, the slashed zero long
  5094. predates computers; Florian Cajori's monumental "A History of
  5095. Mathematical Notations" notes that it was used in the twelfth and
  5096. thirteenth centuries.) If letter-O has a slash across it and the zero
  5097. does not, your display is tuned for a very old convention used at IBM
  5098. and a few other early mainframe makers (Scandinavians curse &lt;emphasis&gt;this&lt;/emphasis&gt;
  5099. arrangement even more, because it means two of their letters collide).
  5100. Some Burroughs/Unisys equipment displays a zero with a &lt;emphasis&gt;reversed&lt;/emphasis&gt;
  5101. slash. Old CDC computers rendered letter O as an unbroken oval and 0
  5102. as an oval broken at upper right and lower left. And yet another
  5103. convention common on early line printers left zero unornamented but
  5104. added a tail or hook to the letter-O so that it resembled an inverted
  5105. Q or cursive capital letter-O (this was endorsed by a draft ANSI
  5106. standard for how to draw ASCII characters, but the final standard
  5107. changed the distinguisher to a tick-mark in the upper-left corner).
  5108. Are we sufficiently confused yet?&lt;/para&gt;
  5109. &lt;/glossdef&gt;
  5110. &lt;/glossentry&gt;
  5111. &lt;glossentry&gt;
  5112. &lt;glossterm&gt;1TBS&lt;/glossterm&gt;
  5113. &lt;glossdef&gt;
  5114. &lt;para role="accidence"&gt;
  5115. &lt;phrase role="pronounce"&gt;&lt;/phrase&gt;
  5116. &lt;phrase role="partsofspeach"&gt;n&lt;/phrase&gt;
  5117. &lt;/para&gt;
  5118. &lt;para&gt;The "One True Brace Style"&lt;/para&gt;
  5119. &lt;glossseealso&gt;indent style&lt;/glossseealso&gt;
  5120. &lt;/glossdef&gt;
  5121. &lt;/glossentry&gt;
  5122. &lt;!-- ... --&gt;
  5123. &lt;/glossdiv&gt;
  5124. &lt;!-- ... --&gt;
  5125. &lt;/glossary&gt;</programlisting>
  5126. </informalexample>
  5127. </refsection>
  5128. <refsection><info><title>Marking Up Glossary Terms</title></info>
  5129. <para>That takes care of the glossary database, now you have to get the entries
  5130. into your document. Unlike bibliography entries, which can be empty, creating
  5131. <quote>placeholder</quote> glossary entries would be very tedious. So instead,
  5132. support for <parameter>glossary.collection</parameter> relies on implicit linking.</para>
  5133. <para>In your source document, simply use <tag>firstterm</tag> and
  5134. <tag>glossterm</tag> to identify the terms you wish to have included
  5135. in the glossary. The stylesheets assume that you will either set the
  5136. <tag class="attribute">baseform</tag> attribute correctly, or that the
  5137. content of the element exactly matches a term in your glossary.</para>
  5138. <para>If you're using a <parameter>glossary.collection</parameter>, don't
  5139. make explicit links on the terms in your document.</para>
  5140. <para>So, in your document, you might write things like this:</para>
  5141. <informalexample>
  5142. <programlisting>&lt;para&gt;This is dummy text, without any real meaning.
  5143. The point is simply to reference glossary terms like &lt;glossterm&gt;0&lt;/glossterm&gt;
  5144. and the &lt;firstterm baseform="1TBS"&gt;One True Brace Style (1TBS)&lt;/firstterm&gt;.
  5145. The &lt;glossterm&gt;1TBS&lt;/glossterm&gt;, as you can probably imagine, is a nearly
  5146. religious issue.&lt;/para&gt;</programlisting>
  5147. </informalexample>
  5148. <para>If you set the <parameter>firstterm.only.link</parameter> parameter,
  5149. only the terms marked with <tag>firstterm</tag> will be links.
  5150. Otherwise, all the terms will be linked.</para>
  5151. </refsection>
  5152. <refsection><info><title>Marking Up the Glossary</title></info>
  5153. <para>The glossary itself has to be identified for the stylesheets. For lack
  5154. of a better choice, the <tag class="attribute">role</tag> is used.
  5155. To identify the glossary as the target for automatic processing, set
  5156. the role to <quote><literal>auto</literal></quote>. The title of this
  5157. glossary (and any other information from the <tag>glossaryinfo</tag>
  5158. that's rendered by your stylesheet) will be displayed, but the entries will
  5159. come from the database.
  5160. </para>
  5161. <para>Unfortunately, the glossary can't be empty, so you must put in
  5162. at least one <tag>glossentry</tag>. The content of this entry
  5163. is irrelevant, it will not be rendered:</para>
  5164. <informalexample>
  5165. <programlisting>&lt;glossary role="auto"&gt;
  5166. &lt;glossentry&gt;
  5167. &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
  5168. &lt;glossdef&gt;
  5169. &lt;para&gt;If you can see this, the document was processed incorrectly. Use
  5170. the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
  5171. &lt;/glossdef&gt;
  5172. &lt;/glossentry&gt;
  5173. &lt;/glossary&gt;</programlisting>
  5174. </informalexample>
  5175. <para>What about glossary divisions? If your glossary database has glossary
  5176. divisions <emphasis>and</emphasis> your automatic glossary contains at least
  5177. one <tag>glossdiv</tag>, the automic glossary will have divisions.
  5178. If the <tag>glossdiv</tag> is missing from either location, no divisions
  5179. will be rendered.</para>
  5180. <para>Glossary entries (and divisions, if appropriate) in the glossary will
  5181. occur in precisely the order they occur in your database.</para>
  5182. </refsection>
  5183. <refsection><info><title>Formatting the Document</title></info>
  5184. <para>Finally, when you are ready to format your document, simply set the
  5185. <parameter>glossary.collection</parameter> parameter (in either a
  5186. customization layer or directly through your processor's interface) to
  5187. point to your global glossary.</para>
  5188. <para>A relative path in the parameter is interpreted in one
  5189. of two ways:</para>
  5190. <orderedlist numeration="loweralpha">
  5191. <listitem>
  5192. <para>If the parameter <literal>glossterm.auto.link</literal>
  5193. is set to zero, then the path is relative to the file containing
  5194. the empty <tag>glossary</tag> element in the document.</para>
  5195. </listitem>
  5196. <listitem>
  5197. <para>If the parameter <literal>glossterm.auto.link</literal>
  5198. is set to non-zero, then the path is relative to the file containing
  5199. the first inline <tag>glossterm</tag> or
  5200. <tag>firstterm</tag> in the document to be linked.</para>
  5201. </listitem>
  5202. </orderedlist>
  5203. <para>Once the collection file is opened by the first instance described
  5204. above, it stays open for the current document
  5205. and the relative path is not reinterpreted again.</para>
  5206. <para>The stylesheets will format the glossary in your document as if
  5207. all of the entries implicilty referenced appeared there literally.</para>
  5208. </refsection>
  5209. <refsection><info><title>Limitations</title></info>
  5210. <para>Glossary cross-references <emphasis>within the glossary</emphasis> are
  5211. not supported. For example, this <emphasis>will not</emphasis> work:</para>
  5212. <informalexample>
  5213. <programlisting>&lt;glossentry&gt;
  5214. &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
  5215. &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
  5216. &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
  5217. &lt;/glossdef&gt;
  5218. &lt;/glossentry&gt;</programlisting>
  5219. </informalexample>
  5220. <para>If you put glossary cross-references in your glossary that way,
  5221. you'll get the cryptic error: <computeroutput>Warning:
  5222. glossary.collection specified, but there are 0 automatic
  5223. glossaries</computeroutput>.</para>
  5224. <para>Instead, you must do two things:</para>
  5225. <orderedlist>
  5226. <listitem>
  5227. <para>Markup your glossary using <tag>glossseealso</tag>:</para>
  5228. <informalexample>
  5229. <programlisting>&lt;glossentry&gt;
  5230. &lt;glossterm&gt;gloss-1&lt;/glossterm&gt;
  5231. &lt;glossdef&gt;&lt;para&gt;A description that references &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/para&gt;
  5232. &lt;glossseealso&gt;gloss-2&lt;/glossseealso&gt;
  5233. &lt;/glossdef&gt;
  5234. &lt;/glossentry&gt;</programlisting>
  5235. </informalexample>
  5236. </listitem>
  5237. <listitem>
  5238. <para>Make sure there is at least one <tag>glossterm</tag> reference to
  5239. <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The
  5240. easiest way to do that is probably within a <tag>remark</tag> in your
  5241. automatic glossary:</para>
  5242. <informalexample>
  5243. <programlisting>&lt;glossary role="auto"&gt;
  5244. &lt;remark&gt;Make sure there's a reference to &lt;glossterm&gt;gloss-2&lt;/glossterm&gt;.&lt;/remark&gt;
  5245. &lt;glossentry&gt;
  5246. &lt;glossterm&gt;Irrelevant&lt;/glossterm&gt;
  5247. &lt;glossdef&gt;
  5248. &lt;para&gt;If you can see this, the document was processed incorrectly. Use
  5249. the &lt;parameter&gt;glossary.collection&lt;/parameter&gt; parameter.&lt;/para&gt;
  5250. &lt;/glossdef&gt;
  5251. &lt;/glossentry&gt;
  5252. &lt;/glossary&gt;</programlisting>
  5253. </informalexample>
  5254. </listitem>
  5255. </orderedlist>
  5256. </refsection>
  5257. </refsection>
  5258. </refentry>
  5259. <refentry version="5.0" xml:id="glossary.sort">
  5260. <refmeta>
  5261. <refentrytitle>glossary.sort</refentrytitle>
  5262. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5263. </refmeta>
  5264. <refnamediv>
  5265. <refname>glossary.sort</refname>
  5266. <refpurpose>Sort glossentry elements?</refpurpose>
  5267. </refnamediv>
  5268. <refsynopsisdiv>
  5269. <programlisting xml:id="glossary.sort.frag">
  5270. &lt;xsl:param name="glossary.sort" select="0"&gt;&lt;/xsl:param&gt;
  5271. </programlisting>
  5272. </refsynopsisdiv>
  5273. <refsection><info><title>Description</title></info>
  5274. <para>If non-zero, then the glossentry elements within a
  5275. glossary, glossdiv, or glosslist are sorted on the glossterm, using
  5276. the current lang setting. If zero (the default), then
  5277. glossentry elements are not sorted and are presented
  5278. in document order.
  5279. </para>
  5280. </refsection>
  5281. </refentry>
  5282. <refentry version="5.0" xml:id="glossentry.show.acronym">
  5283. <refmeta>
  5284. <refentrytitle>glossentry.show.acronym</refentrytitle>
  5285. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  5286. <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
  5287. <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
  5288. <refmiscinfo class="other" otherclass="value">primary</refmiscinfo>
  5289. </refmeta>
  5290. <refnamediv>
  5291. <refname>glossentry.show.acronym</refname>
  5292. <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose>
  5293. </refnamediv>
  5294. <refsynopsisdiv>
  5295. <programlisting xml:id="glossentry.show.acronym.frag">
  5296. &lt;xsl:param name="glossentry.show.acronym"&gt;no&lt;/xsl:param&gt;
  5297. </programlisting>
  5298. </refsynopsisdiv>
  5299. <refsection><info><title>Description</title></info>
  5300. <para>A setting of <quote>yes</quote> means they should be displayed;
  5301. <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used,
  5302. then they are shown as the primary text for the entry.</para>
  5303. <note>
  5304. <para>This setting controls both <tag>acronym</tag> and
  5305. <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para>
  5306. </note>
  5307. </refsection>
  5308. </refentry>
  5309. </reference>
  5310. <reference xml:id="misc"><title>Miscellaneous</title>
  5311. <refentry version="5.0" xml:id="formal.procedures">
  5312. <refmeta>
  5313. <refentrytitle>formal.procedures</refentrytitle>
  5314. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5315. </refmeta>
  5316. <refnamediv>
  5317. <refname>formal.procedures</refname>
  5318. <refpurpose>Selects formal or informal procedures</refpurpose>
  5319. </refnamediv>
  5320. <refsynopsisdiv>
  5321. <programlisting xml:id="formal.procedures.frag">
  5322. &lt;xsl:param name="formal.procedures" select="1"&gt;&lt;/xsl:param&gt;
  5323. </programlisting>
  5324. </refsynopsisdiv>
  5325. <refsection><info><title>Description</title></info>
  5326. <para>Formal procedures are numbered and always have a title.
  5327. </para>
  5328. </refsection>
  5329. </refentry>
  5330. <refentry version="5.0" xml:id="formal.title.placement">
  5331. <refmeta>
  5332. <refentrytitle>formal.title.placement</refentrytitle>
  5333. <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>
  5334. </refmeta>
  5335. <refnamediv>
  5336. <refname>formal.title.placement</refname>
  5337. <refpurpose>Specifies where formal object titles should occur</refpurpose>
  5338. </refnamediv>
  5339. <refsynopsisdiv>
  5340. <programlisting xml:id="formal.title.placement.frag">
  5341. &lt;xsl:param name="formal.title.placement"&gt;
  5342. figure before
  5343. example before
  5344. equation before
  5345. table before
  5346. procedure before
  5347. task before
  5348. &lt;/xsl:param&gt;
  5349. </programlisting>
  5350. </refsynopsisdiv>
  5351. <refsection><info><title>Description</title></info>
  5352. <para>Specifies where formal object titles should occur. For each formal object
  5353. type (<tag>figure</tag>,
  5354. <tag>example</tag>,
  5355. <tag>equation</tag>,
  5356. <tag>table</tag>, and <tag>procedure</tag>)
  5357. you can specify either the keyword
  5358. <quote><literal>before</literal></quote> or
  5359. <quote><literal>after</literal></quote>.</para>
  5360. </refsection>
  5361. </refentry>
  5362. <refentry version="5.0" xml:id="runinhead.default.title.end.punct">
  5363. <refmeta>
  5364. <refentrytitle>runinhead.default.title.end.punct</refentrytitle>
  5365. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5366. </refmeta>
  5367. <refnamediv>
  5368. <refname>runinhead.default.title.end.punct</refname>
  5369. <refpurpose>Default punctuation character on a run-in-head</refpurpose>
  5370. </refnamediv>
  5371. <refsynopsisdiv>
  5372. <programlisting xml:id="runinhead.default.title.end.punct.frag">&lt;xsl:param name="runinhead.default.title.end.punct"&gt;.&lt;/xsl:param&gt;
  5373. </programlisting>
  5374. </refsynopsisdiv>
  5375. <refsection><info><title>Description</title></info>
  5376. <para>If non-zero, For a <tag>formalpara</tag>, use the specified
  5377. string as the separator between the title and following text. The period is the default value.</para>
  5378. </refsection>
  5379. </refentry>
  5380. <refentry version="5.0" xml:id="runinhead.title.end.punct">
  5381. <refmeta>
  5382. <refentrytitle>runinhead.title.end.punct</refentrytitle>
  5383. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5384. </refmeta>
  5385. <refnamediv>
  5386. <refname>runinhead.title.end.punct</refname>
  5387. <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose>
  5388. </refnamediv>
  5389. <refsynopsisdiv>
  5390. <programlisting xml:id="runinhead.title.end.punct.frag">
  5391. &lt;xsl:param name="runinhead.title.end.punct"&gt;.!?:&lt;/xsl:param&gt;
  5392. </programlisting>
  5393. </refsynopsisdiv>
  5394. <refsection><info><title>Description</title></info>
  5395. <para>Specify which characters are to be counted as punctuation. These
  5396. characters are checked for a match with the last character of the
  5397. title. If no match is found, the
  5398. <parameter>runinhead.default.title.end.punct</parameter> contents are
  5399. inserted. This is to avoid duplicated punctuation in the output.
  5400. </para>
  5401. </refsection>
  5402. </refentry>
  5403. <refentry version="5.0" xml:id="show.comments">
  5404. <refmeta>
  5405. <refentrytitle>show.comments</refentrytitle>
  5406. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5407. </refmeta>
  5408. <refnamediv>
  5409. <refname>show.comments</refname>
  5410. <refpurpose>Display <tag>remark</tag> elements?</refpurpose>
  5411. </refnamediv>
  5412. <refsynopsisdiv>
  5413. <programlisting xml:id="show.comments.frag">
  5414. &lt;xsl:param name="show.comments" select="1"&gt;&lt;/xsl:param&gt;
  5415. </programlisting>
  5416. </refsynopsisdiv>
  5417. <refsection><info><title>Description</title></info>
  5418. <para>If non-zero, comments will be displayed, otherwise they
  5419. are suppressed. Comments here refers to the <tag>remark</tag> element
  5420. (which was called <literal>comment</literal> prior to DocBook
  5421. 4.0), not XML comments (&lt;-- like this --&gt;) which are
  5422. unavailable.
  5423. </para>
  5424. </refsection>
  5425. </refentry>
  5426. <refentry version="5.0" xml:id="show.revisionflag">
  5427. <refmeta>
  5428. <refentrytitle>show.revisionflag</refentrytitle>
  5429. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5430. </refmeta>
  5431. <refnamediv>
  5432. <refname>show.revisionflag</refname>
  5433. <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
  5434. </refnamediv>
  5435. <refsynopsisdiv>
  5436. <programlisting xml:id="show.revisionflag.frag">
  5437. &lt;xsl:param name="show.revisionflag" select="0"&gt;&lt;/xsl:param&gt;
  5438. </programlisting>
  5439. </refsynopsisdiv>
  5440. <refsection><info><title>Description</title></info>
  5441. <para>
  5442. If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
  5443. may produce additional markup designed to allow a CSS stylesheet to
  5444. highlight elements that have specific revisionflag settings.</para>
  5445. <para>The markup inserted will be usually be either a &lt;span&gt; or
  5446. &lt;div&gt; with an appropriate <literal>class</literal>
  5447. attribute. (The value of the class attribute will be the same as the
  5448. value of the revisionflag attribute). In some contexts, for example
  5449. tables, where extra markup would be structurally illegal, the class
  5450. attribute will be added to the appropriate container element.</para>
  5451. <para>In general, the stylesheets only test for revisionflag in contexts
  5452. where an importing stylesheet would have to redefine whole templates.
  5453. Most of the revisionflag processing is expected to be done by another
  5454. stylesheet, for example <filename>changebars.xsl</filename>.</para>
  5455. </refsection>
  5456. </refentry>
  5457. <refentry version="5.0" xml:id="shade.verbatim">
  5458. <refmeta>
  5459. <refentrytitle>shade.verbatim</refentrytitle>
  5460. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5461. </refmeta>
  5462. <refnamediv>
  5463. <refname>shade.verbatim</refname>
  5464. <refpurpose>Should verbatim environments be shaded?</refpurpose>
  5465. </refnamediv>
  5466. <refsynopsisdiv>
  5467. <programlisting xml:id="shade.verbatim.frag">&lt;xsl:param name="shade.verbatim" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  5468. </refsynopsisdiv>
  5469. <refsection><info><title>Description</title></info>
  5470. <para>In the FO stylesheet, if this parameter is non-zero then the
  5471. <property>shade.verbatim.style</property> properties will be applied
  5472. to verbatim environments.</para>
  5473. <para>In the HTML stylesheet, this parameter is now deprecated. Use
  5474. CSS instead.</para>
  5475. </refsection>
  5476. </refentry>
  5477. <refentry version="5.0" xml:id="shade.verbatim.style">
  5478. <refmeta>
  5479. <refentrytitle>shade.verbatim.style</refentrytitle>
  5480. <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
  5481. </refmeta>
  5482. <refnamediv>
  5483. <refname>shade.verbatim.style</refname>
  5484. <refpurpose>Properties that specify the style of shaded verbatim listings</refpurpose>
  5485. </refnamediv>
  5486. <refsynopsisdiv>
  5487. <programlisting xml:id="shade.verbatim.style.frag">
  5488. &lt;xsl:attribute-set name="shade.verbatim.style"&gt;
  5489. &lt;xsl:attribute name="border"&gt;0&lt;/xsl:attribute&gt;
  5490. &lt;xsl:attribute name="bgcolor"&gt;#E0E0E0&lt;/xsl:attribute&gt;
  5491. &lt;/xsl:attribute-set&gt;
  5492. </programlisting>
  5493. </refsynopsisdiv>
  5494. <refsection><info><title>Description</title></info>
  5495. <para>Properties that specify the style of shaded verbatim listings. The
  5496. parameters specified (the border and background color) are added to
  5497. the styling of the xsl-fo output. A border might be specified as "thin
  5498. black solid" for example. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></para>
  5499. </refsection>
  5500. </refentry>
  5501. <refentry version="5.0" xml:id="punct.honorific">
  5502. <refmeta>
  5503. <refentrytitle>punct.honorific</refentrytitle>
  5504. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5505. </refmeta>
  5506. <refnamediv>
  5507. <refname>punct.honorific</refname>
  5508. <refpurpose>Punctuation after an honorific in a personal name.</refpurpose>
  5509. </refnamediv>
  5510. <refsynopsisdiv>
  5511. <programlisting xml:id="punct.honorific.frag">
  5512. &lt;xsl:param name="punct.honorific"&gt;.&lt;/xsl:param&gt;
  5513. </programlisting>
  5514. </refsynopsisdiv>
  5515. <refsection><info><title>Description</title></info>
  5516. <para>This parameter specifies the punctuation that should be added after an
  5517. honorific in a personal name.</para>
  5518. </refsection>
  5519. </refentry>
  5520. <refentry version="5.0" xml:id="tex.math.in.alt">
  5521. <refmeta>
  5522. <refentrytitle>tex.math.in.alt</refentrytitle>
  5523. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  5524. <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
  5525. <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
  5526. </refmeta>
  5527. <refnamediv>
  5528. <refname>tex.math.in.alt</refname>
  5529. <refpurpose>TeX notation used for equations</refpurpose>
  5530. </refnamediv>
  5531. <refsynopsisdiv>
  5532. <programlisting xml:id="tex.math.in.alt.frag">
  5533. &lt;xsl:param name="tex.math.in.alt"&gt;&lt;/xsl:param&gt;
  5534. </programlisting>
  5535. </refsynopsisdiv>
  5536. <refsection><info><title>Description</title></info>
  5537. <para>If you want type math directly in TeX notation in equations,
  5538. this parameter specifies notation used. Currently are supported two
  5539. values -- <literal>plain</literal> and <literal>latex</literal>. Empty
  5540. value means that you are not using TeX math at all.</para>
  5541. <para>Preferred way for including TeX alternative of math is inside of
  5542. <tag>textobject</tag> element. Eg.:</para>
  5543. <programlisting>&lt;inlineequation&gt;
  5544. &lt;inlinemediaobject&gt;
  5545. &lt;imageobject&gt;
  5546. &lt;imagedata fileref="eq1.gif"/&gt;
  5547. &lt;/imageobject&gt;
  5548. &lt;textobject&gt;&lt;phrase&gt;E=mc squared&lt;/phrase&gt;&lt;/textobject&gt;
  5549. &lt;textobject role="tex"&gt;&lt;phrase&gt;E=mc^2&lt;/phrase&gt;&lt;/textobject&gt;
  5550. &lt;/inlinemediaobject&gt;
  5551. &lt;/inlineequation&gt;</programlisting>
  5552. <para>If you are using <tag>graphic</tag> element, you can
  5553. store TeX inside <tag>alt</tag> element:</para>
  5554. <programlisting>&lt;inlineequation&gt;
  5555. &lt;alt role="tex"&gt;a^2+b^2=c^2&lt;/alt&gt;
  5556. &lt;graphic fileref="a2b2c2.gif"/&gt;
  5557. &lt;/inlineequation&gt;</programlisting>
  5558. <para>If you want use this feature, you should process your FO with
  5559. PassiveTeX, which only supports TeX math notation. When calling
  5560. stylsheet, don't forget to specify also
  5561. passivetex.extensions=1.</para>
  5562. <para>If you want equations in HTML, just process generated file
  5563. <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
  5564. dvi2bitmap program on result DVI file. You will get images for
  5565. equations in your document.</para>
  5566. <warning>
  5567. <para>This feature is useful for print/PDF output only if you
  5568. use the obsolete and now unsupported PassiveTeX XSL-FO
  5569. engine.</para>
  5570. </warning>
  5571. </refsection>
  5572. <refsection><info><title>Related Parameters</title></info>
  5573. <para><parameter>tex.math.delims</parameter>,
  5574. <parameter>passivetex.extensions</parameter>,
  5575. <parameter>tex.math.file</parameter></para>
  5576. </refsection>
  5577. </refentry>
  5578. <refentry version="5.0" xml:id="tex.math.file">
  5579. <refmeta>
  5580. <refentrytitle>tex.math.file</refentrytitle>
  5581. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5582. </refmeta>
  5583. <refnamediv>
  5584. <refname>tex.math.file</refname>
  5585. <refpurpose>Name of temporary file for generating images from equations</refpurpose>
  5586. </refnamediv>
  5587. <refsynopsisdiv>
  5588. <programlisting xml:id="tex.math.file.frag">
  5589. &lt;xsl:param name="tex.math.file"&gt;tex-math-equations.tex&lt;/xsl:param&gt;
  5590. </programlisting>
  5591. </refsynopsisdiv>
  5592. <refsection><info><title>Description</title></info>
  5593. <para>Name of auxiliary file for TeX equations. This file can be
  5594. processed by dvi2bitmap to get bitmap versions of equations for HTML
  5595. output.</para>
  5596. </refsection>
  5597. <refsection><info><title>Related Parameters</title></info>
  5598. <para><parameter>tex.math.in.alt</parameter>,
  5599. <parameter>tex.math.delims</parameter>,
  5600. </para>
  5601. </refsection>
  5602. <refsection><info><title>More information</title></info>
  5603. <para>For how-to documentation on embedding TeX equations and
  5604. generating output from them, see
  5605. <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexMath.html">DBTeXMath</link>.</para>
  5606. </refsection>
  5607. </refentry>
  5608. <refentry version="5.0" xml:id="tex.math.delims">
  5609. <refmeta>
  5610. <refentrytitle>tex.math.delims</refentrytitle>
  5611. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5612. </refmeta>
  5613. <refnamediv>
  5614. <refname>tex.math.delims</refname>
  5615. <refpurpose>Should equations output for processing by TeX be
  5616. surrounded by math mode delimiters?</refpurpose>
  5617. </refnamediv>
  5618. <refsynopsisdiv>
  5619. <programlisting xml:id="tex.math.delims.frag">
  5620. &lt;xsl:param name="tex.math.delims" select="1"&gt;&lt;/xsl:param&gt;
  5621. </programlisting>
  5622. </refsynopsisdiv>
  5623. <refsection><info><title>Description</title></info>
  5624. <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell
  5625. you should set this parameter to 0.</para>
  5626. <warning>
  5627. <para>This feature is useful for print/PDF output only if you
  5628. use the obsolete and now unsupported PassiveTeX XSL-FO
  5629. engine.</para>
  5630. </warning>
  5631. </refsection>
  5632. <refsection><info><title>Related Parameters</title></info>
  5633. <para><parameter>tex.math.in.alt</parameter>,
  5634. <parameter>passivetex.extensions</parameter></para>
  5635. </refsection>
  5636. <refsection><info><title>See Also</title></info>
  5637. <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing
  5638. instruction to control whether delimiters are output.</para>
  5639. </refsection>
  5640. </refentry>
  5641. <refentry version="5.0" xml:id="pixels.per.inch">
  5642. <refmeta>
  5643. <refentrytitle>pixels.per.inch</refentrytitle>
  5644. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  5645. </refmeta>
  5646. <refnamediv>
  5647. <refname>pixels.per.inch</refname>
  5648. <refpurpose>How many pixels are there per inch?</refpurpose>
  5649. </refnamediv>
  5650. <refsynopsisdiv>
  5651. <programlisting xml:id="pixels.per.inch.frag">
  5652. &lt;xsl:param name="pixels.per.inch"&gt;90&lt;/xsl:param&gt;
  5653. </programlisting>
  5654. </refsynopsisdiv>
  5655. <refsection><info><title>Description</title></info>
  5656. <para>When lengths are converted to pixels, this value is used to
  5657. determine the size of a pixel. The default value is taken from the
  5658. <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/">XSL
  5659. Recommendation</link>.
  5660. </para>
  5661. </refsection>
  5662. </refentry>
  5663. <refentry version="5.0" xml:id="points.per.em">
  5664. <refmeta>
  5665. <refentrytitle>points.per.em</refentrytitle>
  5666. <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
  5667. </refmeta>
  5668. <refnamediv>
  5669. <refname>points.per.em</refname>
  5670. <refpurpose>Specify the nominal size of an em-space in points</refpurpose>
  5671. </refnamediv>
  5672. <refsynopsisdiv>
  5673. <programlisting xml:id="points.per.em.frag">
  5674. &lt;xsl:param name="points.per.em"&gt;10&lt;/xsl:param&gt;
  5675. </programlisting>
  5676. </refsynopsisdiv>
  5677. <refsection><info><title>Description</title></info>
  5678. <para>The fixed value used for calculations based upon the size of a
  5679. character. The assumption made is that ten point font is in use. This
  5680. assumption may not be valid.</para>
  5681. </refsection>
  5682. </refentry>
  5683. <refentry version="5.0" xml:id="use.svg">
  5684. <refmeta>
  5685. <refentrytitle>use.svg</refentrytitle>
  5686. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5687. </refmeta>
  5688. <refnamediv>
  5689. <refname>use.svg</refname>
  5690. <refpurpose>Allow SVG in the result tree?</refpurpose>
  5691. </refnamediv>
  5692. <refsynopsisdiv>
  5693. <programlisting xml:id="use.svg.frag">
  5694. &lt;xsl:param name="use.svg" select="1"&gt;&lt;/xsl:param&gt;
  5695. </programlisting>
  5696. </refsynopsisdiv>
  5697. <refsection><info><title>Description</title></info>
  5698. <para>If non-zero, SVG will be considered an acceptable image format. SVG
  5699. is passed through to the result tree, so correct rendering of the resulting
  5700. diagram depends on the formatter (FO processor or web browser) that is used
  5701. to process the output from the stylesheet.</para>
  5702. </refsection>
  5703. </refentry>
  5704. <refentry version="5.0" xml:id="menuchoice.separator">
  5705. <refmeta>
  5706. <refentrytitle>menuchoice.separator</refentrytitle>
  5707. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5708. </refmeta>
  5709. <refnamediv>
  5710. <refname>menuchoice.separator</refname>
  5711. <refpurpose>Separator between items of a <tag>menuchoice</tag>
  5712. other than <tag>guimenuitem</tag> and
  5713. <tag>guisubmenu</tag></refpurpose>
  5714. </refnamediv>
  5715. <refsynopsisdiv>
  5716. <programlisting xml:id="menuchoice.separator.frag">
  5717. &lt;xsl:param name="menuchoice.separator"&gt;+&lt;/xsl:param&gt;
  5718. </programlisting>
  5719. </refsynopsisdiv>
  5720. <refsection><info><title>Description</title></info>
  5721. <para>Separator used to connect items of a <tag>menuchoice</tag> other
  5722. than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter
  5723. elements are linked with <parameter>menuchoice.menu.separator</parameter>.
  5724. </para>
  5725. </refsection>
  5726. </refentry>
  5727. <refentry version="5.0" xml:id="menuchoice.menu.separator">
  5728. <refmeta>
  5729. <refentrytitle>menuchoice.menu.separator</refentrytitle>
  5730. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5731. </refmeta>
  5732. <refnamediv>
  5733. <refname>menuchoice.menu.separator</refname>
  5734. <refpurpose>Separator between items of a <tag>menuchoice</tag>
  5735. with <tag>guimenuitem</tag> or
  5736. <tag>guisubmenu</tag></refpurpose>
  5737. </refnamediv>
  5738. <refsynopsisdiv>
  5739. <programlisting xml:id="menuchoice.menu.separator.frag">
  5740. &lt;xsl:param name="menuchoice.menu.separator"&gt; &#8594; &lt;/xsl:param&gt;
  5741. </programlisting>
  5742. </refsynopsisdiv>
  5743. <refsection><info><title>Description</title></info>
  5744. <para>Separator used to connect items of a <tag>menuchoice</tag> with
  5745. <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements
  5746. are linked with <parameter>menuchoice.separator</parameter>.
  5747. </para>
  5748. <para>The default value is &amp;#x2192;, which is the
  5749. &amp;rarr; (right arrow) character entity.
  5750. The current FOP (0.20.5) requires setting the font-family
  5751. explicitly.
  5752. </para>
  5753. <para>The default value also includes spaces around the arrow,
  5754. which will allow a line to break. Replace the spaces with
  5755. &amp;#xA0; (nonbreaking space) if you don't want those
  5756. spaces to break.
  5757. </para>
  5758. </refsection>
  5759. </refentry>
  5760. <refentry version="5.0" xml:id="default.float.class">
  5761. <refmeta>
  5762. <refentrytitle>default.float.class</refentrytitle>
  5763. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5764. </refmeta>
  5765. <refnamediv>
  5766. <refname>default.float.class</refname>
  5767. <refpurpose>Specifies the default float class</refpurpose>
  5768. </refnamediv>
  5769. <refsynopsisdiv>
  5770. <programlisting xml:id="default.float.class.frag">
  5771. &lt;xsl:param name="default.float.class"&gt;
  5772. &lt;xsl:choose&gt;
  5773. &lt;xsl:when test="contains($stylesheet.result.type,'html')"&gt;left&lt;/xsl:when&gt;
  5774. &lt;xsl:otherwise&gt;before&lt;/xsl:otherwise&gt;
  5775. &lt;/xsl:choose&gt;
  5776. &lt;/xsl:param&gt;
  5777. </programlisting>
  5778. </refsynopsisdiv>
  5779. <refsection><info><title>Description</title></info>
  5780. <para>Selects the direction in which a float should be placed. for
  5781. xsl-fo this is before, for html it is left. For Western texts, the
  5782. before direction is the top of the page.</para>
  5783. </refsection>
  5784. </refentry>
  5785. <refentry version="5.0" xml:id="footnote.number.format">
  5786. <refmeta>
  5787. <refentrytitle>footnote.number.format</refentrytitle>
  5788. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  5789. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  5790. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  5791. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  5792. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  5793. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  5794. </refmeta>
  5795. <refnamediv>
  5796. <refname>footnote.number.format</refname>
  5797. <refpurpose>Identifies the format used for footnote numbers</refpurpose>
  5798. </refnamediv>
  5799. <refsynopsisdiv>
  5800. <programlisting xml:id="footnote.number.format.frag">
  5801. &lt;xsl:param name="footnote.number.format"&gt;1&lt;/xsl:param&gt;
  5802. </programlisting>
  5803. </refsynopsisdiv>
  5804. <refsection><info><title>Description</title></info>
  5805. <para>The <parameter>footnote.number.format</parameter> specifies the format
  5806. to use for footnote numeration (1, i, I, a, or A).</para>
  5807. </refsection>
  5808. </refentry>
  5809. <refentry version="5.0" xml:id="table.footnote.number.format">
  5810. <refmeta>
  5811. <refentrytitle>table.footnote.number.format</refentrytitle>
  5812. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  5813. <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
  5814. <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
  5815. <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
  5816. <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
  5817. <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
  5818. </refmeta>
  5819. <refnamediv>
  5820. <refname>table.footnote.number.format</refname>
  5821. <refpurpose>Identifies the format used for footnote numbers in tables</refpurpose>
  5822. </refnamediv>
  5823. <refsynopsisdiv>
  5824. <programlisting xml:id="table.footnote.number.format.frag">
  5825. &lt;xsl:param name="table.footnote.number.format"&gt;a&lt;/xsl:param&gt;
  5826. </programlisting>
  5827. </refsynopsisdiv>
  5828. <refsection><info><title>Description</title></info>
  5829. <para>The <parameter>table.footnote.number.format</parameter> specifies the format
  5830. to use for footnote numeration (1, i, I, a, or A) in tables.</para>
  5831. </refsection>
  5832. </refentry>
  5833. <refentry version="5.0" xml:id="footnote.number.symbols">
  5834. <refmeta>
  5835. <refentrytitle>footnote.number.symbols</refentrytitle>
  5836. <refmiscinfo class="other" otherclass="datatype"/>
  5837. </refmeta>
  5838. <refnamediv>
  5839. <refname>footnote.number.symbols</refname>
  5840. <refpurpose>Special characters to use as footnote markers</refpurpose>
  5841. </refnamediv>
  5842. <refsynopsisdiv>
  5843. <programlisting xml:id="footnote.number.symbols.frag">
  5844. &lt;xsl:param name="footnote.number.symbols"&gt;&lt;/xsl:param&gt;
  5845. </programlisting>
  5846. </refsynopsisdiv>
  5847. <refsection><info><title>Description</title></info>
  5848. <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
  5849. footnotes will use the characters it contains as footnote symbols. For example,
  5850. <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
  5851. footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
  5852. <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
  5853. than symbols, the stylesheets will fall back to numbered footnotes using
  5854. <parameter>footnote.number.format</parameter>.</para>
  5855. <para>The use of symbols for footnotes depends on the ability of your
  5856. processor (or browser) to render the symbols you select. Not all systems are
  5857. capable of displaying the full range of Unicode characters. If the quoted characters
  5858. in the preceding paragraph are not displayed properly, that's a good indicator
  5859. that you may have trouble using those symbols for footnotes.</para>
  5860. </refsection>
  5861. </refentry>
  5862. <refentry version="5.0" xml:id="table.footnote.number.symbols">
  5863. <refmeta>
  5864. <refentrytitle>table.footnote.number.symbols</refentrytitle>
  5865. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5866. </refmeta>
  5867. <refnamediv>
  5868. <refname>table.footnote.number.symbols</refname>
  5869. <refpurpose>Special characters to use a footnote markers in tables</refpurpose>
  5870. </refnamediv>
  5871. <refsynopsisdiv>
  5872. <programlisting xml:id="table.footnote.number.symbols.frag">
  5873. &lt;xsl:param name="table.footnote.number.symbols"&gt;&lt;/xsl:param&gt;
  5874. </programlisting>
  5875. </refsynopsisdiv>
  5876. <refsection><info><title>Description</title></info>
  5877. <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty string,
  5878. table footnotes will use the characters it contains as footnote symbols. For example,
  5879. <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
  5880. footnotes with <quote>*</quote>, <quote>&#8224;</quote>, <quote>&#8225;</quote>,
  5881. <quote>&#9674;</quote>, and <quote>&#10016;</quote>. If there are more footnotes
  5882. than symbols, the stylesheets will fall back to numbered footnotes using
  5883. <parameter>table.footnote.number.format</parameter>.</para>
  5884. <para>The use of symbols for footnotes depends on the ability of your
  5885. processor (or browser) to render the symbols you select. Not all systems are
  5886. capable of displaying the full range of Unicode characters. If the quoted characters
  5887. in the preceding paragraph are not displayed properly, that's a good indicator
  5888. that you may have trouble using those symbols for footnotes.</para>
  5889. </refsection>
  5890. </refentry>
  5891. <refentry version="5.0" xml:id="highlight.source">
  5892. <refmeta>
  5893. <refentrytitle>highlight.source</refentrytitle>
  5894. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  5895. </refmeta>
  5896. <refnamediv>
  5897. <refname>highlight.source</refname>
  5898. <refpurpose>Should the content of <tag>programlisting</tag>
  5899. be syntactically highlighted?</refpurpose>
  5900. </refnamediv>
  5901. <refsynopsisdiv>
  5902. <programlisting xml:id="highlight.source.frag">
  5903. &lt;xsl:param name="highlight.source" select="0"&gt;&lt;/xsl:param&gt;
  5904. </programlisting>
  5905. </refsynopsisdiv>
  5906. <refsection><info><title>Description</title></info>
  5907. <para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
  5908. content of <tag>programlisting</tag> elements. You specify the language for each programlisting
  5909. by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
  5910. parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
  5911. attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
  5912. <para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
  5913. downloaded separately (see below).</para>
  5914. <itemizedlist>
  5915. <para>In order to use this extension, you must</para>
  5916. <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
  5917. from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link>
  5918. at SourceForge.</para>
  5919. </listitem>
  5920. <listitem>
  5921. <para>use a customization layer in which you import one of the following stylesheet modules:
  5922. <itemizedlist>
  5923. <listitem>
  5924. <para><filename>html/highlight.xsl</filename>
  5925. </para>
  5926. </listitem>
  5927. <listitem>
  5928. <para><filename>xhtml/highlight.xsl</filename>
  5929. </para>
  5930. </listitem>
  5931. <listitem>
  5932. <para><filename>xhtml-1_1/highlight.xsl</filename>
  5933. </para>
  5934. </listitem>
  5935. <listitem>
  5936. <para><filename>fo/highlight.xsl</filename>
  5937. </para>
  5938. </listitem>
  5939. </itemizedlist>
  5940. </para>
  5941. </listitem>
  5942. <listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
  5943. <parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
  5944. highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
  5945. <filename>highlighting/xslthl-config.xml</filename>.</para>
  5946. </listitem>
  5947. </itemizedlist>
  5948. <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
  5949. an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
  5950. <para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
  5951. <informalexample>
  5952. <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
  5953. -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
  5954. -o test.html test.xml myhtml.xsl</command></para>
  5955. </informalexample>
  5956. </refsection>
  5957. </refentry>
  5958. <refentry version="5.0" xml:id="highlight.xslthl.config">
  5959. <refmeta>
  5960. <refentrytitle>highlight.xslthl.config</refentrytitle>
  5961. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  5962. </refmeta>
  5963. <refnamediv>
  5964. <refname>highlight.xslthl.config</refname>
  5965. <refpurpose>Location of XSLTHL configuration file</refpurpose>
  5966. </refnamediv>
  5967. <refsynopsisdiv>
  5968. <programlisting xml:id="highlight.xslthl.config.frag">
  5969. &lt;xsl:param name="highlight.xslthl.config"&gt;&lt;/xsl:param&gt;
  5970. </programlisting>
  5971. </refsynopsisdiv>
  5972. <refsection><info><title>Description</title></info>
  5973. <para>This location has precedence over the corresponding Java property.</para>
  5974. <para>Please note that usually you have to specify location as URL not
  5975. just as a simple path on the local
  5976. filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filename>.</para>
  5977. </refsection>
  5978. </refentry>
  5979. <refentry version="5.0" xml:id="highlight.default.language">
  5980. <refmeta>
  5981. <refentrytitle>highlight.default.language</refentrytitle>
  5982. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  5983. </refmeta>
  5984. <refnamediv>
  5985. <refname>highlight.default.language</refname>
  5986. <refpurpose>Default language of programlisting</refpurpose>
  5987. </refnamediv>
  5988. <refsynopsisdiv>
  5989. <programlisting xml:id="highlight.default.language.frag">
  5990. &lt;xsl:param name="highlight.default.language"&gt;&lt;/xsl:param&gt;
  5991. </programlisting>
  5992. </refsynopsisdiv>
  5993. <refsection><info><title>Description</title></info>
  5994. <para>This language is used when there is no language attribute on programlisting.</para>
  5995. </refsection>
  5996. </refentry>
  5997. <refentry version="5.0" xml:id="email.delimiters.enabled">
  5998. <refmeta>
  5999. <refentrytitle>email.delimiters.enabled</refentrytitle>
  6000. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6001. </refmeta>
  6002. <refnamediv>
  6003. <refname>email.delimiters.enabled</refname>
  6004. <refpurpose>Generate delimiters around email addresses?</refpurpose>
  6005. </refnamediv>
  6006. <refsynopsisdiv>
  6007. <programlisting xml:id="email.delimiters.enabled.frag">
  6008. &lt;xsl:param name="email.delimiters.enabled" select="1"&gt;&lt;/xsl:param&gt;
  6009. </programlisting>
  6010. </refsynopsisdiv>
  6011. <refsection><info><title>Description</title></info>
  6012. <para>If non-zero, delimiters
  6013. <footnote><para>For delimiters, the
  6014. stylesheets are currently hard-coded to output angle
  6015. brackets.</para></footnote>
  6016. are generated around e-mail addresses
  6017. (the output of the <tag>email</tag> element).</para>
  6018. </refsection>
  6019. </refentry>
  6020. <refentry version="5.0" xml:id="exsl.node.set.available">
  6021. <refmeta>
  6022. <refentrytitle>exsl.node.set.available</refentrytitle>
  6023. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6024. </refmeta>
  6025. <refnamediv>
  6026. <refname>exsl.node.set.available</refname>
  6027. <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose>
  6028. </refnamediv>
  6029. <refsynopsisdiv>
  6030. <programlisting xml:id="exsl.node.set.available.frag">&lt;xsl:param name="exsl.node.set.available"&gt;
  6031. &lt;xsl:choose&gt;
  6032. &lt;xsl:when exsl:foo="" test="function-available('exsl:node-set') or contains(system-property('xsl:vendor'), 'Apache Software Foundation')"&gt;1&lt;/xsl:when&gt;
  6033. &lt;xsl:otherwise&gt;0&lt;/xsl:otherwise&gt;
  6034. &lt;/xsl:choose&gt;
  6035. &lt;/xsl:param&gt;
  6036. </programlisting>
  6037. </refsynopsisdiv>
  6038. <refsection><info><title>Description</title></info>
  6039. <para>If non-zero,
  6040. then the exsl:node-set() function is available to be used in
  6041. the stylesheet.
  6042. If zero, then the function is not available.
  6043. This param automatically detects the presence of
  6044. the function and does not normally need to be set manually.</para>
  6045. <para>This param was created to handle a long-standing
  6046. bug in the Xalan processor that fails to detect the
  6047. function even though it is available.</para>
  6048. </refsection>
  6049. </refentry>
  6050. </reference>
  6051. <reference xml:id="annos"><title>Annotations</title>
  6052. <refentry version="5.0" xml:id="annotation.support">
  6053. <refmeta>
  6054. <refentrytitle>annotation.support</refentrytitle>
  6055. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6056. </refmeta>
  6057. <refnamediv>
  6058. <refname>annotation.support</refname>
  6059. <refpurpose>Enable annotations?</refpurpose>
  6060. </refnamediv>
  6061. <refsynopsisdiv>
  6062. <programlisting xml:id="annotation.support.frag">
  6063. &lt;xsl:param name="annotation.support" select="0"&gt;&lt;/xsl:param&gt;
  6064. </programlisting>
  6065. </refsynopsisdiv>
  6066. <refsection><info><title>Description</title></info>
  6067. <para>If non-zero, the stylesheets will attempt to support annotation
  6068. elements in HTML by including some JavaScript (see
  6069. <parameter>annotation.js</parameter>).</para>
  6070. </refsection>
  6071. </refentry>
  6072. <refentry version="5.0" xml:id="annotation.js">
  6073. <refmeta>
  6074. <refentrytitle>annotation.js</refentrytitle>
  6075. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6076. </refmeta>
  6077. <refnamediv>
  6078. <refname>annotation.js</refname>
  6079. <refpurpose>URIs identifying JavaScript files with support for annotation popups</refpurpose>
  6080. </refnamediv>
  6081. <refsynopsisdiv>
  6082. <programlisting xml:id="annotation.js.frag">
  6083. &lt;xsl:param name="annotation.js"&gt;
  6084. &lt;xsl:text&gt;http://docbook.sourceforge.net/release/script/AnchorPosition.js http://docbook.sourceforge.net/release/script/PopupWindow.js&lt;/xsl:text&gt;&lt;/xsl:param&gt;
  6085. </programlisting>
  6086. </refsynopsisdiv>
  6087. <refsection><info><title>Description</title></info>
  6088. <para>If <property>annotation.support</property> is enabled and the
  6089. document contains <tag>annotation</tag>s, then the URIs listed
  6090. in this parameter will be included. These JavaScript files are required
  6091. for popup annotation support.</para>
  6092. </refsection>
  6093. </refentry>
  6094. <refentry version="5.0" xml:id="annotation.css">
  6095. <refmeta>
  6096. <refentrytitle>annotation.css</refentrytitle>
  6097. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6098. </refmeta>
  6099. <refnamediv>
  6100. <refname>annotation.css</refname>
  6101. <refpurpose>CSS rules for annotations</refpurpose>
  6102. </refnamediv>
  6103. <refsynopsisdiv>
  6104. <programlisting xml:id="annotation.css.frag">
  6105. &lt;xsl:param name="annotation.css"&gt;
  6106. /* ======================================================================
  6107. Annotations
  6108. */
  6109. div.annotation-list { visibility: hidden;
  6110. }
  6111. div.annotation-nocss { position: absolute;
  6112. visibility: hidden;
  6113. }
  6114. div.annotation-popup { position: absolute;
  6115. z-index: 4;
  6116. visibility: hidden;
  6117. padding: 0px;
  6118. margin: 2px;
  6119. border-style: solid;
  6120. border-width: 1px;
  6121. width: 200px;
  6122. background-color: white;
  6123. }
  6124. div.annotation-title { padding: 1px;
  6125. font-weight: bold;
  6126. border-bottom-style: solid;
  6127. border-bottom-width: 1px;
  6128. color: white;
  6129. background-color: black;
  6130. }
  6131. div.annotation-body { padding: 2px;
  6132. }
  6133. div.annotation-body p { margin-top: 0px;
  6134. padding-top: 0px;
  6135. }
  6136. div.annotation-close { position: absolute;
  6137. top: 2px;
  6138. right: 2px;
  6139. }
  6140. &lt;/xsl:param&gt;
  6141. </programlisting>
  6142. </refsynopsisdiv>
  6143. <refsection><info><title>Description</title></info>
  6144. <para>If <parameter>annotation.support</parameter> is enabled and the
  6145. document contains <tag>annotation</tag>s, then the CSS in this
  6146. parameter will be included in the document.</para>
  6147. </refsection>
  6148. </refentry>
  6149. <refentry version="5.0" xml:id="annotation.graphic.open">
  6150. <refmeta>
  6151. <refentrytitle>annotation.graphic.open</refentrytitle>
  6152. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  6153. </refmeta>
  6154. <refnamediv>
  6155. <refname>annotation.graphic.open</refname>
  6156. <refpurpose>Image for identifying a link that opens an annotation popup</refpurpose>
  6157. </refnamediv>
  6158. <refsynopsisdiv>
  6159. <programlisting xml:id="annotation.graphic.open.frag">
  6160. &lt;xsl:param name="annotation.graphic.open"&gt;http://docbook.sourceforge.net/release/images/annot-open.png&lt;/xsl:param&gt;
  6161. </programlisting>
  6162. </refsynopsisdiv>
  6163. <refsection><info><title>Description</title></info>
  6164. <para>This image is used inline to identify the location of
  6165. annotations. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
  6166. </refsection>
  6167. </refentry>
  6168. <refentry version="5.0" xml:id="annotation.graphic.close">
  6169. <refmeta>
  6170. <refentrytitle>annotation.graphic.close</refentrytitle>
  6171. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  6172. </refmeta>
  6173. <refnamediv>
  6174. <refname>annotation.graphic.close</refname>
  6175. <refpurpose>Image for identifying a link that closes an annotation popup</refpurpose>
  6176. </refnamediv>
  6177. <refsynopsisdiv>
  6178. <programlisting xml:id="annotation.graphic.close.frag">
  6179. &lt;xsl:param name="annotation.graphic.close"&gt;
  6180. http://docbook.sourceforge.net/release/images/annot-close.png&lt;/xsl:param&gt;
  6181. </programlisting>
  6182. </refsynopsisdiv>
  6183. <refsection><info><title>Description</title></info>
  6184. <para>This image is used on popup annotations as the &#8220;x&#8221; that the
  6185. user can click to dismiss the popup.</para>
  6186. <para>This image is used on popup annotations as the &#8220;x&#8221; that the user can
  6187. click to dismiss the popup. It may be replaced by a user provided graphic. The size should be approximately 10x10 pixels.</para>
  6188. </refsection>
  6189. </refentry>
  6190. </reference>
  6191. <reference xml:id="graphics"><title>Graphics</title>
  6192. <refentry version="5.0" xml:id="img.src.path">
  6193. <refmeta>
  6194. <refentrytitle>img.src.path</refentrytitle>
  6195. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6196. </refmeta>
  6197. <refnamediv>
  6198. <refname>img.src.path</refname>
  6199. <refpurpose>Path to HTML/FO image files</refpurpose>
  6200. </refnamediv>
  6201. <refsynopsisdiv>
  6202. <programlisting xml:id="img.src.path.frag">&lt;xsl:param name="img.src.path"&gt;&lt;/xsl:param&gt;</programlisting>
  6203. </refsynopsisdiv>
  6204. <refsection><info><title>Description</title></info>
  6205. <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
  6206. attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting
  6207. compound path is used in the output as the value of the <tag class="attribute">src</tag>
  6208. attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
  6209. </para>
  6210. <para>
  6211. The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
  6212. files are created, or it could be an absolute URI.
  6213. The default value is empty.
  6214. Be sure to include a trailing slash if needed.
  6215. </para>
  6216. <para>This prefix is not applied to any filerefs that start
  6217. with "/" or contain "//:".
  6218. </para>
  6219. </refsection>
  6220. </refentry>
  6221. <refentry version="5.0" xml:id="keep.relative.image.uris">
  6222. <refmeta>
  6223. <refentrytitle>keep.relative.image.uris</refentrytitle>
  6224. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6225. </refmeta>
  6226. <refnamediv>
  6227. <refname>keep.relative.image.uris</refname>
  6228. <refpurpose>Should image URIs be resolved against xml:base?</refpurpose>
  6229. </refnamediv>
  6230. <refsynopsisdiv>
  6231. <programlisting xml:id="keep.relative.image.uris.frag">
  6232. &lt;xsl:param name="keep.relative.image.uris" select="1"&gt;&lt;/xsl:param&gt;
  6233. </programlisting>
  6234. </refsynopsisdiv>
  6235. <refsection><info><title>Description</title></info>
  6236. <para>If non-zero, relative URIs (in, for example
  6237. <literal>fileref</literal> attributes) will be used in the generated
  6238. output. Otherwise, the URIs will be made absolute with respect to the
  6239. base URI.</para>
  6240. <para>Note that the stylesheets calculate (and use) the absolute form
  6241. for some purposes, this only applies to the resulting output.</para>
  6242. </refsection>
  6243. </refentry>
  6244. <refentry version="5.0" xml:id="graphic.default.extension">
  6245. <refmeta>
  6246. <refentrytitle>graphic.default.extension</refentrytitle>
  6247. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6248. </refmeta>
  6249. <refnamediv>
  6250. <refname>graphic.default.extension</refname>
  6251. <refpurpose>Default extension for graphic filenames</refpurpose>
  6252. </refnamediv>
  6253. <refsynopsisdiv>
  6254. <programlisting xml:id="graphic.default.extension.frag">&lt;xsl:param name="graphic.default.extension"&gt;&lt;/xsl:param&gt;</programlisting>
  6255. </refsynopsisdiv>
  6256. <refsection><info><title>Description</title></info>
  6257. <para>If a <tag>graphic</tag> or <tag>mediaobject</tag>
  6258. includes a reference to a filename that does not include an extension,
  6259. and the <tag class="attribute">format</tag> attribute is
  6260. <emphasis>unspecified</emphasis>, the default extension will be used.
  6261. </para>
  6262. </refsection>
  6263. </refentry>
  6264. <refentry version="5.0" xml:id="default.image.width">
  6265. <refmeta>
  6266. <refentrytitle>default.image.width</refentrytitle>
  6267. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  6268. </refmeta>
  6269. <refnamediv>
  6270. <refname>default.image.width</refname>
  6271. <refpurpose>The default width of images</refpurpose>
  6272. </refnamediv>
  6273. <refsynopsisdiv>
  6274. <programlisting xml:id="default.image.width.frag">
  6275. &lt;xsl:param name="default.image.width"&gt;&lt;/xsl:param&gt;
  6276. </programlisting>
  6277. </refsynopsisdiv>
  6278. <refsection><info><title>Description</title></info>
  6279. <para>If specified, this value will be used for the
  6280. <tag class="attribute">width</tag> attribute on images that do not specify any
  6281. <emphasis xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="DocBook 5: The Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#viewport.area">viewport dimensions</emphasis>.</para>
  6282. </refsection>
  6283. </refentry>
  6284. <refentry version="5.0" xml:id="nominal.image.width">
  6285. <refmeta>
  6286. <refentrytitle>nominal.image.width</refentrytitle>
  6287. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  6288. </refmeta>
  6289. <refnamediv>
  6290. <refname>nominal.image.width</refname>
  6291. <refpurpose>The nominal image width</refpurpose>
  6292. </refnamediv>
  6293. <refsynopsisdiv>
  6294. <programlisting xml:id="nominal.image.width.frag">
  6295. &lt;xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
  6296. </programlisting>
  6297. </refsynopsisdiv>
  6298. <refsection><info><title>Description</title></info>
  6299. <para>Graphic widths expressed as a percentage are problematic. In the
  6300. following discussion, we speak of width and contentwidth, but
  6301. the same issues apply to depth and contentdepth.</para>
  6302. <para>A width of 50% means "half of the available space for the image."
  6303. That's fine. But note that in HTML, this is a dynamic property and
  6304. the image size will vary if the browser window is resized.</para>
  6305. <para>A contentwidth of 50% means "half of the actual image width".
  6306. But what does that mean if the stylesheets cannot assess the image's
  6307. actual size? Treating this as a width of 50% is one possibility, but
  6308. it produces behavior (dynamic scaling) that seems entirely out of
  6309. character with the meaning.</para>
  6310. <para>Instead, the stylesheets define a
  6311. <parameter>nominal.image.width</parameter> and convert percentages to
  6312. actual values based on that nominal size.</para>
  6313. </refsection>
  6314. </refentry>
  6315. <refentry version="5.0" xml:id="nominal.image.depth">
  6316. <refmeta>
  6317. <refentrytitle>nominal.image.depth</refentrytitle>
  6318. <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  6319. </refmeta>
  6320. <refnamediv>
  6321. <refname>nominal.image.depth</refname>
  6322. <refpurpose>Nominal image depth</refpurpose>
  6323. </refnamediv>
  6324. <refsynopsisdiv>
  6325. <programlisting xml:id="nominal.image.depth.frag">
  6326. &lt;xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"&gt;&lt;/xsl:param&gt;
  6327. </programlisting>
  6328. </refsynopsisdiv>
  6329. <refsection><info><title>Description</title></info>
  6330. <para>See <parameter>nominal.image.width</parameter>.</para>
  6331. </refsection>
  6332. </refentry>
  6333. <refentry version="5.0" xml:id="use.embed.for.svg">
  6334. <refmeta>
  6335. <refentrytitle>use.embed.for.svg</refentrytitle>
  6336. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6337. </refmeta>
  6338. <refnamediv>
  6339. <refname>use.embed.for.svg</refname>
  6340. <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose>
  6341. </refnamediv>
  6342. <refsynopsisdiv>
  6343. <programlisting xml:id="use.embed.for.svg.frag">
  6344. &lt;xsl:param name="use.embed.for.svg" select="0"&gt;&lt;/xsl:param&gt;
  6345. </programlisting>
  6346. </refsynopsisdiv>
  6347. <refsection><info><title>Description</title></info>
  6348. <para>If non-zero, an <tag>embed</tag> element will be created for
  6349. SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created,
  6350. this parameter merely controls whether or not an additional <tag>embed</tag>
  6351. is generated inside the <tag>object</tag>.</para>
  6352. <para>On the plus side, this may be more portable among browsers and plug-ins.
  6353. On the minus side, it isn't valid HTML.</para>
  6354. </refsection>
  6355. </refentry>
  6356. <refentry version="5.0" xml:id="make.graphic.viewport">
  6357. <refmeta>
  6358. <refentrytitle>make.graphic.viewport</refentrytitle>
  6359. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6360. </refmeta>
  6361. <refnamediv>
  6362. <refname>make.graphic.viewport</refname>
  6363. <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose>
  6364. </refnamediv>
  6365. <refsynopsisdiv>
  6366. <programlisting xml:id="make.graphic.viewport.frag">
  6367. &lt;xsl:param name="make.graphic.viewport" select="1"&gt;&lt;/xsl:param&gt;
  6368. </programlisting>
  6369. </refsynopsisdiv>
  6370. <refsection><info><title>Description</title></info>
  6371. <para>The HTML <tag>img</tag> element only supports the notion
  6372. of content-area scaling; it doesn't support the distinction between a
  6373. content-area and a viewport-area, so we have to make some compromises.</para>
  6374. <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table
  6375. will be used to frame the image. This creates an effective viewport-area.
  6376. </para>
  6377. <para>Tables and alignment don't work together, so this parameter is ignored
  6378. if alignment is specified on an image.</para>
  6379. </refsection>
  6380. </refentry>
  6381. <refentry version="5.0" xml:id="preferred.mediaobject.role">
  6382. <refmeta>
  6383. <refentrytitle>preferred.mediaobject.role</refentrytitle>
  6384. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6385. </refmeta>
  6386. <refnamediv>
  6387. <refname>preferred.mediaobject.role</refname>
  6388. <refpurpose>Select which mediaobject to use based on
  6389. this value of an object's <tag class="attribute">role</tag> attribute.
  6390. </refpurpose>
  6391. </refnamediv>
  6392. <refsynopsisdiv>
  6393. <programlisting xml:id="preferred.mediaobject.role.frag">
  6394. &lt;xsl:param name="preferred.mediaobject.role"&gt;&lt;/xsl:param&gt;
  6395. </programlisting>
  6396. </refsynopsisdiv>
  6397. <refsection><info><title>Description</title></info>
  6398. <para>A mediaobject may contain several objects such as imageobjects.
  6399. If the parameter <parameter>use.role.for.mediaobject</parameter> is
  6400. non-zero, then the <literal>role</literal> attribute on
  6401. <tag>imageobject</tag>s and other objects within a
  6402. <tag>mediaobject</tag> container will be used to select which object
  6403. will be used. If one of the objects has a role value that matches the
  6404. <parameter>preferred.mediaobject.role</parameter> parameter, then it
  6405. has first priority for selection. If more than one has such a role
  6406. value, the first one is used.
  6407. </para>
  6408. <para>
  6409. See the <parameter>use.role.for.mediaobject</parameter> parameter
  6410. for the sequence of selection.</para>
  6411. </refsection>
  6412. </refentry>
  6413. <refentry version="5.0" xml:id="use.role.for.mediaobject">
  6414. <refmeta>
  6415. <refentrytitle>use.role.for.mediaobject</refentrytitle>
  6416. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6417. </refmeta>
  6418. <refnamediv>
  6419. <refname>use.role.for.mediaobject</refname>
  6420. <refpurpose>Use <tag class="attribute">role</tag> attribute
  6421. value for selecting which of several objects within a mediaobject to use.
  6422. </refpurpose>
  6423. </refnamediv>
  6424. <refsynopsisdiv>
  6425. <programlisting xml:id="use.role.for.mediaobject.frag">
  6426. &lt;xsl:param name="use.role.for.mediaobject" select="1"&gt;&lt;/xsl:param&gt;
  6427. </programlisting>
  6428. </refsynopsisdiv>
  6429. <refsection><info><title>Description</title></info>
  6430. <para>If non-zero, the <tag class="attribute">role</tag> attribute on
  6431. <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
  6432. used.
  6433. </para>
  6434. <para>
  6435. The order of selection when then parameter is non-zero is:
  6436. </para>
  6437. <orderedlist>
  6438. <listitem>
  6439. <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
  6440. </listitem>
  6441. <listitem>
  6442. <para>Else if an object's role attribute has a value of
  6443. <literal>html</literal> for HTML processing or
  6444. <literal>fo</literal> for FO output, then the first
  6445. of such objects is selected.
  6446. </para>
  6447. </listitem>
  6448. <listitem>
  6449. <para>Else the first suitable object is selected.</para>
  6450. </listitem>
  6451. </orderedlist>
  6452. <para>
  6453. If the value of
  6454. <parameter>use.role.for.mediaobject</parameter>
  6455. is zero, then role attributes are not considered
  6456. and the first suitable object
  6457. with or without a role value is used.
  6458. </para>
  6459. </refsection>
  6460. </refentry>
  6461. <refentry version="5.0" xml:id="ignore.image.scaling">
  6462. <refmeta>
  6463. <refentrytitle>ignore.image.scaling</refentrytitle>
  6464. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6465. </refmeta>
  6466. <refnamediv>
  6467. <refname>ignore.image.scaling</refname>
  6468. <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes</refpurpose>
  6469. </refnamediv>
  6470. <refsynopsisdiv>
  6471. <programlisting xml:id="ignore.image.scaling.frag">
  6472. &lt;xsl:param name="ignore.image.scaling" select="0"&gt;&lt;/xsl:param&gt;
  6473. </programlisting>
  6474. </refsynopsisdiv>
  6475. <refsection><info><title>Description</title></info>
  6476. <para>If non-zero, the scaling attributes on graphics and media objects are
  6477. ignored.</para>
  6478. </refsection>
  6479. </refentry>
  6480. </reference>
  6481. <reference xml:id="chunking"><title>Chunking</title>
  6482. <refentry version="5.0" xml:id="chunker.output.cdata-section-elements">
  6483. <refmeta>
  6484. <refentrytitle>chunker.output.cdata-section-elements</refentrytitle>
  6485. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6486. </refmeta>
  6487. <refnamediv>
  6488. <refname>chunker.output.cdata-section-elements</refname>
  6489. <refpurpose>List of elements to escape with CDATA sections</refpurpose>
  6490. </refnamediv>
  6491. <refsynopsisdiv>
  6492. <programlisting xml:id="chunker.output.cdata-section-elements.frag">
  6493. &lt;xsl:param name="chunker.output.cdata-section-elements"&gt;&lt;/xsl:param&gt;
  6494. </programlisting>
  6495. </refsynopsisdiv>
  6496. <refsection><info><title>Description</title></info>
  6497. <para>This parameter specifies the list of elements that should be escaped
  6498. as CDATA sections by the chunking stylesheet. Not all processors support
  6499. specification of this parameter.
  6500. </para>
  6501. <note>
  6502. <para>This parameter is documented here, but the declaration is actually
  6503. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6504. </note>
  6505. </refsection>
  6506. </refentry>
  6507. <refentry version="5.0" xml:id="chunker.output.doctype-public">
  6508. <refmeta>
  6509. <refentrytitle>chunker.output.doctype-public</refentrytitle>
  6510. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6511. </refmeta>
  6512. <refnamediv>
  6513. <refname>chunker.output.doctype-public</refname>
  6514. <refpurpose>Public identifer to use in the document type of generated pages</refpurpose>
  6515. </refnamediv>
  6516. <refsynopsisdiv>
  6517. <programlisting xml:id="chunker.output.doctype-public.frag">
  6518. &lt;xsl:param name="chunker.output.doctype-public"&gt;&lt;/xsl:param&gt;
  6519. </programlisting>
  6520. </refsynopsisdiv>
  6521. <refsection><info><title>Description</title></info>
  6522. <para>This parameter specifies the public identifier that should be used by
  6523. the chunking stylesheet in the document type declaration of chunked pages.
  6524. Not all processors support specification of
  6525. this parameter.
  6526. </para>
  6527. <note>
  6528. <para>This parameter is documented here, but the declaration is actually
  6529. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6530. </note>
  6531. </refsection>
  6532. </refentry>
  6533. <refentry version="5.0" xml:id="chunker.output.doctype-system">
  6534. <refmeta>
  6535. <refentrytitle>chunker.output.doctype-system</refentrytitle>
  6536. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  6537. </refmeta>
  6538. <refnamediv>
  6539. <refname>chunker.output.doctype-system</refname>
  6540. <refpurpose>System identifier to use for the document type in generated pages</refpurpose>
  6541. </refnamediv>
  6542. <refsynopsisdiv>
  6543. <programlisting xml:id="chunker.output.doctype-system.frag">
  6544. &lt;xsl:param name="chunker.output.doctype-system"&gt;&lt;/xsl:param&gt;
  6545. </programlisting>
  6546. </refsynopsisdiv>
  6547. <refsection><info><title>Description</title></info>
  6548. <para>This parameter specifies the system identifier that should be used by
  6549. the chunking stylesheet in the document type declaration of chunked pages.
  6550. Not all processors support specification of
  6551. this parameter.
  6552. </para>
  6553. <note>
  6554. <para>This parameter is documented here, but the declaration is actually
  6555. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6556. </note>
  6557. </refsection>
  6558. </refentry>
  6559. <refentry version="5.0" xml:id="chunker.output.encoding">
  6560. <refmeta>
  6561. <refentrytitle>chunker.output.encoding</refentrytitle>
  6562. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6563. </refmeta>
  6564. <refnamediv>
  6565. <refname>chunker.output.encoding</refname>
  6566. <refpurpose>Encoding used in generated pages</refpurpose>
  6567. </refnamediv>
  6568. <refsynopsisdiv>
  6569. <programlisting xml:id="chunker.output.encoding.frag">
  6570. &lt;xsl:param name="chunker.output.encoding"&gt;ISO-8859-1&lt;/xsl:param&gt;
  6571. </programlisting>
  6572. </refsynopsisdiv>
  6573. <refsection><info><title>Description</title></info>
  6574. <para>This parameter specifies the encoding to be used in files
  6575. generated by the chunking stylesheet. Not all processors support
  6576. specification of this parameter.
  6577. </para>
  6578. <para>This parameter used to be named <literal>default.encoding</literal>.</para>
  6579. <note>
  6580. <para>This parameter is documented here, but the declaration is actually
  6581. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6582. </note>
  6583. </refsection>
  6584. </refentry>
  6585. <refentry version="5.0" xml:id="chunker.output.indent">
  6586. <refmeta>
  6587. <refentrytitle>chunker.output.indent</refentrytitle>
  6588. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6589. </refmeta>
  6590. <refnamediv>
  6591. <refname>chunker.output.indent</refname>
  6592. <refpurpose>Specification of indentation on generated pages</refpurpose>
  6593. </refnamediv>
  6594. <refsynopsisdiv>
  6595. <programlisting xml:id="chunker.output.indent.frag">
  6596. &lt;xsl:param name="chunker.output.indent"&gt;no&lt;/xsl:param&gt;
  6597. </programlisting>
  6598. </refsynopsisdiv>
  6599. <refsection><info><title>Description</title></info>
  6600. <para>This parameter specifies the value of the indent
  6601. specification for generated pages. Not all processors support
  6602. specification of this parameter.
  6603. </para>
  6604. <note>
  6605. <para>This parameter is documented here, but the declaration is actually
  6606. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6607. </note>
  6608. </refsection>
  6609. </refentry>
  6610. <refentry version="5.0" xml:id="chunker.output.media-type">
  6611. <refmeta>
  6612. <refentrytitle>chunker.output.media-type</refentrytitle>
  6613. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6614. </refmeta>
  6615. <refnamediv>
  6616. <refname>chunker.output.media-type</refname>
  6617. <refpurpose>Media type to use in generated pages</refpurpose>
  6618. </refnamediv>
  6619. <refsynopsisdiv>
  6620. <programlisting xml:id="chunker.output.media-type.frag">
  6621. &lt;xsl:param name="chunker.output.media-type"&gt;&lt;/xsl:param&gt;
  6622. </programlisting>
  6623. </refsynopsisdiv>
  6624. <refsection><info><title>Description</title></info>
  6625. <para>This parameter specifies the media type that should be used by
  6626. the chunking stylesheet. Not all processors support specification of
  6627. this parameter.
  6628. </para>
  6629. <para>This parameter specifies the media type that should be used by the
  6630. chunking stylesheet. This should be one from those defined in
  6631. <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2045.txt">[RFC2045]</link> and
  6632. <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2046.txt">[RFC2046]</link> </para>
  6633. <note>
  6634. <para>This parameter is documented here, but the declaration is actually
  6635. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6636. <para>It must be one from html, xml or text</para>
  6637. </note>
  6638. </refsection>
  6639. </refentry>
  6640. <refentry version="5.0" xml:id="chunker.output.method">
  6641. <refmeta>
  6642. <refentrytitle>chunker.output.method</refentrytitle>
  6643. <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
  6644. <refmiscinfo class="other" otherclass="value">html</refmiscinfo>
  6645. <refmiscinfo class="other" otherclass="value">xml</refmiscinfo>
  6646. </refmeta>
  6647. <refnamediv>
  6648. <refname>chunker.output.method</refname>
  6649. <refpurpose>Method used in generated pages</refpurpose>
  6650. </refnamediv>
  6651. <refsynopsisdiv>
  6652. <programlisting xml:id="chunker.output.method.frag">
  6653. &lt;xsl:param name="chunker.output.method"&gt;html&lt;/xsl:param&gt;
  6654. </programlisting>
  6655. </refsynopsisdiv>
  6656. <refsection><info><title>Description</title></info>
  6657. <para>This parameter specifies the output method to be used in files
  6658. generated by the chunking stylesheet.
  6659. </para>
  6660. <para>This parameter used to be named <literal>output.method</literal>.</para>
  6661. <note>
  6662. <para>This parameter is documented here, but the declaration is actually
  6663. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6664. </note>
  6665. </refsection>
  6666. </refentry>
  6667. <refentry version="5.0" xml:id="chunker.output.omit-xml-declaration">
  6668. <refmeta>
  6669. <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle>
  6670. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6671. </refmeta>
  6672. <refnamediv>
  6673. <refname>chunker.output.omit-xml-declaration</refname>
  6674. <refpurpose>Omit-xml-declaration for generated pages</refpurpose>
  6675. </refnamediv>
  6676. <refsynopsisdiv>
  6677. <programlisting xml:id="chunker.output.omit-xml-declaration.frag">
  6678. &lt;xsl:param name="chunker.output.omit-xml-declaration"&gt;no&lt;/xsl:param&gt;
  6679. </programlisting>
  6680. </refsynopsisdiv>
  6681. <refsection><info><title>Description</title></info>
  6682. <para>This parameter specifies the value of the omit-xml-declaration
  6683. specification for generated pages. Not all processors support
  6684. specification of this parameter.
  6685. </para>
  6686. <note>
  6687. <para>This parameter is documented here, but the declaration is actually
  6688. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6689. </note>
  6690. </refsection>
  6691. </refentry>
  6692. <refentry version="5.0" xml:id="chunker.output.standalone">
  6693. <refmeta>
  6694. <refentrytitle>chunker.output.standalone</refentrytitle>
  6695. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6696. </refmeta>
  6697. <refnamediv>
  6698. <refname>chunker.output.standalone</refname>
  6699. <refpurpose>Standalone declaration for generated pages</refpurpose>
  6700. </refnamediv>
  6701. <refsynopsisdiv>
  6702. <programlisting xml:id="chunker.output.standalone.frag">
  6703. &lt;xsl:param name="chunker.output.standalone"&gt;no&lt;/xsl:param&gt;
  6704. </programlisting>
  6705. </refsynopsisdiv>
  6706. <refsection><info><title>Description</title></info>
  6707. <para>This parameter specifies the value of the standalone
  6708. specification for generated pages. It must be either
  6709. <literal>yes</literal> or <literal>no</literal>. Not all
  6710. processors support specification of this parameter.
  6711. </para>
  6712. <note>
  6713. <para>This parameter is documented here, but the declaration is actually
  6714. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6715. </note>
  6716. </refsection>
  6717. </refentry>
  6718. <refentry version="5.0" xml:id="saxon.character.representation">
  6719. <refmeta>
  6720. <refentrytitle>saxon.character.representation</refentrytitle>
  6721. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6722. </refmeta>
  6723. <refnamediv>
  6724. <refname>saxon.character.representation</refname>
  6725. <refpurpose>Saxon character representation used in generated HTML pages</refpurpose>
  6726. </refnamediv>
  6727. <refsynopsisdiv>
  6728. <programlisting xml:id="saxon.character.representation.frag">&lt;xsl:param name="saxon.character.representation" select="'entity;decimal'"&gt;&lt;/xsl:param&gt;</programlisting>
  6729. </refsynopsisdiv>
  6730. <refsection><info><title>Description</title></info>
  6731. <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or later).
  6732. It sets the character representation in files generated by the chunking stylesheets.
  6733. If you want to suppress entity references for characters with direct representations in
  6734. <parameter>chunker.output.encoding</parameter>, set the parameter value to <literal>native</literal>.
  6735. </para>
  6736. <para> For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output character representation</link>.</para>
  6737. <note>
  6738. <para>This parameter is documented here, but the declaration is actually
  6739. in the <filename>chunker.xsl</filename> stylesheet module.</para>
  6740. </note>
  6741. </refsection>
  6742. </refentry>
  6743. <refentry version="5.0" xml:id="html.ext">
  6744. <refmeta>
  6745. <refentrytitle>html.ext</refentrytitle>
  6746. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6747. </refmeta>
  6748. <refnamediv>
  6749. <refname>html.ext</refname>
  6750. <refpurpose>Identifies the extension of generated HTML files</refpurpose>
  6751. </refnamediv>
  6752. <refsynopsisdiv>
  6753. <programlisting xml:id="html.ext.frag">
  6754. &lt;xsl:param name="html.ext"&gt;.html&lt;/xsl:param&gt;
  6755. </programlisting>
  6756. </refsynopsisdiv>
  6757. <refsection><info><title>Description</title></info>
  6758. <para>The extension identified by <parameter>html.ext</parameter> will
  6759. be used as the filename extension for chunks created by this
  6760. stylesheet. </para>
  6761. </refsection>
  6762. </refentry>
  6763. <refentry version="5.0" xml:id="use.id.as.filename">
  6764. <refmeta>
  6765. <refentrytitle>use.id.as.filename</refentrytitle>
  6766. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6767. </refmeta>
  6768. <refnamediv>
  6769. <refname>use.id.as.filename</refname>
  6770. <refpurpose>Use ID value of chunk elements as the filename?</refpurpose>
  6771. </refnamediv>
  6772. <refsynopsisdiv>
  6773. <programlisting xml:id="use.id.as.filename.frag">
  6774. &lt;xsl:param name="use.id.as.filename" select="0"&gt;&lt;/xsl:param&gt;
  6775. </programlisting>
  6776. </refsynopsisdiv>
  6777. <refsection><info><title>Description</title></info>
  6778. <para>If <parameter>use.id.as.filename</parameter>
  6779. is non-zero, the filename of chunk elements that have IDs will be
  6780. derived from the ID value.
  6781. </para>
  6782. </refsection>
  6783. </refentry>
  6784. <refentry version="5.0" xml:id="html.extra.head.links">
  6785. <refmeta>
  6786. <refentrytitle>html.extra.head.links</refentrytitle>
  6787. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6788. </refmeta>
  6789. <refnamediv>
  6790. <refname>html.extra.head.links</refname>
  6791. <refpurpose>Toggle extra HTML head link information</refpurpose>
  6792. </refnamediv>
  6793. <refsynopsisdiv>
  6794. <programlisting xml:id="html.extra.head.links.frag">
  6795. &lt;xsl:param name="html.extra.head.links" select="0"&gt;&lt;/xsl:param&gt;
  6796. </programlisting>
  6797. </refsynopsisdiv>
  6798. <refsection><info><title>Description</title></info>
  6799. <para>If non-zero, extra <tag>link</tag> elements will be
  6800. generated in the <tag>head</tag> of chunked HTML files. These
  6801. extra links point to chapters, appendixes, sections, etc. as supported
  6802. by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least).
  6803. </para>
  6804. </refsection>
  6805. </refentry>
  6806. <refentry version="5.0" xml:id="root.filename">
  6807. <refmeta>
  6808. <refentrytitle>root.filename</refentrytitle>
  6809. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  6810. </refmeta>
  6811. <refnamediv>
  6812. <refname>root.filename</refname>
  6813. <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose>
  6814. </refnamediv>
  6815. <refsynopsisdiv>
  6816. <programlisting xml:id="root.filename.frag">
  6817. &lt;xsl:param name="root.filename"&gt;index&lt;/xsl:param&gt;
  6818. </programlisting>
  6819. </refsynopsisdiv>
  6820. <refsection><info><title>Description</title></info>
  6821. <para>The <parameter>root.filename</parameter> is the base filename for
  6822. the chunk created for the root of each document processed.
  6823. </para>
  6824. </refsection>
  6825. </refentry>
  6826. <refentry version="5.0" xml:id="base.dir">
  6827. <refmeta>
  6828. <refentrytitle>base.dir</refentrytitle>
  6829. <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>
  6830. </refmeta>
  6831. <refnamediv>
  6832. <refname>base.dir</refname>
  6833. <refpurpose>The base directory of chunks</refpurpose>
  6834. </refnamediv>
  6835. <refsynopsisdiv>
  6836. <programlisting xml:id="base.dir.frag">
  6837. &lt;xsl:param name="base.dir"&gt;&lt;/xsl:param&gt;
  6838. </programlisting>
  6839. </refsynopsisdiv>
  6840. <refsection><info><title>Description</title></info>
  6841. <para>If specified, the <parameter>base.dir</parameter> parameter identifies
  6842. the output directory for chunks. (If not specified, the output directory
  6843. is system dependent.)</para>
  6844. <para>Starting with version 1.77 of the stylesheets,
  6845. the param's value will have a trailing slash added if it does
  6846. not already have one.</para>
  6847. <caution><para>Do not use <parameter>base.dir</parameter>
  6848. to add a filename prefix string to chunked files.
  6849. Instead, use the <parameter>chunked.filename.prefix</parameter>
  6850. parameter.</para></caution>
  6851. </refsection>
  6852. </refentry>
  6853. <refentry version="5.0" xml:id="chunked.filename.prefix">
  6854. <refmeta>
  6855. <refentrytitle>chunked.filename.prefix</refentrytitle>
  6856. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6857. </refmeta>
  6858. <refnamediv>
  6859. <refname>chunked.filename.prefix</refname>
  6860. <refpurpose>Filename prefix for chunked files</refpurpose>
  6861. </refnamediv>
  6862. <refsynopsisdiv>
  6863. <programlisting xml:id="chunked.filename.prefix.frag">
  6864. &lt;xsl:param name="chunked.filename.prefix"&gt;&lt;/xsl:param&gt;
  6865. </programlisting>
  6866. </refsynopsisdiv>
  6867. <refsection><info><title>Description</title></info>
  6868. <para>If specified, the <parameter>chunked.filename.prefix</parameter>
  6869. parameter specifies a prefix string to add to each generated chunk filename.
  6870. For example:</para>
  6871. <programlisting>&lt;xsl:param name="chunked.filename.prefix"&gt;admin-&lt;xsl:param&gt;</programlisting>
  6872. <para>will produce chunked filenames like:</para>
  6873. <programlisting>admin-index.html
  6874. admin-ch01.html
  6875. admin-ch01s01.html
  6876. ...
  6877. </programlisting>
  6878. <caution><para>Trying to use the <parameter>base.dir</parameter>
  6879. parameter to add a string prefix (by omitting the trailing slash)
  6880. no longer works (it never worked completely anyway). That parameter
  6881. value should contain only a directory path, and
  6882. now gets a trailing slash appended if it was omitted from the param.</para></caution>
  6883. </refsection>
  6884. </refentry>
  6885. <refentry version="5.0" xml:id="generate.manifest">
  6886. <refmeta>
  6887. <refentrytitle>generate.manifest</refentrytitle>
  6888. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6889. </refmeta>
  6890. <refnamediv>
  6891. <refname>generate.manifest</refname>
  6892. <refpurpose>Generate a manifest file?</refpurpose>
  6893. </refnamediv>
  6894. <refsynopsisdiv>
  6895. <programlisting xml:id="generate.manifest.frag">&lt;xsl:param name="generate.manifest" select="0"&gt;&lt;/xsl:param&gt;</programlisting>
  6896. </refsynopsisdiv>
  6897. <refsection><info><title>Description</title></info>
  6898. <para>If non-zero, a list of HTML files generated by the
  6899. stylesheet transformation is written to the file named by
  6900. the <parameter>manifest</parameter> parameter.</para>
  6901. </refsection>
  6902. </refentry>
  6903. <refentry version="5.0" xml:id="manifest">
  6904. <refmeta>
  6905. <refentrytitle>manifest</refentrytitle>
  6906. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6907. </refmeta>
  6908. <refnamediv>
  6909. <refname>manifest</refname>
  6910. <refpurpose>Name of manifest file</refpurpose>
  6911. </refnamediv>
  6912. <refsynopsisdiv>
  6913. <programlisting xml:id="manifest.frag">
  6914. &lt;xsl:param name="manifest"&gt;HTML.manifest&lt;/xsl:param&gt;
  6915. </programlisting>
  6916. </refsynopsisdiv>
  6917. <refsection><info><title>Description</title></info>
  6918. <para>The name of the file to which a manifest is written (if the
  6919. value of the <parameter>generate.manifest</parameter> parameter
  6920. is non-zero).</para>
  6921. </refsection>
  6922. </refentry>
  6923. <refentry version="5.0" xml:id="manifest.in.base.dir">
  6924. <refmeta>
  6925. <refentrytitle>manifest.in.base.dir</refentrytitle>
  6926. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6927. </refmeta>
  6928. <refnamediv>
  6929. <refname>manifest.in.base.dir</refname>
  6930. <refpurpose>Should the manifest file be written into <parameter>base.dir</parameter>?</refpurpose>
  6931. </refnamediv>
  6932. <refsynopsisdiv>
  6933. <programlisting xml:id="manifest.in.base.dir.frag">
  6934. &lt;xsl:param name="manifest.in.base.dir" select="0"&gt;&lt;/xsl:param&gt;
  6935. </programlisting>
  6936. </refsynopsisdiv>
  6937. <refsection><info><title>Description</title></info>
  6938. <para>If non-zero, the manifest file as well as project files for HTML Help and
  6939. Eclipse Help are written into <parameter>base.dir</parameter> instead
  6940. of the current directory.</para>
  6941. </refsection>
  6942. </refentry>
  6943. <refentry version="5.0" xml:id="chunk.toc">
  6944. <refmeta>
  6945. <refentrytitle>chunk.toc</refentrytitle>
  6946. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  6947. </refmeta>
  6948. <refnamediv>
  6949. <refname>chunk.toc</refname>
  6950. <refpurpose>An explicit TOC to be used for chunking</refpurpose>
  6951. </refnamediv>
  6952. <refsynopsisdiv>
  6953. <programlisting xml:id="chunk.toc.frag">
  6954. &lt;xsl:param name="chunk.toc"&gt;&lt;/xsl:param&gt;
  6955. </programlisting>
  6956. </refsynopsisdiv>
  6957. <refsection><info><title>Description</title></info>
  6958. <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that
  6959. will be used for chunking. This parameter is only used by the
  6960. <filename>chunktoc.xsl</filename> stylesheet (and customization layers built
  6961. from it).</para>
  6962. </refsection>
  6963. </refentry>
  6964. <refentry version="5.0" xml:id="chunk.tocs.and.lots">
  6965. <refmeta>
  6966. <refentrytitle>chunk.tocs.and.lots</refentrytitle>
  6967. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6968. </refmeta>
  6969. <refnamediv>
  6970. <refname>chunk.tocs.and.lots</refname>
  6971. <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose>
  6972. </refnamediv>
  6973. <refsynopsisdiv>
  6974. <programlisting xml:id="chunk.tocs.and.lots.frag">
  6975. &lt;xsl:param name="chunk.tocs.and.lots" select="0"&gt;&lt;/xsl:param&gt;
  6976. </programlisting>
  6977. </refsynopsisdiv>
  6978. <refsection><info><title>Description</title></info>
  6979. <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.)
  6980. will be put in a separate chunk. At the moment, this chunk is not in the
  6981. normal forward/backward navigation list. Instead, a new link is added to the
  6982. navigation footer.</para>
  6983. <para>This feature is still somewhat experimental. Feedback welcome.</para>
  6984. </refsection>
  6985. </refentry>
  6986. <refentry version="5.0" xml:id="chunk.separate.lots">
  6987. <refmeta>
  6988. <refentrytitle>chunk.separate.lots</refentrytitle>
  6989. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  6990. </refmeta>
  6991. <refnamediv>
  6992. <refname>chunk.separate.lots</refname>
  6993. <refpurpose>Should each LoT be in its own separate chunk?</refpurpose>
  6994. </refnamediv>
  6995. <refsynopsisdiv>
  6996. <programlisting xml:id="chunk.separate.lots.frag">
  6997. &lt;xsl:param name="chunk.separate.lots" select="0"&gt;&lt;/xsl:param&gt;
  6998. </programlisting>
  6999. </refsynopsisdiv>
  7000. <refsection><info><title>Description</title></info>
  7001. <para>If non-zero, each of the ToC and LoTs
  7002. (List of Examples, List of Figures, etc.)
  7003. will be put in its own separate chunk.
  7004. The title page includes generated links to each of the separate files.
  7005. </para>
  7006. <para>
  7007. This feature depends on the
  7008. <parameter>chunk.tocs.and.lots</parameter>
  7009. parameter also being non-zero.
  7010. </para>
  7011. </refsection>
  7012. </refentry>
  7013. <refentry version="5.0" xml:id="chunk.tocs.and.lots.has.title">
  7014. <refmeta>
  7015. <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle>
  7016. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7017. </refmeta>
  7018. <refnamediv>
  7019. <refname>chunk.tocs.and.lots.has.title</refname>
  7020. <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose>
  7021. </refnamediv>
  7022. <refsynopsisdiv>
  7023. <programlisting xml:id="chunk.tocs.and.lots.has.title.frag">
  7024. &lt;xsl:param name="chunk.tocs.and.lots.has.title" select="1"&gt;&lt;/xsl:param&gt;
  7025. </programlisting>
  7026. </refsynopsisdiv>
  7027. <refsection><info><title>Description</title></info>
  7028. <para>If non-zero title of document is shown before ToC/LoT in
  7029. separate chunk.</para>
  7030. </refsection>
  7031. </refentry>
  7032. <refentry version="5.0" xml:id="chunk.section.depth">
  7033. <refmeta>
  7034. <refentrytitle>chunk.section.depth</refentrytitle>
  7035. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  7036. </refmeta>
  7037. <refnamediv>
  7038. <refname>chunk.section.depth</refname>
  7039. <refpurpose>Depth to which sections should be chunked</refpurpose>
  7040. </refnamediv>
  7041. <refsynopsisdiv>
  7042. <programlisting xml:id="chunk.section.depth.frag">
  7043. &lt;xsl:param name="chunk.section.depth" select="1"&gt;&lt;/xsl:param&gt;
  7044. </programlisting>
  7045. </refsynopsisdiv>
  7046. <refsection><info><title>Description</title></info>
  7047. <para>This parameter sets the depth of section chunking.</para>
  7048. </refsection>
  7049. </refentry>
  7050. <refentry version="5.0" xml:id="chunk.first.sections">
  7051. <refmeta>
  7052. <refentrytitle>chunk.first.sections</refentrytitle>
  7053. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7054. </refmeta>
  7055. <refnamediv>
  7056. <refname>chunk.first.sections</refname>
  7057. <refpurpose>Chunk the first top-level section?</refpurpose>
  7058. </refnamediv>
  7059. <refsynopsisdiv>
  7060. <programlisting xml:id="chunk.first.sections.frag">
  7061. &lt;xsl:param name="chunk.first.sections" select="0"&gt;&lt;/xsl:param&gt;
  7062. </programlisting>
  7063. </refsynopsisdiv>
  7064. <refsection><info><title>Description</title></info>
  7065. <para>If non-zero, a chunk will be created for the first top-level
  7066. <tag>sect1</tag> or <tag>section</tag> elements in
  7067. each component. Otherwise, that section will be part of the chunk for
  7068. its parent.
  7069. </para>
  7070. </refsection>
  7071. </refentry>
  7072. <refentry version="5.0" xml:id="chunk.quietly">
  7073. <refmeta>
  7074. <refentrytitle>chunk.quietly</refentrytitle>
  7075. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7076. </refmeta>
  7077. <refnamediv>
  7078. <refname>chunk.quietly</refname>
  7079. <refpurpose>Omit the chunked filename messages.</refpurpose>
  7080. </refnamediv>
  7081. <refsynopsisdiv>
  7082. <programlisting xml:id="chunk.quietly.frag">
  7083. &lt;xsl:param name="chunk.quietly" select="0"&gt;&lt;/xsl:param&gt;
  7084. </programlisting>
  7085. </refsynopsisdiv>
  7086. <refsection><info><title>Description</title></info>
  7087. <para>If zero (the default), the XSL processor emits a message naming
  7088. each separate chunk filename as it is being output.
  7089. If nonzero, then the messages are suppressed.
  7090. </para>
  7091. </refsection>
  7092. </refentry>
  7093. <refentry version="5.0" xml:id="chunk.append">
  7094. <refmeta>
  7095. <refentrytitle>chunk.append</refentrytitle>
  7096. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7097. </refmeta>
  7098. <refnamediv>
  7099. <refname>chunk.append</refname>
  7100. <refpurpose>Specifies content to append to chunked HTML output</refpurpose>
  7101. </refnamediv>
  7102. <refsynopsisdiv>
  7103. <programlisting xml:id="chunk.append.frag">&lt;xsl:param name="chunk.append"&gt;&lt;/xsl:param&gt;</programlisting>
  7104. </refsynopsisdiv>
  7105. <refsection><info><title>Description</title></info>
  7106. <para>Specifies content to append to the end of HTML files output by
  7107. the <filename>html/chunk.xsl</filename> stylesheet, after the closing
  7108. <code>&lt;html&gt;</code> tag. You probably don&#8217;t want to set any value
  7109. for this parameter; but if you do, the only value it should ever be
  7110. set to is a newline character: <code>&amp;#x0a;</code> or
  7111. <code>&amp;#10;</code></para>
  7112. </refsection>
  7113. </refentry>
  7114. <refentry version="5.0" xml:id="navig.graphics">
  7115. <refmeta>
  7116. <refentrytitle>navig.graphics</refentrytitle>
  7117. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7118. </refmeta>
  7119. <refnamediv>
  7120. <refname>navig.graphics</refname>
  7121. <refpurpose>Use graphics in navigational headers and footers?</refpurpose>
  7122. </refnamediv>
  7123. <refsynopsisdiv>
  7124. <programlisting xml:id="navig.graphics.frag">
  7125. &lt;xsl:param name="navig.graphics" select="0"&gt;&lt;/xsl:param&gt;
  7126. </programlisting>
  7127. </refsynopsisdiv>
  7128. <refsection><info><title>Description</title></info>
  7129. <para>If non-zero, the navigational headers and footers in chunked
  7130. HTML are presented in an alternate style that uses graphical icons for
  7131. Next, Previous, Up, and Home. Default graphics are provided in the
  7132. distribution. If zero, text is used instead of graphics.
  7133. </para>
  7134. </refsection>
  7135. </refentry>
  7136. <refentry version="5.0" xml:id="navig.graphics.extension">
  7137. <refmeta>
  7138. <refentrytitle>navig.graphics.extension</refentrytitle>
  7139. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7140. </refmeta>
  7141. <refnamediv>
  7142. <refname>navig.graphics.extension</refname>
  7143. <refpurpose>Extension for navigational graphics</refpurpose>
  7144. </refnamediv>
  7145. <refsynopsisdiv>
  7146. <programlisting xml:id="navig.graphics.extension.frag">
  7147. &lt;xsl:param name="navig.graphics.extension"&gt;.gif&lt;/xsl:param&gt;
  7148. </programlisting>
  7149. </refsynopsisdiv>
  7150. <refsection><info><title>Description</title></info>
  7151. <para>Sets the filename extension to use on navigational graphics used
  7152. in the headers and footers of chunked HTML.</para>
  7153. </refsection>
  7154. </refentry>
  7155. <refentry version="5.0" xml:id="navig.graphics.path">
  7156. <refmeta>
  7157. <refentrytitle>navig.graphics.path</refentrytitle>
  7158. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7159. </refmeta>
  7160. <refnamediv>
  7161. <refname>navig.graphics.path</refname>
  7162. <refpurpose>Path to navigational graphics</refpurpose>
  7163. </refnamediv>
  7164. <refsynopsisdiv>
  7165. <programlisting xml:id="navig.graphics.path.frag">
  7166. &lt;xsl:param name="navig.graphics.path"&gt;images/&lt;/xsl:param&gt;
  7167. </programlisting>
  7168. </refsynopsisdiv>
  7169. <refsection><info><title>Description</title></info>
  7170. <para>Sets the path, probably relative to the directory where the HTML
  7171. files are created, to the navigational graphics used in the
  7172. headers and footers of chunked HTML.
  7173. </para>
  7174. </refsection>
  7175. </refentry>
  7176. <refentry version="5.0" xml:id="navig.showtitles">
  7177. <refmeta>
  7178. <refentrytitle>navig.showtitles</refentrytitle>
  7179. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7180. </refmeta>
  7181. <refnamediv>
  7182. <refname>navig.showtitles</refname>
  7183. <refpurpose>Display titles in HTML headers and footers?</refpurpose>
  7184. </refnamediv>
  7185. <refsynopsisdiv>
  7186. <programlisting xml:id="navig.showtitles.frag">&lt;xsl:param name="navig.showtitles"&gt;1&lt;/xsl:param&gt;</programlisting>
  7187. </refsynopsisdiv>
  7188. <refsection><info><title>Description</title></info>
  7189. <para>If non-zero,
  7190. the headers and footers of chunked HTML
  7191. display the titles of the next and previous chunks,
  7192. along with the words 'Next' and 'Previous' (or the
  7193. equivalent graphical icons if navig.graphics is true).
  7194. If false (zero), then only the words 'Next' and 'Previous'
  7195. (or the icons) are displayed.
  7196. </para>
  7197. </refsection>
  7198. </refentry>
  7199. </reference>
  7200. <reference xml:id="profiling"><title>Profiling</title>
  7201. <partintro xml:id="partintro">
  7202. <para>The following parameters can be used for attribute-based
  7203. profiling of your document. For more information about profiling, see
  7204. <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profiling.html">Profiling (conditional text)</link>.</para>
  7205. </partintro>
  7206. <refentry version="5.0" xml:id="profile.arch">
  7207. <refmeta>
  7208. <refentrytitle>profile.arch</refentrytitle>
  7209. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7210. </refmeta>
  7211. <refnamediv>
  7212. <refname>profile.arch</refname>
  7213. <refpurpose>Target profile for <tag class="attribute">arch</tag>
  7214. attribute</refpurpose>
  7215. </refnamediv>
  7216. <refsynopsisdiv>
  7217. <programlisting xml:id="profile.arch.frag">
  7218. &lt;xsl:param name="profile.arch"&gt;&lt;/xsl:param&gt;
  7219. </programlisting>
  7220. </refsynopsisdiv>
  7221. <refsection><info><title>Description</title></info>
  7222. <para>The value of this parameter specifies profiles which should be
  7223. included in the output. You can specify multiple profiles by
  7224. separating them by semicolon. You can change separator character by
  7225. <parameter>profile.separator</parameter>
  7226. parameter.</para>
  7227. <para>This parameter has effect only when you are using profiling
  7228. stylesheets (<filename>profile-docbook.xsl</filename>,
  7229. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7230. ones (<filename>docbook.xsl</filename>,
  7231. <filename>chunk.xsl</filename>, &#8230;).</para>
  7232. </refsection>
  7233. </refentry>
  7234. <refentry version="5.0" xml:id="profile.audience">
  7235. <refmeta>
  7236. <refentrytitle>profile.audience</refentrytitle>
  7237. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7238. </refmeta>
  7239. <refnamediv>
  7240. <refname>profile.audience</refname>
  7241. <refpurpose>Target profile for <tag class="attribute">audience</tag>
  7242. attribute</refpurpose>
  7243. </refnamediv>
  7244. <refsynopsisdiv>
  7245. <programlisting xml:id="profile.audience.frag">
  7246. &lt;xsl:param name="profile.audience"&gt;&lt;/xsl:param&gt;
  7247. </programlisting>
  7248. </refsynopsisdiv>
  7249. <refsection><info><title>Description</title></info>
  7250. <para>Value of this parameter specifies profiles which should be
  7251. included in the output. You can specify multiple profiles by
  7252. separating them by semicolon. You can change separator character by
  7253. <parameter>profile.separator</parameter>
  7254. parameter.</para>
  7255. <para>This parameter has effect only when you are using profiling
  7256. stylesheets (<filename>profile-docbook.xsl</filename>,
  7257. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7258. ones (<filename>docbook.xsl</filename>,
  7259. <filename>chunk.xsl</filename>, &#8230;).</para>
  7260. </refsection>
  7261. </refentry>
  7262. <refentry version="5.0" xml:id="profile.condition">
  7263. <refmeta>
  7264. <refentrytitle>profile.condition</refentrytitle>
  7265. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7266. </refmeta>
  7267. <refnamediv>
  7268. <refname>profile.condition</refname>
  7269. <refpurpose>Target profile for <tag class="attribute">condition</tag>
  7270. attribute</refpurpose>
  7271. </refnamediv>
  7272. <refsynopsisdiv>
  7273. <programlisting xml:id="profile.condition.frag">
  7274. &lt;xsl:param name="profile.condition"&gt;&lt;/xsl:param&gt;
  7275. </programlisting>
  7276. </refsynopsisdiv>
  7277. <refsection><info><title>Description</title></info>
  7278. <para>The value of this parameter specifies profiles which should be
  7279. included in the output. You can specify multiple profiles by
  7280. separating them by semicolon. You can change separator character by
  7281. <parameter>profile.separator</parameter>
  7282. parameter.</para>
  7283. <para>This parameter has effect only when you are using profiling
  7284. stylesheets (<filename>profile-docbook.xsl</filename>,
  7285. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7286. ones (<filename>docbook.xsl</filename>,
  7287. <filename>chunk.xsl</filename>, &#8230;).</para>
  7288. </refsection>
  7289. </refentry>
  7290. <refentry version="5.0" xml:id="profile.conformance">
  7291. <refmeta>
  7292. <refentrytitle>profile.conformance</refentrytitle>
  7293. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7294. </refmeta>
  7295. <refnamediv>
  7296. <refname>profile.conformance</refname>
  7297. <refpurpose>Target profile for <tag class="attribute">conformance</tag>
  7298. attribute</refpurpose>
  7299. </refnamediv>
  7300. <refsynopsisdiv>
  7301. <programlisting xml:id="profile.conformance.frag">
  7302. &lt;xsl:param name="profile.conformance"&gt;&lt;/xsl:param&gt;
  7303. </programlisting>
  7304. </refsynopsisdiv>
  7305. <refsection><info><title>Description</title></info>
  7306. <para>The value of this parameter specifies profiles which should be
  7307. included in the output. You can specify multiple profiles by
  7308. separating them by semicolon. You can change separator character by
  7309. <parameter>profile.separator</parameter>
  7310. parameter.</para>
  7311. <para>This parameter has effect only when you are using profiling
  7312. stylesheets (<filename>profile-docbook.xsl</filename>,
  7313. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7314. ones (<filename>docbook.xsl</filename>,
  7315. <filename>chunk.xsl</filename>, &#8230;).</para>
  7316. </refsection>
  7317. </refentry>
  7318. <refentry version="5.0" xml:id="profile.lang">
  7319. <refmeta>
  7320. <refentrytitle>profile.lang</refentrytitle>
  7321. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7322. </refmeta>
  7323. <refnamediv>
  7324. <refname>profile.lang</refname>
  7325. <refpurpose>Target profile for <tag class="attribute">lang</tag>
  7326. attribute</refpurpose>
  7327. </refnamediv>
  7328. <refsynopsisdiv>
  7329. <programlisting xml:id="profile.lang.frag">
  7330. &lt;xsl:param name="profile.lang"&gt;&lt;/xsl:param&gt;
  7331. </programlisting>
  7332. </refsynopsisdiv>
  7333. <refsection><info><title>Description</title></info>
  7334. <para>The value of this parameter specifies profiles which should be
  7335. included in the output. You can specify multiple profiles by
  7336. separating them by semicolon. You can change separator character by
  7337. <parameter>profile.separator</parameter>
  7338. parameter.</para>
  7339. <para>This parameter has effect only when you are using profiling
  7340. stylesheets (<filename>profile-docbook.xsl</filename>,
  7341. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7342. ones (<filename>docbook.xsl</filename>,
  7343. <filename>chunk.xsl</filename>, &#8230;).</para>
  7344. </refsection>
  7345. </refentry>
  7346. <refentry version="5.0" xml:id="profile.os">
  7347. <refmeta>
  7348. <refentrytitle>profile.os</refentrytitle>
  7349. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7350. </refmeta>
  7351. <refnamediv>
  7352. <refname>profile.os</refname>
  7353. <refpurpose>Target profile for <tag class="attribute">os</tag>
  7354. attribute</refpurpose>
  7355. </refnamediv>
  7356. <refsynopsisdiv>
  7357. <programlisting xml:id="profile.os.frag">
  7358. &lt;xsl:param name="profile.os"&gt;&lt;/xsl:param&gt;
  7359. </programlisting>
  7360. </refsynopsisdiv>
  7361. <refsection><info><title>Description</title></info>
  7362. <para>The value of this parameter specifies profiles which should be
  7363. included in the output. You can specify multiple profiles by
  7364. separating them by semicolon. You can change separator character by
  7365. <parameter>profile.separator</parameter>
  7366. parameter.</para>
  7367. <para>This parameter has effect only when you are using profiling
  7368. stylesheets (<filename>profile-docbook.xsl</filename>,
  7369. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7370. ones (<filename>docbook.xsl</filename>,
  7371. <filename>chunk.xsl</filename>, &#8230;).</para>
  7372. </refsection>
  7373. </refentry>
  7374. <refentry version="5.0" xml:id="profile.revision">
  7375. <refmeta>
  7376. <refentrytitle>profile.revision</refentrytitle>
  7377. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7378. </refmeta>
  7379. <refnamediv>
  7380. <refname>profile.revision</refname>
  7381. <refpurpose>Target profile for <tag class="attribute">revision</tag>
  7382. attribute</refpurpose>
  7383. </refnamediv>
  7384. <refsynopsisdiv>
  7385. <programlisting xml:id="profile.revision.frag">
  7386. &lt;xsl:param name="profile.revision"&gt;&lt;/xsl:param&gt;
  7387. </programlisting>
  7388. </refsynopsisdiv>
  7389. <refsection><info><title>Description</title></info>
  7390. <para>The value of this parameter specifies profiles which should be
  7391. included in the output. You can specify multiple profiles by
  7392. separating them by semicolon. You can change separator character by
  7393. <parameter>profile.separator</parameter>
  7394. parameter.</para>
  7395. <para>This parameter has effect only when you are using profiling
  7396. stylesheets (<filename>profile-docbook.xsl</filename>,
  7397. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7398. ones (<filename>docbook.xsl</filename>,
  7399. <filename>chunk.xsl</filename>, &#8230;).</para>
  7400. </refsection>
  7401. </refentry>
  7402. <refentry version="5.0" xml:id="profile.revisionflag">
  7403. <refmeta>
  7404. <refentrytitle>profile.revisionflag</refentrytitle>
  7405. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7406. </refmeta>
  7407. <refnamediv>
  7408. <refname>profile.revisionflag</refname>
  7409. <refpurpose>Target profile for <tag class="attribute">revisionflag</tag>
  7410. attribute</refpurpose>
  7411. </refnamediv>
  7412. <refsynopsisdiv>
  7413. <programlisting xml:id="profile.revisionflag.frag">
  7414. &lt;xsl:param name="profile.revisionflag"&gt;&lt;/xsl:param&gt;
  7415. </programlisting>
  7416. </refsynopsisdiv>
  7417. <refsection><info><title>Description</title></info>
  7418. <para>The value of this parameter specifies profiles which should be
  7419. included in the output. You can specify multiple profiles by
  7420. separating them by semicolon. You can change separator character by
  7421. <parameter>profile.separator</parameter>
  7422. parameter.</para>
  7423. <para>This parameter has effect only when you are using profiling
  7424. stylesheets (<filename>profile-docbook.xsl</filename>,
  7425. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7426. ones (<filename>docbook.xsl</filename>,
  7427. <filename>chunk.xsl</filename>, &#8230;).</para>
  7428. </refsection>
  7429. </refentry>
  7430. <refentry version="5.0" xml:id="profile.role">
  7431. <refmeta>
  7432. <refentrytitle>profile.role</refentrytitle>
  7433. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7434. </refmeta>
  7435. <refnamediv>
  7436. <refname>profile.role</refname>
  7437. <refpurpose>Target profile for <tag class="attribute">role</tag>
  7438. attribute</refpurpose>
  7439. </refnamediv>
  7440. <refsynopsisdiv>
  7441. <programlisting xml:id="profile.role.frag">
  7442. &lt;xsl:param name="profile.role"&gt;&lt;/xsl:param&gt;
  7443. </programlisting>
  7444. </refsynopsisdiv>
  7445. <refsection><info><title>Description</title></info>
  7446. <para>The value of this parameter specifies profiles which should be
  7447. included in the output. You can specify multiple profiles by
  7448. separating them by semicolon. You can change separator character by
  7449. <parameter>profile.separator</parameter>
  7450. parameter.</para>
  7451. <para>This parameter has effect only when you are using profiling
  7452. stylesheets (<filename>profile-docbook.xsl</filename>,
  7453. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7454. ones (<filename>docbook.xsl</filename>,
  7455. <filename>chunk.xsl</filename>, &#8230;).</para>
  7456. <warning>
  7457. <para>Note that <tag class="attribute">role</tag> is often
  7458. used for other purposes than profiling. For example it is commonly
  7459. used to get emphasize in bold font:</para>
  7460. <programlisting>&lt;emphasis role="bold"&gt;very important&lt;/emphasis&gt;</programlisting>
  7461. <para>If you are using <tag class="attribute">role</tag> for
  7462. these purposes do not forget to add values like <literal>bold</literal> to
  7463. value of this parameter. If you forgot you will get document with
  7464. small pieces missing which are very hard to track.</para>
  7465. <para>For this reason it is not recommended to use <tag class="attribute">role</tag> attribute for profiling. You should
  7466. rather use profiling specific attributes like <tag class="attribute">userlevel</tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag class="attribute">condition</tag>, etc.</para>
  7467. </warning>
  7468. </refsection>
  7469. </refentry>
  7470. <refentry version="5.0" xml:id="profile.security">
  7471. <refmeta>
  7472. <refentrytitle>profile.security</refentrytitle>
  7473. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7474. </refmeta>
  7475. <refnamediv>
  7476. <refname>profile.security</refname>
  7477. <refpurpose>Target profile for <tag class="attribute">security</tag>
  7478. attribute</refpurpose>
  7479. </refnamediv>
  7480. <refsynopsisdiv>
  7481. <programlisting xml:id="profile.security.frag">
  7482. &lt;xsl:param name="profile.security"&gt;&lt;/xsl:param&gt;
  7483. </programlisting>
  7484. </refsynopsisdiv>
  7485. <refsection><info><title>Description</title></info>
  7486. <para>The value of this parameter specifies profiles which should be
  7487. included in the output. You can specify multiple profiles by
  7488. separating them by semicolon. You can change separator character by
  7489. <parameter>profile.separator</parameter>
  7490. parameter.</para>
  7491. <para>This parameter has effect only when you are using profiling
  7492. stylesheets (<filename>profile-docbook.xsl</filename>,
  7493. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7494. ones (<filename>docbook.xsl</filename>,
  7495. <filename>chunk.xsl</filename>, &#8230;).</para>
  7496. </refsection>
  7497. </refentry>
  7498. <refentry version="5.0" xml:id="profile.status">
  7499. <refmeta>
  7500. <refentrytitle>profile.status</refentrytitle>
  7501. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7502. </refmeta>
  7503. <refnamediv>
  7504. <refname>profile.status</refname>
  7505. <refpurpose>Target profile for <tag class="attribute">status</tag>
  7506. attribute</refpurpose>
  7507. </refnamediv>
  7508. <refsynopsisdiv>
  7509. <programlisting xml:id="profile.status.frag">
  7510. &lt;xsl:param name="profile.status"&gt;&lt;/xsl:param&gt;
  7511. </programlisting>
  7512. </refsynopsisdiv>
  7513. <refsection><info><title>Description</title></info>
  7514. <para>The value of this parameter specifies profiles which should be
  7515. included in the output. You can specify multiple profiles by
  7516. separating them by semicolon. You can change separator character by
  7517. <parameter>profile.separator</parameter>
  7518. parameter.</para>
  7519. <para>This parameter has effect only when you are using profiling
  7520. stylesheets (<filename>profile-docbook.xsl</filename>,
  7521. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7522. ones (<filename>docbook.xsl</filename>,
  7523. <filename>chunk.xsl</filename>, &#8230;).</para>
  7524. </refsection>
  7525. </refentry>
  7526. <refentry version="5.0" xml:id="profile.userlevel">
  7527. <refmeta>
  7528. <refentrytitle>profile.userlevel</refentrytitle>
  7529. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7530. </refmeta>
  7531. <refnamediv>
  7532. <refname>profile.userlevel</refname>
  7533. <refpurpose>Target profile for <tag class="attribute">userlevel</tag>
  7534. attribute</refpurpose>
  7535. </refnamediv>
  7536. <refsynopsisdiv>
  7537. <programlisting xml:id="profile.userlevel.frag">
  7538. &lt;xsl:param name="profile.userlevel"&gt;&lt;/xsl:param&gt;
  7539. </programlisting>
  7540. </refsynopsisdiv>
  7541. <refsection><info><title>Description</title></info>
  7542. <para>The value of this parameter specifies profiles which should be
  7543. included in the output. You can specify multiple profiles by
  7544. separating them by semicolon. You can change separator character by
  7545. <parameter>profile.separator</parameter>
  7546. parameter.</para>
  7547. <para>This parameter has effect only when you are using profiling
  7548. stylesheets (<filename>profile-docbook.xsl</filename>,
  7549. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7550. ones (<filename>docbook.xsl</filename>,
  7551. <filename>chunk.xsl</filename>, &#8230;).</para>
  7552. </refsection>
  7553. </refentry>
  7554. <refentry version="5.0" xml:id="profile.vendor">
  7555. <refmeta>
  7556. <refentrytitle>profile.vendor</refentrytitle>
  7557. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7558. </refmeta>
  7559. <refnamediv>
  7560. <refname>profile.vendor</refname>
  7561. <refpurpose>Target profile for <tag class="attribute">vendor</tag>
  7562. attribute</refpurpose>
  7563. </refnamediv>
  7564. <refsynopsisdiv>
  7565. <programlisting xml:id="profile.vendor.frag">
  7566. &lt;xsl:param name="profile.vendor"&gt;&lt;/xsl:param&gt;
  7567. </programlisting>
  7568. </refsynopsisdiv>
  7569. <refsection><info><title>Description</title></info>
  7570. <para>The value of this parameter specifies profiles which should be
  7571. included in the output. You can specify multiple profiles by
  7572. separating them by semicolon. You can change separator character by
  7573. <parameter>profile.separator</parameter>
  7574. parameter.</para>
  7575. <para>This parameter has effect only when you are using profiling
  7576. stylesheets (<filename>profile-docbook.xsl</filename>,
  7577. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7578. ones (<filename>docbook.xsl</filename>,
  7579. <filename>chunk.xsl</filename>, &#8230;).</para>
  7580. </refsection>
  7581. </refentry>
  7582. <refentry version="5.0" xml:id="profile.wordsize">
  7583. <refmeta>
  7584. <refentrytitle>profile.wordsize</refentrytitle>
  7585. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7586. </refmeta>
  7587. <refnamediv>
  7588. <refname>profile.wordsize</refname>
  7589. <refpurpose>Target profile for <tag class="attribute">wordsize</tag>
  7590. attribute</refpurpose>
  7591. </refnamediv>
  7592. <refsynopsisdiv>
  7593. <programlisting xml:id="profile.wordsize.frag">
  7594. &lt;xsl:param name="profile.wordsize"&gt;&lt;/xsl:param&gt;
  7595. </programlisting>
  7596. </refsynopsisdiv>
  7597. <refsection><info><title>Description</title></info>
  7598. <para>The value of this parameter specifies profiles which should be
  7599. included in the output. You can specify multiple profiles by
  7600. separating them by semicolon. You can change separator character by
  7601. <parameter>profile.separator</parameter>
  7602. parameter.</para>
  7603. <para>This parameter has effect only when you are using profiling
  7604. stylesheets (<filename>profile-docbook.xsl</filename>,
  7605. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7606. ones (<filename>docbook.xsl</filename>,
  7607. <filename>chunk.xsl</filename>, &#8230;).</para>
  7608. </refsection>
  7609. </refentry>
  7610. <refentry version="5.0" xml:id="profile.attribute">
  7611. <refmeta>
  7612. <refentrytitle>profile.attribute</refentrytitle>
  7613. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7614. </refmeta>
  7615. <refnamediv>
  7616. <refname>profile.attribute</refname>
  7617. <refpurpose>Name of user-specified profiling attribute</refpurpose>
  7618. </refnamediv>
  7619. <refsynopsisdiv>
  7620. <programlisting xml:id="profile.attribute.frag">
  7621. &lt;xsl:param name="profile.attribute"&gt;&lt;/xsl:param&gt;
  7622. </programlisting>
  7623. </refsynopsisdiv>
  7624. <refsection><info><title>Description</title></info>
  7625. <para>This parameter is used in conjuction with
  7626. <parameter>profile.value</parameter>.</para>
  7627. <para>This parameter has effect only when you are using profiling
  7628. stylesheets (<filename>profile-docbook.xsl</filename>,
  7629. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7630. ones (<filename>docbook.xsl</filename>,
  7631. <filename>chunk.xsl</filename>, &#8230;).</para>
  7632. </refsection>
  7633. </refentry>
  7634. <refentry version="5.0" xml:id="profile.value">
  7635. <refmeta>
  7636. <refentrytitle>profile.value</refentrytitle>
  7637. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7638. </refmeta>
  7639. <refnamediv>
  7640. <refname>profile.value</refname>
  7641. <refpurpose>Target profile for user-specified attribute</refpurpose>
  7642. </refnamediv>
  7643. <refsynopsisdiv>
  7644. <programlisting xml:id="profile.value.frag">
  7645. &lt;xsl:param name="profile.value"&gt;&lt;/xsl:param&gt;
  7646. </programlisting>
  7647. </refsynopsisdiv>
  7648. <refsection><info><title>Description</title></info>
  7649. <para>When you are using this parameter you must also specify name of
  7650. profiling attribute with parameter
  7651. <parameter>profile.attribute</parameter>.</para>
  7652. <para>The value of this parameter specifies profiles which should be
  7653. included in the output. You can specify multiple profiles by
  7654. separating them by semicolon. You can change separator character by
  7655. <parameter>profile.separator</parameter>
  7656. parameter.</para>
  7657. <para>This parameter has effect only when you are using profiling
  7658. stylesheets (<filename>profile-docbook.xsl</filename>,
  7659. <filename>profile-chunk.xsl</filename>, &#8230;) instead of normal
  7660. ones (<filename>docbook.xsl</filename>,
  7661. <filename>chunk.xsl</filename>, &#8230;).</para>
  7662. </refsection>
  7663. </refentry>
  7664. <refentry version="5.0" xml:id="profile.separator">
  7665. <refmeta>
  7666. <refentrytitle>profile.separator</refentrytitle>
  7667. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7668. </refmeta>
  7669. <refnamediv>
  7670. <refname>profile.separator</refname>
  7671. <refpurpose>Separator character for compound profile values</refpurpose>
  7672. </refnamediv>
  7673. <refsynopsisdiv>
  7674. <programlisting xml:id="profile.separator.frag">
  7675. &lt;xsl:param name="profile.separator"&gt;;&lt;/xsl:param&gt;
  7676. </programlisting>
  7677. </refsynopsisdiv>
  7678. <refsection><info><title>Description</title></info>
  7679. <para>Separator character used for compound profile values. See <parameter>profile.arch</parameter></para>
  7680. </refsection>
  7681. </refentry>
  7682. </reference>
  7683. <reference xml:id="htmlhelp"><title>HTML Help</title>
  7684. <refentry version="5.0" xml:id="htmlhelp.encoding">
  7685. <refmeta>
  7686. <refentrytitle>htmlhelp.encoding</refentrytitle>
  7687. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7688. </refmeta>
  7689. <refnamediv>
  7690. <refname>htmlhelp.encoding</refname>
  7691. <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpose>
  7692. </refnamediv>
  7693. <refsynopsisdiv>
  7694. <programlisting xml:id="htmlhelp.encoding.frag">
  7695. &lt;xsl:param name="htmlhelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
  7696. </programlisting>
  7697. </refsynopsisdiv>
  7698. <refsection><info><title>Description</title></info>
  7699. <para>The HTML Help Compiler is not UTF-8 aware, so you should always use an
  7700. appropriate single-byte encoding here. See also <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="HtmlHelp.html#HelpProcOptions" role="tcg">Processing options</link>.</para>
  7701. </refsection>
  7702. </refentry>
  7703. <refentry version="5.0" xml:id="htmlhelp.autolabel">
  7704. <refmeta>
  7705. <refentrytitle>htmlhelp.autolabel</refentrytitle>
  7706. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7707. </refmeta>
  7708. <refnamediv>
  7709. <refname>htmlhelp.autolabel</refname>
  7710. <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
  7711. </refnamediv>
  7712. <refsynopsisdiv>
  7713. <programlisting xml:id="htmlhelp.autolabel.frag">
  7714. &lt;xsl:param name="htmlhelp.autolabel" select="0"&gt;&lt;/xsl:param&gt;
  7715. </programlisting>
  7716. </refsynopsisdiv>
  7717. <refsection><info><title>Description</title></info>
  7718. <para>Set this to non-zero to include chapter and section numbers into ToC
  7719. in the left panel.</para>
  7720. </refsection>
  7721. </refentry>
  7722. <refentry version="5.0" xml:id="htmlhelp.chm">
  7723. <refmeta>
  7724. <refentrytitle>htmlhelp.chm</refentrytitle>
  7725. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7726. </refmeta>
  7727. <refnamediv>
  7728. <refname>htmlhelp.chm</refname>
  7729. <refpurpose>Filename of output HTML Help file.</refpurpose>
  7730. </refnamediv>
  7731. <refsynopsisdiv>
  7732. <programlisting xml:id="htmlhelp.chm.frag">
  7733. &lt;xsl:param name="htmlhelp.chm"&gt;htmlhelp.chm&lt;/xsl:param&gt;
  7734. </programlisting>
  7735. </refsynopsisdiv>
  7736. <refsection><info><title>Description</title></info>
  7737. <para>Set the name of resulting CHM file</para>
  7738. </refsection>
  7739. </refentry>
  7740. <refentry version="5.0" xml:id="htmlhelp.default.topic">
  7741. <refmeta>
  7742. <refentrytitle>htmlhelp.default.topic</refentrytitle>
  7743. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7744. </refmeta>
  7745. <refnamediv>
  7746. <refname>htmlhelp.default.topic</refname>
  7747. <refpurpose>Name of file with default topic</refpurpose>
  7748. </refnamediv>
  7749. <refsynopsisdiv>
  7750. <programlisting xml:id="htmlhelp.default.topic.frag">
  7751. &lt;xsl:param name="htmlhelp.default.topic"&gt;&lt;/xsl:param&gt;
  7752. </programlisting>
  7753. </refsynopsisdiv>
  7754. <refsection><info><title>Description</title></info>
  7755. <para>Normally first chunk of document is displayed when you open HTML
  7756. Help file. If you want to display another topic, simply set its
  7757. filename by this parameter.</para>
  7758. <para>This is useful especially if you don't generate ToC in front of
  7759. your document and you also hide root element in ToC. E.g.:</para>
  7760. <programlisting>&lt;xsl:param name="generate.book.toc" select="0"/&gt;
  7761. &lt;xsl:param name="htmlhelp.hhc.show.root" select="0"/&gt;
  7762. &lt;xsl:param name="htmlhelp.default.topic"&gt;pr01.html&lt;/xsl:param&gt;
  7763. </programlisting>
  7764. </refsection>
  7765. </refentry>
  7766. <refentry version="5.0" xml:id="htmlhelp.display.progress">
  7767. <refmeta>
  7768. <refentrytitle>htmlhelp.display.progress</refentrytitle>
  7769. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7770. </refmeta>
  7771. <refnamediv>
  7772. <refname>htmlhelp.display.progress</refname>
  7773. <refpurpose>Display compile progress?</refpurpose>
  7774. </refnamediv>
  7775. <refsynopsisdiv>
  7776. <programlisting xml:id="htmlhelp.display.progress.frag">
  7777. &lt;xsl:param name="htmlhelp.display.progress" select="1"&gt;&lt;/xsl:param&gt;
  7778. </programlisting>
  7779. </refsynopsisdiv>
  7780. <refsection><info><title>Description</title></info>
  7781. <para>Set to non-zero to to display compile progress
  7782. </para>
  7783. </refsection>
  7784. </refentry>
  7785. <refentry version="5.0" xml:id="htmlhelp.hhp">
  7786. <refmeta>
  7787. <refentrytitle>htmlhelp.hhp</refentrytitle>
  7788. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7789. </refmeta>
  7790. <refnamediv>
  7791. <refname>htmlhelp.hhp</refname>
  7792. <refpurpose>Filename of project file.</refpurpose>
  7793. </refnamediv>
  7794. <refsynopsisdiv>
  7795. <programlisting xml:id="htmlhelp.hhp.frag">
  7796. &lt;xsl:param name="htmlhelp.hhp"&gt;htmlhelp.hhp&lt;/xsl:param&gt;
  7797. </programlisting>
  7798. </refsynopsisdiv>
  7799. <refsection><info><title>Description</title></info>
  7800. <para>Change this parameter if you want different name of project
  7801. file than htmlhelp.hhp.</para>
  7802. </refsection>
  7803. </refentry>
  7804. <refentry version="5.0" xml:id="htmlhelp.hhc">
  7805. <refmeta>
  7806. <refentrytitle>htmlhelp.hhc</refentrytitle>
  7807. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7808. </refmeta>
  7809. <refnamediv>
  7810. <refname>htmlhelp.hhc</refname>
  7811. <refpurpose>Filename of TOC file.</refpurpose>
  7812. </refnamediv>
  7813. <refsynopsisdiv>
  7814. <programlisting xml:id="htmlhelp.hhc.frag">
  7815. &lt;xsl:param name="htmlhelp.hhc"&gt;toc.hhc&lt;/xsl:param&gt;
  7816. </programlisting>
  7817. </refsynopsisdiv>
  7818. <refsection><info><title>Description</title></info>
  7819. <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.</para>
  7820. </refsection>
  7821. </refentry>
  7822. <refentry version="5.0" xml:id="htmlhelp.hhk">
  7823. <refmeta>
  7824. <refentrytitle>htmlhelp.hhk</refentrytitle>
  7825. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7826. </refmeta>
  7827. <refnamediv>
  7828. <refname>htmlhelp.hhk</refname>
  7829. <refpurpose>Filename of index file.</refpurpose>
  7830. </refnamediv>
  7831. <refsynopsisdiv>
  7832. <programlisting xml:id="htmlhelp.hhk.frag">
  7833. &lt;xsl:param name="htmlhelp.hhk"&gt;index.hhk&lt;/xsl:param&gt;
  7834. </programlisting>
  7835. </refsynopsisdiv>
  7836. <refsection><info><title>Description</title></info>
  7837. <para>set the name of the index file. The default is <filename>index.hhk</filename>.</para>
  7838. </refsection>
  7839. </refentry>
  7840. <refentry version="5.0" xml:id="htmlhelp.hhp.tail">
  7841. <refmeta>
  7842. <refentrytitle>htmlhelp.hhp.tail</refentrytitle>
  7843. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7844. </refmeta>
  7845. <refnamediv>
  7846. <refname>htmlhelp.hhp.tail</refname>
  7847. <refpurpose>Additional content for project file.</refpurpose>
  7848. </refnamediv>
  7849. <refsynopsisdiv>
  7850. <programlisting xml:id="htmlhelp.hhp.tail.frag">
  7851. &lt;xsl:param name="htmlhelp.hhp.tail"&gt;&lt;/xsl:param&gt;
  7852. </programlisting>
  7853. </refsynopsisdiv>
  7854. <refsection><info><title>Description</title></info>
  7855. <para>If you want to include some additional parameters into project file,
  7856. store appropriate part of project file into this parameter.</para>
  7857. </refsection>
  7858. </refentry>
  7859. <refentry version="5.0" xml:id="htmlhelp.hhp.window">
  7860. <refmeta>
  7861. <refentrytitle>htmlhelp.hhp.window</refentrytitle>
  7862. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7863. </refmeta>
  7864. <refnamediv>
  7865. <refname>htmlhelp.hhp.window</refname>
  7866. <refpurpose>Name of default window.</refpurpose>
  7867. </refnamediv>
  7868. <refsynopsisdiv>
  7869. <programlisting xml:id="htmlhelp.hhp.window.frag">
  7870. &lt;xsl:param name="htmlhelp.hhp.window"&gt;Main&lt;/xsl:param&gt;
  7871. </programlisting>
  7872. </refsynopsisdiv>
  7873. <refsection><info><title>Description</title></info>
  7874. <para>Name of default window. If empty no [WINDOWS] section will be
  7875. added to project file.</para>
  7876. </refsection>
  7877. </refentry>
  7878. <refentry version="5.0" xml:id="htmlhelp.hhp.windows">
  7879. <refmeta>
  7880. <refentrytitle>htmlhelp.hhp.windows</refentrytitle>
  7881. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7882. </refmeta>
  7883. <refnamediv>
  7884. <refname>htmlhelp.hhp.windows</refname>
  7885. <refpurpose>Definition of additional windows</refpurpose>
  7886. </refnamediv>
  7887. <refsynopsisdiv>
  7888. <programlisting xml:id="htmlhelp.hhp.windows.frag">
  7889. &lt;xsl:param name="htmlhelp.hhp.windows"&gt;&lt;/xsl:param&gt;
  7890. </programlisting>
  7891. </refsynopsisdiv>
  7892. <refsection><info><title>Description</title></info>
  7893. <para>Content of this parameter is placed at the end of [WINDOWS]
  7894. section of project file. You can use it for defining your own
  7895. addtional windows.</para>
  7896. </refsection>
  7897. </refentry>
  7898. <refentry version="5.0" xml:id="htmlhelp.enhanced.decompilation">
  7899. <refmeta>
  7900. <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle>
  7901. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7902. </refmeta>
  7903. <refnamediv>
  7904. <refname>htmlhelp.enhanced.decompilation</refname>
  7905. <refpurpose>Allow enhanced decompilation of CHM?</refpurpose>
  7906. </refnamediv>
  7907. <refsynopsisdiv>
  7908. <programlisting xml:id="htmlhelp.enhanced.decompilation.frag">
  7909. &lt;xsl:param name="htmlhelp.enhanced.decompilation" select="0"&gt;&lt;/xsl:param&gt;
  7910. </programlisting>
  7911. </refsynopsisdiv>
  7912. <refsection><info><title>Description</title></info>
  7913. <para>When non-zero this parameter enables enhanced decompilation of CHM.</para>
  7914. </refsection>
  7915. </refentry>
  7916. <refentry version="5.0" xml:id="htmlhelp.enumerate.images">
  7917. <refmeta>
  7918. <refentrytitle>htmlhelp.enumerate.images</refentrytitle>
  7919. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7920. </refmeta>
  7921. <refnamediv>
  7922. <refname>htmlhelp.enumerate.images</refname>
  7923. <refpurpose>Should the paths to all used images be added to the project file?</refpurpose>
  7924. </refnamediv>
  7925. <refsynopsisdiv>
  7926. <programlisting xml:id="htmlhelp.enumerate.images.frag">
  7927. &lt;xsl:param name="htmlhelp.enumerate.images" select="0"&gt;&lt;/xsl:param&gt;
  7928. </programlisting>
  7929. </refsynopsisdiv>
  7930. <refsection><info><title>Description</title></info>
  7931. <para>Set to non-zero if you insert images into your documents as
  7932. external binary entities or if you are using absolute image paths.</para>
  7933. </refsection>
  7934. </refentry>
  7935. <refentry version="5.0" xml:id="htmlhelp.force.map.and.alias">
  7936. <refmeta>
  7937. <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle>
  7938. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  7939. </refmeta>
  7940. <refnamediv>
  7941. <refname>htmlhelp.force.map.and.alias</refname>
  7942. <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file unconditionally?</refpurpose>
  7943. </refnamediv>
  7944. <refsynopsisdiv>
  7945. <programlisting xml:id="htmlhelp.force.map.and.alias.frag">
  7946. &lt;xsl:param name="htmlhelp.force.map.and.alias" select="0"&gt;&lt;/xsl:param&gt;
  7947. </programlisting>
  7948. </refsynopsisdiv>
  7949. <refsection><info><title>Description</title></info>
  7950. <para>Set to non-zero if you have your own
  7951. <literal>alias.h</literal> and <literal>context.h</literal>
  7952. files and you want to include references to them in the project
  7953. file.</para>
  7954. </refsection>
  7955. </refentry>
  7956. <refentry version="5.0" xml:id="htmlhelp.map.file">
  7957. <refmeta>
  7958. <refentrytitle>htmlhelp.map.file</refentrytitle>
  7959. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7960. </refmeta>
  7961. <refnamediv>
  7962. <refname>htmlhelp.map.file</refname>
  7963. <refpurpose>Filename of map file.</refpurpose>
  7964. </refnamediv>
  7965. <refsynopsisdiv>
  7966. <programlisting xml:id="htmlhelp.map.file.frag">
  7967. &lt;xsl:param name="htmlhelp.map.file"&gt;context.h&lt;/xsl:param&gt;
  7968. </programlisting>
  7969. </refsynopsisdiv>
  7970. <refsection><info><title>Description</title></info>
  7971. <para>Set the name of map file. The default is
  7972. <filename>context.h</filename>. (used for context-sensitive
  7973. help).</para>
  7974. </refsection>
  7975. </refentry>
  7976. <refentry version="5.0" xml:id="htmlhelp.alias.file">
  7977. <refmeta>
  7978. <refentrytitle>htmlhelp.alias.file</refentrytitle>
  7979. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  7980. </refmeta>
  7981. <refnamediv>
  7982. <refname>htmlhelp.alias.file</refname>
  7983. <refpurpose>Filename of alias file.</refpurpose>
  7984. </refnamediv>
  7985. <refsynopsisdiv>
  7986. <programlisting xml:id="htmlhelp.alias.file.frag">
  7987. &lt;xsl:param name="htmlhelp.alias.file"&gt;alias.h&lt;/xsl:param&gt;
  7988. </programlisting>
  7989. </refsynopsisdiv>
  7990. <refsection><info><title>Description</title></info>
  7991. <para>Specifies the filename of the alias file (used for context-sensitive help).</para>
  7992. </refsection>
  7993. </refentry>
  7994. <refentry version="5.0" xml:id="htmlhelp.hhc.section.depth">
  7995. <refmeta>
  7996. <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle>
  7997. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  7998. </refmeta>
  7999. <refnamediv>
  8000. <refname>htmlhelp.hhc.section.depth</refname>
  8001. <refpurpose>Depth of TOC for sections in a left pane.</refpurpose>
  8002. </refnamediv>
  8003. <refsynopsisdiv>
  8004. <programlisting xml:id="htmlhelp.hhc.section.depth.frag">
  8005. &lt;xsl:param name="htmlhelp.hhc.section.depth"&gt;5&lt;/xsl:param&gt;
  8006. </programlisting>
  8007. </refsynopsisdiv>
  8008. <refsection><info><title>Description</title></info>
  8009. <para>Set the section depth in the left pane of HTML Help viewer. </para>
  8010. </refsection>
  8011. </refentry>
  8012. <refentry version="5.0" xml:id="htmlhelp.hhc.show.root">
  8013. <refmeta>
  8014. <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
  8015. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8016. </refmeta>
  8017. <refnamediv>
  8018. <refname>htmlhelp.hhc.show.root</refname>
  8019. <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
  8020. </refnamediv>
  8021. <refsynopsisdiv>
  8022. <programlisting xml:id="htmlhelp.hhc.show.root.frag">
  8023. &lt;xsl:param name="htmlhelp.hhc.show.root" select="1"&gt;&lt;/xsl:param&gt;
  8024. </programlisting>
  8025. </refsynopsisdiv>
  8026. <refsection><info><title>Description</title></info>
  8027. <para>If set to zero, there will be no entry for the root element in the
  8028. ToC. This is useful when you want to provide the user with an expanded
  8029. ToC as a default.</para>
  8030. </refsection>
  8031. </refentry>
  8032. <refentry version="5.0" xml:id="htmlhelp.hhc.folders.instead.books">
  8033. <refmeta>
  8034. <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle>
  8035. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8036. </refmeta>
  8037. <refnamediv>
  8038. <refname>htmlhelp.hhc.folders.instead.books</refname>
  8039. <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose>
  8040. </refnamediv>
  8041. <refsynopsisdiv>
  8042. <programlisting xml:id="htmlhelp.hhc.folders.instead.books.frag">
  8043. &lt;xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"&gt;&lt;/xsl:param&gt;
  8044. </programlisting>
  8045. </refsynopsisdiv>
  8046. <refsection><info><title>Description</title></info>
  8047. <para>Set to non-zero for folder-like icons or zero for book-like icons in the ToC.
  8048. If you want to use folder-like icons, you must switch off the binary ToC using
  8049. <parameter>htmlhelp.hhc.binary</parameter>.
  8050. </para>
  8051. </refsection>
  8052. </refentry>
  8053. <refentry version="5.0" xml:id="htmlhelp.hhc.binary">
  8054. <refmeta>
  8055. <refentrytitle>htmlhelp.hhc.binary</refentrytitle>
  8056. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8057. </refmeta>
  8058. <refnamediv>
  8059. <refname>htmlhelp.hhc.binary</refname>
  8060. <refpurpose>Generate binary ToC?</refpurpose>
  8061. </refnamediv>
  8062. <refsynopsisdiv>
  8063. <programlisting xml:id="htmlhelp.hhc.binary.frag">
  8064. &lt;xsl:param name="htmlhelp.hhc.binary" select="1"&gt;&lt;/xsl:param&gt;
  8065. </programlisting>
  8066. </refsynopsisdiv>
  8067. <refsection><info><title>Description</title></info>
  8068. <para>Set to non-zero to generate a binary TOC. You must create a binary TOC
  8069. if you want to add Prev/Next buttons to toolbar (which is default
  8070. behaviour). Files with binary TOC can't be merged.</para>
  8071. </refsection>
  8072. </refentry>
  8073. <refentry version="5.0" xml:id="htmlhelp.hhc.width">
  8074. <refmeta>
  8075. <refentrytitle>htmlhelp.hhc.width</refentrytitle>
  8076. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  8077. </refmeta>
  8078. <refnamediv>
  8079. <refname>htmlhelp.hhc.width</refname>
  8080. <refpurpose>Width of navigation pane</refpurpose>
  8081. </refnamediv>
  8082. <refsynopsisdiv>
  8083. <programlisting xml:id="htmlhelp.hhc.width.frag">
  8084. &lt;xsl:param name="htmlhelp.hhc.width"&gt;&lt;/xsl:param&gt;
  8085. </programlisting>
  8086. </refsynopsisdiv>
  8087. <refsection><info><title>Description</title></info>
  8088. <para>This parameter specifies the width of the navigation pane (containing TOC and
  8089. other navigation tabs) in pixels.</para>
  8090. </refsection>
  8091. </refentry>
  8092. <refentry version="5.0" xml:id="htmlhelp.title">
  8093. <refmeta>
  8094. <refentrytitle>htmlhelp.title</refentrytitle>
  8095. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8096. </refmeta>
  8097. <refnamediv>
  8098. <refname>htmlhelp.title</refname>
  8099. <refpurpose>Title of HTML Help</refpurpose>
  8100. </refnamediv>
  8101. <refsynopsisdiv>
  8102. <programlisting xml:id="htmlhelp.title.frag">
  8103. &lt;xsl:param name="htmlhelp.title"&gt;&lt;/xsl:param&gt;
  8104. </programlisting>
  8105. </refsynopsisdiv>
  8106. <refsection><info><title>Description</title></info>
  8107. <para>Content of this parameter will be used as a title for generated
  8108. HTML Help. If empty, title will be automatically taken from document.</para>
  8109. </refsection>
  8110. </refentry>
  8111. <refentry version="5.0" xml:id="htmlhelp.show.menu">
  8112. <refmeta>
  8113. <refentrytitle>htmlhelp.show.menu</refentrytitle>
  8114. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8115. </refmeta>
  8116. <refnamediv>
  8117. <refname>htmlhelp.show.menu</refname>
  8118. <refpurpose>Should the menu bar be shown?</refpurpose>
  8119. </refnamediv>
  8120. <refsynopsisdiv>
  8121. <programlisting xml:id="htmlhelp.show.menu.frag">
  8122. &lt;xsl:param name="htmlhelp.show.menu" select="0"&gt;&lt;/xsl:param&gt;
  8123. </programlisting>
  8124. </refsynopsisdiv>
  8125. <refsection><info><title>Description</title></info>
  8126. <para>Set to non-zero to have an application menu bar in your HTML Help window.
  8127. </para>
  8128. </refsection>
  8129. </refentry>
  8130. <refentry version="5.0" xml:id="htmlhelp.show.toolbar.text">
  8131. <refmeta>
  8132. <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle>
  8133. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8134. </refmeta>
  8135. <refnamediv>
  8136. <refname>htmlhelp.show.toolbar.text</refname>
  8137. <refpurpose>Show text under toolbar buttons?</refpurpose>
  8138. </refnamediv>
  8139. <refsynopsisdiv>
  8140. <programlisting xml:id="htmlhelp.show.toolbar.text.frag">
  8141. &lt;xsl:param name="htmlhelp.show.toolbar.text" select="1"&gt;&lt;/xsl:param&gt;
  8142. </programlisting>
  8143. </refsynopsisdiv>
  8144. <refsection><info><title>Description</title></info>
  8145. <para>Set to non-zero to display texts under toolbar buttons, zero to switch
  8146. off displays.</para>
  8147. </refsection>
  8148. </refentry>
  8149. <refentry version="5.0" xml:id="htmlhelp.show.advanced.search">
  8150. <refmeta>
  8151. <refentrytitle>htmlhelp.show.advanced.search</refentrytitle>
  8152. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8153. </refmeta>
  8154. <refnamediv>
  8155. <refname>htmlhelp.show.advanced.search</refname>
  8156. <refpurpose>Should advanced search features be available?</refpurpose>
  8157. </refnamediv>
  8158. <refsynopsisdiv>
  8159. <programlisting xml:id="htmlhelp.show.advanced.search.frag">
  8160. &lt;xsl:param name="htmlhelp.show.advanced.search" select="0"&gt;&lt;/xsl:param&gt;
  8161. </programlisting>
  8162. </refsynopsisdiv>
  8163. <refsection><info><title>Description</title></info>
  8164. <para>If you want advanced search features in your help, turn this
  8165. parameter to 1.</para>
  8166. </refsection>
  8167. </refentry>
  8168. <refentry version="5.0" xml:id="htmlhelp.show.favorities">
  8169. <refmeta>
  8170. <refentrytitle>htmlhelp.show.favorities</refentrytitle>
  8171. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8172. </refmeta>
  8173. <refnamediv>
  8174. <refname>htmlhelp.show.favorities</refname>
  8175. <refpurpose>Should the Favorites tab be shown?</refpurpose>
  8176. </refnamediv>
  8177. <refsynopsisdiv>
  8178. <programlisting xml:id="htmlhelp.show.favorities.frag">
  8179. &lt;xsl:param name="htmlhelp.show.favorities" select="0"&gt;&lt;/xsl:param&gt;
  8180. </programlisting>
  8181. </refsynopsisdiv>
  8182. <refsection><info><title>Description</title></info>
  8183. <para>Set to non-zero to include a Favorites tab in the navigation pane
  8184. of the help window.</para>
  8185. </refsection>
  8186. </refentry>
  8187. <refentry version="5.0" xml:id="htmlhelp.button.hideshow">
  8188. <refmeta>
  8189. <refentrytitle>htmlhelp.button.hideshow</refentrytitle>
  8190. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8191. </refmeta>
  8192. <refnamediv>
  8193. <refname>htmlhelp.button.hideshow</refname>
  8194. <refpurpose>Should the Hide/Show button be shown?</refpurpose>
  8195. </refnamediv>
  8196. <refsynopsisdiv>
  8197. <programlisting xml:id="htmlhelp.button.hideshow.frag">
  8198. &lt;xsl:param name="htmlhelp.button.hideshow" select="1"&gt;&lt;/xsl:param&gt;
  8199. </programlisting>
  8200. </refsynopsisdiv>
  8201. <refsection><info><title>Description</title></info>
  8202. <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
  8203. </refsection>
  8204. </refentry>
  8205. <refentry version="5.0" xml:id="htmlhelp.button.back">
  8206. <refmeta>
  8207. <refentrytitle>htmlhelp.button.back</refentrytitle>
  8208. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8209. </refmeta>
  8210. <refnamediv>
  8211. <refname>htmlhelp.button.back</refname>
  8212. <refpurpose>Should the Back button be shown?</refpurpose>
  8213. </refnamediv>
  8214. <refsynopsisdiv>
  8215. <programlisting xml:id="htmlhelp.button.back.frag">
  8216. &lt;xsl:param name="htmlhelp.button.back" select="1"&gt;&lt;/xsl:param&gt;
  8217. </programlisting>
  8218. </refsynopsisdiv>
  8219. <refsection><info><title>Description</title></info>
  8220. <para>Set to non-zero to include the Hide/Show button shown on toolbar</para>
  8221. </refsection>
  8222. </refentry>
  8223. <refentry version="5.0" xml:id="htmlhelp.button.forward">
  8224. <refmeta>
  8225. <refentrytitle>htmlhelp.button.forward</refentrytitle>
  8226. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8227. </refmeta>
  8228. <refnamediv>
  8229. <refname>htmlhelp.button.forward</refname>
  8230. <refpurpose>Should the Forward button be shown?</refpurpose>
  8231. </refnamediv>
  8232. <refsynopsisdiv>
  8233. <programlisting xml:id="htmlhelp.button.forward.frag">
  8234. &lt;xsl:param name="htmlhelp.button.forward" select="0"&gt;&lt;/xsl:param&gt;
  8235. </programlisting>
  8236. </refsynopsisdiv>
  8237. <refsection><info><title>Description</title></info>
  8238. <para>Set to non-zero to include the Forward button on the toolbar.</para>
  8239. </refsection>
  8240. </refentry>
  8241. <refentry version="5.0" xml:id="htmlhelp.button.stop">
  8242. <refmeta>
  8243. <refentrytitle>htmlhelp.button.stop</refentrytitle>
  8244. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8245. </refmeta>
  8246. <refnamediv>
  8247. <refname>htmlhelp.button.stop</refname>
  8248. <refpurpose>Should the Stop button be shown?</refpurpose>
  8249. </refnamediv>
  8250. <refsynopsisdiv>
  8251. <programlisting xml:id="htmlhelp.button.stop.frag">
  8252. &lt;xsl:param name="htmlhelp.button.stop" select="0"&gt;&lt;/xsl:param&gt;
  8253. </programlisting>
  8254. </refsynopsisdiv>
  8255. <refsection><info><title>Description</title></info>
  8256. <para>If you want Stop button shown on toolbar, turn this
  8257. parameter to 1.</para>
  8258. </refsection>
  8259. </refentry>
  8260. <refentry version="5.0" xml:id="htmlhelp.button.refresh">
  8261. <refmeta>
  8262. <refentrytitle>htmlhelp.button.refresh</refentrytitle>
  8263. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8264. </refmeta>
  8265. <refnamediv>
  8266. <refname>htmlhelp.button.refresh</refname>
  8267. <refpurpose>Should the Refresh button be shown?</refpurpose>
  8268. </refnamediv>
  8269. <refsynopsisdiv>
  8270. <programlisting xml:id="htmlhelp.button.refresh.frag">
  8271. &lt;xsl:param name="htmlhelp.button.refresh" select="0"&gt;&lt;/xsl:param&gt;
  8272. </programlisting>
  8273. </refsynopsisdiv>
  8274. <refsection><info><title>Description</title></info>
  8275. <para>Set to non-zero to include the Stop button on the toolbar.</para>
  8276. </refsection>
  8277. </refentry>
  8278. <refentry version="5.0" xml:id="htmlhelp.button.home">
  8279. <refmeta>
  8280. <refentrytitle>htmlhelp.button.home</refentrytitle>
  8281. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8282. </refmeta>
  8283. <refnamediv>
  8284. <refname>htmlhelp.button.home</refname>
  8285. <refpurpose>Should the Home button be shown?</refpurpose>
  8286. </refnamediv>
  8287. <refsynopsisdiv>
  8288. <programlisting xml:id="htmlhelp.button.home.frag">
  8289. &lt;xsl:param name="htmlhelp.button.home" select="0"&gt;&lt;/xsl:param&gt;
  8290. </programlisting>
  8291. </refsynopsisdiv>
  8292. <refsection><info><title>Description</title></info>
  8293. <para>Set to non-zero to include the Home button on the toolbar.</para>
  8294. </refsection>
  8295. </refentry>
  8296. <refentry version="5.0" xml:id="htmlhelp.button.home.url">
  8297. <refmeta>
  8298. <refentrytitle>htmlhelp.button.home.url</refentrytitle>
  8299. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8300. </refmeta>
  8301. <refnamediv>
  8302. <refname>htmlhelp.button.home.url</refname>
  8303. <refpurpose>URL address of page accessible by Home button</refpurpose>
  8304. </refnamediv>
  8305. <refsynopsisdiv>
  8306. <programlisting xml:id="htmlhelp.button.home.url.frag">
  8307. &lt;xsl:param name="htmlhelp.button.home.url"&gt;&lt;/xsl:param&gt;
  8308. </programlisting>
  8309. </refsynopsisdiv>
  8310. <refsection><info><title>Description</title></info>
  8311. <para>URL address of page accessible by Home button.</para>
  8312. </refsection>
  8313. </refentry>
  8314. <refentry version="5.0" xml:id="htmlhelp.button.options">
  8315. <refmeta>
  8316. <refentrytitle>htmlhelp.button.options</refentrytitle>
  8317. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8318. </refmeta>
  8319. <refnamediv>
  8320. <refname>htmlhelp.button.options</refname>
  8321. <refpurpose>Should the Options button be shown?</refpurpose>
  8322. </refnamediv>
  8323. <refsynopsisdiv>
  8324. <programlisting xml:id="htmlhelp.button.options.frag">
  8325. &lt;xsl:param name="htmlhelp.button.options" select="1"&gt;&lt;/xsl:param&gt;
  8326. </programlisting>
  8327. </refsynopsisdiv>
  8328. <refsection><info><title>Description</title></info>
  8329. <para>If you want Options button shown on toolbar, turn this
  8330. parameter to 1.</para>
  8331. </refsection>
  8332. </refentry>
  8333. <refentry version="5.0" xml:id="htmlhelp.button.print">
  8334. <refmeta>
  8335. <refentrytitle>htmlhelp.button.print</refentrytitle>
  8336. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8337. </refmeta>
  8338. <refnamediv>
  8339. <refname>htmlhelp.button.print</refname>
  8340. <refpurpose>Should the Print button be shown?</refpurpose>
  8341. </refnamediv>
  8342. <refsynopsisdiv>
  8343. <programlisting xml:id="htmlhelp.button.print.frag">
  8344. &lt;xsl:param name="htmlhelp.button.print" select="1"&gt;&lt;/xsl:param&gt;
  8345. </programlisting>
  8346. </refsynopsisdiv>
  8347. <refsection><info><title>Description</title></info>
  8348. <para>Set to non-zero to include the Print button on the toolbar.
  8349. </para>
  8350. </refsection>
  8351. </refentry>
  8352. <refentry version="5.0" xml:id="htmlhelp.button.locate">
  8353. <refmeta>
  8354. <refentrytitle>htmlhelp.button.locate</refentrytitle>
  8355. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8356. </refmeta>
  8357. <refnamediv>
  8358. <refname>htmlhelp.button.locate</refname>
  8359. <refpurpose>Should the Locate button be shown?</refpurpose>
  8360. </refnamediv>
  8361. <refsynopsisdiv>
  8362. <programlisting xml:id="htmlhelp.button.locate.frag">
  8363. &lt;xsl:param name="htmlhelp.button.locate" select="0"&gt;&lt;/xsl:param&gt;
  8364. </programlisting>
  8365. </refsynopsisdiv>
  8366. <refsection><info><title>Description</title></info>
  8367. <para>If you want Locate button shown on toolbar, turn this
  8368. parameter to 1.</para>
  8369. </refsection>
  8370. </refentry>
  8371. <refentry version="5.0" xml:id="htmlhelp.button.jump1">
  8372. <refmeta>
  8373. <refentrytitle>htmlhelp.button.jump1</refentrytitle>
  8374. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8375. </refmeta>
  8376. <refnamediv>
  8377. <refname>htmlhelp.button.jump1</refname>
  8378. <refpurpose>Should the Jump1 button be shown?</refpurpose>
  8379. </refnamediv>
  8380. <refsynopsisdiv>
  8381. <programlisting xml:id="htmlhelp.button.jump1.frag">
  8382. &lt;xsl:param name="htmlhelp.button.jump1" select="0"&gt;&lt;/xsl:param&gt;
  8383. </programlisting>
  8384. </refsynopsisdiv>
  8385. <refsection><info><title>Description</title></info>
  8386. <para>Set to non-zero to include the <literal>Jump1</literal> button on the toolbar.</para>
  8387. </refsection>
  8388. </refentry>
  8389. <refentry version="5.0" xml:id="htmlhelp.button.jump1.url">
  8390. <refmeta>
  8391. <refentrytitle>htmlhelp.button.jump1.url</refentrytitle>
  8392. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8393. </refmeta>
  8394. <refnamediv>
  8395. <refname>htmlhelp.button.jump1.url</refname>
  8396. <refpurpose>URL address of page accessible by Jump1 button</refpurpose>
  8397. </refnamediv>
  8398. <refsynopsisdiv>
  8399. <programlisting xml:id="htmlhelp.button.jump1.url.frag">
  8400. &lt;xsl:param name="htmlhelp.button.jump1.url"&gt;&lt;/xsl:param&gt;
  8401. </programlisting>
  8402. </refsynopsisdiv>
  8403. <refsection><info><title>Description</title></info>
  8404. <para>URL address of page accessible by Jump1 button.</para>
  8405. </refsection>
  8406. </refentry>
  8407. <refentry version="5.0" xml:id="htmlhelp.button.jump1.title">
  8408. <refmeta>
  8409. <refentrytitle>htmlhelp.button.jump1.title</refentrytitle>
  8410. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8411. </refmeta>
  8412. <refnamediv>
  8413. <refname>htmlhelp.button.jump1.title</refname>
  8414. <refpurpose>Title of Jump1 button</refpurpose>
  8415. </refnamediv>
  8416. <refsynopsisdiv>
  8417. <programlisting xml:id="htmlhelp.button.jump1.title.frag">
  8418. &lt;xsl:param name="htmlhelp.button.jump1.title"&gt;User1&lt;/xsl:param&gt;
  8419. </programlisting>
  8420. </refsynopsisdiv>
  8421. <refsection><info><title>Description</title></info>
  8422. <para>Title of Jump1 button.</para>
  8423. </refsection>
  8424. </refentry>
  8425. <refentry version="5.0" xml:id="htmlhelp.button.jump2">
  8426. <refmeta>
  8427. <refentrytitle>htmlhelp.button.jump2</refentrytitle>
  8428. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8429. </refmeta>
  8430. <refnamediv>
  8431. <refname>htmlhelp.button.jump2</refname>
  8432. <refpurpose>Should the Jump2 button be shown?</refpurpose>
  8433. </refnamediv>
  8434. <refsynopsisdiv>
  8435. <programlisting xml:id="htmlhelp.button.jump2.frag">
  8436. &lt;xsl:param name="htmlhelp.button.jump2" select="0"&gt;&lt;/xsl:param&gt;
  8437. </programlisting>
  8438. </refsynopsisdiv>
  8439. <refsection><info><title>Description</title></info>
  8440. <para>Set to non-zero to include the Jump2 button on the toolbar.</para>
  8441. </refsection>
  8442. </refentry>
  8443. <refentry version="5.0" xml:id="htmlhelp.button.jump2.url">
  8444. <refmeta>
  8445. <refentrytitle>htmlhelp.button.jump2.url</refentrytitle>
  8446. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8447. </refmeta>
  8448. <refnamediv>
  8449. <refname>htmlhelp.button.jump2.url</refname>
  8450. <refpurpose>URL address of page accessible by Jump2 button</refpurpose>
  8451. </refnamediv>
  8452. <refsynopsisdiv>
  8453. <programlisting xml:id="htmlhelp.button.jump2.url.frag">
  8454. &lt;xsl:param name="htmlhelp.button.jump2.url"&gt;&lt;/xsl:param&gt;
  8455. </programlisting>
  8456. </refsynopsisdiv>
  8457. <refsection><info><title>Description</title></info>
  8458. <para>URL address of page accessible by Jump2 button.</para>
  8459. </refsection>
  8460. </refentry>
  8461. <refentry version="5.0" xml:id="htmlhelp.button.jump2.title">
  8462. <refmeta>
  8463. <refentrytitle>htmlhelp.button.jump2.title</refentrytitle>
  8464. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8465. </refmeta>
  8466. <refnamediv>
  8467. <refname>htmlhelp.button.jump2.title</refname>
  8468. <refpurpose>Title of Jump2 button</refpurpose>
  8469. </refnamediv>
  8470. <refsynopsisdiv>
  8471. <programlisting xml:id="htmlhelp.button.jump2.title.frag">
  8472. &lt;xsl:param name="htmlhelp.button.jump2.title"&gt;User2&lt;/xsl:param&gt;
  8473. </programlisting>
  8474. </refsynopsisdiv>
  8475. <refsection><info><title>Description</title></info>
  8476. <para>Title of Jump2 button.</para>
  8477. </refsection>
  8478. </refentry>
  8479. <refentry version="5.0" xml:id="htmlhelp.button.next">
  8480. <refmeta>
  8481. <refentrytitle>htmlhelp.button.next</refentrytitle>
  8482. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8483. </refmeta>
  8484. <refnamediv>
  8485. <refname>htmlhelp.button.next</refname>
  8486. <refpurpose>Should the Next button be shown?</refpurpose>
  8487. </refnamediv>
  8488. <refsynopsisdiv>
  8489. <programlisting xml:id="htmlhelp.button.next.frag">
  8490. &lt;xsl:param name="htmlhelp.button.next" select="1"&gt;&lt;/xsl:param&gt;
  8491. </programlisting>
  8492. </refsynopsisdiv>
  8493. <refsection><info><title>Description</title></info>
  8494. <para>Set to non-zero to include the Next button on the toolbar.</para>
  8495. </refsection>
  8496. </refentry>
  8497. <refentry version="5.0" xml:id="htmlhelp.button.prev">
  8498. <refmeta>
  8499. <refentrytitle>htmlhelp.button.prev</refentrytitle>
  8500. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8501. </refmeta>
  8502. <refnamediv>
  8503. <refname>htmlhelp.button.prev</refname>
  8504. <refpurpose>Should the Prev button be shown?</refpurpose>
  8505. </refnamediv>
  8506. <refsynopsisdiv>
  8507. <programlisting xml:id="htmlhelp.button.prev.frag">
  8508. &lt;xsl:param name="htmlhelp.button.prev" select="1"&gt;&lt;/xsl:param&gt;
  8509. </programlisting>
  8510. </refsynopsisdiv>
  8511. <refsection><info><title>Description</title></info>
  8512. <para>Set to non-zero to include the Prev button on the toolbar.
  8513. </para>
  8514. </refsection>
  8515. </refentry>
  8516. <refentry version="5.0" xml:id="htmlhelp.button.zoom">
  8517. <refmeta>
  8518. <refentrytitle>htmlhelp.button.zoom</refentrytitle>
  8519. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8520. </refmeta>
  8521. <refnamediv>
  8522. <refname>htmlhelp.button.zoom</refname>
  8523. <refpurpose>Should the Zoom button be shown?</refpurpose>
  8524. </refnamediv>
  8525. <refsynopsisdiv>
  8526. <programlisting xml:id="htmlhelp.button.zoom.frag">
  8527. &lt;xsl:param name="htmlhelp.button.zoom" select="0"&gt;&lt;/xsl:param&gt;
  8528. </programlisting>
  8529. </refsynopsisdiv>
  8530. <refsection><info><title>Description</title></info>
  8531. <para>Set to non-zero to include the Zoom button on the toolbar.
  8532. </para>
  8533. </refsection>
  8534. </refentry>
  8535. <refentry version="5.0" xml:id="htmlhelp.remember.window.position">
  8536. <refmeta>
  8537. <refentrytitle>htmlhelp.remember.window.position</refentrytitle>
  8538. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8539. </refmeta>
  8540. <refnamediv>
  8541. <refname>htmlhelp.remember.window.position</refname>
  8542. <refpurpose>Remember help window position?</refpurpose>
  8543. </refnamediv>
  8544. <refsynopsisdiv>
  8545. <programlisting xml:id="htmlhelp.remember.window.position.frag">
  8546. &lt;xsl:param name="htmlhelp.remember.window.position" select="0"&gt;&lt;/xsl:param&gt;
  8547. </programlisting>
  8548. </refsynopsisdiv>
  8549. <refsection><info><title>Description</title></info>
  8550. <para>Set to non-zero to remember help window position between starts.</para>
  8551. </refsection>
  8552. </refentry>
  8553. <refentry version="5.0" xml:id="htmlhelp.window.geometry">
  8554. <refmeta>
  8555. <refentrytitle>htmlhelp.window.geometry</refentrytitle>
  8556. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8557. </refmeta>
  8558. <refnamediv>
  8559. <refname>htmlhelp.window.geometry</refname>
  8560. <refpurpose>Set initial geometry of help window</refpurpose>
  8561. </refnamediv>
  8562. <refsynopsisdiv>
  8563. <programlisting xml:id="htmlhelp.window.geometry.frag">
  8564. &lt;xsl:param name="htmlhelp.window.geometry"&gt;&lt;/xsl:param&gt;
  8565. </programlisting>
  8566. </refsynopsisdiv>
  8567. <refsection><info><title>Description</title></info>
  8568. <para>This parameter specifies initial position of help
  8569. window. E.g.</para>
  8570. <programlisting>&lt;xsl:param name="htmlhelp.window.geometry"&gt;[160,64,992,704]&lt;/xsl:param&gt;</programlisting>
  8571. </refsection>
  8572. </refentry>
  8573. <refentry version="5.0" xml:id="htmlhelp.use.hhk">
  8574. <refmeta>
  8575. <refentrytitle>htmlhelp.use.hhk</refentrytitle>
  8576. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8577. </refmeta>
  8578. <refnamediv>
  8579. <refname>htmlhelp.use.hhk</refname>
  8580. <refpurpose>Should the index be built using the HHK file?</refpurpose>
  8581. </refnamediv>
  8582. <refsynopsisdiv>
  8583. <programlisting xml:id="htmlhelp.use.hhk.frag">
  8584. &lt;xsl:param name="htmlhelp.use.hhk" select="0"&gt;&lt;/xsl:param&gt;
  8585. </programlisting>
  8586. </refsynopsisdiv>
  8587. <refsection><info><title>Description</title></info>
  8588. <para>If non-zero, the index is created using the HHK file (instead of using <tag role="html">object</tag>
  8589. elements in the HTML files). For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generating an index</link>.</para>
  8590. </refsection>
  8591. </refentry>
  8592. <refentry version="5.0" xml:id="htmlhelp.only">
  8593. <refmeta>
  8594. <refentrytitle>htmlhelp.only</refentrytitle>
  8595. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8596. </refmeta>
  8597. <refnamediv>
  8598. <refname>htmlhelp.only</refname>
  8599. <refpurpose>Should only project files be generated?</refpurpose>
  8600. </refnamediv>
  8601. <refsynopsisdiv>
  8602. <programlisting xml:id="htmlhelp.only.frag">
  8603. &lt;xsl:param name="htmlhelp.only" select="0"&gt;&lt;/xsl:param&gt;
  8604. </programlisting>
  8605. </refsynopsisdiv>
  8606. <refsection><info><title>Description</title></info>
  8607. <para>Set to non-zero if you want to play with various HTML Help parameters
  8608. and you don't need to regenerate all HTML files. This setting will not
  8609. process whole document, only project files (hhp, hhc, hhk,...) will be
  8610. generated.</para>
  8611. </refsection>
  8612. </refentry>
  8613. </reference>
  8614. <reference xml:id="eclipse_help"><title>Eclipse Help Platform</title>
  8615. <refentry version="5.0" xml:id="eclipse.autolabel">
  8616. <refmeta>
  8617. <refentrytitle>eclipse.autolabel</refentrytitle>
  8618. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8619. </refmeta>
  8620. <refnamediv>
  8621. <refname>eclipse.autolabel</refname>
  8622. <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
  8623. </refnamediv>
  8624. <refsynopsisdiv>
  8625. <programlisting xml:id="eclipse.autolabel.frag">
  8626. &lt;xsl:param name="eclipse.autolabel" select="0"&gt;&lt;/xsl:param&gt;
  8627. </programlisting>
  8628. </refsynopsisdiv>
  8629. <refsection><info><title>Description</title></info>
  8630. <para>If you want to include chapter and section numbers into ToC in
  8631. the left panel, set this parameter to 1.</para>
  8632. </refsection>
  8633. </refentry>
  8634. <refentry version="5.0" xml:id="eclipse.plugin.name">
  8635. <refmeta>
  8636. <refentrytitle>eclipse.plugin.name</refentrytitle>
  8637. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8638. </refmeta>
  8639. <refnamediv>
  8640. <refname>eclipse.plugin.name</refname>
  8641. <refpurpose>Eclipse Help plugin name</refpurpose>
  8642. </refnamediv>
  8643. <refsynopsisdiv>
  8644. <programlisting xml:id="eclipse.plugin.name.frag">
  8645. &lt;xsl:param name="eclipse.plugin.name"&gt;DocBook Online Help Sample&lt;/xsl:param&gt;
  8646. </programlisting>
  8647. </refsynopsisdiv>
  8648. <refsection><info><title>Description</title></info>
  8649. <para>Eclipse Help plugin name.</para>
  8650. </refsection>
  8651. </refentry>
  8652. <refentry version="5.0" xml:id="eclipse.plugin.id">
  8653. <refmeta>
  8654. <refentrytitle>eclipse.plugin.id</refentrytitle>
  8655. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8656. </refmeta>
  8657. <refnamediv>
  8658. <refname>eclipse.plugin.id</refname>
  8659. <refpurpose>Eclipse Help plugin id</refpurpose>
  8660. </refnamediv>
  8661. <refsynopsisdiv>
  8662. <programlisting xml:id="eclipse.plugin.id.frag">
  8663. &lt;xsl:param name="eclipse.plugin.id"&gt;com.example.help&lt;/xsl:param&gt;
  8664. </programlisting>
  8665. </refsynopsisdiv>
  8666. <refsection><info><title>Description</title></info>
  8667. <para>Eclipse Help plugin id. You should change this id to something
  8668. unique for each help.</para>
  8669. </refsection>
  8670. </refentry>
  8671. <refentry version="5.0" xml:id="eclipse.plugin.provider">
  8672. <refmeta>
  8673. <refentrytitle>eclipse.plugin.provider</refentrytitle>
  8674. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8675. </refmeta>
  8676. <refnamediv>
  8677. <refname>eclipse.plugin.provider</refname>
  8678. <refpurpose>Eclipse Help plugin provider name</refpurpose>
  8679. </refnamediv>
  8680. <refsynopsisdiv>
  8681. <programlisting xml:id="eclipse.plugin.provider.frag">
  8682. &lt;xsl:param name="eclipse.plugin.provider"&gt;Example provider&lt;/xsl:param&gt;
  8683. </programlisting>
  8684. </refsynopsisdiv>
  8685. <refsection><info><title>Description</title></info>
  8686. <para>Eclipse Help plugin provider name.</para>
  8687. </refsection>
  8688. </refentry>
  8689. </reference>
  8690. <reference xml:id="webhelp"><title>WebHelp</title>
  8691. <refentry version="5.0" xml:id="webhelp.autolabel">
  8692. <refmeta>
  8693. <refentrytitle>webhelp.autolabel</refentrytitle>
  8694. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8695. </refmeta>
  8696. <refnamediv>
  8697. <refname>webhelp.autolabel</refname>
  8698. <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose>
  8699. </refnamediv>
  8700. <refsynopsisdiv>
  8701. <programlisting xml:id="webhelp.autolabel.frag">
  8702. &lt;xsl:param name="webhelp.autolabel"&gt;0&lt;/xsl:param&gt;
  8703. </programlisting>
  8704. </refsynopsisdiv>
  8705. <refsection><info><title>Description</title></info>
  8706. <para>To include chapter and section numbers the table of contents pane, set this parameter to 1.</para>
  8707. </refsection>
  8708. </refentry>
  8709. <refentry version="5.0" xml:id="webhelp.base.dir">
  8710. <refmeta>
  8711. <refentrytitle>webhelp.base.dir</refentrytitle>
  8712. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8713. </refmeta>
  8714. <refnamediv>
  8715. <refname>webhelp.base.dir</refname>
  8716. <refpurpose>The base directory for webhelp output.</refpurpose>
  8717. </refnamediv>
  8718. <refsynopsisdiv>
  8719. <programlisting xml:id="webhelp.base.dir.frag">
  8720. &lt;xsl:param name="webhelp.base.dir"&gt;docs&lt;/xsl:param&gt;
  8721. </programlisting>
  8722. </refsynopsisdiv>
  8723. <refsection><info><title>Description</title></info>
  8724. <para>If specified, the <parameter>webhelp.base.dir</parameter>
  8725. parameter identifies the output directory for webhelp. (If not
  8726. specified, the output directory is system dependent.) By default, this
  8727. parameter is set to <filename>docs</filename>.</para>
  8728. </refsection>
  8729. </refentry>
  8730. <refentry version="5.0" xml:id="webhelp.common.dir">
  8731. <refmeta>
  8732. <refentrytitle>webhelp.common.dir</refentrytitle>
  8733. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8734. </refmeta>
  8735. <refnamediv>
  8736. <refname>webhelp.common.dir</refname>
  8737. <refpurpose>Path to the directory for the common webhelp resources (JavaScript, css, common images, etc).</refpurpose>
  8738. </refnamediv>
  8739. <refsynopsisdiv>
  8740. <programlisting xml:id="webhelp.common.dir.frag">
  8741. &lt;xsl:param name="webhelp.common.dir"&gt;../common/&lt;/xsl:param&gt;
  8742. </programlisting>
  8743. </refsynopsisdiv>
  8744. <refsection><info><title>Description</title></info>
  8745. <para>By default, webhelp creates a common directory containing resources such as JavaScript files, css, common images, etc. In some cases you may prefer to store these files in a standard location on your site and point all webhelp documents to that location. You can use this parameter to control the urls written to these common resources. For example, you might set this parameter to <code>/common</code> and create a single common directory at the root of your web server. </para>
  8746. </refsection>
  8747. </refentry>
  8748. <refentry version="5.0" xml:id="webhelp.default.topic">
  8749. <refmeta>
  8750. <refentrytitle>webhelp.default.topic</refentrytitle>
  8751. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8752. </refmeta>
  8753. <refnamediv>
  8754. <refname>webhelp.default.topic</refname>
  8755. <refpurpose>The name of the file to which the start file in the webhelp base directory redirects</refpurpose>
  8756. </refnamediv>
  8757. <refsynopsisdiv>
  8758. <programlisting xml:id="webhelp.default.topic.frag">
  8759. &lt;xsl:param name="webhelp.default.topic"&gt;index.html&lt;/xsl:param&gt;
  8760. </programlisting>
  8761. </refsynopsisdiv>
  8762. <refsection><info><title>Description</title></info>
  8763. <para>Currently webhelp creates a base directory and puts the output
  8764. files in a <filename>content</filename> subdirectory. It creates a
  8765. file in the base directory that redirects to a configured file in the
  8766. <filename>content</filename> directory. The
  8767. <parameter>webhelp.default.topic</parameter> parameter lets you
  8768. configure the name of the file that is redirected to.
  8769. <note>
  8770. <para>This parameter will be removed from a future version of
  8771. webhelp along with the <filename>content</filename>
  8772. directory.</para>
  8773. </note>
  8774. </para>
  8775. </refsection>
  8776. </refentry>
  8777. <refentry version="5.0" xml:id="webhelp.include.search.tab">
  8778. <refmeta>
  8779. <refentrytitle>webhelp.include.search.tab</refentrytitle>
  8780. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8781. </refmeta>
  8782. <refnamediv>
  8783. <refname>webhelp.include.search.tab</refname>
  8784. <refpurpose>Should the webhelp output include a Search tab?</refpurpose>
  8785. </refnamediv>
  8786. <refsynopsisdiv>
  8787. <programlisting xml:id="webhelp.include.search.tab.frag">
  8788. &lt;xsl:param name="webhelp.include.search.tab"&gt;1&lt;/xsl:param&gt;
  8789. </programlisting>
  8790. </refsynopsisdiv>
  8791. <refsection><info><title>Description</title></info>
  8792. <para>Set this parameter to 0 to suppress the search tab from webhelp output.</para>
  8793. </refsection>
  8794. </refentry>
  8795. <refentry version="5.0" xml:id="webhelp.indexer.language">
  8796. <refmeta>
  8797. <refentrytitle>webhelp.indexer.language</refentrytitle>
  8798. <refmiscinfo class="other" otherclass="datatype"/>
  8799. </refmeta>
  8800. <refnamediv>
  8801. <refname>webhelp.indexer.language</refname>
  8802. <refpurpose>The language to use for creating the webhelp search index.</refpurpose>
  8803. </refnamediv>
  8804. <refsynopsisdiv>
  8805. <programlisting xml:id="webhelp.indexer.language.frag">
  8806. &lt;xsl:param name="webhelp.indexer.language"&gt;en&lt;/xsl:param&gt;
  8807. </programlisting>
  8808. </refsynopsisdiv>
  8809. <refsection><info><title>Description</title></info>
  8810. <para>To support stemming in the client-side webhelp stemmer, you must provide the language code. By default, the following languages are supported:
  8811. <itemizedlist>
  8812. <listitem>
  8813. <para><code>en</code>: English</para>
  8814. </listitem>
  8815. <listitem>
  8816. <para><code>de</code>: German</para>
  8817. </listitem>
  8818. <listitem>
  8819. <para><code>fr</code>: French</para>
  8820. </listitem>
  8821. <listitem>
  8822. <para><code>zh</code>: Chinese</para>
  8823. </listitem>
  8824. <listitem>
  8825. <para><code>ja</code>: Japanese</para>
  8826. </listitem>
  8827. <listitem>
  8828. <para><code>ko</code>: Korean</para>
  8829. </listitem>
  8830. </itemizedlist>
  8831. See the webhelp documentation for information on adding support for additional languages.
  8832. </para>
  8833. </refsection>
  8834. </refentry>
  8835. <refentry version="5.0" xml:id="webhelp.start.filename">
  8836. <refmeta>
  8837. <refentrytitle>webhelp.start.filename</refentrytitle>
  8838. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8839. </refmeta>
  8840. <refnamediv>
  8841. <refname>webhelp.start.filename</refname>
  8842. <refpurpose>The name of the start file in the webhelp base directory.</refpurpose>
  8843. </refnamediv>
  8844. <refsynopsisdiv>
  8845. <programlisting xml:id="webhelp.start.filename.frag">
  8846. &lt;xsl:param name="webhelp.start.filename"&gt;index.html&lt;/xsl:param&gt;
  8847. </programlisting>
  8848. </refsynopsisdiv>
  8849. <refsection><info><title>Description</title></info>
  8850. <para>Currently webhelp creates a base directory and puts the output
  8851. files in a <filename>content</filename> subdirectory. It creates a
  8852. file in the base directory that redirects to a configured file in the
  8853. <filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file.
  8854. <note>
  8855. <para>This parameter will be removed from a future version of
  8856. webhelp along with the <filename>content</filename>
  8857. directory.</para>
  8858. </note>
  8859. </para>
  8860. </refsection>
  8861. </refentry>
  8862. <refentry version="5.0" xml:id="webhelp.tree.cookie.id">
  8863. <refmeta>
  8864. <refentrytitle>webhelp.tree.cookie.id</refentrytitle>
  8865. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8866. </refmeta>
  8867. <refnamediv>
  8868. <refname>webhelp.tree.cookie.id</refname>
  8869. <refpurpose>Controls how the cookie that stores the webhelp toc state is named.</refpurpose>
  8870. </refnamediv>
  8871. <refsynopsisdiv>
  8872. <programlisting xml:id="webhelp.tree.cookie.id.frag">
  8873. &lt;xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(//node()) )"&gt;&lt;/xsl:param&gt;
  8874. </programlisting>
  8875. </refsynopsisdiv>
  8876. <refsection><info><title>Description</title></info>
  8877. <para>The webhelp output does not use a frameset. Instead, the table of contents is a div on each page. To preserve the state of the table of contents as the user navigates from page to page, webhelp stores the state in a cookie and reads that cookie when you get to the next page. If you've published several webhelp documents on the same domain, it is important that each cookie have a unique id. In lieu of calling on a GUID generator, by default this parameter is just set to the number of nodes in the document on the assumption that it is unlikely that you will have more than one document with the exact number of nodes. A more optimal solution would be for the user to pass in some unique, stable identifier from the build system to use as the webhelp cookie id. For example, if you have safeguards in place to ensure that the xml:id of the root element of each document will be unique on your site, then you could set webhelptree.cookie.id as follows:
  8878. <programlisting>
  8879. &lt;xsl:param name="webhelp.tree.cookie.id"&gt;
  8880. &lt;xsl:choose&gt;
  8881. &lt;xsl:when test="/*/@xml:id"&gt;
  8882. &lt;xsl:value-of select="concat('treeview-',/*/@xml:id)"/&gt;
  8883. &lt;/xsl:when&gt;
  8884. &lt;xsl:otherwise&gt;
  8885. &lt;xsl:value-of select="concat( 'treeview-', count(//node()) )"/&gt;
  8886. &lt;/xsl:otherwise&gt;
  8887. &lt;/xsl:choose&gt;
  8888. &lt;/xsl:param&gt;
  8889. </programlisting>
  8890. </para>
  8891. </refsection>
  8892. </refentry>
  8893. </reference>
  8894. <reference xml:id="javahelp"><title>JavaHelp</title>
  8895. <refentry version="5.0" xml:id="javahelp.encoding">
  8896. <refmeta>
  8897. <refentrytitle>javahelp.encoding</refentrytitle>
  8898. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8899. </refmeta>
  8900. <refnamediv>
  8901. <refname>javahelp.encoding</refname>
  8902. <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose>
  8903. </refnamediv>
  8904. <refsynopsisdiv>
  8905. <programlisting xml:id="javahelp.encoding.frag">
  8906. &lt;xsl:param name="javahelp.encoding"&gt;iso-8859-1&lt;/xsl:param&gt;
  8907. </programlisting>
  8908. </refsynopsisdiv>
  8909. <refsection><info><title>Description</title></info>
  8910. <para>JavaHelp crashes on some characters when written as character
  8911. references. In that case you can use this parameter to select an appropriate encoding.</para>
  8912. </refsection>
  8913. </refentry>
  8914. </reference>
  8915. <reference xml:id="l10n"><title>Localization</title>
  8916. <refentry version="5.0" xml:id="l10n.gentext.language">
  8917. <refmeta>
  8918. <refentrytitle>l10n.gentext.language</refentrytitle>
  8919. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8920. </refmeta>
  8921. <refnamediv>
  8922. <refname>l10n.gentext.language</refname>
  8923. <refpurpose>Sets the gentext language</refpurpose>
  8924. </refnamediv>
  8925. <refsynopsisdiv>
  8926. <programlisting xml:id="l10n.gentext.language.frag">
  8927. &lt;xsl:param name="l10n.gentext.language"&gt;&lt;/xsl:param&gt;
  8928. </programlisting>
  8929. </refsynopsisdiv>
  8930. <refsection><info><title>Description</title></info>
  8931. <para>If this parameter is set to any value other than the empty string, its
  8932. value will be used as the value for the language when generating text. Setting
  8933. <parameter>l10n.gentext.language</parameter> overrides any settings within the
  8934. document being formatted.</para>
  8935. <para>It's much more likely that you might want to set the
  8936. <parameter>l10n.gentext.default.language</parameter> parameter.</para>
  8937. </refsection>
  8938. </refentry>
  8939. <refentry version="5.0" xml:id="l10n.gentext.default.language">
  8940. <refmeta>
  8941. <refentrytitle>l10n.gentext.default.language</refentrytitle>
  8942. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  8943. </refmeta>
  8944. <refnamediv>
  8945. <refname>l10n.gentext.default.language</refname>
  8946. <refpurpose>Sets the default language for generated text</refpurpose>
  8947. </refnamediv>
  8948. <refsynopsisdiv>
  8949. <programlisting xml:id="l10n.gentext.default.language.frag">
  8950. &lt;xsl:param name="l10n.gentext.default.language"&gt;en&lt;/xsl:param&gt;
  8951. </programlisting>
  8952. </refsynopsisdiv>
  8953. <refsection><info><title>Description</title></info>
  8954. <para>The value of the <parameter>l10n.gentext.default.language</parameter>
  8955. parameter is used as the language for generated text if no setting is provided
  8956. in the source document.</para>
  8957. </refsection>
  8958. </refentry>
  8959. <refentry version="5.0" xml:id="l10n.gentext.use.xref.language">
  8960. <refmeta>
  8961. <refentrytitle>l10n.gentext.use.xref.language</refentrytitle>
  8962. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  8963. </refmeta>
  8964. <refnamediv>
  8965. <refname>l10n.gentext.use.xref.language</refname>
  8966. <refpurpose>Use the language of target when generating cross-reference text?</refpurpose>
  8967. </refnamediv>
  8968. <refsynopsisdiv>
  8969. <programlisting xml:id="l10n.gentext.use.xref.language.frag">
  8970. &lt;xsl:param name="l10n.gentext.use.xref.language" select="0"&gt;&lt;/xsl:param&gt;
  8971. </programlisting>
  8972. </refsynopsisdiv>
  8973. <refsection><info><title>Description</title></info>
  8974. <para>If non-zero, the language of the target will be used when
  8975. generating cross reference text. Usually, the <quote>current</quote>
  8976. language is used when generating text (that is, the language of the
  8977. element that contains the cross-reference element). But setting this parameter
  8978. allows the language of the element <emphasis>pointed to</emphasis> to control
  8979. the generated text.</para>
  8980. <para>Consider the following example:</para>
  8981. <informalexample>
  8982. <programlisting>&lt;para lang="en"&gt;See also &lt;xref linkend="chap3"/&gt;.&lt;/para&gt;
  8983. </programlisting>
  8984. </informalexample>
  8985. <para>Suppose that Chapter 3 happens to be written in German.
  8986. If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the
  8987. resulting text will be something like this:</para>
  8988. <blockquote>
  8989. <para>See also Kapital 3.</para>
  8990. </blockquote>
  8991. <para>Where the more traditional rendering would be:</para>
  8992. <blockquote>
  8993. <para>See also Chapter 3.</para>
  8994. </blockquote>
  8995. </refsection>
  8996. </refentry>
  8997. <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant">
  8998. <refmeta>
  8999. <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle>
  9000. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  9001. </refmeta>
  9002. <refnamediv>
  9003. <refname>l10n.lang.value.rfc.compliant</refname>
  9004. <refpurpose>Make value of lang attribute RFC compliant?</refpurpose>
  9005. </refnamediv>
  9006. <refsynopsisdiv>
  9007. <programlisting xml:id="l10n.lang.value.rfc.compliant.frag">
  9008. &lt;xsl:param name="l10n.lang.value.rfc.compliant" select="1"&gt;&lt;/xsl:param&gt;
  9009. </programlisting>
  9010. </refsynopsisdiv>
  9011. <refsection><info><title>Description</title></info>
  9012. <para>If non-zero, ensure that the values for all <tag class="attribute">lang</tag> attributes in HTML output are RFC
  9013. compliant<footnote><para>Section 8.1.1, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1">Language Codes</link>, in the HTML 4.0 Recommendation states that:
  9014. <blockquote><para>[RFC1766] defines and explains the language codes
  9015. that must be used in HTML documents.</para>
  9016. <para>Briefly, language codes consist of a primary code and a possibly
  9017. empty series of subcodes:
  9018. <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*</literallayout>
  9019. </para>
  9020. <para>And in RFC 1766, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification
  9021. of Languages</link>, the EBNF for "language tag" is given as:
  9022. <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag )
  9023. Primary-tag = 1*8ALPHA
  9024. Subtag = 1*8ALPHA</literallayout>
  9025. </para>
  9026. </blockquote>
  9027. </para></footnote>.
  9028. by taking any underscore characters in any <tag class="attribute">lang</tag> values found in source documents, and
  9029. replacing them with hyphen characters in output HTML files. For
  9030. example, <literal>zh_CN</literal> in a source document becomes
  9031. <literal>zh-CN</literal> in the HTML output form that source.
  9032. <note>
  9033. <para>This parameter does not cause any case change in <tag class="attribute">lang</tag> values, because RFC 1766
  9034. explicitly states that all "language tags" (as it calls them) "are
  9035. to be treated as case insensitive".</para>
  9036. </note>
  9037. </para>
  9038. </refsection>
  9039. </refentry>
  9040. <refentry version="5.0" xml:id="writing.mode">
  9041. <refmeta>
  9042. <refentrytitle>writing.mode</refentrytitle>
  9043. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  9044. </refmeta>
  9045. <refnamediv>
  9046. <refname>writing.mode</refname>
  9047. <refpurpose>Direction of text flow based on locale</refpurpose>
  9048. </refnamediv>
  9049. <refsynopsisdiv>
  9050. <programlisting xml:id="writing.mode.frag">
  9051. &lt;xsl:param name="writing.mode"&gt;
  9052. &lt;xsl:call-template name="gentext"&gt;
  9053. &lt;xsl:with-param name="key"&gt;writing-mode&lt;/xsl:with-param&gt;
  9054. &lt;xsl:with-param name="lang"&gt;
  9055. &lt;xsl:call-template name="l10n.language"&gt;
  9056. &lt;xsl:with-param name="target" select="/*[1]"&gt;&lt;/xsl:with-param&gt;
  9057. &lt;/xsl:call-template&gt;
  9058. &lt;/xsl:with-param&gt;
  9059. &lt;/xsl:call-template&gt;
  9060. &lt;/xsl:param&gt;
  9061. </programlisting>
  9062. </refsynopsisdiv>
  9063. <refsection><info><title>Description</title></info>
  9064. <para>Sets direction of text flow and text alignment based on locale.
  9065. The value is normally taken from the gentext file for the
  9066. lang attribute of the document's root element, using the
  9067. key name 'writing-mode' to look it up in the gentext file.
  9068. But this param can also be
  9069. set on the command line to override that gentext value.
  9070. </para>
  9071. <para>Accepted values are:
  9072. <variablelist>
  9073. <varlistentry>
  9074. <term>lr-tb</term>
  9075. <listitem>
  9076. <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
  9077. </listitem>
  9078. </varlistentry>
  9079. <varlistentry>
  9080. <term>rl-tb</term>
  9081. <listitem>
  9082. <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
  9083. </listitem>
  9084. </varlistentry>
  9085. <varlistentry>
  9086. <term>tb-rl</term>
  9087. <listitem>
  9088. <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
  9089. Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
  9090. </listitem>
  9091. </varlistentry>
  9092. <varlistentry>
  9093. <term>lr</term>
  9094. <listitem>
  9095. <para>Shorthand for lr-tb.</para>
  9096. </listitem>
  9097. </varlistentry>
  9098. <varlistentry>
  9099. <term>rl</term>
  9100. <listitem>
  9101. <para>Shorthand for rl-tb.</para>
  9102. </listitem>
  9103. </varlistentry>
  9104. <varlistentry>
  9105. <term>tb</term>
  9106. <listitem>
  9107. <para>Shorthand for tb-rl.</para>
  9108. </listitem>
  9109. </varlistentry>
  9110. </variablelist>
  9111. </para>
  9112. </refsection>
  9113. </refentry>
  9114. </reference>
  9115. <appendix xml:id="stylesheet"><title>The Stylesheet</title>
  9116. <para>The <filename>param.xsl</filename> stylesheet is just a wrapper
  9117. around all these parameters.</para>
  9118. <programlisting xml:id="top">
  9119. &lt;!-- This file is generated from param.xweb --&gt;
  9120. &lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;
  9121. &lt;!-- ********************************************************************
  9122. $Id: param.xweb 9658 2012-10-29 22:28:34Z bobstayton $
  9123. ********************************************************************
  9124. This file is part of the XSL DocBook Stylesheet distribution.
  9125. See ../README or http://docbook.sf.net/release/xsl/current/ for
  9126. copyright and other information.
  9127. ******************************************************************** --&gt;
  9128. &lt;src:fragref linkend="abstract.notitle.enabled.frag"&gt;&lt;/src:fragref&gt;
  9129. &lt;src:fragref linkend="activate.external.olinks.frag"&gt;&lt;/src:fragref&gt;
  9130. &lt;src:fragref linkend="admon.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
  9131. &lt;src:fragref linkend="admon.graphics.frag"&gt;&lt;/src:fragref&gt;
  9132. &lt;src:fragref linkend="admon.graphics.path.frag"&gt;&lt;/src:fragref&gt;
  9133. &lt;src:fragref linkend="admon.style.frag"&gt;&lt;/src:fragref&gt;
  9134. &lt;src:fragref linkend="admon.textlabel.frag"&gt;&lt;/src:fragref&gt;
  9135. &lt;src:fragref linkend="annotate.toc.frag"&gt;&lt;/src:fragref&gt;
  9136. &lt;src:fragref linkend="annotation.css.frag"&gt;&lt;/src:fragref&gt;
  9137. &lt;src:fragref linkend="annotation.graphic.close.frag"&gt;&lt;/src:fragref&gt;
  9138. &lt;src:fragref linkend="annotation.graphic.open.frag"&gt;&lt;/src:fragref&gt;
  9139. &lt;src:fragref linkend="annotation.js.frag"&gt;&lt;/src:fragref&gt;
  9140. &lt;src:fragref linkend="annotation.support.frag"&gt;&lt;/src:fragref&gt;
  9141. &lt;src:fragref linkend="appendix.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9142. &lt;src:fragref linkend="author.othername.in.middle.frag"&gt;&lt;/src:fragref&gt;
  9143. &lt;src:fragref linkend="autotoc.label.in.hyperlink.frag"&gt;&lt;/src:fragref&gt;
  9144. &lt;src:fragref linkend="autotoc.label.separator.frag"&gt;&lt;/src:fragref&gt;
  9145. &lt;src:fragref linkend="base.dir.frag"&gt;&lt;/src:fragref&gt;
  9146. &lt;src:fragref linkend="biblioentry.item.separator.frag"&gt;&lt;/src:fragref&gt;
  9147. &lt;src:fragref linkend="bibliography.collection.frag"&gt;&lt;/src:fragref&gt;
  9148. &lt;src:fragref linkend="bibliography.numbered.frag"&gt;&lt;/src:fragref&gt;
  9149. &lt;src:fragref linkend="bibliography.style.frag"&gt;&lt;/src:fragref&gt;
  9150. &lt;src:fragref linkend="blurb.on.titlepage.enabled.frag"&gt;&lt;/src:fragref&gt;
  9151. &lt;src:fragref linkend="bridgehead.in.toc.frag"&gt;&lt;/src:fragref&gt;
  9152. &lt;src:fragref linkend="callout.defaultcolumn.frag"&gt;&lt;/src:fragref&gt;
  9153. &lt;src:fragref linkend="callout.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
  9154. &lt;src:fragref linkend="callout.graphics.frag"&gt;&lt;/src:fragref&gt;
  9155. &lt;src:fragref linkend="callout.graphics.number.limit.frag"&gt;&lt;/src:fragref&gt;
  9156. &lt;src:fragref linkend="callout.graphics.path.frag"&gt;&lt;/src:fragref&gt;
  9157. &lt;src:fragref linkend="callout.list.table.frag"&gt;&lt;/src:fragref&gt;
  9158. &lt;src:fragref linkend="callout.unicode.frag"&gt;&lt;/src:fragref&gt;
  9159. &lt;src:fragref linkend="callout.unicode.number.limit.frag"&gt;&lt;/src:fragref&gt;
  9160. &lt;src:fragref linkend="callout.unicode.start.character.frag"&gt;&lt;/src:fragref&gt;
  9161. &lt;src:fragref linkend="callouts.extension.frag"&gt;&lt;/src:fragref&gt;
  9162. &lt;src:fragref linkend="chapter.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9163. &lt;src:fragref linkend="chunk.append.frag"&gt;&lt;/src:fragref&gt;
  9164. &lt;src:fragref linkend="chunk.first.sections.frag"&gt;&lt;/src:fragref&gt;
  9165. &lt;src:fragref linkend="chunk.quietly.frag"&gt;&lt;/src:fragref&gt;
  9166. &lt;src:fragref linkend="chunk.section.depth.frag"&gt;&lt;/src:fragref&gt;
  9167. &lt;src:fragref linkend="chunk.separate.lots.frag"&gt;&lt;/src:fragref&gt;
  9168. &lt;src:fragref linkend="chunk.toc.frag"&gt;&lt;/src:fragref&gt;
  9169. &lt;src:fragref linkend="chunk.tocs.and.lots.frag"&gt;&lt;/src:fragref&gt;
  9170. &lt;src:fragref linkend="chunk.tocs.and.lots.has.title.frag"&gt;&lt;/src:fragref&gt;
  9171. &lt;src:fragref linkend="chunked.filename.prefix.frag"&gt;&lt;/src:fragref&gt;
  9172. &lt;src:fragref linkend="citerefentry.link.frag"&gt;&lt;/src:fragref&gt;
  9173. &lt;src:fragref linkend="collect.xref.targets.frag"&gt;&lt;/src:fragref&gt;
  9174. &lt;src:fragref linkend="component.label.includes.part.label.frag"&gt;&lt;/src:fragref&gt;
  9175. &lt;src:fragref linkend="contrib.inline.enabled.frag"&gt;&lt;/src:fragref&gt;
  9176. &lt;src:fragref linkend="css.decoration.frag"&gt;&lt;/src:fragref&gt;
  9177. &lt;src:fragref linkend="current.docid.frag"&gt;&lt;/src:fragref&gt;
  9178. &lt;src:fragref linkend="custom.css.source.frag"&gt;&lt;/src:fragref&gt;
  9179. &lt;src:fragref linkend="default.float.class.frag"&gt;&lt;/src:fragref&gt;
  9180. &lt;src:fragref linkend="default.image.width.frag"&gt;&lt;/src:fragref&gt;
  9181. &lt;src:fragref linkend="default.table.frame.frag"&gt;&lt;/src:fragref&gt;
  9182. &lt;src:fragref linkend="default.table.width.frag"&gt;&lt;/src:fragref&gt;
  9183. &lt;src:fragref linkend="docbook.css.link.frag"&gt;&lt;/src:fragref&gt;
  9184. &lt;src:fragref linkend="docbook.css.source.frag"&gt;&lt;/src:fragref&gt;
  9185. &lt;src:fragref linkend="draft.mode.frag"&gt;&lt;/src:fragref&gt;
  9186. &lt;src:fragref linkend="draft.watermark.image.frag"&gt;&lt;/src:fragref&gt;
  9187. &lt;src:fragref linkend="ebnf.assignment.frag"&gt;&lt;/src:fragref&gt;
  9188. &lt;src:fragref linkend="ebnf.statement.terminator.frag"&gt;&lt;/src:fragref&gt;
  9189. &lt;src:fragref linkend="ebnf.table.bgcolor.frag"&gt;&lt;/src:fragref&gt;
  9190. &lt;src:fragref linkend="ebnf.table.border.frag"&gt;&lt;/src:fragref&gt;
  9191. &lt;src:fragref linkend="eclipse.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9192. &lt;src:fragref linkend="eclipse.plugin.id.frag"&gt;&lt;/src:fragref&gt;
  9193. &lt;src:fragref linkend="eclipse.plugin.name.frag"&gt;&lt;/src:fragref&gt;
  9194. &lt;src:fragref linkend="eclipse.plugin.provider.frag"&gt;&lt;/src:fragref&gt;
  9195. &lt;src:fragref linkend="editedby.enabled.frag"&gt;&lt;/src:fragref&gt;
  9196. &lt;src:fragref linkend="email.delimiters.enabled.frag"&gt;&lt;/src:fragref&gt;
  9197. &lt;src:fragref linkend="emphasis.propagates.style.frag"&gt;&lt;/src:fragref&gt;
  9198. &lt;src:fragref linkend="entry.propagates.style.frag"&gt;&lt;/src:fragref&gt;
  9199. &lt;src:fragref linkend="exsl.node.set.available.frag"&gt;&lt;/src:fragref&gt;
  9200. &lt;src:fragref linkend="firstterm.only.link.frag"&gt;&lt;/src:fragref&gt;
  9201. &lt;src:fragref linkend="footer.rule.frag"&gt;&lt;/src:fragref&gt;
  9202. &lt;src:fragref linkend="footnote.number.format.frag"&gt;&lt;/src:fragref&gt;
  9203. &lt;src:fragref linkend="footnote.number.symbols.frag"&gt;&lt;/src:fragref&gt;
  9204. &lt;src:fragref linkend="formal.procedures.frag"&gt;&lt;/src:fragref&gt;
  9205. &lt;src:fragref linkend="formal.title.placement.frag"&gt;&lt;/src:fragref&gt;
  9206. &lt;src:fragref linkend="funcsynopsis.decoration.frag"&gt;&lt;/src:fragref&gt;
  9207. &lt;src:fragref linkend="funcsynopsis.style.frag"&gt;&lt;/src:fragref&gt;
  9208. &lt;src:fragref linkend="function.parens.frag"&gt;&lt;/src:fragref&gt;
  9209. &lt;src:fragref linkend="generate.consistent.ids.frag"&gt;&lt;/src:fragref&gt;
  9210. &lt;src:fragref linkend="generate.css.header.frag"&gt;&lt;/src:fragref&gt;
  9211. &lt;src:fragref linkend="generate.id.attributes.frag"&gt;&lt;/src:fragref&gt;
  9212. &lt;src:fragref linkend="generate.index.frag"&gt;&lt;/src:fragref&gt;
  9213. &lt;src:fragref linkend="generate.legalnotice.link.frag"&gt;&lt;/src:fragref&gt;
  9214. &lt;src:fragref linkend="generate.manifest.frag"&gt;&lt;/src:fragref&gt;
  9215. &lt;src:fragref linkend="generate.meta.abstract.frag"&gt;&lt;/src:fragref&gt;
  9216. &lt;src:fragref linkend="generate.revhistory.link.frag"&gt;&lt;/src:fragref&gt;
  9217. &lt;src:fragref linkend="generate.section.toc.level.frag"&gt;&lt;/src:fragref&gt;
  9218. &lt;src:fragref linkend="generate.toc.frag"&gt;&lt;/src:fragref&gt;
  9219. &lt;src:fragref linkend="glossary.collection.frag"&gt;&lt;/src:fragref&gt;
  9220. &lt;src:fragref linkend="glossary.sort.frag"&gt;&lt;/src:fragref&gt;
  9221. &lt;src:fragref linkend="glossentry.show.acronym.frag"&gt;&lt;/src:fragref&gt;
  9222. &lt;src:fragref linkend="glossterm.auto.link.frag"&gt;&lt;/src:fragref&gt;
  9223. &lt;src:fragref linkend="graphic.default.extension.frag"&gt;&lt;/src:fragref&gt;
  9224. &lt;src:fragref linkend="graphicsize.extension.frag"&gt;&lt;/src:fragref&gt;
  9225. &lt;src:fragref linkend="graphicsize.use.img.src.path.frag"&gt;&lt;/src:fragref&gt;
  9226. &lt;src:fragref linkend="header.rule.frag"&gt;&lt;/src:fragref&gt;
  9227. &lt;src:fragref linkend="highlight.default.language.frag"&gt;&lt;/src:fragref&gt;
  9228. &lt;src:fragref linkend="highlight.source.frag"&gt;&lt;/src:fragref&gt;
  9229. &lt;src:fragref linkend="highlight.xslthl.config.frag"&gt;&lt;/src:fragref&gt;
  9230. &lt;src:fragref linkend="html.append.frag"&gt;&lt;/src:fragref&gt;
  9231. &lt;src:fragref linkend="html.base.frag"&gt;&lt;/src:fragref&gt;
  9232. &lt;src:fragref linkend="html.cellpadding.frag"&gt;&lt;/src:fragref&gt;
  9233. &lt;src:fragref linkend="html.cellspacing.frag"&gt;&lt;/src:fragref&gt;
  9234. &lt;src:fragref linkend="html.cleanup.frag"&gt;&lt;/src:fragref&gt;
  9235. &lt;src:fragref linkend="html.ext.frag"&gt;&lt;/src:fragref&gt;
  9236. &lt;src:fragref linkend="html.extra.head.links.frag"&gt;&lt;/src:fragref&gt;
  9237. &lt;src:fragref linkend="html.head.legalnotice.link.multiple.frag"&gt;&lt;/src:fragref&gt;
  9238. &lt;src:fragref linkend="html.head.legalnotice.link.types.frag"&gt;&lt;/src:fragref&gt;
  9239. &lt;src:fragref linkend="html.longdesc.frag"&gt;&lt;/src:fragref&gt;
  9240. &lt;src:fragref linkend="html.longdesc.link.frag"&gt;&lt;/src:fragref&gt;
  9241. &lt;src:fragref linkend="html.script.frag"&gt;&lt;/src:fragref&gt;
  9242. &lt;src:fragref linkend="html.script.type.frag"&gt;&lt;/src:fragref&gt;
  9243. &lt;src:fragref linkend="html.stylesheet.frag"&gt;&lt;/src:fragref&gt;
  9244. &lt;src:fragref linkend="html.stylesheet.type.frag"&gt;&lt;/src:fragref&gt;
  9245. &lt;src:fragref linkend="htmlhelp.alias.file.frag"&gt;&lt;/src:fragref&gt;
  9246. &lt;src:fragref linkend="htmlhelp.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9247. &lt;src:fragref linkend="htmlhelp.button.back.frag"&gt;&lt;/src:fragref&gt;
  9248. &lt;src:fragref linkend="htmlhelp.button.forward.frag"&gt;&lt;/src:fragref&gt;
  9249. &lt;src:fragref linkend="htmlhelp.button.hideshow.frag"&gt;&lt;/src:fragref&gt;
  9250. &lt;src:fragref linkend="htmlhelp.button.home.frag"&gt;&lt;/src:fragref&gt;
  9251. &lt;src:fragref linkend="htmlhelp.button.home.url.frag"&gt;&lt;/src:fragref&gt;
  9252. &lt;src:fragref linkend="htmlhelp.button.jump1.frag"&gt;&lt;/src:fragref&gt;
  9253. &lt;src:fragref linkend="htmlhelp.button.jump1.title.frag"&gt;&lt;/src:fragref&gt;
  9254. &lt;src:fragref linkend="htmlhelp.button.jump1.url.frag"&gt;&lt;/src:fragref&gt;
  9255. &lt;src:fragref linkend="htmlhelp.button.jump2.frag"&gt;&lt;/src:fragref&gt;
  9256. &lt;src:fragref linkend="htmlhelp.button.jump2.title.frag"&gt;&lt;/src:fragref&gt;
  9257. &lt;src:fragref linkend="htmlhelp.button.jump2.url.frag"&gt;&lt;/src:fragref&gt;
  9258. &lt;src:fragref linkend="htmlhelp.button.locate.frag"&gt;&lt;/src:fragref&gt;
  9259. &lt;src:fragref linkend="htmlhelp.button.next.frag"&gt;&lt;/src:fragref&gt;
  9260. &lt;src:fragref linkend="htmlhelp.button.options.frag"&gt;&lt;/src:fragref&gt;
  9261. &lt;src:fragref linkend="htmlhelp.button.prev.frag"&gt;&lt;/src:fragref&gt;
  9262. &lt;src:fragref linkend="htmlhelp.button.print.frag"&gt;&lt;/src:fragref&gt;
  9263. &lt;src:fragref linkend="htmlhelp.button.refresh.frag"&gt;&lt;/src:fragref&gt;
  9264. &lt;src:fragref linkend="htmlhelp.button.stop.frag"&gt;&lt;/src:fragref&gt;
  9265. &lt;src:fragref linkend="htmlhelp.button.zoom.frag"&gt;&lt;/src:fragref&gt;
  9266. &lt;src:fragref linkend="htmlhelp.chm.frag"&gt;&lt;/src:fragref&gt;
  9267. &lt;src:fragref linkend="htmlhelp.default.topic.frag"&gt;&lt;/src:fragref&gt;
  9268. &lt;src:fragref linkend="htmlhelp.display.progress.frag"&gt;&lt;/src:fragref&gt;
  9269. &lt;src:fragref linkend="htmlhelp.encoding.frag"&gt;&lt;/src:fragref&gt;
  9270. &lt;src:fragref linkend="htmlhelp.enhanced.decompilation.frag"&gt;&lt;/src:fragref&gt;
  9271. &lt;src:fragref linkend="htmlhelp.enumerate.images.frag"&gt;&lt;/src:fragref&gt;
  9272. &lt;src:fragref linkend="htmlhelp.force.map.and.alias.frag"&gt;&lt;/src:fragref&gt;
  9273. &lt;src:fragref linkend="htmlhelp.hhc.binary.frag"&gt;&lt;/src:fragref&gt;
  9274. &lt;src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"&gt;&lt;/src:fragref&gt;
  9275. &lt;src:fragref linkend="htmlhelp.hhc.frag"&gt;&lt;/src:fragref&gt;
  9276. &lt;src:fragref linkend="htmlhelp.hhc.section.depth.frag"&gt;&lt;/src:fragref&gt;
  9277. &lt;src:fragref linkend="htmlhelp.hhc.show.root.frag"&gt;&lt;/src:fragref&gt;
  9278. &lt;src:fragref linkend="htmlhelp.hhc.width.frag"&gt;&lt;/src:fragref&gt;
  9279. &lt;src:fragref linkend="htmlhelp.hhk.frag"&gt;&lt;/src:fragref&gt;
  9280. &lt;src:fragref linkend="htmlhelp.hhp.frag"&gt;&lt;/src:fragref&gt;
  9281. &lt;src:fragref linkend="htmlhelp.hhp.tail.frag"&gt;&lt;/src:fragref&gt;
  9282. &lt;src:fragref linkend="htmlhelp.hhp.window.frag"&gt;&lt;/src:fragref&gt;
  9283. &lt;src:fragref linkend="htmlhelp.hhp.windows.frag"&gt;&lt;/src:fragref&gt;
  9284. &lt;src:fragref linkend="htmlhelp.map.file.frag"&gt;&lt;/src:fragref&gt;
  9285. &lt;src:fragref linkend="htmlhelp.only.frag"&gt;&lt;/src:fragref&gt;
  9286. &lt;src:fragref linkend="htmlhelp.remember.window.position.frag"&gt;&lt;/src:fragref&gt;
  9287. &lt;src:fragref linkend="htmlhelp.show.advanced.search.frag"&gt;&lt;/src:fragref&gt;
  9288. &lt;src:fragref linkend="htmlhelp.show.favorities.frag"&gt;&lt;/src:fragref&gt;
  9289. &lt;src:fragref linkend="htmlhelp.show.menu.frag"&gt;&lt;/src:fragref&gt;
  9290. &lt;src:fragref linkend="htmlhelp.show.toolbar.text.frag"&gt;&lt;/src:fragref&gt;
  9291. &lt;src:fragref linkend="htmlhelp.title.frag"&gt;&lt;/src:fragref&gt;
  9292. &lt;src:fragref linkend="htmlhelp.use.hhk.frag"&gt;&lt;/src:fragref&gt;
  9293. &lt;src:fragref linkend="htmlhelp.window.geometry.frag"&gt;&lt;/src:fragref&gt;
  9294. &lt;src:fragref linkend="id.warnings.frag"&gt;&lt;/src:fragref&gt;
  9295. &lt;src:fragref linkend="ignore.image.scaling.frag"&gt;&lt;/src:fragref&gt;
  9296. &lt;src:fragref linkend="img.src.path.frag"&gt;&lt;/src:fragref&gt;
  9297. &lt;src:fragref linkend="index.links.to.section.frag"&gt;&lt;/src:fragref&gt;
  9298. &lt;src:fragref linkend="index.method.frag"&gt;&lt;/src:fragref&gt;
  9299. &lt;src:fragref linkend="index.number.separator.frag"&gt;&lt;/src:fragref&gt;
  9300. &lt;src:fragref linkend="index.on.role.frag"&gt;&lt;/src:fragref&gt;
  9301. &lt;src:fragref linkend="index.on.type.frag"&gt;&lt;/src:fragref&gt;
  9302. &lt;src:fragref linkend="index.prefer.titleabbrev.frag"&gt;&lt;/src:fragref&gt;
  9303. &lt;src:fragref linkend="index.range.separator.frag"&gt;&lt;/src:fragref&gt;
  9304. &lt;src:fragref linkend="index.term.separator.frag"&gt;&lt;/src:fragref&gt;
  9305. &lt;src:fragref linkend="inherit.keywords.frag"&gt;&lt;/src:fragref&gt;
  9306. &lt;src:fragref linkend="insert.olink.page.number.frag"&gt;&lt;/src:fragref&gt;
  9307. &lt;src:fragref linkend="insert.olink.pdf.frag.frag"&gt;&lt;/src:fragref&gt;
  9308. &lt;src:fragref linkend="insert.xref.page.number.frag"&gt;&lt;/src:fragref&gt;
  9309. &lt;src:fragref linkend="javahelp.encoding.frag"&gt;&lt;/src:fragref&gt;
  9310. &lt;src:fragref linkend="keep.relative.image.uris.frag"&gt;&lt;/src:fragref&gt;
  9311. &lt;src:fragref linkend="l10n.gentext.default.language.frag"&gt;&lt;/src:fragref&gt;
  9312. &lt;src:fragref linkend="l10n.gentext.language.frag"&gt;&lt;/src:fragref&gt;
  9313. &lt;src:fragref linkend="l10n.gentext.use.xref.language.frag"&gt;&lt;/src:fragref&gt;
  9314. &lt;src:fragref linkend="l10n.lang.value.rfc.compliant.frag"&gt;&lt;/src:fragref&gt;
  9315. &lt;src:fragref linkend="label.from.part.frag"&gt;&lt;/src:fragref&gt;
  9316. &lt;src:fragref linkend="linenumbering.everyNth.frag"&gt;&lt;/src:fragref&gt;
  9317. &lt;src:fragref linkend="linenumbering.extension.frag"&gt;&lt;/src:fragref&gt;
  9318. &lt;src:fragref linkend="linenumbering.separator.frag"&gt;&lt;/src:fragref&gt;
  9319. &lt;src:fragref linkend="linenumbering.width.frag"&gt;&lt;/src:fragref&gt;
  9320. &lt;src:fragref linkend="link.mailto.url.frag"&gt;&lt;/src:fragref&gt;
  9321. &lt;src:fragref linkend="make.clean.html.frag"&gt;&lt;/src:fragref&gt;
  9322. &lt;src:fragref linkend="make.graphic.viewport.frag"&gt;&lt;/src:fragref&gt;
  9323. &lt;src:fragref linkend="make.single.year.ranges.frag"&gt;&lt;/src:fragref&gt;
  9324. &lt;src:fragref linkend="make.valid.html.frag"&gt;&lt;/src:fragref&gt;
  9325. &lt;src:fragref linkend="make.year.ranges.frag"&gt;&lt;/src:fragref&gt;
  9326. &lt;src:fragref linkend="manifest.frag"&gt;&lt;/src:fragref&gt;
  9327. &lt;src:fragref linkend="manifest.in.base.dir.frag"&gt;&lt;/src:fragref&gt;
  9328. &lt;src:fragref linkend="manual.toc.frag"&gt;&lt;/src:fragref&gt;
  9329. &lt;src:fragref linkend="menuchoice.menu.separator.frag"&gt;&lt;/src:fragref&gt;
  9330. &lt;src:fragref linkend="menuchoice.separator.frag"&gt;&lt;/src:fragref&gt;
  9331. &lt;src:fragref linkend="navig.graphics.extension.frag"&gt;&lt;/src:fragref&gt;
  9332. &lt;src:fragref linkend="navig.graphics.frag"&gt;&lt;/src:fragref&gt;
  9333. &lt;src:fragref linkend="navig.graphics.path.frag"&gt;&lt;/src:fragref&gt;
  9334. &lt;src:fragref linkend="navig.showtitles.frag"&gt;&lt;/src:fragref&gt;
  9335. &lt;src:fragref linkend="nominal.image.depth.frag"&gt;&lt;/src:fragref&gt;
  9336. &lt;src:fragref linkend="nominal.image.width.frag"&gt;&lt;/src:fragref&gt;
  9337. &lt;src:fragref linkend="nominal.table.width.frag"&gt;&lt;/src:fragref&gt;
  9338. &lt;src:fragref linkend="olink.base.uri.frag"&gt;&lt;/src:fragref&gt;
  9339. &lt;src:fragref linkend="olink.debug.frag"&gt;&lt;/src:fragref&gt;
  9340. &lt;src:fragref linkend="olink.doctitle.frag"&gt;&lt;/src:fragref&gt;
  9341. &lt;src:fragref linkend="olink.lang.fallback.sequence.frag"&gt;&lt;/src:fragref&gt;
  9342. &lt;src:fragref linkend="olink.properties.frag"&gt;&lt;/src:fragref&gt;
  9343. &lt;src:fragref linkend="othercredit.like.author.enabled.frag"&gt;&lt;/src:fragref&gt;
  9344. &lt;src:fragref linkend="para.propagates.style.frag"&gt;&lt;/src:fragref&gt;
  9345. &lt;src:fragref linkend="part.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9346. &lt;src:fragref linkend="phrase.propagates.style.frag"&gt;&lt;/src:fragref&gt;
  9347. &lt;src:fragref linkend="pixels.per.inch.frag"&gt;&lt;/src:fragref&gt;
  9348. &lt;src:fragref linkend="points.per.em.frag"&gt;&lt;/src:fragref&gt;
  9349. &lt;src:fragref linkend="preface.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9350. &lt;src:fragref linkend="prefer.internal.olink.frag"&gt;&lt;/src:fragref&gt;
  9351. &lt;src:fragref linkend="preferred.mediaobject.role.frag"&gt;&lt;/src:fragref&gt;
  9352. &lt;src:fragref linkend="process.empty.source.toc.frag"&gt;&lt;/src:fragref&gt;
  9353. &lt;src:fragref linkend="process.source.toc.frag"&gt;&lt;/src:fragref&gt;
  9354. &lt;src:fragref linkend="profile.arch.frag"&gt;&lt;/src:fragref&gt;
  9355. &lt;src:fragref linkend="profile.attribute.frag"&gt;&lt;/src:fragref&gt;
  9356. &lt;src:fragref linkend="profile.audience.frag"&gt;&lt;/src:fragref&gt;
  9357. &lt;src:fragref linkend="profile.condition.frag"&gt;&lt;/src:fragref&gt;
  9358. &lt;src:fragref linkend="profile.conformance.frag"&gt;&lt;/src:fragref&gt;
  9359. &lt;src:fragref linkend="profile.lang.frag"&gt;&lt;/src:fragref&gt;
  9360. &lt;src:fragref linkend="profile.os.frag"&gt;&lt;/src:fragref&gt;
  9361. &lt;src:fragref linkend="profile.revision.frag"&gt;&lt;/src:fragref&gt;
  9362. &lt;src:fragref linkend="profile.revisionflag.frag"&gt;&lt;/src:fragref&gt;
  9363. &lt;src:fragref linkend="profile.role.frag"&gt;&lt;/src:fragref&gt;
  9364. &lt;src:fragref linkend="profile.security.frag"&gt;&lt;/src:fragref&gt;
  9365. &lt;src:fragref linkend="profile.separator.frag"&gt;&lt;/src:fragref&gt;
  9366. &lt;src:fragref linkend="profile.status.frag"&gt;&lt;/src:fragref&gt;
  9367. &lt;src:fragref linkend="profile.userlevel.frag"&gt;&lt;/src:fragref&gt;
  9368. &lt;src:fragref linkend="profile.value.frag"&gt;&lt;/src:fragref&gt;
  9369. &lt;src:fragref linkend="profile.vendor.frag"&gt;&lt;/src:fragref&gt;
  9370. &lt;src:fragref linkend="profile.wordsize.frag"&gt;&lt;/src:fragref&gt;
  9371. &lt;src:fragref linkend="punct.honorific.frag"&gt;&lt;/src:fragref&gt;
  9372. &lt;src:fragref linkend="qanda.defaultlabel.frag"&gt;&lt;/src:fragref&gt;
  9373. &lt;src:fragref linkend="qanda.in.toc.frag"&gt;&lt;/src:fragref&gt;
  9374. &lt;src:fragref linkend="qanda.inherit.numeration.frag"&gt;&lt;/src:fragref&gt;
  9375. &lt;src:fragref linkend="qanda.nested.in.toc.frag"&gt;&lt;/src:fragref&gt;
  9376. &lt;src:fragref linkend="qandadiv.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9377. &lt;src:fragref linkend="refclass.suppress.frag"&gt;&lt;/src:fragref&gt;
  9378. &lt;src:fragref linkend="refentry.generate.name.frag"&gt;&lt;/src:fragref&gt;
  9379. &lt;src:fragref linkend="refentry.generate.title.frag"&gt;&lt;/src:fragref&gt;
  9380. &lt;src:fragref linkend="refentry.separator.frag"&gt;&lt;/src:fragref&gt;
  9381. &lt;src:fragref linkend="refentry.xref.manvolnum.frag"&gt;&lt;/src:fragref&gt;
  9382. &lt;src:fragref linkend="reference.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9383. &lt;src:fragref linkend="root.filename.frag"&gt;&lt;/src:fragref&gt;
  9384. &lt;src:fragref linkend="rootid.frag"&gt;&lt;/src:fragref&gt;
  9385. &lt;src:fragref linkend="runinhead.default.title.end.punct.frag"&gt;&lt;/src:fragref&gt;
  9386. &lt;src:fragref linkend="runinhead.title.end.punct.frag"&gt;&lt;/src:fragref&gt;
  9387. &lt;src:fragref linkend="section.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9388. &lt;src:fragref linkend="section.autolabel.max.depth.frag"&gt;&lt;/src:fragref&gt;
  9389. &lt;src:fragref linkend="section.label.includes.component.label.frag"&gt;&lt;/src:fragref&gt;
  9390. &lt;src:fragref linkend="segmentedlist.as.table.frag"&gt;&lt;/src:fragref&gt;
  9391. &lt;src:fragref linkend="shade.verbatim.frag"&gt;&lt;/src:fragref&gt;
  9392. &lt;src:fragref linkend="shade.verbatim.style.frag"&gt;&lt;/src:fragref&gt;
  9393. &lt;src:fragref linkend="show.comments.frag"&gt;&lt;/src:fragref&gt;
  9394. &lt;src:fragref linkend="show.revisionflag.frag"&gt;&lt;/src:fragref&gt;
  9395. &lt;src:fragref linkend="simplesect.in.toc.frag"&gt;&lt;/src:fragref&gt;
  9396. &lt;src:fragref linkend="spacing.paras.frag"&gt;&lt;/src:fragref&gt;
  9397. &lt;src:fragref linkend="suppress.footer.navigation.frag"&gt;&lt;/src:fragref&gt;
  9398. &lt;src:fragref linkend="suppress.header.navigation.frag"&gt;&lt;/src:fragref&gt;
  9399. &lt;src:fragref linkend="suppress.navigation.frag"&gt;&lt;/src:fragref&gt;
  9400. &lt;src:fragref linkend="table.borders.with.css.frag"&gt;&lt;/src:fragref&gt;
  9401. &lt;src:fragref linkend="table.cell.border.color.frag"&gt;&lt;/src:fragref&gt;
  9402. &lt;src:fragref linkend="table.cell.border.style.frag"&gt;&lt;/src:fragref&gt;
  9403. &lt;src:fragref linkend="table.cell.border.thickness.frag"&gt;&lt;/src:fragref&gt;
  9404. &lt;src:fragref linkend="table.footnote.number.format.frag"&gt;&lt;/src:fragref&gt;
  9405. &lt;src:fragref linkend="table.footnote.number.symbols.frag"&gt;&lt;/src:fragref&gt;
  9406. &lt;src:fragref linkend="table.frame.border.color.frag"&gt;&lt;/src:fragref&gt;
  9407. &lt;src:fragref linkend="table.frame.border.style.frag"&gt;&lt;/src:fragref&gt;
  9408. &lt;src:fragref linkend="table.frame.border.thickness.frag"&gt;&lt;/src:fragref&gt;
  9409. &lt;src:fragref linkend="tablecolumns.extension.frag"&gt;&lt;/src:fragref&gt;
  9410. &lt;src:fragref linkend="target.database.document.frag"&gt;&lt;/src:fragref&gt;
  9411. &lt;src:fragref linkend="targets.filename.frag"&gt;&lt;/src:fragref&gt;
  9412. &lt;src:fragref linkend="tex.math.delims.frag"&gt;&lt;/src:fragref&gt;
  9413. &lt;src:fragref linkend="tex.math.file.frag"&gt;&lt;/src:fragref&gt;
  9414. &lt;src:fragref linkend="tex.math.in.alt.frag"&gt;&lt;/src:fragref&gt;
  9415. &lt;src:fragref linkend="textdata.default.encoding.frag"&gt;&lt;/src:fragref&gt;
  9416. &lt;src:fragref linkend="textinsert.extension.frag"&gt;&lt;/src:fragref&gt;
  9417. &lt;src:fragref linkend="toc.list.type.frag"&gt;&lt;/src:fragref&gt;
  9418. &lt;src:fragref linkend="toc.max.depth.frag"&gt;&lt;/src:fragref&gt;
  9419. &lt;src:fragref linkend="toc.section.depth.frag"&gt;&lt;/src:fragref&gt;
  9420. &lt;src:fragref linkend="ulink.target.frag"&gt;&lt;/src:fragref&gt;
  9421. &lt;src:fragref linkend="use.embed.for.svg.frag"&gt;&lt;/src:fragref&gt;
  9422. &lt;src:fragref linkend="use.extensions.frag"&gt;&lt;/src:fragref&gt;
  9423. &lt;src:fragref linkend="use.id.as.filename.frag"&gt;&lt;/src:fragref&gt;
  9424. &lt;src:fragref linkend="use.local.olink.style.frag"&gt;&lt;/src:fragref&gt;
  9425. &lt;src:fragref linkend="use.role.as.xrefstyle.frag"&gt;&lt;/src:fragref&gt;
  9426. &lt;src:fragref linkend="use.role.for.mediaobject.frag"&gt;&lt;/src:fragref&gt;
  9427. &lt;src:fragref linkend="use.svg.frag"&gt;&lt;/src:fragref&gt;
  9428. &lt;src:fragref linkend="variablelist.as.table.frag"&gt;&lt;/src:fragref&gt;
  9429. &lt;src:fragref linkend="variablelist.term.break.after.frag"&gt;&lt;/src:fragref&gt;
  9430. &lt;src:fragref linkend="variablelist.term.separator.frag"&gt;&lt;/src:fragref&gt;
  9431. &lt;src:fragref linkend="webhelp.autolabel.frag"&gt;&lt;/src:fragref&gt;
  9432. &lt;src:fragref linkend="webhelp.base.dir.frag"&gt;&lt;/src:fragref&gt;
  9433. &lt;src:fragref linkend="webhelp.common.dir.frag"&gt;&lt;/src:fragref&gt;
  9434. &lt;src:fragref linkend="webhelp.default.topic.frag"&gt;&lt;/src:fragref&gt;
  9435. &lt;src:fragref linkend="webhelp.include.search.tab.frag"&gt;&lt;/src:fragref&gt;
  9436. &lt;src:fragref linkend="webhelp.indexer.language.frag"&gt;&lt;/src:fragref&gt;
  9437. &lt;src:fragref linkend="webhelp.start.filename.frag"&gt;&lt;/src:fragref&gt;
  9438. &lt;src:fragref linkend="webhelp.tree.cookie.id.frag"&gt;&lt;/src:fragref&gt;
  9439. &lt;src:fragref linkend="writing.mode.frag"&gt;&lt;/src:fragref&gt;
  9440. &lt;src:fragref linkend="xref.label-page.separator.frag"&gt;&lt;/src:fragref&gt;
  9441. &lt;src:fragref linkend="xref.label-title.separator.frag"&gt;&lt;/src:fragref&gt;
  9442. &lt;src:fragref linkend="xref.title-page.separator.frag"&gt;&lt;/src:fragref&gt;
  9443. &lt;src:fragref linkend="xref.with.number.and.title.frag"&gt;&lt;/src:fragref&gt;
  9444. &lt;/xsl:stylesheet&gt;
  9445. </programlisting>
  9446. </appendix>
  9447. </book>