[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [sc-dev] general question about the GUI helpfiles

I could also have the stubGenerator replace everything until a certain keyword. Then the cross platform docs could include custom prose and examples below that keyword. If people regenerate their docs to fix the links and the list of redirect calsses, then only what is above the keyword gets replaces.

The advantage of this approach is that the help-file menu would not get crowded with cryptice include html files in exmples in an examples subdirectory.

I think I will try to to do this. Then we can make additions to the help stubs at our leisure.

jost

jostM wrote: 


Actually I have been thinking of putting an examples directory inside
the Main_Gui directory. Then the stub generator would simply add a a
basic usage plus examples to the stub, using cross platform syntax.

what would you think of that?

We could move all the code from the "examples" section into these. Only
the example interspersed with the help file prose would not be put here.

I can do this if people think it is sensible.

this advantage would be that people only have to go beyond the stubs for
real details.

jost

_______________________________________________
sc-dev mailing list

info (subscription, etc.): http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml
archive: https://listarc.bham.ac.uk/marchives/sc-dev/
search: https://listarc.bham.ac.uk/lists/sc-dev/search/