About HMG docs

Moderator: Rathinagiri

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:

Re: About HMG docs

Post by Rathinagiri » Mon Apr 25, 2011 7:33 am

Today I have checked your work Carlos Britos.

It is really excellent and very much useful to the HMG community. Thanks a lot man!
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 25, 2011 5:42 pm

rathinagiri wrote:Today I have checked your work Carlos Britos.

It is really excellent and very much useful to the HMG community. Thanks a lot man!
Great, that's make me happy, thanks.
Regards/Saludos, Carlos (bcd12a)

User avatar
bedipritpal
Posts: 122
Joined: Thu Sep 02, 2010 10:47 pm

Post by bedipritpal » Tue Apr 26, 2011 3:35 am

Hi

May be you are onto some other type of implementation of documentation...

Harbour has the following official syntax:

/* $DOC$
* $TEMPLATE$
* Command
* $NAME$
* DATA
* $CATEGORY$
* Class
* $SUBCATEGORY$
* Data
* $ONELINER$
* Alternate syntax for VAR: instance variable for the objects.
* $SYNTAX$
* DATA <DataName1> [,<DataNameN>] [ AS <type> ] [ INIT <uValue> ]
* [[EXPORTED | VISIBLE] | [PROTECTED] | [HIDDEN]] [READONLY | RO]
* $ARGUMENTS$
* <DataName1> Name of the DATA

* <type> Optional data type specification from the following:
* Character, Numeric, Date, Logical, Codeblock, Nil.
*
* <uValue> Optional initial value when creating a new object.
*
* EXPORTED Specifies that this DATA is accessible to functions and
* methods outside of the class. VISIBLE is a synonym for EXPORTED.
*
* PROTECTED Specifies that this DATA is only accessible to functions and methods within this class and its subclasses.
*
* HIDDEN Specifies that this DATA is only accessible to the
* class where it was defined, and is not inherited by the
* subclasses.
*
* READONLY Restricts assignment to the variable. If specified with
* the EXPORTED clause, assignment is only permitted from the current
* class and its subclasses. If specified with the PROTECTED clause,
* assignment is only permitted from the current class.
* RO is a synonym for READONLY.
* $DESCRIPTION$
* DATA elements can also be thought of as the "properties" of an
* object. They can be of any data type, including codeblock.
* Once an object has been created, the DATA elements are referenced
* with the colon (:) as in MyObject:Heading := "Last name".
* Usually a class also defines methods to manipulate the DATA.
*
* You can use the "AS <type>" clause to enforce that the DATA is
* maintained as a certain type. Otherwise it will take on the type of
* whatever value is first assigned to it.
*
* Use the "INIT <uValue>" clause to initialize that DATA to <uValue>
* whenever a new object is created.
*
* VAR can be a synonym for DATA, or it can use a slightly different
* syntax for compatibility with other dialects.
* $EXAMPLES$
* CLASS TBColumn
*
* DATA Block // Code block to retrieve data for the column
* DATA Cargo // User-definable variable
* DATA ColorBlock // Code block that determines color of data items
* DATA ColSep // Column separator character
* DATA DefColor // Array of numeric indexes into the color table
* DATA Footing // Column footing
* DATA FootSep // Footing separator character
* DATA Heading // Column heading
* DATA HeadSep // Heading separator character
* DATA Width // Column display width
* DATA ColPos // Temporary column position on screen
*
* METHOD New() // Constructor
*
* ENDCLASS
* $STATUS$
* R
* $COMPLIANCE$
* H
* $PLATFORMS$
* All
* $SEEALSO$
* Object Oriented Programming,CLASS,METHOD,CLASSDATA,VAR
* $END$
*/


If you follow the above pattern then hbIDE has a really useful utility
to display them like .chm help.

Anyway it is just to update you, if you do missed it by-chance.

Pritpal Bedi
enjoy hbIDEing... Pritpal Bedi

User avatar
bedipritpal
Posts: 122
Joined: Thu Sep 02, 2010 10:47 pm

Post by bedipritpal » Tue Apr 26, 2011 3:37 am

Hi

Previous post does not showup the indentation under here.
For reference check any .txt in harbour/doc/en folder.

Pritpal Bedi
enjoy hbIDEing... Pritpal Bedi

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

Post by Carlos Britos » Wed Apr 27, 2011 12:38 am

bedipritpal wrote:May be you are onto some other type of implementation of documentation...
If you follow the above pattern then hbIDE has a really useful utility
to display them like .chm help.
Anyway it is just to update you, if you do missed it by-chance.
Hi Pritpal Bedi
HMG documentation is intended to make it so simple as possible and it's a bit different, but is strongly based on hbdoc. The most different things are, is more flexible with indentation in txt and can use more than once the same section name, which is useful for $NOTES$ , $REMARKS$, $IMAGES$, etc. Harbour does not accept duplicate sections inside the same entry. Of course by nature, hbdoc is hard-coded to harbour docs, which is logic.
By the way I made a tool (hmgdoc.exe) that can convert HMG document's to Harbour docs in a few seconds with the format and indentation of harbour docs. Then I guess is possible to use them with hbide, although I don't know how hbide handle docs.
Hmgdoc.exe was intended to build docs in the htm format like in HMG 3 and as an enhance in pdf format, (no yet).
I saw you made harupdf lib in harbour. Can you tell me if I can create a pdf file with links to all the headings (a table of contents) in the navigation pane ?
Regards/Saludos, Carlos (bcd12a)

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 May 14, 2011 5:51 pm

Below is the hmgdoc.exe. version 20110514 compressed with some small changes and bug fixed from previous one.

Unzip it in /harbour/bin/

Thanks.
Regards/Saludos, Carlos (bcd12a)

gvaronas
Posts: 109
Joined: Wed Aug 06, 2008 5:21 pm

Post by gvaronas » Sun May 15, 2011 4:39 pm

Hola Carlos, despues de generar la ayuda, en firefox no se visualiza bien, pero con el IE funciona bien.
Salu2,
GVS
Attachments
moz-screenshot-1.png
moz-screenshot-1.png (91.43 KiB) Viewed 2161 times
moz-screenshot.png
moz-screenshot.png (239.27 KiB) Viewed 2161 times

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 May 15, 2011 5:36 pm

gvaronas wrote:Hola Carlos, despues de generar la ayuda, en firefox no se visualiza bien, pero con el IE funciona bien.
Salu2,
GVS
Can you tell me which version of firefox are you using. I'm using firefox 3.53 and is ok.
I'll research to fix it.

Gracias por el aviso voy a ver como solucionarlo. Que version usas ?
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 » Mon May 16, 2011 4:31 am

I am using Firefox 4.0.1 and get the same with problem.
East or West HMG is the Best.
South or North HMG is worth.
...the possibilities are endless.

gvaronas
Posts: 109
Joined: Wed Aug 06, 2008 5:21 pm

Post by gvaronas » Mon May 16, 2011 12:33 pm

Carlos Britos wrote:
gvaronas wrote:Hola Carlos, despues de generar la ayuda, en firefox no se visualiza bien, pero con el IE funciona bien.
Salu2,
GVS
Can you tell me which version of firefox are you using. I'm using firefox 3.53 and is ok.
I'll research to fix it.

Gracias por el aviso voy a ver como solucionarlo. Que version usas ?
Uso la versión 4.0.1

Salu2,
GVS

Post Reply