X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/aaabe0ee11ea7082bf86f89b40afb9cf3ab7b2f0..6c584a00de76e3193cc514572974e8ae99212e9c:/doc/todo/basewiki_should_be_self_documenting.mdwn diff --git a/doc/todo/basewiki_should_be_self_documenting.mdwn b/doc/todo/basewiki_should_be_self_documenting.mdwn index d467f2f0b..cb8dee697 100644 --- a/doc/todo/basewiki_should_be_self_documenting.mdwn +++ b/doc/todo/basewiki_should_be_self_documenting.mdwn @@ -1,7 +1,16 @@ The pages in the basewiki should be fully self-documenting as far as what -users need to know to edit pages in the wiki. [[HelpOnFormatting]] +users need to know to edit pages in the wiki. [[ikiwiki/Formatting]] documents the basics, but doesn't include every preprocessor directive. +> Thanks to Joey's work applying and fixing up my patches, this is mostly done. +> The one thing I'd add above the way things currently work would be to add +> the [[plugins/listdirectives]] plugin to [[plugins/goodstuff]]. +> Doing that requires making the decision about whether you really want the +> documentation in every wiki - it is 200k. -- [[Will]] + +>> I don't think that it needs to be in goodstuff to close this, though I +>> might decide to add it to goodstuff later. [[done]] --[[Joey]] + Note that there's a disctinction between being self-documenting for users, and being complete documentation for ikiwiki. The basewiki is _not_ intended to be the latter, so it lacks the usage page, all the plugin @@ -28,33 +37,4 @@ basewiki: Meta is another one. -The holdup on documenting these in full in the basewiki is that I'm not sure -where to put the docs. [[HelpOnFormatting]] should stay as simple as possible -and just give examples, not full lists of availavle parameters, etc. And -it's bad enough that [[blog]] uses that toplevel namespace, without adding -lots more toplevel pages to the basewiki. ([[blog]] really needs to be moved.. -I have several wikis that override it with their actual blog content). - -Maybe the thing to do would be to make a meta/ or usage/ or wiki/ or something -directory in the basewiki, and put new pages documenting how to use preprocesor -directives in there. - -Actually, if we look at the basewiki contents: - - blog.mdwn@ pagespec.mdwn@ subpage@ - favicon.ico@ preprocessordirective.mdwn@ subpage.mdwn@ - helponformatting.mdwn@ sandbox.mdwn@ templates/ - index.mdwn@ shortcuts.mdwn@ templates.mdwn@ - local.css@ smileys@ wikiicons@ - markdown.mdwn@ smileys.mdwn@ wikilink.mdwn@ - openid.mdwn@ style.css@ - -Most of this is meta stuff. Only index.mdwn, local.css, favicon.ico, -smileys, wikiicons, shortcuts, and templates are really content/configs that -are used as the base of a wiki. The rest is documentation. - -Moving a lot of these pages could be hard though.. Lots of wikis probably -link to them. Maybe the directory they're moved to could be in the search -path, like the userdir is, so that simple links keep working. - See also: [[Conditional_Underlay_Files]]