asciidoc: moved support files into doc/

Docs should live happily together, after all,
and toplevel should be more or less uncluttered :)

Adjusted/rewrote as appropriate as well.
This commit is contained in:
Michael Shigorin 2012-11-05 13:08:59 +02:00
parent ccf3b2220a
commit 4e0cd6bdf6
7 changed files with 60 additions and 57 deletions

View File

@ -61,3 +61,6 @@ SHELL = /bin/bash
fi; \ fi; \
done; \ done; \
if [ "$$n" -lt "$(NUM_TARGETS)" ]; then say; fi if [ "$$n" -lt "$(NUM_TARGETS)" ]; then say; fi
docs:
@$(MAKE) -C doc

View File

@ -1,14 +0,0 @@
== Генерация документации ==
Необходимые пакеты:
apt-get install asciidoc-a2x xmlgraphics* fonts-ttf-ms
Внимание! Пакеты весьма увесисты (около гигабайта), имейте ввиду.
Для генерации текущей документации посредством ASCIIDOC выполнить:
для pdf-версии
make -f Makefile.asciidoc -d pdf
для html-версии
make -f Makefile.asciidoc -d
Сгенерируются соответственно mkimage-profiles.pdf или mkimage-profiles.html
Опция -d для детального вывода, необязательна.

View File

@ -1,9 +1,9 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!-- $Id: fop.xconf 901793 2010-01-21 17:37:07Z jeremias $ --> <!-- $Id: fop.xconf 901793 2010-01-21 17:37:07Z jeremias $ -->
<!-- NOTE: This is the version of the configuration --> <!-- NOTE: This is the version of the configuration -->
<fop version="1.0"> <fop version="1.0">
<base>.</base> <base>.</base>
<source-resolution>72</source-resolution> <source-resolution>72</source-resolution>
<target-resolution>72</target-resolution> <target-resolution>72</target-resolution>
@ -13,42 +13,42 @@
<filterList> <filterList>
<value>flate</value> <value>flate</value>
</filterList> </filterList>
<fonts> <fonts>
<auto-detect/> <auto-detect/>
</fonts> </fonts>
</renderer> </renderer>
<renderer mime="application/x-afp"> <renderer mime="application/x-afp">
<images mode="b+w" bits-per-pixel="8"/> <images mode="b+w" bits-per-pixel="8"/>
<renderer-resolution>240</renderer-resolution> <renderer-resolution>240</renderer-resolution>
<resource-group-file>resources.afp</resource-group-file> <resource-group-file>resources.afp</resource-group-file>
</renderer> </renderer>
<renderer mime="application/postscript"> <renderer mime="application/postscript">
</renderer> </renderer>
<renderer mime="application/vnd.hp-PCL"> <renderer mime="application/vnd.hp-PCL">
</renderer> </renderer>
<renderer mime="image/svg+xml"> <renderer mime="image/svg+xml">
<format type="paginated"/> <format type="paginated"/>
<link value="true"/> <link value="true"/>
<strokeText value="false"/> <strokeText value="false"/>
</renderer> </renderer>
<renderer mime="application/awt"> <renderer mime="application/awt">
</renderer> </renderer>
<renderer mime="image/png"> <renderer mime="image/png">
</renderer> </renderer>
<renderer mime="image/tiff"> <renderer mime="image/tiff">
</renderer> </renderer>
<renderer mime="text/xml"> <renderer mime="text/xml">
</renderer> </renderer>
</renderers> </renderers>
</fop> </fop>

View File

