About HMG docs

Moderator: Rathinagiri

Carlos Britos
Posts: 220
Joined: Sat Aug 02, 2008 5:03 pm
Has thanked: 6 times
Been thanked: 2 times

About HMG docs

Post by Carlos Britos » Sat Apr 16, 2011 5:16 pm

Hi:
I've made some test with hmg documents, based on that we discuss in
the message http://hmgforum.com/viewtopic.php?f=32&t=1897&start=30.

I've made a tool to produce htm documents from txt. Is very similar
than hbdoc, just with small changes to make it more flexible to fit with our needs.
It's not finished, I want to produce pdf documents with this tool,
but I don't know how to build the tree in a pdf doc. (if someone know it, please let me know)
Before spend more time on this tool, I want to know if we continue with hmg docs as we discuss in
previous message.
If the answer is yes, then:

HbDoc is strict with indentation, which cause some troubles with viewers if the doc is not ok.
As you know harbour use docs with this format:
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* __setcentury()
* $CATEGORY$
* API
* $ONELINER$
* Set the Current Century
...
* $END$
*/

Instead of this we can use docs as below.
We don't need C-style tags comments, /* * */ in txt docs.
Indentation is almost free.
BTW HMGdoc builder can read and write docs in harbour format, but I think is easier in this way.
It's possible to use the same section name several times in one document. f.e. $REMARKS$
We have to discuss about section names, but is possible expand them or reduce them.
Sections suggested by Esgici were added. $NOTES$, $HINTS$, $SEE ALSO$, $SOURCE$, $SAMPLES$, and others, read more about this in the htm.

$DOC$

$NAME$
Button

$CATEGORY$
Control

$ONELINER$
button gui object ...

...

$END$

Below there is a package to test this.
This package is to see more clear about what I'm talking about.
Please unzip it in ../hmg.4/svn/doc/
There you'll find some few source txt files, the output in htm format and the exe tool to make test.

I'll wait for your feedback.
Regards/Saludos, Carlos (bcd12a)

User avatar
esgici
Posts: 4513
Joined: Wed Jul 30, 2008 9:17 pm
DBs Used: DBF
Location: iskenderun / Turkiye
Has thanked: 389 times
Been thanked: 111 times
Contact:

Post by esgici » Sat Apr 16, 2011 7:06 pm

Carlos Britos wrote: I've made some test with hmg documents, ...
Very well, Carlos; thanks a lot :)
I've made a tool to produce htm documents from txt. Is very similar
than hbdoc, just with small changes to make it more flexible to fit with our needs.
Yet another very well news, thanks separately :)
Sections suggested by Esgici were added ...
One more thanks for this also :)
I'll wait for your feedback.
Please don't wait much, only continue please ;)

Saludos cordiales and muchas gracias.

--

Esgici
Viva INTERNATIONAL HMG :D

User avatar
Rathinagiri
Posts: 5263
Joined: Tue Jul 29, 2008 6:30 pm
DBs Used: MariaDB, SQLite, SQLCipher and MySQL
Location: Sivakasi, India
Has thanked: 169 times
Been thanked: 172 times
Contact:

Post by Rathinagiri » Sat Apr 16, 2011 7:55 pm

What a great job and contribution!
East or West HMG is the Best.
South or North HMG is worth.
...the possibilities are endless.

Carlos Britos
Posts: 220
Joined: Sat Aug 02, 2008 5:03 pm
Has thanked: 6 times
Been thanked: 2 times

Post by Carlos Britos » Mon Apr 18, 2011 11:31 pm

Thanks Rathinagiri, Esgici.

Rathinagiri if you are agree, I can start to create txt from hmg3 docs and commit them. Of course they must be updated later. What you think about this?
Regards/Saludos, Carlos (bcd12a)

User avatar
Rathinagiri
Posts: 5263
Joined: Tue Jul 29, 2008 6:30 pm
DBs Used: MariaDB, SQLite, SQLCipher and MySQL
Location: Sivakasi, India
Has thanked: 169 times
Been thanked: 172 times
Contact:

Post by Rathinagiri » Fri Apr 22, 2011 7:49 pm

Yes please. You can do it as early as possible.

Thanks a lot.
East or West HMG is the Best.
South or North HMG is worth.
...the possibilities are endless.

Carlos Britos
Posts: 220
Joined: Sat Aug 02, 2008 5:03 pm
Has thanked: 6 times
Been thanked: 2 times

Post by Carlos Britos » Sat Apr 23, 2011 5:41 pm

2011-04-23 14:34 UTC-0300 Carlos Britos ( <bcd12a(a_t)yahoo.com.ar> )

60 txt files were added to HMG SVN, to build HMG docs. Still missing more.
At this moment these documents are just a very rough draft.
Feel free to edit/add as much as you like to these and new txt files.
Most files are blank or copy paste from HMG3, so must be edited.
If you don't know enough to contribute just fill them with that you know.
Don't be afraid about your mistakes. Another contributor will clean up after you.
If your english is not perfect is not a problem. Most of the users and developers are not native english speakers.
Others who know better english (as you see, not me) will edit the txt files.

Hoping this could be usefull for all of us, I encourage you to edit and/or commit txt.

If you think the estructure of docs need changes, please post it here, in this topic.

If you need it, below is the hmgdoc.exe. version 20110422 compressed with some small changes from previous one.
Regards/Saludos, Carlos (bcd12a)

User avatar
esgici
Posts: 4513
Joined: Wed Jul 30, 2008 9:17 pm
DBs Used: DBF
Location: iskenderun / Turkiye
Has thanked: 389 times
Been thanked: 111 times
Contact:

Post by esgici » Sat Apr 23, 2011 6:55 pm

Carlos Britos wrote: 60 txt files were added to HMG SVN, to build HMG docs.
Thanks a lot Carlos :)

Saludos / Regards

--

Esgici
Viva INTERNATIONAL HMG :D

Carlos Britos
Posts: 220
Joined: Sat Aug 02, 2008 5:03 pm
Has thanked: 6 times
Been thanked: 2 times

Post by Carlos Britos » Sat Apr 23, 2011 9:36 pm

I forgot to say, unzip hmgdoc.zip in ../harbour/bin/
Regards/Saludos, Carlos (bcd12a)

User avatar
Rathinagiri
Posts: 5263
Joined: Tue Jul 29, 2008 6:30 pm
DBs Used: MariaDB, SQLite, SQLCipher and MySQL
Location: Sivakasi, India
Has thanked: 169 times
Been thanked: 172 times
Contact:

Post by Rathinagiri » Sun Apr 24, 2011 1:38 am

Thanks a lot. I will check this out.
East or West HMG is the Best.
South or North HMG is worth.
...the possibilities are endless.

Carlos Britos
Posts: 220
Joined: Sat Aug 02, 2008 5:03 pm
Has thanked: 6 times
Been thanked: 2 times

Post by Carlos Britos » Sun Apr 24, 2011 1:30 pm

Images used by docs at this time. Unzip it in /doc/res/
Attachments
doc_img.zip
(350.32 KiB) Downloaded 80 times
Regards/Saludos, Carlos (bcd12a)

Post Reply