On Sunday, June 5, 2016 at 11:46:32 AM UTC+2, Jed Carty wrote: > > This comment is strictly in the context of developing using the javascript > portions of tiddlywiki. This would be a developers tool, not a users guide. >
I didn't write about a users guide. > For the code it isn't that there isn't enough documentation for the core, > but that it isn't easily searchable. At a minimum I would like a function > reference. I keep finding myself having to search through a bunch of core > files to find the definition for something like getTextReference, so even a > list like I already have that lets you search for a function and see what > file it is in will save me a lot of time. Documentation or examples on top > of that will hopefully be useful for lowering the barriers to entry for new > people. > As Richard wrote, this is also a problem of the dev environment. I use brackets.io (without Extract) [1] editor, which allows me to highlight a function and type CTRL-E, which opens an inline editor, with the function code. The "global search" utility shows you all the lines where an eg: function is called. ... Opening the files is just a double click away. > I would like, even as just an experiment, to cut up the code so each > function has its own tiddler and then use templates to build the source > code. > I did some experiments with the "leo outliner" [2] as a TW IDE. ... The leo editor can be used as a literate programming tool. .. The problem is, that it uses <<...>> as the indicator for text macros. In the TW context this is similar to a "transclusion". The editor has no possibility to re-define the sequence, so it's kind of useless, since TW syntax uses <<..>> for macros :/ > I think that there could be many benefits to usability by doing this, like > making it easy to search, > Yes. The workaround here is an editor that supports multi-file, multi-directory search and eventually "inline" function editing. helping reduce redundant code and allowing much more complete documentation > along with the code itself. > Right. This would be nice to have. > Last time I tried starting this Jeremy had brought up a similar project he > had attempted a while ago, so I know I am not the only one with the idea. I > am sure there will be plenty of problems and we would need to build new > tools to make it work. > That's right. ... but from my point of view, it needs to be something, that is created automatically. If human intervention is needed, we simply can't support it, as a "spare time" project. just my thoughts mario [1] http://brackets.io [2] http://leoeditor.com/ -- You received this message because you are subscribed to the Google Groups "TiddlyWiki" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/tiddlywiki. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/aac1269a-9c97-4790-bb66-2d26f05d9d76%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
