There are those times when it is helpful to document the contents of sub directories containing developed software. This application provides all the necessary communications to document and report any available sub directory.
To create a new entry simply click on the “+” button of the database navigator and the application will prompt you through the data entry process.
The first task it to select the sub directory.
Next the application will prompt you for short description.
The record has been inserted and the only remaining task is to enter the detailed description by clicking on the Detailed Description tab and key in the data.
Notice the sub directory and short description is displayed above so the user will not have to leave this tab to review what sub directory and short description is being documented.
Notice also that the file specification is replaced by the sub directory name. This happens because now when you click on the grid the directory is fetched and the file contents of the directory is mane available in the “View File Contents” tab.
Navigation is accomplished by invoking a popup or by double clicking on the file list box control. Below is the popup.
If you double click on the file list you get the following dialog.
Traverse the options then double click on the desired option to return to the calling application.
You may also view the contents of any file by selecting the view option.
The maintenance log is available for the documented application by clicking on the Maintenance Log tab.
To add a new maintenance item via the pop up menu. Conversely to send the copy of the documentation select that option from the pop up menu.
The structure for the associated data table is listed below.
[codesyntax lang=”sql”]
-- phpMyAdmin SQL Dump -- version 4.3.7 -- http://www.phpmyadmin.net -- -- Host: localhost -- Generation Time: Sep 18, 2015 at 05:23 PM -- Server version: 5.6.17 -- PHP Version: 5.5.12 SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO"; SET time_zone = "+00:00"; /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */; /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */; /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */; /*!40101 SET NAMES utf8 */; -- -- Database: `bcsra` -- -- -------------------------------------------------------- -- -- Table structure for table `sdoc` -- CREATE TABLE IF NOT EXISTS `sdoc` ( `id` int(11) NOT NULL, `sdes` varchar(125) NOT NULL, `sdir` varchar(255) NOT NULL, `doc` mediumtext NOT NULL ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=latin1; -- -- Indexes for dumped tables -- -- -- Indexes for table `sdoc` -- ALTER TABLE `sdoc` ADD PRIMARY KEY (`id`), ADD UNIQUE KEY `sdir` (`sdir`); -- -- AUTO_INCREMENT for dumped tables -- -- -- AUTO_INCREMENT for table `sdoc` -- ALTER TABLE `sdoc` MODIFY `id` int(11) NOT NULL AUTO_INCREMENT,AUTO_INCREMENT=3; /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */; /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */; /*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
[/codesyntax]
The structure for the associated extensions and actions table is listed below.
[codesyntax lang=”sql”]
-- phpMyAdmin SQL Dump -- version 4.3.7 -- http://www.phpmyadmin.net -- -- Host: localhost -- Generation Time: Sep 22, 2015 at 04:04 AM -- Server version: 5.6.17 -- PHP Version: 5.5.12 SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO"; SET time_zone = "+00:00"; /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */; /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */; /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */; /*!40101 SET NAMES utf8 */; -- -- Database: `bcsra` -- -- -------------------------------------------------------- -- -- Table structure for table `ext` -- CREATE TABLE IF NOT EXISTS `ext` ( `id` int(11) NOT NULL, `ext` varchar(75) NOT NULL ) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=latin1; -- -- Indexes for dumped tables -- -- -- Indexes for table `ext` -- ALTER TABLE `ext` ADD PRIMARY KEY (`id`), ADD UNIQUE KEY `ext` (`ext`); -- -- AUTO_INCREMENT for dumped tables -- -- -- AUTO_INCREMENT for table `ext` -- ALTER TABLE `ext` MODIFY `id` int(11) NOT NULL AUTO_INCREMENT,AUTO_INCREMENT=11; /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */; /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */; /*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
[/codesyntax]
A 32 bit executable program may be downloaded by clicking here.
A 64 bit executable program may be downloaded by clicking here.
The component documentation can be found by clicking here.
The source code may be found by clicking here.
Mr. Arch Brooks, Software Engineer, Brooks Computing Systems, LLC authored this article.