How Xojo does there documentation?

I was wondering how Xojo does there documentation? I know they use MediaWiki but how do they create templates?

What I am trying to ask is how do they consistently have ‘Methods’, ‘Properties’, etc? Do you manually write it into there documents or do they have some kind of automated system to keep consistency in case this changes for one reason or another? Maybe it is unlikely to change and if anything needs changing then the changes will apply only to individual documents?

Does WikiMedia give you the tools to keep consistent built-in?

I just curious really.

Thanks

Their

We did them manually and tweak them from time to time
And yes it was a lot of work
Stephane Mons helped out immensely in the initial cut over

You can actually go to the wiki & see how things are marked up
You can’t change it but you can look at the media wiki source

[quote=137524:@Norman Palardy]We did them manually and tweak them from time to time
And yes it was a lot of work
Stephane Mons helped out immensely in the initial cut over

You can actually go to the wiki & see how things are marked up
You can’t change it but you can look at the media wiki source[/quote]
Thanks. Wouldn’t it have been easier if you wrote custom software to generate the docs? I don’t see why there isn’t existing software.

It seems like free, easy, point & click software for documentation is a gap in the software market. Maybe I should write a simple one? What do you think?

I am finding it hard to find something like this.

Would you recommend avoiding MediaWiki and try something else?

Thanks

Sorry.

The search for a documentation software option is frustrating just to get started.

Have you looked at “Answers”?

http://nswrs.com/index.php

[quote=137545:@Markus Winter]Have you looked at “Answers”?

http://nswrs.com/index.php[/quote]
Saw that program and I actually tried it out. It looks good and the free version seems fine for me but I did not see how I could make documentation in it. I will have to check out again and maybe read the manual.

Any other options?

[quote=137524:@Norman Palardy]We did them manually and tweak them from time to time
And yes it was a lot of work
Stephane Mons helped out immensely in the initial cut over

You can actually go to the wiki & see how things are marked up
You can’t change it but you can look at the media wiki source[/quote]
Norman, couldn’t you have used this to take out some of the manual work?
https://www.mediawiki.org/wiki/Extension:Variables

Norman, maybe I did not explain what I meant by manual. I had a look. This looks like productive code has been written to make things more automated like this:
‘{{PropertyBox
| name=ListCount
| owner=[[ListBox]]
| ownertype=class
| scope=public
| type=[[Integer]]
| platform=all
| readonly=yes
}}’

It looks like the system has a feature called ‘templates’.

What I actually intend to do is just use RapidWeaver to make a webpage, and include that webpage in my app. Showing it is easy with the HTMLviewer.

If you are on a Mac then I have a spare licence you could have.

That is how the documentation works in all my apps :slight_smile:

I use Kompozer which is free and cross platform, but any decent HTML editor can do.

[quote=137558:@Markus Winter]What I actually intend to do is just use RapidWeaver to make a webpage, and include that webpage in my app. Showing it is easy with the HTMLviewer.

If you are on a Mac then I have a spare licence you could have.[/quote]
I realize that I could use HTML documents but I think it would be more effective to use a documentation system rather than create my own. I will check out RapidWeaver. No thanks to giving out the license. I do not have Mac at the moment.

I think MediaWiki looks good. I could setup a localhost and load that into a HTMLViewer. Despite your app having to take certain permissions to use web servers. My app uses them anyway so this would be no loss.

Oh right, thanks.

I was a bit fast. Apparently, MediaWiki uses php and MySQL, so it is not pure HTML. In addition to setting up a localhost, you will have to install php for Windows. See http://windows.php.net/

On Windows, the alternative to a Wiki could be a CHM generator. See http://alternativeto.net/software/robohelp/

[quote=137570:@Michel Bujardet]I was a bit fast. Apparently, MediaWiki uses php and MySQL, so it is not pure HTML. In addition to setting up a localhost, you will have to install php for Windows. See http://windows.php.net/

On Windows, the alternative to a Wiki could be a CHM generator. See http://alternativeto.net/software/robohelp/[/quote]
Thanks

You could group things with Categories. One for classes, one for methods, properties, etc.
You’re also welcome to ask for features that would help! I’m working on a few requests right now :slight_smile: