6 ms·
Show HN: Expounder – A small JavaScript library for more engaging tutorials
- Kinnard 11y agoThis seems like something that could impact the nature of composition. I wonder if writers would write differently if they knew they could "expound".
- harel 11y agoSurely if you write with expounding in mind you'll take that into consideration in your text. You DO write the expanded text after all...
- Kinnard 11y agoNo, I don't believe I do. I think this could be implemented into a blogging platform— a new medium.
- ponyous 11y agoLol yeah, I feel like I want more examples to read. Easy way to filter data you already know. I think I could learn so much faster with this if texts are written properly.
- StavrosK 11y agoI used it in "normal" usage here: https://www.stavros.io/posts/building-cheap-home-sensorcontroller/ https://www.stavros.io/posts/building-cheap-home-sensorcontr... EDIT: I've added a "real-world examples" section to the page with the above included.
- Kinnard 11y agoAgreed. This could be very powerful. I've at times been called wordy. But I am fastidious when it comes to diction. If the word is there— it's there for a reason. I'd love a way to fold.
- StavrosK 11y agoActually, that would be a great idea. I think I might write a small thing to integrate it into Pastery (https://www.pastery.net/ https://www.pastery.net/), maybe with a Markdown extension. It might even become its own service down the line.
- ChristianBundy 11y agoI knew that name looked familiar! Small world.
- StavrosK 11y agoHaha, you bastard :P
- harel 11y agoVery nice and clever. I like it it fits seamlessly into the text.
- bart3r 11y agoMy advice would be to somehow indicate exactly the text that was expounded - maybe with a faint underline or something. When it expands out, it's sometimes difficult to track the exact words that suddenly appear.
- jtmarmon 11y agoand add an option to re-collapse the text
- StavrosK 11y agoThat's another feature that's requested a lot. I'm still not convinced that it's something people request because they actually want to re-collapse the text or just because they're used to the mechanic of "if it expands, it must contract". Presumably they wouldn't feel the need to collapse a paragraph that they didn't expand first, even if it was the exact same paragraph.
- vcarl 11y agoIt throws off my reading if I'm just checking that I know what something is and only need a quick skim to verify that. I immediately lost track of what was the explanation and what was the original text.
- StavrosK 11y agoThe idea is that you don't need to keep track of what's what, it's all original text. Why did you feel you had to distinguish?
- throwanem 11y agoCan't speak for GP, but I experienced a similar moment of "ok now how do i close this again" before realizing I didn't really need to. But that didn't feel quite right either, like a popup that won't go away once its purpose has been served. Or like checking a footnote, and having a hard time finding my way back to wherever it was referenced. I get that what this library does isn't quite either of those things, but it feels enough like both of them that not being able to un-expound feels a little weird.
- kaishiro 11y agoI feel like this could be a really interesting tool for wikis. It'd be neat to be able to read what is, essentially, an executive summary of a topic, but then be able to drill down into a path of discovery that you're interested in.
- StavrosK 11y agoThat's one of the reasons I developed this. You could essentially go into as much detail as you wanted in the topic you wanted. Of course, the writer must be careful not to overdo it, because sometimes the reader does want to just read everything, but it'd be great for things a reader might be familiar with, or that not everyone will find interesting.
- kaishiro 11y agoYeah, nice work! I dig it.
- GroSacASacs 11y agoHow does a screen reader handle that ?
- StavrosK 11y agoI'm not sure (I'd appreciate some feedback by someone who uses one), but I'd think it would just read the whole text. Depends on what it does with hidden text.
- GroSacASacs 11y agoI recommend reading https://en.wikipedia.org/wiki/WAI-ARIA https://en.wikipedia.org/wiki/WAI-ARIA
- steveklabnik 11y agoI've used something similar for talking about complex code examples. You can show only the current line you're talking about, but have a button to expand out the full example. it's pretty great. Excited to give this a try!
- p0larboy 11y ago(Click -> Tool tip) works better IMO. The sudden append of words threw off my reading rhythm.
- ivan_ah 11y agoVery nice, reminds me of telescopictext. Here's an example that explains magnetic fields: http://www.telescopictext.org/text/pFjkqQY9bmfvQ http://www.telescopictext.org/text/pFjkqQY9bmfvQ
- StavrosK 11y agoThat's pretty much the same context, but I think the demo is lacking. For example, clicking on "magnetic" replaces it with "B", which confuses me even more. There's also at one point a link on "be", which is just baffling. What is there to explain about "be"?
- ivan_ah 11y agoFully agree. Your semantics of "expounder" and "expounded" spans is much more coherent. It's a new modality, but I think it has a lot of potential: I love explanations with "multiple levels" in general...
- watson 11y agoReminds me a little of what Wait But Why is doing in his articles - e.g: http://waitbutwhy.com/2016/03/cryonics.html http://waitbutwhy.com/2016/03/cryonics.html (look for "New to WBW? Open these.")
- polm23 11y agoThis is an old idea in Hypertext called Stretch Text (since 1967!): https://en.wikipedia.org/wiki/StretchText https://en.wikipedia.org/wiki/StretchText Every so often someone hears about the old hypertext theory and implements a Javascript or CSS version, but this is honestly one of the nicest implementations I've ever seen. Good work!
- amk_ 11y agoInteresting. I personally like to use sidenotes for this type of thing on my website; it's nice to be able to scan the sidenotes for additional info without clicking on anything. On the other hand, they really don't work on mobile. BigfootJS[0] is the nicest footnote-inliner I know of that also works gracefully on small screens (unpaginated media); if you haven't seen it, take a look. Feedback for this library: - It would be cool if you could set a few preset levels of expansion (TL;DR, expert, beginner, ELI5) and toggle them at the top of the page. [0] http://www.bigfootjs.com http://www.bigfootjs.com
- StavrosK 11y agoThanks for the feedback, the tiered approach is also something I considered, although with a different method. You would tag things with a number from 1 for outermost to N for innermost and then let the user expand to the specific level. I haven't yet tried that concept, but I probably will soon!
- Negative1 11y agoWouldn't a tooltip give the same information while taking up less space and not messing up your carefully setup layout?
- visarga 11y agoGreat, a nice little used UI pattern. Now when will my Expounder Wikipedia viewer come?
- rawnlq 11y ago(As someone who can't write concisely (without inserting a lot of (unnecessary) context)) I would love (to use) an automated version ((of this) so I can just write with full context (and let people choose the level of details they want (to read))). I would love an automated version.