Scintilla documentation
70 views
Skip to first unread message
Nicholai Benalal
Oct 9, 2012, 3:41:49 PM10/9/12
to scintilla-interest
Hi,
I really like how well the Scintilla API is documented in the HTML file. However, the other day I was looking into turning it into another format as to provide context sensitive documentation and API calltips. I then realized that it would be a bit tricky to parse the HTML file in order to create alternative document formats. The document doesn't really seem created for this purpose.
Has it ever been considered to have the HTML document auto-created from another file format that is more structured?
Best,
Nicholai
I really like how well the Scintilla API is documented in the HTML file. However, the other day I was looking into turning it into another format as to provide context sensitive documentation and API calltips. I then realized that it would be a bit tricky to parse the HTML file in order to create alternative document formats. The document doesn't really seem created for this purpose.
Has it ever been considered to have the HTML document auto-created from another file format that is more structured?
Best,
Nicholai
Neil Hodgson
Oct 9, 2012, 9:43:44 PM10/9/12
to scintilla...@googlegroups.com
Nicholai Benalal:
> However, the other day I was looking into turning it into another format as to provide context sensitive documentation and API calltips. I then realized that it would be a bit tricky to parse the HTML file in order to create alternative document formats. The document doesn't really seem created for this purpose.
>
> Has it ever been considered to have the HTML document auto-created from another file format that is more structured?
Having the document in a format that could be mechanically reused in other ways would be great and it was a factor in defining the .iface file format.
However, there is a degree of irregularity in ordering and sectioning the document that is useful and difficult to specify formally. There is a reasonable classification hierarchy that starts with the table of contents but beneath that element relationships are harder to categorize.
A transformation that may appeal to some is to break up the document into one page per element. I wrote a script to do this for SciTE on OS X which uses the OS X "Help Center" to search and show an individual page. This doesn't allow browsing and its often something related to your search that is what you need.
Additional tags could be added to Scintilla's existing HTML to make it easier to break apart or treat as a tree.
Neil
> However, the other day I was looking into turning it into another format as to provide context sensitive documentation and API calltips. I then realized that it would be a bit tricky to parse the HTML file in order to create alternative document formats. The document doesn't really seem created for this purpose.
>
> Has it ever been considered to have the HTML document auto-created from another file format that is more structured?
However, there is a degree of irregularity in ordering and sectioning the document that is useful and difficult to specify formally. There is a reasonable classification hierarchy that starts with the table of contents but beneath that element relationships are harder to categorize.
A transformation that may appeal to some is to break up the document into one page per element. I wrote a script to do this for SciTE on OS X which uses the OS X "Help Center" to search and show an individual page. This doesn't allow browsing and its often something related to your search that is what you need.
Additional tags could be added to Scintilla's existing HTML to make it easier to break apart or treat as a tree.
Neil
Ahmad Zawawi
Oct 10, 2012, 2:29:13 AM10/10/12
to scintilla...@googlegroups.com
Hi,
You could format it as JSON like NodeJS. Please see http://nodejs.org/api and http://nodejs.org/api/index.json for ideas.
Regards,
--
You received this message because you are subscribed to the Google Groups "scintilla-interest" group.
To post to this group, send email to scintilla...@googlegroups.com.
To unsubscribe from this group, send email to scintilla-inter...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/scintilla-interest?hl=en.
Reply all
Reply to author
Forward
0 new messages