Project Technical report - Ideas

Post Reply
User avatar
Quincunxian
Posts: 63
Joined: Sunday 25th June 2017 12:14am
Location: Western Australia

Project Technical report - Ideas

Post by Quincunxian » Sunday 25th August 2019 11:28pm

Greetings all - I'm in the last phases of writing a utility to quickly view information about your Gambas projects.

I have two last objectives before I say 'It's done'

Technical report
I want to be able to create a technical summary report on any selected project.
This would have all the details from the .project file as the header with all the components used, forms, modules and user created class information.
  • I can simply print out the source code of each of these. (and that may well be enough)
  • List any image/multimedia/other files used.
  • If a configuration file is used then a copy of the existing file.
  • If a database is used then the table schemas
Is there anything else that you may find useful?

Semi-automated Help Document builder for any Gambas project.
  • The help document would be html with a css file for a simple menu system if required.
  • It can be as simple as a single page for a tiny project to multiple pages for a larger projects.
  • The builder will create all the web documents and leave a place holder for a screen shot of any form for you to add later.
  • Bookmarks can be added for any input controls on a form by form basis to provide a detailed explanations.
  • You can add 'empty' pages for other information that you want to add.
There would be some sample code to show how to quickly implement a simple help system in your application.

Is there anything else that you think should be added?

Any input would be greatly appreciated.
Cheers - Quin.
I code therefore I am

User avatar
Cedron
Posts: 100
Joined: Thursday 21st February 2019 5:02pm
Location: The Mitten State
Contact:

Re: Project Technical report - Ideas

Post by Cedron » Monday 26th August 2019 10:07pm

How about a third one? Might be a big one to pile on.

I highly recommend that you provide the ability to divert the reported information to either easily imported files (say tab delimited tables) or directly into a database (SQLite comes to mind).

This could be really useful.
.... and carry a big stick!

User avatar
Quincunxian
Posts: 63
Joined: Sunday 25th June 2017 12:14am
Location: Western Australia

Re: Project Technical report - Ideas

Post by Quincunxian » Monday 26th August 2019 10:52pm

Hi Cedron,
In the database section of the utility, you can export data from the database applied to your project
in CSV, XML & JSON formats. [Is that what you are after ? ]

It also create build scripts for a single or all selected tables.
{This allows you to rebuild your database schema from scratch}
DROP TABLE IF EXISTS 'BillingMethod';
CREATE TABLE 'BillingMethod' (
'Id' INTEGER PRIMARY KEY,
'BillingMethodName' VARCHAR(255),
'Information' TEXT,
'DateCreated' DATE,
'DateChanged' DATE,
'UserName' VARCHAR(255));
 
Create INSERT INTO scripts.
INSERT INTO BillingMethod(
Id,
BillingMethodName,
Information,
DateCreated,
DateChanged,
UserName,
)
 VALUES(
Id,
'BillingMethodName'
'Information'
DateCreated,
DateChanged,
'UserName'
)

--Replace field names in the Value area with the actual value variables
It will also create general gambas code for : Declaration, Read & Write as per this example below.
'------------Declaration------------
Public Id As Integer
Public BillingMethodName As String
Public Information As String
Public DateCreated As Date
Public DateChanged As Date
Public UserName As String
'------------Read-------------------
Id = $Rec!Id
BillingMethodName = $Rec!BillingMethodName
Information = $Rec!Information
DateCreated = $Rec!DateCreated
DateChanged = $Rec!DateChanged
UserName = $Rec!UserName
'------------Write-------------------
$Rec!Id = Id
$Rec!BillingMethodName = BillingMethodName
$Rec!Information = Information
$Rec!DateCreated = DateCreated
$Rec!DateChanged = DateChanged
$Rec!UserName = UserName
If I did not understand the question/request correctly - let me know.

Cheers mate.

Post Reply