help documentation formatting

This forum contains features that has been archived. This section contains implemented features, duplicate requests, and requests which we have decided not to implement.
Post Reply

How would you like to see help doc improvements in formatting?

Yes, it can be a little difficult to read. Some little tweaks help a lot.
2
67%
No, It's fine. I remember the days when docs were all in ASCII text and I downloaded them on my 1200 baud Hayes. Get off my lawn!!
0
No votes
I know it all and don't use any help documentation! Let them work on the core.
1
33%
 
Total votes: 3

kipp
New user
New user
Posts: 29
Joined: 2008-02-05 18:37
Location: Prairieville, LA USA

help documentation formatting

Post by kipp » 2014-04-30 08:44

I find the documentation very difficult to read.
With a minimal amount of css changes it could be much easier to read.
I made a sample change only adding style codes for api_method_name and api_description.
My request is for some small changes such as the example here.


BEFORE

Image


AFTER

Image

Bill48105
Developer
Developer
Posts: 6192
Joined: 2010-04-24 23:16
Location: Michigan, USA

Re: help documentation formatting

Post by Bill48105 » 2014-04-30 09:24

Are you volunteering? :D

I'd have to ask martin but I think there is a story behind the formatting or lack of. Either the site was converted or imported or restored or something. Surely there is a logical explanation.
Bill
hMailServer build LIVE on my servers: 5.4-B2014050402
#hmailserver on FreeNode IRC https://webchat.freenode.net/?channels=#hmailserver
*** ABSENT FROM hMail! Those in IRC know how to find me if urgent. ***

percepts
Senior user
Senior user
Posts: 5282
Joined: 2009-10-20 16:33
Location: Sceptred Isle

Re: help documentation formatting

Post by percepts » 2014-04-30 14:11

I agree that the com api reference is not easy to find anything if you are trying to find functions or properties.

But there is a better way to find out about whats available in the way of COM API functions.

Anyone writing scripts should have some windows development tool or script editor with an Object Browser in it.

You can load "hMailserver Type Library" into your object browser and its then real easy to to find all the objects, properties and functions available in the COM API

Perhaps just a quick note in documentation that you can do this would help as an interim solution.

kipp
New user
New user
Posts: 29
Joined: 2008-02-05 18:37
Location: Prairieville, LA USA

Re: help documentation formatting

Post by kipp » 2014-05-02 06:35

I am just using notepad++ for everything... maybe there is a plugin object browser. I'll have to check. I'm probably not the only unsophisticated programmer around so I am volunteering to update the the object reference pages. I can grab the online files and send them back when updated.

percepts
Senior user
Senior user
Posts: 5282
Joined: 2009-10-20 16:33
Location: Sceptred Isle

Re: help documentation formatting

Post by percepts » 2014-05-02 22:26

if you have a copy of MS Office that used to come with a script editor which has object browser. You would need to install the scripting option of MS Office.

And Visual Studio express which is free has it too.

kipp
New user
New user
Posts: 29
Joined: 2008-02-05 18:37
Location: Prairieville, LA USA

Re: help documentation formatting

Post by kipp » 2014-05-06 19:53

Ok thanks. I will load express and check that out. Thanks.

User avatar
martin
Developer
Developer
Posts: 6834
Joined: 2003-11-21 01:09
Location: Sweden
Contact:

Re: help documentation formatting

Post by martin » 2014-08-16 10:21

I've done some small tweaks to it and it's not pretty but it's better. :)
https://hmailserver.com/documentation/l ... t_accounts

The css for the API is here:
https://hmailserver.com/documentation/api-styles.css

If someone has any suggestions on further improvements, please share.

User avatar
mattg
Moderator
Moderator
Posts: 20301
Joined: 2007-06-14 05:12
Location: 'The Outback' Australia

Re: help documentation formatting

Post by mattg » 2014-08-16 14:35

Particularly in the COM API section of the docs, I'd like to see a set of branch links at the top of each page, like

Code: Select all

Main | Other | COM API | Accounts object 
All being links, and the 'Domains object' being listed between 'COM API' and 'Accounts object', and so attachments would look like

Code: Select all

Main | Other | COM API | Domains Object | Accounts object | IMAP folders object | Messages object | Attachments object
with each of them being links
Just 'cause I link to a page and say little else doesn't mean I am not being nice.
https://www.hmailserver.com/documentation

Post Reply