Changeset 96


Ignore:
Timestamp:
Mar 3, 2010 10:26:18 AM (11 years ago)
Author:
bradbell
Message:

[cbks/trunk] Add image link from each documentation page to ckbs home page.

Lines containing a colon character are "file name" followed by comment; e.g.,
ckbs.omh: Add links to xml, htm, and printable, add Purpose.
copy_doc.sh: always run build_doc.sh.
build_doc.sh: add image link to ckbs home page.

Location:
projects/ckbs/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • projects/ckbs/trunk/build_doc.sh

    r84 r96  
    6767#
    6868# build the documentation
    69 cmd="../$dir/src/omhelp"
     69home_page="https://projects.coin-or.org/CoinBazaar/wiki/Projects/ckbs"
     70cmd="../$dir/src/omhelp ../ckbs.omh -noframe -image_link $home_page"
    7071log="../omhelp.log"
    7172for arg1 in "" -xml
     
    7374        for arg2 in -noframe -printable
    7475        do
    75                 echo "omhelp ckbs.omh $arg1 $arg2 -debug >& omhelp.log"
    76                 if ! $cmd ../ckbs.omh $arg1 $arg2 -debug >& ../omhelp.log
     76                echo "omhelp ckbs.omh $arg1 $arg2 >& omhelp.log"
     77                if ! $cmd $arg1 $arg2 -debug >& ../omhelp.log
    7778                then
    7879                        echo "build_doc.sh: omhelp error, see omhelp.log"
  • projects/ckbs/trunk/ckbs.omh

    r95 r96  
    3939%$$
    4040
    41 $section ckbs-0.20100302.0: A Constrained Kalman-Bucy Smoother$$
     41$section ckbs-0.20100303.0: A Constrained Kalman-Bucy Smoother$$
     42
     43$table
     44$cnext One web page per Section $pre $$ $cnext All as one web page
     45$rnext
     46Math in Latex  $pre $$
     47$cnext  $href%ckbs.htm%$$               $cnext $href%_printable.htm%$$
     48$rnext
     49Math in MathML $pre $$
     50$cnext $href%ckbs.xml%$$                $cnext $href%_priintable.xml%$$
     51$tend
     52
     53$head Purpose$$
     54Minimize the Kalman smoother residual sum of squares objective,
     55subject to inequality constraints,
     56for an $cref/affine/ckbs_affine/$$ or
     57general $cref/nonlinear/ckbs_nonlinear/$$ model.
    4258
    4359$head MathML$$
     
    115131$codei%
    116132        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
    117         svn checkout @web/trunk ckbs-0.20100302.0
     133        svn checkout @web/trunk ckbs-0.20100303.0
    118134%$$
    119 This will create the $code ckbs-0.20100302.0$$ directory.
     135This will create the $code ckbs-0.20100303.0$$ directory.
    120136
    121137$head Test Install$$
     
    138154be built by executing the commands
    139155$codep
    140         cd ckbs-0.20100302.0
     156        cd ckbs-0.20100303.0
    141157        ./build_doc.sh
    142158$$
    143159You can then view the documentation in your browser by opening the file
    144160$codei%
    145         ckbs-0.20100302.0/doc/ckbs.xml
     161        ckbs-0.20100303.0/doc/ckbs.xml
    146162%$$
    147163
  • projects/ckbs/trunk/copy_doc.sh

    r95 r96  
    1717sed -i ckbs.omh -e "s/ckbs-[0-9.]\{10\}/ckbs-$version/"
    1818#
    19 if [ -e doc ]
     19echo "./build_doc.sh"
     20if ! ./build_doc.sh
    2021then
    21         echo "./build_doc.sh"
    22         if ! ./build_doc.sh
    23         then
    24                 echo "copy_doc.sh: ./build_doc.sh error"
    25                 exit 1
    26         fi
     22        echo "copy_doc.sh: ./build_doc.sh error"
     23        exit 1
    2724fi
    2825#
Note: See TracChangeset for help on using the changeset viewer.