Results 1 to 7 of 7

Thread: KeywordDocumenter, optional tool to document module keywords

  1. #1
    Super Moderator Petr Schreiber's Avatar
    Join Date
    Aug 2005
    Location
    Brno - Czech Republic
    Posts
    6,839
    Blog Entries
    3
    Rep Power
    697

    KeywordDocumenter, optional tool to document module keywords

    This is work in progress tool for documenting your modules.

    Its description is available in ReadMe.TXT:
    Document revision from 27-02-2011

    KeywordDocumenter.tbasic
    =========================

    Tool to help with documenting keywords, while preserving "neutral" data format, post processable to HTML or other formats.

    How to use?

    - Fill description
    - Fill syntax
    - Choose return type or add your own
    - Press "Auto fill" to get prefilled template for parameters
    - Fill other fields
    - Press "Save", it will create file named after the keyword
    - Press "Clear all" and go for other keyword


    Make_All.bat
    ============

    This batch file, as its name says, will "Make all". That means it will first ask you for information such as name, version and support website for your library, and then it will automatically generate HTML files from your previously created keyword definitions.

    Once finished with documenting, run this file to generate HTML to HTMLOutput directory.
    To compose the final CHM help file, you need to download Microsoft HTML Help Workshop

    May the tool serve you well


    Petr

    UPDATED: 27-02-2011
    Attached Thumbnails Attached Thumbnails Click image for larger version. 

Name:	KeywordDocumenter.png 
Views:	130 
Size:	30.8 KB 
ID:	7092  
    Attached Files Attached Files
    Last edited by Petr Schreiber; 27-02-2011 at 12:45.
    Learn 3D graphics with ThinBASIC, learn TBGL!
    Windows 7 64bit - Intel Core 2 Duo T6600 @ 2.2GHz - 4 GB RAM - NVIDIA GeForce G210M 512MB
    Windows 8 64bit - Intel Core i5-3350P @ 3.1GHz - 8 GB RAM - NVIDIA GeForce GT640 3GB

  2. #2

    Re: KeywordDocumenter, optional tool to document module keywords

    hello Petr
    i tryed your tool i like it good job.

    thanx for that

    Joshy
    (Sorry about my bad English.)

  3. #3
    Super Moderator Petr Schreiber's Avatar
    Join Date
    Aug 2005
    Location
    Brno - Czech Republic
    Posts
    6,839
    Blog Entries
    3
    Rep Power
    697

    Re: KeywordDocumenter, optional tool to document module keywords

    Thanks Joshy,

    it is possible it has still hardcoded some of TBGL related stuff, like copyright message inside.
    But the rest should work fine.


    Petr
    Learn 3D graphics with ThinBASIC, learn TBGL!
    Windows 7 64bit - Intel Core 2 Duo T6600 @ 2.2GHz - 4 GB RAM - NVIDIA GeForce G210M 512MB
    Windows 8 64bit - Intel Core i5-3350P @ 3.1GHz - 8 GB RAM - NVIDIA GeForce GT640 3GB

  4. #4

    Re: KeywordDocumenter, optional tool to document module keywords

    i never used the help workshop before
    must i create for every created *.html file an topic item to create a compiled *.chm file ?

    Joshy
    (Sorry about my bad English.)

  5. #5
    Super Moderator Petr Schreiber's Avatar
    Join Date
    Aug 2005
    Location
    Brno - Czech Republic
    Posts
    6,839
    Blog Entries
    3
    Rep Power
    697

    Re: KeywordDocumenter, optional tool to document module keywords

    Yes,

    but if you closely examine the structure of table of contents file, you can see it can be easily generated by script, as it is some kind of HTML. The IDE of HTML Help Workshop is very unstable, I recommend to create scripts autogenerating the TOC for you, and use the HHW just for compiling.


    Petr
    Learn 3D graphics with ThinBASIC, learn TBGL!
    Windows 7 64bit - Intel Core 2 Duo T6600 @ 2.2GHz - 4 GB RAM - NVIDIA GeForce G210M 512MB
    Windows 8 64bit - Intel Core i5-3350P @ 3.1GHz - 8 GB RAM - NVIDIA GeForce GT640 3GB

  6. #6
    Super Moderator Petr Schreiber's Avatar
    Join Date
    Aug 2005
    Location
    Brno - Czech Republic
    Posts
    6,839
    Blog Entries
    3
    Rep Power
    697
    New version uploaded,

    removed some TBGL specific parts and fixed autofill bug.


    Petr
    Learn 3D graphics with ThinBASIC, learn TBGL!
    Windows 7 64bit - Intel Core 2 Duo T6600 @ 2.2GHz - 4 GB RAM - NVIDIA GeForce G210M 512MB
    Windows 8 64bit - Intel Core i5-3350P @ 3.1GHz - 8 GB RAM - NVIDIA GeForce GT640 3GB

  7. #7
    thinBasic MVPs kryton9's Avatar
    Join Date
    Nov 2006
    Location
    Naples, Florida & Duluth, Georgia
    Age
    62
    Posts
    3,869
    Rep Power
    398
    A good idea and nice simple interface Petr. Looks good. I didn't use it but looked at the image. If I ever make a module, it will be something of great help, thanks.

Similar Threads

  1. Replies: 1
    Last Post: 21-02-2007, 01:56

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •