Jeremy Ruston wrote: > Scott Sauyet wrote: > My apologies for the late reply (due to drafts folder confusion on > my part)
(And my response is similarly delayed; I'm still trying to catch up after a two-week vacation!) No problem. The biggest issues will be be choosing a format for the project and finding the time to do anything about it. I'm not in any hurry. :-) > particularly unfortunate as you were seeking reassurance, and my > lack of reply may have looked like negative feedback. Not from my perspective. I don't know the community well enough to know if you're likely to weigh in on most threads or only the most technically challenging ones or only those that happen to capture your fancy. I had no expectations whatsoever. Thanks for this detailed answer. > But, in fact, yours is an interesting application that I think is a > perfect fit for TiddlyWiki. Glad to hear it. I will probably try your suggestions and push this from a proof-of-concept into a full-fledged demo. Thank you for taking the time with your detailed response. > I've recently come across another project using TiddlyWiki as a > template for generated documentation - it's a FORTH interpreter > for the Commodore PET (!): > > https://github.com/chitselb/pettil > > The generated TiddlyWiki is here: > > http://chitselb.com/files/tiddlypettil.html Wow! Amazing what people will get up to. Amazing that people are still using Forth. And pretty nice documentation! >> The trouble is that I don't particularly like any of the common >> JSDoc output formats available. It struck me that TW has pretty >> well everything that I would want, though. So I hacked together >> a hand-crafted proof-of-concept: >> >> <http://ramdajs.com/tw/tiddly.html> > Very cool. >> What I would like to do is to remove the edit/save capabilities >> of TW here. And this is where I think I'm straying pretty far >> from the sweet spot of TiddlyWiki. > Not at all :) > > I think there's many applications where a read-only view makes > the most sense for users. Glad to hear it. I'll have to figure out details for my app, and I probably won't get to it for several weeks, but thanks for the encouragement. >> [ ... ] >> I first want to know if this seems so antithetical to the spirit >> of TW that I'd offend people here by even trying it. You see, >> although I really love TiddlyWiki for what it is and what it can >> do, I also really like the UI it presents for simply viewing >> micro-content. That's all I really want to use from it in this >> case. > Yup, makes perfect sense, and definitely highly encouraged. >> - I'd like to make a "Signature" module/widget/template/ >> something that I can feed with source code that looks like "a >> -> b -> c" and puts on the browser something where the "->"'s >> are replaced by Unicode arrows. I don't have an exact syntax >> in mind, but something that I could put on my tiddler that >> looks something like <$sig field="signature"/> > To do this you'd have to write a parse rule for TW5. These are > modules that scan for a particular syntactic construction and > return it's details as a parse tree node. For example, here's > the parse rule that handles converting double and triple dashes > to em- and n-dashes: > > https://github.com/Jermolene/TiddlyWiki5/blob/master/core%2Fmodules%2Fparsers%2Fwikiparser%2Frules%2Fdash.js That looks straightforward enough. >> - I'd like to create some "Types" tiddlers to describe those >> types listed as argument or return types on functions, and >> then link the references to them (and possibly also have some >> way to list the reverse references from those tiddlers.) > > No problem there; you'll just need to figure out a naming convention > for your tiddlers to make sure that different entities don't clash. And that should be straightforward for my specific case, perhaps less so if I want to one day generalize it. I'm not too concerned about that yet, though. >> - I'd like to reorganize the sidebar tabs so that the tabs show >> up in the order I choose: API, A- Z, Overview, (and if I >> decide to keep them) Open, and Recent > You can adjust the order of the tabs by adjusting the `list` field > of the tiddler $:/tags/SideBar Perfect. I knew I'd done some similar things with earlier versions of TW, but still haven't quite found my way around TW5. >> Since there are nearly two hundred functions in the library (including >> aliases), a long scrolling list is not wonderful. I would like to either >> >> - Turn my (to-become-)long list of categorized functions into an >> accordion (there will probably be about ten categories.) > That's reasonable. There are some examples of accordions in > tw5.scholars.tiddlyspot.com I'll have a look. >> - Find a way to turn this list into some multi-column structure, >> so that either each category individually or the entire list >> spans three or four columns to fill up the available space >> better, and more functions are available to see without >> scrolling. This would ideally work for both the main section >> and the sidebar, but I would have no issue with handling them >> separately if necessary. > This may be as simple as using multi-column CSS: > > <div style="column-count:3;-webkit-column-count:3;-moz-column-count:3;"> > > {{your-list-here}} > > </div> Yes, that might well work. Thanks for the suggestion. >> In any case, if you've made it this far, thanks for reading. I >> appreciate your attention, and would love to hear if you think >> this is a reasonable use of TW. > I'll be very interested to see the results - good luck! It will be some time before I actually get to this, if it ever happens. The library itself needs plenty of attention, and, as always, the documentation can suffer for it. But I do hope to do it, and I really believe that TW would be a perfect format for documentation. Finally, thank you for all your hard work with TW over the years. It's a fantastic tool! -- Scott -- You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" 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 http://groups.google.com/group/tiddlywikidev. For more options, visit https://groups.google.com/d/optout.
