PureHELP Maker : fast help builder for userlibraries

All PureFORM, JaPBe, Libs and useful code maintained by gnozal

Moderator: gnozal

ABBKlaus
Addict
Addict
Posts: 1143
Joined: Sat Apr 10, 2004 1:20 pm
Location: Germany

Post by ABBKlaus »

Hi Gnozal,

i have another request :twisted:

sorting of Topics (without the user topics/Index/License ?)

Regards Klaus
User avatar
NoahPhense
Addict
Addict
Posts: 1999
Joined: Thu Oct 16, 2003 8:30 pm
Location: North Florida

Post by NoahPhense »

Flype wrote:thank a lot gnozal. that's a great tool.
yeah it is.. nice work

- np
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Post by gnozal »

ABBKlaus wrote:Hi Gnozal,

i have another request :twisted:

sorting of Topics (without the user topics/Index/License ?)

Regards Klaus
You mean sort the functions ? A manual sort is already possible : you can move a function topic up/down with the [up]/[down] keys. The order is not changed when you update the library, the new functions will be added at the end of the functions list. So you only have to do it once.
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
User avatar
eddy
Addict
Addict
Posts: 1479
Joined: Mon May 26, 2003 3:07 pm
Location: Nantes

Post by eddy »

hi,

I have some feature request :o

1 - Can you add a splitterbar to resize Example / Description sections ?
( or a tabber to switch between Example / Description sections )
2 - color tag :
<pb></pb> -----> #006666
<const></const> -----> #924B72

Actually I use CSS hack :

Code: Select all

