diff -r 630ddf983154 -r 45eecfa64492 doc/interpreter/package.txi --- a/doc/interpreter/package.txi Tue Feb 19 12:27:23 2008 +0000 +++ b/doc/interpreter/package.txi Tue Feb 19 12:47:21 2008 +0000 @@ -449,6 +449,46 @@ Category Name 2 function2 function5 @end example +If you wish to refer to a function that users might expect +to find in your package but is not there, providing a work around or +ponting out that the function is available elsewhere, you can use: address@hidden +fn = workaround description address@hidden example +This workaround description will not appear when listing functions in the +package with @code{pkg describe} but they will be published +in the html documentation online. +Workaround descriptions can use any html markup, but +keep in mind that it will be enclosed in a bold-italic environment. +For the special case of: address@hidden +fn = use alternate expression address@hidden example +the bold-italic is automatically suppressed. You will need +to use @code{} even in references: address@hidden +fn = use fn address@hidden example +Sometimes functions are only partially compatible, in which +case you can list the non-compatible cases separately. To +refer to another function in the package, use @code{fn}. +E.g., address@hidden +eig(A,B) = use qz address@hidden example +Since sites may have many missing functions, you can define +a macro rather than typing the same link over and again. address@hidden +$id = expansion address@hidden example +defines the macro id. You can use @code{$id} anywhere in the +description and it will be expanded. E.g., address@hidden +$TSA = see SPC Tools +arcov = $TSA armcv address@hidden example +id is any string of letters, numbers and @code{_}. + @node PKG_ADD and PKG_DEL directives @subsection PKG_ADD and PKG_DEL directives