Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Graeme Geldenhuys]

On 11/04/2021 1:40 am, Graeme Geldenhuys wrote:
> You use the EXAMPLE tag inside an ELEMENT tag. Here is a
> complete ELEMENT example:

I forgot to mention, you can also use the CODE tag inside the
DESCR tag. Thus you don't have to use a external file for the
code example.


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


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Graeme Geldenhuys]

On 10/04/2021 9:25 pm, Roland Chastain wrote:
> Please could you tell me how I can insert a Pascal code example?

You use the EXAMPLE tag inside an ELEMENT tag. Here is a
complete ELEMENT example:



The constructor for TfpgSystemTrayIcon
.
Modern operating systems usually provide a special area on the desktop,
called the system tray or notification area, where long-running applications
can display icons and short messages.







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


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Roland Chastain]

>MSEide+MSEgui's latest `master` now contains the fpdoc project file and the
> xml documentation - moved over from MSEUniverse repo.
>

The generated HTML is beau-ti-ful! Graeme, you did a great job. I looked
into the little XML files: I think I understood the principle.

Please could you tell me how I can insert a Pascal code example?

The idea to fill the documentation with Martin answers is a very good idea.

I think I will fork the repository and make pull requests for new XML files.

Regards.

Roland




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Roland Chastain]

Thank you for your work Graeme. I downloaded the msegui.inf file and tested
the integration into MSEide. It is great!

Just a small detail. I didn't understand where the FPCHELP variable is
defined. So I did put the explicit path to the file, and it worked.

Thank you for the links to IPF specifications and examples.

Regards.

Roland




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Graeme Geldenhuys]

On 10/04/2021 4:03 pm, Roland Chastain wrote:
> I looked for IPF syntax guide and examples but didn't find many things.

I've included the official documentation from IBM inside the fpGUI
repository.

  https://github.com/graemeg/fpGUI/tree/develop/docview/docs

The file you'll be most interested in will be: IPFREF_v4.INF

The docview.inf file also contain a small section "For Authors and
Developers" on writing IPF files, but I would recommend the IBM
document instead. The latter has a LOT more detail.

There is much to read, but I would start with the following sections:

 * Starting with the Tag Language
 * Displaying Text and Graphics
 * IPF Tag Reference

The second section will probably be the most useful and then using the
Tag Reference to look up any other syntax and more options for each
tag syntax.

As I'm NOT using the IBM IPF Compiler, but rather the OpenWatcom IPF
Compiler, the symbols don't all have to be escaped as the IBM docs
describe.

fpGUI's repository contains more examples for you:

 * a Quick Guide to fpGUI (ebook) in /docs/quick_quide/
 * Various files in http://fpgui.sourceforge.net/

My public PGP key:  http://tinyurl.com/graeme-pgp


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Graeme Geldenhuys]

On 10/04/2021 11:20 am, Graeme Geldenhuys wrote:
> Like advanced search, inline annotations,
> runtime or compile time Index page building, runtime concatenation of INF
> files, very compact binary format etc.

I've just tested fpdoc (from FPC 3.2.1) generating HTML, CHM and INF help as
final output. To give you an idea of how compact INF help is...

Using latest MSEgui `master` source code resulted in the following help
file sizes:

   HTML - 242.0MB
   CHM  -  10.2MB
   INF  -   4.3MB

The CHM content formatting looked really bad using KchmViewer, and KchmViewer
is actually a pretty good CHM viewer. Also doing two searches caused
KchmViewer to crash (reproducible multiple times). There is also no help
Table of Contents, or Index generated for CHM. That's an extra step and requires
even more effort and disk space.

MSEide+MSEgui's latest `master` now contains the fpdoc project file and the
xml documentation - moved over from MSEUniverse repo. I also created a INF
help file attached to the latest release on Github.

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


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Roland Chastain]

Thank you Graeme for having taken time to give all these informations.

I tried (successfully) to generate a documentation for a project I am
working on. I simply used fpdoc to generate the IPF. I haven't yet tried to
create a project. I will try later.

I looked for IPF syntax guide and examples but didn't find many things. (I
found an interesting tool, which is also able to generate IPF from its own
special text format.)