<style type='text/css'>u { color:#924B72;text-decoration:none }; i { color:#009999;text-decoration:none;font-style:normal }</style>
Imagewin10 x64 5.72 | IDE | PB plugin | Tools | Sprite | JSON | visual tool
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Post by gnozal »

Update

Changes :
- updated PB folder detection for PB4.10 beta 4
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
maadjordan
New User
New User
Posts: 2
Joined: Tue Oct 09, 2007 8:00 am

Post by maadjordan »

"gnozal" did you read my post at end here
http://www.purebasic.fr/english/viewtop ... c&start=15

at is a way i use to reduce CHM file size..

i'd like to hear your view :D

for example i've tested my techniques to your CHM file inside purehelp zip file and i reached

PureHELPMaker.chm
original reduced %
105,406 bytes 40,550 bytes 38.47

you can get it here and test it yourself

http://rapidshare.com/files/65709279/pu ... r.zip.html
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Post by gnozal »

maadjordan wrote:"gnozal" did you read my post at end here
http://www.purebasic.fr/english/viewtop ... c&start=15

at is a way i use to reduce CHM file size..

i'd like to hear your view :D
My opinion : your post is interesting, but :
maadjordan wrote:1- optimize HTML by removing comments and other non-viewable ref.
PureHelpMaker does not generate any comments or non-viewable html code
maadjordan wrote:2- optimize GIF files with Trout's GIF Optmizer.
3- optimize PNG files with optipng,advpng,advdef,pngout,deflopt
4- optimize jpeg files with "jpegoptim"
It's your responsability to add optimized images to the help file, PureHelpMaker does not (and probably never will) do any image optimization.
Remember it's just a tool to easily create help files for user libraries, nothing more.
If you want more features, have a look at Vizacc : http://www.vizacc.com/

Update

Changes :
- minor UI fixes
- PureHelpMaker now remembers the last project directory
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Re: PureHELP Maker : fast help builder for userlibraries

Post by gnozal »

Update (version 1.03)

Changes :
- new icon
- new feature : you may now add a user index (right-click on topic list, like for a user topic)
Thanks LSI (french forum) for this feature (and the icon :D).
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
User avatar
Le Soldat Inconnu
Enthusiast
Enthusiast
Posts: 306
Joined: Wed Jul 09, 2003 11:33 am
Location: France

Re: PureHELP Maker : fast help builder for userlibraries

Post by Le Soldat Inconnu »

I Add this changes too :D
- Correction of HTML code generated
- Correction of some small bugs (like add extension automatically on save)
LSI
User avatar
Le Soldat Inconnu
Enthusiast
Enthusiast
Posts: 306
Joined: Wed Jul 09, 2003 11:33 am
Location: France

Re: PureHELP Maker : fast help builder for userlibraries

Post by Le Soldat Inconnu »

Gnozal, i do small mistake

before

Code: Select all

Procedure.l CreateFunctionHelpFile(Filename.s)
  Protected Description.s, Example.s, Overview.s, Stream.l, ReturnValue.l, ListIconText.s, UserIndexOpen.l
  Stream = CreateFile(#PB_Any, Filename)
  If Stream
    Overview = HTMLHelpFiles()\SyntaxOrOverview
    Description = HTMLHelpFiles()\Description
    Example = HTMLHelpFiles()\Example
    WriteStringN("<html><head><title>" + HTMLHelpFiles()\PageTitle + "</title><meta name= " + #g + "GENERATOR" + #g + "content=" + #g + "PureHELP Maker (c) gnozal" + #g + "></HEAD>")
    WriteStringN("<body bgcolor=" + #g + "#FFFFDF" + #g + " link=" + #g + "#009999" + #g + " vlink=" + #g + "#006666" + #g + " alink=" + #g + "#006666" + #g + ">")
    WriteStringN("<font face=" + #g + "Arial" + #g + " size=" + #g + "2" + #g + "><p align=" + #g + "center" + #g + "><b><font size=" + #g + "4" + #g + ">" + HTMLHelpFiles()\PageTitle + " </Font></b></p>")
    If HTMLHelpFiles()\UserPage
      WriteStringN("<blockquote><font face=" + #g + "Arial" + #g + "size=" + #g + "2" + #g + ">")
      Description = ReplaceString(Description, #CRLF, "<br>" + #CRLF)
      WriteStringN(Description)
      WriteStringN("</font></blockquote>")
    ElseIf HTMLHelpFiles()\UserIndex
      If Overview
        WriteStringN("<p><b>"+ Language_Overview + "</b></p>")
        Overview = ReplaceString(Overview, #CRLF, "<br>" + #CRLF)
        WriteStringN(Overview)
        WriteStringN("<Font></blockquote>")
      EndIf
on last WriteStringN("<Font></blockquote>"), there is <Font> and you have to remove it

after

Code: Select all

Procedure.l CreateFunctionHelpFile(Filename.s)
  Protected Description.s, Example.s, Overview.s, Stream.l, ReturnValue.l, ListIconText.s, UserIndexOpen.l
  Stream = CreateFile(#PB_Any, Filename)
  If Stream
    Overview = HTMLHelpFiles()\SyntaxOrOverview
    Description = HTMLHelpFiles()\Description
    Example = HTMLHelpFiles()\Example
    WriteStringN("<html><head><title>" + HTMLHelpFiles()\PageTitle + "</title><meta name= " + #g + "GENERATOR" + #g + "content=" + #g + "PureHELP Maker (c) gnozal" + #g + "></HEAD>")
    WriteStringN("<body bgcolor=" + #g + "#FFFFDF" + #g + " link=" + #g + "#009999" + #g + " vlink=" + #g + "#006666" + #g + " alink=" + #g + "#006666" + #g + ">")
    WriteStringN("<font face=" + #g + "Arial" + #g + " size=" + #g + "2" + #g + "><p align=" + #g + "center" + #g + "><b><font size=" + #g + "4" + #g + ">" + HTMLHelpFiles()\PageTitle + " </Font></b></p>")
    If HTMLHelpFiles()\UserPage
      WriteStringN("<blockquote><font face=" + #g + "Arial" + #g + "size=" + #g + "2" + #g + ">")
      Description = ReplaceString(Description, #CRLF, "<br>" + #CRLF)
      WriteStringN(Description)
      WriteStringN("</font></blockquote>")
    ElseIf HTMLHelpFiles()\UserIndex
      If Overview
        WriteStringN("<p><b>"+ Language_Overview + "</b></p>")
        Overview = ReplaceString(Overview, #CRLF, "<br>" + #CRLF)
        WriteStringN(Overview)
        WriteStringN("</blockquote>")
      EndIf
Sorry :)
LSI
User avatar
Le Soldat Inconnu
Enthusiast
Enthusiast
Posts: 306
Joined: Wed Jul 09, 2003 11:33 am
Location: France

Re: PureHELP Maker : fast help builder for userlibraries

Post by Le Soldat Inconnu »

and again one on line 946, i had system to add link on function but i forgot to add () after function name to search function.

en gros, j'ai zappé les () lors de la recherche des noms de fonction et du coup avec des fonctions du style CreateSkinWindow et CreateSkinWindowError, ça ne marche pas car je détecte CreateSkinWindow dans CreateSkinWindowError

Code: Select all

Description = ReplaceString(Description, HTMLHelpFiles()\FunctionName + "()", "<a href=" + #g + HTMLHelpFiles()\FunctionName + ".html" + #g + ">" + HTMLHelpFiles()\FunctionName + "()</a>")
LSI
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Re: PureHELP Maker : fast help builder for userlibraries

Post by gnozal »

Le Soldat Inconnu wrote:and again one on line 946, i had system to add link on function but i forgot to add () after function name to search function.

en gros, j'ai zappé les () lors de la recherche des noms de fonction et du coup avec des fonctions du style CreateSkinWindow et CreateSkinWindowError, ça ne marche pas car je détecte CreateSkinWindow dans CreateSkinWindowError

Code: Select all

Description = ReplaceString(Description, HTMLHelpFiles()\FunctionName + "()", "<a href=" + #g + HTMLHelpFiles()\FunctionName + ".html" + #g + ">" + HTMLHelpFiles()\FunctionName + "()</a>")
Il me semble l'avoir corrigé dans la version disponible sur mon site ?
(I think it's already fixed ?)
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
User avatar
Le Soldat Inconnu
Enthusiast
Enthusiast
Posts: 306
Joined: Wed Jul 09, 2003 11:33 am
Location: France

Re: PureHELP Maker : fast help builder for userlibraries

Post by Le Soldat Inconnu »

Aucune idée, je tourne la version que j'ai compilé :mrgreen:

Et pour le </Font> en trop ?
LSI
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Re: PureHELP Maker : fast help builder for userlibraries

Post by gnozal »

Le Soldat Inconnu wrote:Aucune idée, je tourne la version que j'ai compilé :mrgreen:
Et pour le </Font> en trop ?
Je ne me souviens plus trop... Je n'ai pas le code sous la main.
J'ai fait quelques modifications dans la source avant de la compiler.

Et j'ai recompilé quelques CHM sans problèmes.
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
gnozal
PureBasic Expert
PureBasic Expert
Posts: 4229
Joined: Sat Apr 26, 2003 8:27 am
Location: Strasbourg / France
Contact:

Re: PureHELP Maker : fast help builder for userlibraries

Post by gnozal »

Update (version 1.04)

Changes :
- some minor bug fixes
- added 'multi-library' support
  For example, PureCOLOR has 3 libs : PureCOLOR, PureCOLOR-Buttons, PureCOLOR-Menu.
  Simply select 'PureCOLOR', PureHELP Maker will detect the other two libraries to generate a unique help file.
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
Post Reply