X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7493b4015bce9a907db81b133162c05faeac3b02..afad77a7e06072609956d19d6bdf7fdd24a5293c:/doc/todo/admonitions.mdwn diff --git a/doc/todo/admonitions.mdwn b/doc/todo/admonitions.mdwn index 752eec336..c68ce11f8 100644 --- a/doc/todo/admonitions.mdwn +++ b/doc/todo/admonitions.mdwn @@ -56,4 +56,96 @@ bangs and all... > might use the right one?) could interpret an ad-hoc syntax and > turn it into a `
` either before or after `htmlize` processing. > However, that would be adding an extra layer of syntax for your -> users to keep track of. --[[smcv]] +> users to keep track of. +> +> [[templates|ikiwiki/directive/template]] are another way this could +> work: +> +> \[[!template id=warning text="Do as I say, not as I do."]] +> +> There's a "note" template bundled with ikiwiki already. +> +> --[[smcv]] + +>> I think you mean the `htmlize` hook, as I cannot find any `htmlize` +>> plugin.. That said, yeah, i understand the limitations of Ikiwiki +>> here. I guess that the [[ikiwiki/directive/template]] directive is a +>> good workaround, but it's not really shorter to write: +>> +>> \[[!template id=warning text="Do as I say, not as I do."]] +>> +>> than to write: +>> +>> [[!format txt """
Do as I say, not as I do.
"""]] +>> +>> ... in fact, it's actually longer. So short of allowing arbitrary +>> classes *and* fenced blocks, I don't think this can go much +>> further. +>> +>> We *could*, however, import the admonition styles from MoinMoin +>> directly. It would involve importing 5 icons from MoinMoin and +>> creating associated styles. Is that something you would be open to? +>> +>> --[[anarcat]] + +>> Looking more at the MoinMoin images, the source (and license!) for +>> them is not quite clear, so they don't make such great targets for +>> inclusion. They are, nevertheless, included in Debian so presumably +>> they are DFSG-friendly? The copyright file marks them as "UNKNOWN" +>> which is worrisome... I have found the following results about them: +>> +>> * [admon-warning.png][] seems to be [public domain according to this sketchy site][] +>> * [admon-note.png][] seems to have a [source in XFCE][], as part of +>> the notes plugin +>> * [admon-tip.png][] is used in the Debian release notes, so is +>presumably fine as well [source there](https://www.debian.org/releases/testing/amd64/release-notes/images/note.png) +>> * [admon-important.png][], same, [important.png](https://www.debian.org/releases/testing/amd64/release-notes/images/important.png) +>> * [admon-caution.png][] can be found in Mediawiki as well, which is +>> a good source of icons. According to Debian, some are public domain, +>> some are LGPL (!?). In MediaWiki itself, the source of that file is +>> lost in the mists of time. +>> +>> Even though there is some confusion about the source of those +>> images, I think, in good faith, that they can be generally be +>> considered reusable. --[[anarcat]] + +[public domain according to this sketchy site]: http://all-free-download.com/free-vector/download/tango_process_stop_115912.html +[source in XFCE]: http://git.xfce.org/panel-plugins/xfce4-notes-plugin/tree/data/icons/scalable/xfce4-notes-plugin.svg +[admon-warning.png]: https://moinmo.in/moin_static19/modernized/img/admon-warning.png +[admon-note.png]: https://moinmo.in/moin_static19/modernized/img/admon-note.png +[admon-tip.png]: https://moinmo.in/moin_static19/modernized/img/admon-tip.png +[admon-important.png]: https://moinmo.in/moin_static19/modernized/img/admon-important.png +[admon-caution.png]: https://moinmo.in/moin_static19/modernized/img/admon-caution.png + +Update: I have made a [[plugins/contrib/admonition]] plugin for this +purpose, as a patch. Hopefully it will be mergeable here? Here's a +screenshot of what the help page would look like, to give you an idea +of the results: + + + +--- + +I like the idea of admonitions. I've done something vaguely similar on my own site ([e.g.](https://jmtd.net/film/blade_runner/)), but I just +use `\[[!template` and put up with the verbosity.I like that `\[[!tip` is shorter than `\[[!template id=…`. If +I was being a total purist I'd argue that the correct change would be to make a syntax shortcut +for the template syntax, since functionally that's what `tip` is doing, and include the +admonition styles in either `style.css` or in every shipped theme. But I'm more of a pragmatist +and your current plugin actually exists and IkiWiki is starving for contributors (IMHO) +so I encourage maintainers to merge it. I will probably merge it into [opinionated ikiwiki](https://jmtd.net/log/opinionated_ikiwiki/) +in either case (which will at least mean there'll be another avenue for people to check it out) *— [[Jon]], 2020-08-07* + +> One quick tip/request, [[anarcat]]: If you could update the "master" branch in your IkiWiki +> fork to match the merge base for your branches, it would be easy to use Gitlab's "compare" +> feature in-browser to see a combined diff of your changes. *— [[Jon]], 2020-08-07* + +> > Thanks for your support and comments! :) I don't have the time to manage another extra branch on top of the stack I already have unfortunately. but it might be simpler for me in the future... I keep on hoping all patches get merged and that i don't need to (more officially) fork `master`, but it seems that's where I need to go myself... In the meantime you can see the list of patches I maintain in [[users/anarcat]] and [my maintenance log](https://anarc.at/services/wiki/). I hope that helps! -- [[anarcat]] + +> > Turns out I found the time. I merged all my active branches in the `master` branch on gitlab. not sure what you'd compare it against, but there, it's done. :) [[anarcat]] + +>>> Thanks for that! I'll try to explain what I meant in terms of an example. your `admonitions` is a series of commits that ultimately sit on top of +>>> upstream's `d0099568` ("Prepare release for unstable"). If I want to see a quick combined diff of all the changes made in that branch, I can try to +>>> use GitLab's "Compare" feature, but it does not let me specify a SHA to compare against, only a ref-name such as (your) `master`, which (at the time) +>>> was a much earlier commit than `d0099568`, so "Compare" would include all the unrelated upstream changes. If instead either `master` was `d0099568`, or +>>> `admonitions` was rebased on top of whatever your `master` was, then GitLab's "Compare" would be useful. As it is, I cloned locally and did the necessary +>>> `git` incantation. *— [[Jon]], 2020-08-12*