Re: [Lazarus] Building help files: the nitty-gritty

2018-09-23 Thread Graeme Geldenhuys via Lazarus
On 18/08/18 18:10, Marco van de Voort via Lazarus wrote:
>> On Tue, Jul 10, 2012 at 05:39:05PM +0100, Graeme Geldenhuys wrote:
>^^^
> 
> Well, that happens, when you try to be modern, and read your mail with mutt
> instead of elm :-)


hahaha... I was about to comment on dredging up such and *old* thread.
The solution to the original question has been solved since a long
time... DocView of course with the help source in IPF format. ;-)


Regards,
  Graeme

-- 
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://fpgui.sourceforge.net/

My public PGP key:  http://tinyurl.com/graeme-pgp
-- 
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus


Re: [Lazarus] Building help files: the nitty-gritty

2018-09-02 Thread Michael Van Canneyt via Lazarus



On Sun, 2 Sep 2018, Marco van de Voort via Lazarus wrote:


On Thu, Aug 30, 2018 at 08:38:13PM +0200, Kostas Michalopoulos via Lazarus 
wrote:

FWIW your post made me realize i have a few uncommitted changes (including
a very important one - outlines
https://coinsh.red/p/2018-08-30_20_27_48-Help_-_Welcome.png) for LazHelp
:-P. I'm not working on it much though, it is mainly on life support with
the rare addition of new stuff (mainly needed because i made it a target
for a document preparation system i work on and needed some features from
it).


I only work on the non visual (CHM reader/writer) parts. 


Recently there were some new bugreports from people that use chmcmd with
Sphinx (a tool like fpdoc for .NET).


Sphinx is Python, not .NET.

I tried for 2 days to get read-the-docs (a web front-end for sphinx) to work. 
Never again ! The python dependencies are a complete disaster. Almost as bad

as npm...

Michael.
--
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus


Re: [Lazarus] Building help files: the nitty-gritty

2018-09-02 Thread Marco van de Voort via Lazarus
On Thu, Aug 30, 2018 at 08:38:13PM +0200, Kostas Michalopoulos via Lazarus 
wrote:
> FWIW your post made me realize i have a few uncommitted changes (including
> a very important one - outlines
> https://coinsh.red/p/2018-08-30_20_27_48-Help_-_Welcome.png) for LazHelp
> :-P. I'm not working on it much though, it is mainly on life support with
> the rare addition of new stuff (mainly needed because i made it a target
> for a document preparation system i work on and needed some features from
> it).

I only work on the non visual (CHM reader/writer) parts. 

Recently there were some new bugreports from people that use chmcmd with
Sphinx (a tool like fpdoc for .NET).

-- 
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus


Re: [Lazarus] Building help files: the nitty-gritty

2018-08-30 Thread Kostas Michalopoulos via Lazarus
FWIW your post made me realize i have a few uncommitted changes (including
a very important one - outlines
https://coinsh.red/p/2018-08-30_20_27_48-Help_-_Welcome.png) for LazHelp
:-P. I'm not working on it much though, it is mainly on life support with
the rare addition of new stuff (mainly needed because i made it a target
for a document preparation system i work on and needed some features from
it).

On Sat, Aug 18, 2018 at 7:11 PM Marco van de Voort via Lazarus <
lazarus@lists.lazarus-ide.org> wrote:

> On Sat, Aug 18, 2018 at 06:31:15PM +0200, Marco van de Voort via Lazarus
> wrote:
>
>
> > On Tue, Jul 10, 2012 at 05:39:05PM +0100, Graeme Geldenhuys wrote:
>^^^
>
> Well, that happens, when you try to be modern, and read your mail with mutt
> instead of elm :-)
> --
> ___
> Lazarus mailing list
> Lazarus@lists.lazarus-ide.org
> https://lists.lazarus-ide.org/listinfo/lazarus
>
-- 
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus


Re: [Lazarus] Building help files: the nitty-gritty

2018-08-18 Thread Marco van de Voort via Lazarus
On Sat, Aug 18, 2018 at 06:31:15PM +0200, Marco van de Voort via Lazarus wrote:


> On Tue, Jul 10, 2012 at 05:39:05PM +0100, Graeme Geldenhuys wrote:
   ^^^

Well, that happens, when you try to be modern, and read your mail with mutt
instead of elm :-)
-- 
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus


Re: [Lazarus] Building help files: the nitty-gritty

2018-08-18 Thread Marco van de Voort via Lazarus
On Tue, Jul 10, 2012 at 05:39:05PM +0100, Graeme Geldenhuys wrote:
> > Noted, but I'm using Lazarus (and this /is/ the Lazarus mailing list, so
> > please don't act all surprised :-)
> 
> I know that all too well. :)
> 
> My question still stands though. I don't know what is the
> recommendation for "application help" with LCL based applications. eg:
> I create a new project which is a new Programming Editor. I want to
> supply a end-user help file with my binary - like all good software
> does. What help file format do I use (as the developer of that
> product), and how do I create/edit that help file?

There is no cross platform helproduct, so that way you are fcked.


> Now if you tell me CHM, that means I need to ship LHelp with my
> product because Linux & Mac users don't have CHM help viewers out of
> the box.

They have no decent help system out of the box. Seems the lowest common
denomitor is plain html, which I would avoid.

The best route would be to create some fphttpserver that serves up chm
content, but I don't know the FPC webcomponents enough for that.


> But what is the source help format for CHM

For non API chms ?  html + some index and project files.

> and what tools (help editor) do I use to edit that source format

It is called an "html editor". Some people rough it though, and use a "text"
editor. Holy wars have been fought

> and what
> tool do I use to "compile" that source help format into the end result CHM
> file?

chmcmd, included with FPC since 2.2.x

> Also, how does my product know where to find LHelp (or whatever CHM viewer
> I want to use)?

As said, that is not a CHM issue, but a "state of linux help" issue.
-- 
___
Lazarus mailing list
Lazarus@lists.lazarus-ide.org
https://lists.lazarus-ide.org/listinfo/lazarus