I am ready to start the french interface for DocView  (when you have time of
course). It will be the occasion to take it in hand. demo-pasfor-inf.zip
  

Regards.

Roland




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] PacmanXG

[fredvs]

> It is a command-line package manager for some Linux distributions

Ha, ok, pacman is for ArchLinux distros.

I use Debian based Linux distributions, like Debian (of course), Ubuntu,
Mint, ... and they dont use pacman.

But there is a emulator for Debian distros:
https://gitlab.com/TriVoxel/deb-pacman

Infos:
https://blog.sombex.com/2019/12/install-pacman-on-ubuntu-mint-debian-based-linux.html

Fre;D






--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] PacmanXG

[Roland Chastain]

It is a command-line package manager for some Linux distributions, for
example Manjaro.
https://wiki.manjaro.org/index.php?title=Pacman_Overview





--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[fredvs]

Hello Roland.

> Do you see what I mean? 

Ha, yes, I see now.
Ok, perfect, and, once again, sorry for the noise.

Have fun.

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[Roland Chastain]

Thank you Fred. But, I believe that this is the same code that you posted
before. I never said it doesn't work. It works, as I said here and on the
russian forum: "Fred provided to me a working example. I made a simplified
version which doesn't work with dark themes."

I thank you again for your efforts, to make your example work even with dark
themes. Your code for background colors is instructive (and works) but I
prefer not to use it. I can live without dark themes. Do you see what I
mean?




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[fredvs]

Hello Roland.

It is still me!

In attachment, your project with background color enabled.

synedit_roland.zip
  

Now I really let you in peace.

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] PacmanXG

[fredvs]

> It's a GUI for pacman.

Sorry for my total ignorance but what is pacman?

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[fredvs]

Hello Roland.

For the colors, in  the synthax def file, there are colors for the col
numbers, so you need to have one fixed col (-1) in the grid1.
Also for the icon column it is in column = 0.
For the text himself it is on column = 1.

Did you seen my second attachment in previous post, it has color enabled?

synedit.zip
   

But maybe you have seen it, so sorry for the noise.

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] PacmanXG

[Roland Chastain]

It's a GUI for pacman. I said Manjaro as an example (and because I use it
sometimes). On Mageia (my main system), pacman doesn't exist, as far as I
know.




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[Roland Chastain]

Hello Fred!

I was speaking of the simplified version that I attached to my message: "I
attach a simplified version. It doesn't work well etc."




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Graeme Geldenhuys]

On 10/04/2021 9:34 am, Roland Chastain wrote:
> So, I have a fully functional *wipfc* + *docview* + *fpdoc* installation. :)

That's excellent news.

> 1. To generate the IPF for MSEgui, do you also use the XML?

fpdoc can generate documentation output only using the source code, but
then there wouldn't be any actual documentation content. Only skeleton
documentation showing the structure, classes, methods etc, but no actual
contents.

The XML is used to add the content to that skeleton documentation. So if you
create documentation about TButton.Caption in the XML, then when you generate
the fpdoc output, it will include the TButton.Caption content into the
generated docs.

The nice thing of fpdoc is that you don't have to document everything in
one go. You can do bits at a time, and slowly build up your documentation
over time.


> 2. Did you make the main XML file by yourself, using a script or something
> like that? And the little XML files, I imagine, in a text editor.

The XML required for fpdoc is very simple in layout. You don't need anything
fancy. I created a few code templates for MSEide. So I can quickly add a
new topic. It's the actual help content that takes long (or longer) to
write.

I'll merge the current MSEgui docs I have shown into the master branch, as
well as the fpdoc templates I mentioned. I'll make sure to update a
README file with starting instructions.


> The IPF format is very nice. I can't wait to learn it. One could write a
> book (as you wrote somewhere) using that format, and view it with DocView.
> :)

It is indeed a very nice format. Back when I started researching
documentation formats for fpGUI applications, I spent 3 months trying various
help formats to see what they offer and how good their help viewers are.
IPF was created by IBM and is actually very powerful, without the verbosity
or complexity of HTML and CSS.

