AutoHotkey Community

[Titan]

XN-Docs generates web pages for your scripts based on the Natural Docs syntax. Visit the link for more information.
_________________

RegExReplace("irc.freenode.net/ahk", "^(?=(.(?=[\0-r\[]*((?<=\.).))))(?:[c-\x73]{2,8}(\S))+((2)|\b[^\2-]){2}\D++$", "$u3$1$3$4$2")

[ahklerner]

[Titan]

Thanks, it's fixed.
_________________

RegExReplace("irc.freenode.net/ahk", "^(?=(.(?=[\0-r\[]*((?<=\.).))))(?:[c-\x73]{2,8}(\S))+((2)|\b[^\2-]){2}\D++$", "$u3$1$3$4$2")

[ahklerner]

got a lot of garbage this time. (no zip file)
edit: here is the top lines from it the rest is fubar.

[Titan]

That script doesn't use standard Natural Docs syntax. Take a look at some of my scripts to see what they should be like.
_________________

RegExReplace("irc.freenode.net/ahk", "^(?=(.(?=[\0-r\[]*((?<=\.).))))(?:[c-\x73]{2,8}(\S))+((2)|\b[^\2-]){2}\D++$", "$u3$1$3$4$2")

[Elevator_Hazard]

Gah that beats what I'm working on. Good job, its so good I wonder if I should continue with mine

Great job.
_________________
Changed siggy at request of ahklerner

[corrupt]

Hi Titan,

I'm glad to hear that you decided to take on the project . I'm a bit confused though . The main suggestion that I was trying to make was to have someone fill in fields in a form for generating the documentation. Your implementation does not seem to have this functionality. Is this planned? I definitely wasn't suggesting having users learn how to embed the documentation into their code using Natural Docs formatting (or any other formatting that needs to be in the code). That's exactly what I wanted to avoid.


Here's the output received when submitting code (no Natural Docs formatting in the code):

[Titan]

[corrupt]

Thanks for clarifying . So once the information has been collected from the form it will be automatically added to the code using Natural Docs format? or will an additional file get generated containing the Natural Docs code that can be submitted separately to avoid having to re-enter the information? or have I misunderstood? Would you mind explaining the concept, planned functionality?

[Titan]

Source files will not be modified, instead the data collected will be used to create an RDF then an XSL transformed HTML web page (as it happens currently). I'm reluctant to create a from because I'm very sure the majority will take advantage of the integrated parsers - i.e. write syntax usage within the script source and leave it to XN-Docs to generate documentation on successive updates etc. From my point creating a form will be a nightmare with so many fields to validate and error handling to manage. Therefore it's unlikely you'll see this until a later stage, unless someone else writes it for me.
_________________

RegExReplace("irc.freenode.net/ahk", "^(?=(.(?=[\0-r\[]*((?<=\.).))))(?:[c-\x73]{2,8}(\S))+((2)|\b[^\2-]){2}\D++$", "$u3$1$3$4$2")

[Elevator_Hazard]

[corrupt]

[Titan]

What about a Natural Docs converter? It will take form input and return standard syntax. This way users can make amendments in any text editor without filling in the entire form repeatedly if need be. The text wouldn't even needed to be combined with the script because XN-Docs will parse it as usual.

I don't know why you're intimidated by ndocs syntax - there's no learning involved because it's plain English. The default AutoHotkey script template has it's own metadata syntax which is very similar and I plan to support that too.
_________________

RegExReplace("irc.freenode.net/ahk", "^(?=(.(?=[\0-r\[]*((?<=\.).))))(?:[c-\x73]{2,8}(\S))+((2)|\b[^\2-]){2}\D++$", "$u3$1$3$4$2")

[corrupt]

A Natural Docs converter sounds like a great idea. I'm not really intimidated by Natural Docs. I just have no interest in memorizing additional information, and I doubt many others are either, just to submit a function . Having it generated is much less of an inconvenience .

For making amendments, would it be just as easy to retrieve the data from the existing documentation and place it back into the form fields for editing?

[Titan]