@ -1,7 +1,7 @@
PROJECT = mkimage-profiles PROJECT = mkimage-profiles
TOPLEVEL_DOC = mkimage-profiles.asciidoc TOPLEVEL_DOC = mkimage-profiles.asciidoc
HTMLPAGE = $(TOPLEVEL_DOC:.asciidoc=.html) HTMLPAGE = $(TOPLEVEL_DOC:.asciidoc=.html)
RESOURCE_FILES = /etc/asciidoc/ RESOURCE_FILES = /etc/asciidoc
A2X = a2x A2X = a2x
@ -11,18 +11,18 @@ all: $(HTMLPAGE)
%.html: %.asciidoc %.html: %.asciidoc
$(A2X) -d book -f xhtml -a lang=ru \ $(A2X) -d book -f xhtml -a lang=ru \
--icons -r $(RESOURCE_FILES) -r ./ \ --icons -r $(RESOURCE_FILES) -r . \
--xsltproc-opts='--stringparam toc.max.depth 3' \ --xsltproc-opts='--stringparam toc.max.depth 3' \
$< $<
chunked: $(TOPLEVEL_DOC) chunked: $(TOPLEVEL_DOC)
$(A2X) -d book -f chunked -a lang=ru \ $(A2X) -d book -f chunked -a lang=ru \
--icons -r /etc/asciidoc/ -r ./ \ --icons -r $(RESOURCE_FILES) -r . \
--xsltproc-opts='--stringparam toc.max.depth 3' \ --xsltproc-opts='--stringparam toc.max.depth 3' \
$< $<
pdf: $(TOPLEVEL_DOC) pdf: $(TOPLEVEL_DOC)
$(A2X) --verbose --fop --fop-opts='-c fop.xconf' -d book -f pdf -a lang=ru \ $(A2X) --verbose --fop --fop-opts='-c .fop.xconf' -d book -f pdf -a lang=ru \
--xsltproc-opts=' \ --xsltproc-opts=' \
--stringparam toc.max.depth 3 \ --stringparam toc.max.depth 3 \
--stringparam title.font.family "Arial" \ --stringparam title.font.family "Arial" \

View File

@ -1,5 +1,4 @@
== Предположения фрагментов кода об окружении ==
*Предположения фрагментов кода об окружении*
NB: пути приводятся от верхнего уровня; проект в целом предполагает NB: пути приводятся от верхнего уровня; проект в целом предполагает
ALT Linux 6.0+ и GNU make 3.81 (на которых и разрабатывается), ALT Linux 6.0+ и GNU make 3.81 (на которых и разрабатывается),

16
doc/gen-asciidoc.txt Normal file
View File

@ -0,0 +1,16 @@
== Генерация документации ==
При желании сгенерировать PDF устанавливаем необходимые пакеты:
# apt-get install asciidoc-a2x xmlgraphics-fop fonts-ttf-dejavu
// Внимание! FOP со всем нужным весьма увесист (несколько сот мегабайт).
Для генерации текущей документации посредством ASCIIDOC выполнить по вкусу:
$ make pdf
$ make xhtml
Сгенерируются соответственно mkimage-profiles.pdf или mkimage-profiles.html
(в текущем каталоге либо BUILDDIR, если задан).
Для очистки:
$ make clean

View File

@ -1,11 +1,12 @@
= mkimage-profiles = = mkimage-profiles =
Michael Shigorin <mike@altlinux.org> Michael Shigorin <mike@altlinux.org>
:DocVersion: v0.1.0 :DocVersion: v0.2.0
:DocDate: Oct 2012 :DocDate: Oct 2012
= Введение = = Введение =
mkimage-profiles, или m-p — результат осмысления и обобщения опыта создания семейств дистрибутивов. mkimage-profiles, или m-p — результат осмысления и обобщения опыта создания
семейств дистрибутивов свободного программного обеспечения на базе ALT Linux.
*Цели* *Цели*
@ -30,45 +31,43 @@ mkimage-profiles, или m-p — результат осмысления и об
cd mkimage-profiles cd mkimage-profiles
make distro/icewm.iso make distro/icewm.iso
include::README[] include::../README[]
= Основы = = Основы =
== Предположения об окружении == include::assumptions.txt[]
include::doc/assumptions.txt[] include::debug.txt[]
include::doc/debug.txt[] include::features.txt[]
include::doc/features.txt[] include::params.txt[]
include::doc/params.txt[] include::pkglists.txt[]
include::doc/pkglists.txt[] include::qemu.txt[]
include::doc/qemu.txt[] include::style.txt[]
include::doc/style.txt[] include::vm.txt[]
include::doc/vm.txt[]
= Каталоги = = Каталоги =
include::conf.d/README[] include::../conf.d/README[]
include::features.in/README[] include::../features.in/README[]
include::image.in/README[] include::../image.in/README[]
include::lib/README[] include::../lib/README[]
include::pkg.in/README[] include::../pkg.in/README[]
include::sub.in/README[] include::../sub.in/README[]
include::sub.in/main/README[] include::../sub.in/main/README[]
include::sub.in/stage1/README[] include::../sub.in/stage1/README[]
include::sub.in/stage2/README[] include::../sub.in/stage2/README[]