Re: Documentation for module developers

2006-07-31 Thread Viktor Griph

On Sun, 30 Jul 2006, Thomas Adam wrote:


On Mon, 31 Jul 2006 00:19:51 +0400
Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:


On Sun, Jul 30, 2006 at 06:02:51PM +0100, Thomas Adam wrote:

On Sun, 30 Jul 2006 14:40:50 +0400
Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:


  Hi,

Are http://www.fvwm.org/documentation/dev_modules.php is the only module
related documentation available? BTW, I found an error on this page: in
section 'Colorset support' InitPictureCMap() should be PictureInitCMap()
instead (this function  was renamed on 2002-04-22 according to main
ChangeLog).


Other than that minor fix, was there some specific information not listed
on that page you were after?


Yes. I want full FVWM API description. For example, FScreenInit,
FRenderInit and many other functions used in modules aren't described
there. Tutorials are also welcome. Of course I can figure out all
missing details by reading source code, but this cost time.



Currently there isn't any such documentation about those.  Do what you can
by reading the source code and sporadic comments therein where applicable.
This is all I do.  If you feel like documenting it yourself as you go, that
too would be good.  :)

-- Thomas Adam




There is '[C]Modules from scratch'[1] which gives a quick introduction to 
the module communication, but it's not using the fvwm libs.


There is however one thing in there that is worth noting, either as a bug 
in the module communication or in the documentation:


 | Basically you have to send the command NOP FINISHED STARTUP to FVWM
 | before it will start talking to your module. This isn't mentioned
 | anywhere on the module page, and is barely eluded to in the fvwm man
 | page.

/Viktor

[1] http://fvwm.lair.be/viewtopic.php?t=260



Documentation for module developers

2006-07-30 Thread Serge (gentoosiast) Koksharov
  Hi,

Are http://www.fvwm.org/documentation/dev_modules.php is the only module
related documentation available? BTW, I found an error on this page: in
section 'Colorset support' InitPictureCMap() should be PictureInitCMap()
instead (this function  was renamed on 2002-04-22 according to main
ChangeLog).

Best wishes

-- 
Serge Koksharov, Free Software user  supporter
GPG public key ID: 0x3D330896 (pgp.mit.edu)
Key fingerprint: 5BC4 0475 CB03 6A31 0076  82C2 C240 72F0 3D33 0896


pgprWsnL0uNTe.pgp
Description: PGP signature


Re: Documentation for module developers

2006-07-30 Thread Thomas Adam
On Sun, 30 Jul 2006 14:40:50 +0400
Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:

   Hi,
 
 Are http://www.fvwm.org/documentation/dev_modules.php is the only module
 related documentation available? BTW, I found an error on this page: in
 section 'Colorset support' InitPictureCMap() should be PictureInitCMap()
 instead (this function  was renamed on 2002-04-22 according to main
 ChangeLog).

Other than that minor fix, was there some specific information not listed on
that page you were after?

-- Thomas Adam

-- 
ThisWindow (thomas_adam) Destroy



Re: Documentation for module developers

2006-07-30 Thread Serge (gentoosiast) Koksharov
On Sun, Jul 30, 2006 at 06:02:51PM +0100, Thomas Adam wrote:
 On Sun, 30 Jul 2006 14:40:50 +0400
 Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:
 
Hi,
  
  Are http://www.fvwm.org/documentation/dev_modules.php is the only module
  related documentation available? BTW, I found an error on this page: in
  section 'Colorset support' InitPictureCMap() should be PictureInitCMap()
  instead (this function  was renamed on 2002-04-22 according to main
  ChangeLog).
 
 Other than that minor fix, was there some specific information not listed on
 that page you were after?

Yes. I want full FVWM API description. For example, FScreenInit,
FRenderInit and many other functions used in modules aren't described
there. Tutorials are also welcome. Of course I can figure out all
missing details by reading source code, but this cost time.

-- 
Serge Koksharov, Free Software user  supporter
GPG public key ID: 0x3D330896 (pgp.mit.edu)
Key fingerprint: 5BC4 0475 CB03 6A31 0076  82C2 C240 72F0 3D33 0896


pgpkCHn5AuzdO.pgp
Description: PGP signature


Re: Documentation for module developers

2006-07-30 Thread Thomas Adam
On Mon, 31 Jul 2006 00:19:51 +0400
Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:

 On Sun, Jul 30, 2006 at 06:02:51PM +0100, Thomas Adam wrote:
  On Sun, 30 Jul 2006 14:40:50 +0400
  Serge (gentoosiast) Koksharov [EMAIL PROTECTED] wrote:
  
 Hi,
   
   Are http://www.fvwm.org/documentation/dev_modules.php is the only module
   related documentation available? BTW, I found an error on this page: in
   section 'Colorset support' InitPictureCMap() should be PictureInitCMap()
   instead (this function  was renamed on 2002-04-22 according to main
   ChangeLog).
  
  Other than that minor fix, was there some specific information not listed
  on that page you were after?
 
 Yes. I want full FVWM API description. For example, FScreenInit,
 FRenderInit and many other functions used in modules aren't described
 there. Tutorials are also welcome. Of course I can figure out all
 missing details by reading source code, but this cost time.


Currently there isn't any such documentation about those.  Do what you can
by reading the source code and sporadic comments therein where applicable.
This is all I do.  If you feel like documenting it yourself as you go, that
too would be good.  :)

-- Thomas Adam

-- 
ThisWindow (thomas_adam) Destroy