Index: Makefile.in =================================================================== diff -u -rfc514e34230f1e3a77801e6283697f92b3b3b674 -r737566422019b19eddca6e2ab1758019cad02633 --- Makefile.in (.../Makefile.in) (revision fc514e34230f1e3a77801e6283697f92b3b3b674) +++ Makefile.in (.../Makefile.in) (revision 737566422019b19eddca6e2ab1758019cad02633) @@ -294,13 +294,15 @@ libraries-pkgindex: pkgIndex.tcl $(TCLSH) $(src_lib_dir_native)/lib/mkIndex.tcl -dir $(src_lib_dir_native) + + full-doc: doc pdf example-doc # use language reference as sample file to trigger generation of documentation files #doc: $(xotcl_target_doc_dir)/langRef-xotcl.html # for now, just the two doc files -doc: +doc: man (cd $(src_doc_dir); asciidoc next-migration.txt) (cd $(src_doc_dir)/next-tutorial; asciidoc next-tutorial.txt) pdfdoc: @@ -321,6 +323,29 @@ -(cd $(src_doc_dir); htmldoc --webpage --format pdf14 \ -f langRef-xotcl.pdf langRef-xotcl.html ) +NX_MAN = \ + $(src_doc_dir)/Object.man \ + $(src_doc_dir)/Class.man \ + $(src_doc_dir)/configure.man \ + $(src_doc_dir)/current.man \ + $(src_doc_dir)/next.man + +man : man-html man-nroff + +man-html : $(NX_MAN) + @for m in $(^F) ; do \ + echo " Generating html manpage from $$m" ; \ + (cd $(src_doc_dir); dtplite -style man.css -o . html $$m) ; \ + done; + +man-nroff : $(NX_MAN) + @for m in $(^F) ; do \ + echo " Generating nroff manpage from $$m" ; \ + (cd $(src_doc_dir); dtplite -ext n -o . nroff $$m) ; \ + done; + + + install: install-binaries install-shells install-libraries install-doc install-xotcl-shells install-xotcl-libraries @if test ! "x$(subdirs)" = "x" ; then dirs="$(subdirs)" ; \ for dir in $$dirs ; do \ Index: doc/Class.man =================================================================== diff -u -r75646435653428116a115935d771ba86e524011d -r737566422019b19eddca6e2ab1758019cad02633 --- doc/Class.man (.../Class.man) (revision 75646435653428116a115935d771ba86e524011d) +++ doc/Class.man (.../Class.man) (revision 737566422019b19eddca6e2ab1758019cad02633) @@ -16,7 +16,7 @@ [vset MODIFIER ""] [copyright {2014 Stefan Sobernig , Gustaf Neumann }] -[titledesc {nx::Class API Reference}] +[titledesc {API reference of the base-metaclass of the NX objectsystem}] [description] [para] Index: doc/Object.man =================================================================== diff -u -r6ad661853e90c87a9c1cf1a950c2e0b6564fe373 -r737566422019b19eddca6e2ab1758019cad02633 --- doc/Object.man (.../Object.man) (revision 6ad661853e90c87a9c1cf1a950c2e0b6564fe373) +++ doc/Object.man (.../Object.man) (revision 737566422019b19eddca6e2ab1758019cad02633) @@ -1,6 +1,9 @@ [comment {-*- tcl -*- nx::Object manpage}] [manpage_begin nx::Object n 2.0b6] +[comment {For the time being, we do not render keywords and the corresponding reverse index}] +[proc keywords args {}] + [keywords baseclass] [keywords NX] [keywords "mixin class"] @@ -14,15 +17,15 @@ [vset MODIFIER "object"] [copyright {2014 Stefan Sobernig , Gustaf Neumann }] -[titledesc {API Reference of the base class in the NX object system}] +[titledesc {API reference of the base class in the NX object system}] [description] [para] -[syscmd nx::Object] is the [term baseclass] of the [term NX] object system. All +[syscmd nx::Object] is the [term "base class"] of the [term NX] object system. All objects defined in [term NX] are (direct or indirect) instances of this -[term baseclass]. The methods provided by the [syscmd nx::Object] -[term baseclass] are available to all objects and to all classes defined in +[term "base class"]. The methods provided by the [syscmd nx::Object] +[term "base class"] are available to all objects and to all classes defined in NX. [example { @@ -40,23 +43,23 @@ of | | | +-----+-----+ subclass of | | instance | |.....................| | of - | cls | (by default) | + | /cls/ | (by default) | | | | +-----------+ | ^ | instance |.............(xor)..............| of | +-----------+ | |.........| |..........| - | obj | + | /obj/ | | | +-----------+ }] [term NX] allows for creating and for using objects (e.g. [emph obj]) which are -instantiated from the [term baseclass] [cmd nx::Object] +instantiated from the [term "base class"] [cmd nx::Object] directly. Typical use cases are singeltons and anonymous, inline objects. In such use cases, [term NX] does not require creating an -intermediate application class (e.g. [emph cls]), which specializes the [term baseclass] +intermediate application class (e.g. [emph cls]), which specializes the [term "base class"] [cmd nx::Object] by default, beforehand. [para] @@ -74,8 +77,8 @@ [para] -To create a direct instance of [cmd nx::Object] having an explicit -[arg objectName], use [method create] on [cmd nx::Object]. Note that +To create a direct instance of [cmd nx::Object] having an explicit name +[arg obj], use [method create] on [cmd nx::Object]. Note that [method create] is defined by [cmd nx::Class] and is available to [cmd nx::Object] being an instance of [cmd nx::Class]. This way, singelton objects can be created, for example.