Hi Scott My apologies for the late reply (due to drafts folder confusion on my part) - particularly unfortunate as you were seeking reassurance, and my lack of reply may have looked like negative feedback. But, in fact, yours is an interesting application that I think is a perfect fit for TiddlyWiki.
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 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. > I would like to remove the last modified timestamp > as well as the Info and Edit icons from each Tiddler, as well as all the > icons and at least the "Tools" and "More" sidebar tabs. In other words, > what I really want to do is to remove everything which makes this a > dynamic Wiki, leaving behind only an excellent micro-content viewer. > > I have no idea yet how to do any of that, but before I even ask about > that, 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 > - 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. > - 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 > 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 > - 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> > 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! Best wishes Jeremy > > > Thanks, > > -- Scott > > [1]: https://github.com/CrossEye/ramda > [2]: http://jashkenas.github.io/docco/ > [3]: http://usejsdoc.org/ > > -- > 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. > -- Jeremy Ruston mailto:[email protected] -- 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.
