CTAN Comprehensive TeX Archive Network

xdoc – Extending the doc system

Xdoc is a project to rewrite the im­ple­men­ta­tion of the doc pack­age (in a broader sense) to make its fea­tures more gen­eral and flex­i­ble. For ex­am­ple, where doc only pro­vides com­mands for doc­u­ment­ing macros and en­vi­ron­ments, xdoc also pro­vides com­mands for sim­i­larly doc­u­ment­ing pack­age op­tions and switches. This is fur­ther­more done in such a way that it is very easy to add more such com­mands for doc­u­ment­ing things, such as e.g., tem­plates (an im­por­tant con­cept in the fu­ture 3) and pro­gram com­po­nents for other lan­guages (func­tions, classes, pro­ce­dures, etc.). A side ef­fect is that many mi­nor bugs in doc are fixed.

The de­sign aims to take ad­van­tage of many still ex­per­i­men­tal fea­tures of fu­ture ver­sions of , but since these are nei­ther rea­son­ably sta­ble nor widely avail­able, the con­fig­u­ra­tion in­ter­faces and pack­age au­thor com­mands of xdoc are likely to change. To still pro­vide a sta­ble in­ter­face for other pack­ages to build upon, the ac­tual pack­age names in­clude a "ma­jor ver­sion num­ber" of sorts. The drop-in re­place­ment pack­age for stan­dard doc is xdoc2; it re­quires noth­ing out­side stan­dard .

The docin­dex/do­cidx2e pack­age changes the in­dex and list of changes type­set­ting so that none of the for­mat­ting has to be con­trolled via the in­dex style file. The docin­dex pack­age pro­vides con­trol of for­mat­ting via tem­plates (nice in­ter­face, but re­quires sev­eral ex­per­i­men­tal pack­ages), whereas the do­cidx2e pack­age has tra­di­tional raw macro in­ter­faces and works with stan­dard .

Li­censesThe Project Public Li­cense
Main­tainerLars Hell­ström
Con­tained inTeX Live as xdoc
MiKTeX as xdoc
TopicsDoc­u­men­ta­tion sup­port

Down­load the con­tents of this pack­age in one zip archive (915.9k).

Com­mu­nity Com­ments



Here you can see a re­spec­tive di­a­gram in newer browsers.


Guest Book Sitemap Contact Contact Author