Reported by hoehna on 2013-11-11 09:39 UTC
Make sure all functions have an XML help file and make sure that the XML help file is displayed more nicely than it is currently. I have provided an example for the readCharacterData function but would like to elaborate a little more on it. Generally speaking, I want help information very similar to that available in R, with paragraphs, subsections and executable code like they do. I also think we should read the info on the fly instead of processing all of it on start-up. And the help XML files should be structured so that we can easily make a bunch of hyper-linked html pages from them in time for the workshop. Currently, the help directory only contains the readCharacterData.xml page and then a bunch of pages that were made in 2011 in connection with the RevBayes workshop in Berkeley. I am going to delete the latter because they are completely outdated.
Reported by hoehna on 2013-11-11 09:39 UTC Make sure all functions have an XML help file and make sure that the XML help file is displayed more nicely than it is currently. I have provided an example for the readCharacterData function but would like to elaborate a little more on it. Generally speaking, I want help information very similar to that available in R, with paragraphs, subsections and executable code like they do. I also think we should read the info on the fly instead of processing all of it on start-up. And the help XML files should be structured so that we can easily make a bunch of hyper-linked html pages from them in time for the workshop. Currently, the help directory only contains the readCharacterData.xml page and then a bunch of pages that were made in 2011 in connection with the RevBayes workshop in Berkeley. I am going to delete the latter because they are completely outdated.