[devel] TeX, размещение документации сторонних макропакетов

[devel] TeX, размещение документации сторонних макропакетов

[Bergman Andrey]

Други!

В документе TeXPolicy - http://www.altlinux.org/TeXPolicy#.D0.A0.D0.B0.D0.B7.D0.BC.D0.B5.D1.89.D0.B5.D0.BD.D0.B8.D0.B5_.D1.84.D0.B0.D0.B9.D0.BB.D0.BE.D0.B2

написано:
"Файлы документации размещаются в подкаталогах TEXMFMAIN/doc 
в соответствии с TDS — это позволяет утилитам поиска 
ТеХ-документации (texdoc и пр.) обнаруживать эти файлы."

Это хорошо, но недостаточно - непонятно, куда записывать
документацию для пакетов вида texmf-pgf - в каталог
TEXMFMAIN/doc (оно же TEXMFDOC) или в TEXMFMAIN/doc/tex?

А куда записывать документацию для пакетов вида
texmf-latex-beamer - в TEXMFMAIN/doc/latex или в
TEXMFMAIN/doc/tex/latex?

Как быть, если пакет вида texmf-pgf на самом деле
ставит 4 пакета texmf-pgf-generic, texmf-pgf-plain,
texmf-pgf-latex, texmf-pgf-context? По-видимому, для
таких пакетов документация должна храниться в одном
месте. Но где?

Заранее спасибо за уточнения,
               Андрей.

Re: [devel] TeX, размещение документации сторонних макропакетов

[Kirill Maslinsky]

[-- Attachment #1: Type: text/plain, Size: 2376 bytes --]

On Sat, Jul 11, 2009 at 02:35:20AM +0400, Bergman Andrey wrote:
> Други!
> 
> В документе TeXPolicy - http://www.altlinux.org/TeXPolicy#.D0.A0.D0.B0.D0.B7.D0.BC.D0.B5.D1.89.D0.B5.D0.BD.D0.B8.D0.B5_.D1.84.D0.B0.D0.B9.D0.BB.D0.BE.D0.B2
> 
> написано:
> "Файлы документации размещаются в подкаталогах TEXMFMAIN/doc 
> в соответствии с TDS — это позволяет утилитам поиска 
> ТеХ-документации (texdoc и пр.) обнаруживать эти файлы."
> 

"в соответствии с TDS" в процитированном тексте означает, что более
детальные рекомендации по размещению документации следует искать
в TDS. См.:

http://www.tug.org/tds/tds.html#Documentation

The TDS specifies that these additional documentation files shall be stored in
a structure that parallels to some extent the fonts and tex directories, as
follows:

     texmf/doc/category/...

category identifies the general topic of documentation that resides below it;
for example, a TeX format name (latex), program name (bibtex, tex), language
(french, german), a file format (info, man), or other system components (web,
fonts).

One possible arrangement is to organize doc by language, with all the other
category types below that. This helps users find documentation in the
language(s) in which they are fluent. Neither this nor any other particular
arrangement is required, however. 

Нужно ли в тексте полиси уточнить формулировку?

> Это хорошо, но недостаточно - непонятно, куда записывать
> документацию для пакетов вида texmf-pgf - в каталог
> TEXMFMAIN/doc (оно же TEXMFDOC) или в TEXMFMAIN/doc/tex?

> А куда записывать документацию для пакетов вида
> texmf-latex-beamer - в TEXMFMAIN/doc/latex или в
> TEXMFMAIN/doc/tex/latex?
TEXMFDOC/latex однозначно, см. процитированный выше TDS.

> Как быть, если пакет вида texmf-pgf на самом деле
> ставит 4 пакета texmf-pgf-generic, texmf-pgf-plain,
> texmf-pgf-latex, texmf-pgf-context? По-видимому, для
> таких пакетов документация должна храниться в одном
> месте. Но где?
В случае pgf, если у него отдельные руководства для разных
форматов, то логично их разложить по разным categories,
соотвествующих этим форматам. Т.е. TEXMFDOC/{latex,generic,plain...}
Если у него общая документация для всех форматов, то либо 
generic, а если он совсем особенный, то, в принципе, можно и
TEXMFDOC/pgf. А ещё посмотрите, как в дебиане.

-- 
KM

[-- Attachment #2: Type: application/pgp-signature, Size: 197 bytes --]