IBM wrote tons of massive ebooks and help with IPF, so it was a very well tested
format. It was also quick to integrate it into application help
using Object Pascal. DocView took some time to write, but the end result
was well worth it. It is so fast compared to Windows HLP or CHM viewers,
and has many more feature over those too. Like advanced search, inline 
annotations,
runtime or compile time Index page building, runtime concatenation of INF
files, very compact binary format etc.



> When I have time, I will try to make a french version of DocView. Please
> tell me your ideas about the translation system that you would prefer.

fpGUI already has a defined translation system using Object Pascal's
ResourceStrings and .po files. Docview and other fpGUI applications can
load those .po files and start-up, or you can recompile the application
with a new default language - if you don't want the external .po files.
You can use any know PO editor, or do it by hand.

I'll make sure to extract the resource strings into an initial English
.po file, ready for more translations. The fpGUI library itself already
has French translations, so it's just the Docview resource strings that
will need translating.

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


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] How to use a tsyntaxedit

[fredvs]

Hello Roland.

I have seen in MSEgui  Russian forum that you said:

> (1) It doesn't work well for dark themes, because the background stays
> white.

Not sure to understand, is "pascal_solarized_dark.sdef" not working for you?

Here it works (see picture):

 

Fre;D






--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[fredvs]

Hello Roland.

> (I noticed that I waste too much energy to find words in english. Maybe I
> will continue in french.) 

Same for me.  But I notice that Google Translate works much better from
French to English than English to French.

So maybe it will be faster and easier to do all the work in french and let
Google Translate do the translation.

This because all the words used for computing are in english and so Google
Translate will not translate it.

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] PacmanXG

[fredvs]

Hello Roland.

Thanks for make that project on the road again.

> I didn't really tried it (I mainly use Mageia, even if I have Manjaro
> installed on my second computer), but it's one more project example. 

Not sure to understand, is this project for Manjaro only?

Fre;D 



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[fredvs]

Hello Roland!

> You can see the result here:
> http://msegui.net/doc/msedataedits.tenumtypeedit.html

Wow, sincerely the most clear and beautiful doc I ever seen.

Congrats.

Fre;D



--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

[MSEide-MSEgui-talk] PacmanXG

[Roland Chastain]

Hello!

I discovered an interesting application made with MSEgui: PacmanXG

I forked it, and made it editable and compilable with the current version of
MSEide: PacmanXG

I didn't really tried it (I mainly use Mageia, even if I have Manjaro
installed on my second computer), but it's one more project example.

Regards.

Roland




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Roland Chastain]

I continue to explore the features of PasDoc.

Here is my first comment:

{++ Component for editing a value of enumerated type. The @code(OnInit)
event can be used to import the different values of the type.
  @includeCode(../../../contributed/examples/tenumtypeedit1.pas) }
 tenumtypeedit = class(tcustomenumedit)

You can see the result here:
http://msegui.net/doc/msedataedits.tenumtypeedit.html

(I no longer can bear this mailing list. I think I will migrate to the
russian forum.)




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Re: [MSEide-MSEgui-talk] MSEgui documentation generated with PasDoc

[Roland Chastain]

Hello Graeme (and other)!

So, I have a fully functional *wipfc* + *docview* + *fpdoc* installation. :)

I tested IPF to INF conversion (with wipfc): OK.

I tested HTML doc for MSEgui generation (with fpdoc, using the XML files
that you provided): OK.

I tested your Lazarus demo, including an INF help. It's great! I will
certainly use it for future projects.

Two little questions, to be sure that I correctly understood all.

1. To generate the IPF for MSEgui, do you also use the XML?

2. Did you make the main XML file by yourself, using a script or something
like that? And the little XML files, I imagine, in a text editor.

The IPF format is very nice. I can't wait to learn it. One could write a
book (as you wrote somewhere) using that format, and view it with DocView.
:)

When I have time, I will try to make a french version of DocView. Please
tell me your ideas about the translation system that you would prefer.
(Recently I discovered this one:  Lightweight Translation Manager
  .)

Regards.

Roland




--
Sent from: http://mseide-msegui-talk.13964.n8.nabble.com/


___
mseide-msegui-talk mailing list
mseide-msegui-talk@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk