Re: [fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-15 Thread Marco van de Voort
In our previous episode, Andrew Haines said:
> I realized that I didn't add the option --make-searchable to the 
> available options when --help is used.

Btw, a while back I made a wiki page for the pkg, see if you have time to
update it with the recent changes:

http://wiki.freepascal.org/chm
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel


Re: [fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-14 Thread Andrew Haines

Michael Van Canneyt wrote:

On Fri, 14 Nov 2008, Andrew Haines wrote:

  

hi attached is a patch to add the option --make-searchable to fpdoc for the
chm target

It can take some time to index all the documents in the rtl for example.



Applied, and merged to fixes, so it gets included in 2.2.4

Can you write a small paragraph for the docs about it ?

  

Hi,

I realized that I didn't add the option --make-searchable to the 
available options when --help is used.


Thanks,

Andrew
Index: dw_htmlchm.inc
===
--- dw_htmlchm.inc  (revision 12090)
+++ dw_htmlchm.inc  (working copy)
@@ -518,6 +518,8 @@
   List.Add(SCHMUsageAutoIDX);
   List.add('--auto-toc');
   List.Add(SCHMUsageAutoTOC);
+  List.add('--make-searchable');
+  List.Add(SCHMUsageMakeSearch);
 end;
 
 
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel


Re: [fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-14 Thread Michael Van Canneyt


On Fri, 14 Nov 2008, Andrew Haines wrote:

> Michael Van Canneyt wrote:
> > On Fri, 14 Nov 2008, Andrew Haines wrote:
> >
> >   
> > > hi attached is a patch to add the option --make-searchable to fpdoc for
> > > the
> > > chm target
> > >
> > > It can take some time to index all the documents in the rtl for example.
> > > 
> >
> > Applied, and merged to fixes, so it gets included in 2.2.4
> >
> > Can you write a small paragraph for the docs about it ?
> >
> > Michael.
> > ___
> >   
> Here you go. I had already written it but not sent it since I couldn't get the
> html docs to compile. I installed a dvi viewer and checked it that way.

Thank you. Applied.

I also documented the new image support.

Michael. 
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel


Re: [fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-14 Thread Andrew Haines

Michael Van Canneyt wrote:

On Fri, 14 Nov 2008, Andrew Haines wrote:

  

hi attached is a patch to add the option --make-searchable to fpdoc for the
chm target

It can take some time to index all the documents in the rtl for example.



Applied, and merged to fixes, so it gets included in 2.2.4

Can you write a small paragraph for the docs about it ?

Michael.
___
  
Here you go. I had already written it but not sent it since I couldn't 
get the html docs to compile. I installed a dvi viewer and checked it 
that way.


Regards,

Andrew
Index: fpdoc.tex
===
--- fpdoc.tex   (revision 474)
+++ fpdoc.tex   (working copy)
@@ -507,6 +507,12 @@
 implemented. By default, syntax highlighting is provided by the syntax
 package that comes with \fpc.
 
+% make-searchable
+\subsection{make-searchable}
+This option generates an index of all the *.htm* files added in the chm, 
+including files added with the --other-files option so that a full text search
+is possible. This option only applies to the chm backend.
+
 % other-files
 \subsection{other-files}
 \label{suse:other-files}
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel


Re: [fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-14 Thread Michael Van Canneyt


On Fri, 14 Nov 2008, Andrew Haines wrote:

> hi attached is a patch to add the option --make-searchable to fpdoc for the
> chm target
> 
> It can take some time to index all the documents in the rtl for example.

Applied, and merged to fixes, so it gets included in 2.2.4

Can you write a small paragraph for the docs about it ?

Michael.
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel


[fpc-devel] [PATCH] for chm search ability for fpdoc

2008-11-13 Thread Andrew Haines
hi attached is a patch to add the option --make-searchable to fpdoc for 
the chm target


It can take some time to index all the documents in the rtl for example.

Regards,

Andrew

Index: dw_htmlchm.inc
===
--- dw_htmlchm.inc  (revision 11973)
+++ dw_htmlchm.inc  (working copy)
@@ -14,6 +14,7 @@
 FIndexName,
 FDefaultPage: String;
 FCSSFile: String;
+FMakeSearchable,
 FAutoTOC,
 FAutoIndex: Boolean;
 FOtherFiles: String;
@@ -60,6 +61,8 @@
 FChm.FilesToCompress.LoadFromFile(FOtherFiles);
   end;
 
+  FChm.FullTextSearch := FMakeSearchable;
+
 end;
 
 function TCHMHTMLWriter.RetrieveOtherFiles(const DataName: String; out
@@ -492,6 +495,8 @@
 FAutoIndex := True
   else if Cmd = '--auto-toc' then
 FAutoTOC := True
+  else if Cmd = '--make-searchable' then
+FMakeSearchable := True
   else
 Result:=inherited InterPretOption(Cmd, Arg);
 end;
Index: dglobals.pp
===
--- dglobals.pp (revision 11973)
+++ dglobals.pp (working copy)
@@ -116,6 +116,7 @@
   SCHMUsageCSSFile = 'Filename of a .css file to be included in the chm.';
   SCHMUsageAutoTOC = 'Automatically generate a Table of Contents. Ignores --toc-file';
   SCHMUsageAutoIDX = 'Automatically generate an Index. Ignores --index-file';
+  SCHMUsageMakeSearch = 'Automatically generate a Search Index from filenames that match *.htm*';
 
   STitle   = 'FPDoc - Free Pascal Documentation Tool';
   SVersion = 'Version %s [%s]';
___
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel