Short: Generates AutoDocs with MUIbase Author: muibase@rripley.de (Ralph Reuchlein) Uploader: muibase@rripley.de (Ralph Reuchlein) Version: 1.0.1 Type: biz/dbase Kurz: Erzeugt AutoDocs mit MUIbase Date: 17-Jan-2000 Requires: biz/dbase/mb_rrfuncs.lha Replaces: biz/dbase/mb_rrAutoDocs.lha MUIbase rr_AutoDocs =================== PURPOSE In the archive you can find a small database that helps creating AutoDoc files for developers of e.g. libraries. The database also generates AmigaGuide files with the same contents and links to the nodes. This package is eMailware, which means, that if you like this piece of software, you have to write me an eMail (address see end of readme). HISTORY v1.0: - public release v1.0.1: - Oops :) I made a typo at the Short: line :-) - The archive itself is unchanged. INSTALL Unpack the archive to MUIBASE: using lha x mb_rrAutoDocs.lha MUIBASE: REQUIREMENTS - OS 3.0 and higher - a registered version of MUIbase 1.3 or higher - latest version of Aminet:biz/dbase/mb_rrfuncs.lha USAGE The database has two registers. The first one contains the project settings: Project Name of project, e.g. 'exec.library' Basename Name of output file. The suffixes'.doc' and '.guide' will be added on output. Below the project settings you have two save buttons, one for AutoDocs, another for AmigaGuide®. The line below them is the status line, that will be updated during output. When writing an AmigaGuide® document, known node names with a trailing '()' were replaced as links. The second register page has the Nodes and their attached Sections. Both tables are connected hierarchical, so you only can see the sections according to the current node. The button 'order section' allowes to order the section within a node. A window with two lists appears and you have to select the two sections you want to swap. After pressing Ok, you can continue swapping until you get your prefered order. The table Sections has a listview for the section name; it just contain the most used section names. The button below the section allowes adding node names (with a trailing '()') to the content of the section. The checkbox 'allow formatting' turns on the formatting mechanism during output. You then don't need to pay attention for the border at row 77 while typing the contents. DISCLAIMER THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. MISC Suggestions and bug reports are welcome. I have some items in the TODO (look at the MUIbase program), which I intend to implement. OTHER MUIBASE PROJECTS mb_rrfuncs an ultimative include files collection, also used by this database CONTACT snail Ralph Reuchlein mail: Eibseestr. 18c 86163 Augsburg GERMANY eMail: muibase@rripley.de WWW: http://www.rripley.de IRC: RRipley on #germany Have a look to the MUIbase homepage at http://www.amigaworld.com/support/muibase/ MUIbase is © 1998-1999 Steffen Gutmann ============================= Archive contents ============================= Original Packed Ratio Date Time Name -------- ------- ----- --------- -------- ------------- 27 27 0.0% 15-Jan-00 16:05:40 +.lock 30 30 0.0% 15-Jan-00 16:05:40 +Nodes 560 230 58.9% 15-Jan-00 16:05:40 +Project 481 259 46.1% 15-Jan-00 16:05:40 +Sections 15892 4265 73.1% 15-Jan-00 16:05:40 +Structure.mb 3951 1954 50.5% 17-Jan-00 21:20:12 mb_rrAutoDocs.readme -------- ------- ----- --------- -------- 20941 6765 67.6% 20-Jan-100 22:30:00 6 files