diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ikiwiki/markdown.mdwn | 5 | ||||
| -rw-r--r-- | doc/plugins/contrib/po.mdwn | 6 | ||||
| -rw-r--r-- | doc/plugins/format/discussion.mdwn | 10 | ||||
| -rw-r--r-- | doc/robots.txt | 2 | ||||
| -rw-r--r-- | doc/tips/convert_mediawiki_to_ikiwiki/discussion.mdwn | 14 | ||||
| -rw-r--r-- | doc/tips/emacs_syntax_highlighting.mdwn | 3 | ||||
| -rw-r--r-- | doc/tips/untrusted_git_push/discussion.mdwn | 33 | ||||
| -rw-r--r-- | doc/tips/vim_syntax_highlighting.mdwn | 6 | ||||
| -rw-r--r-- | doc/tips/vim_syntax_highlighting/discussion.mdwn | 7 | ||||
| -rw-r--r-- | doc/users/jondowland.mdwn | 12 |
10 files changed, 89 insertions, 9 deletions
diff --git a/doc/ikiwiki/markdown.mdwn b/doc/ikiwiki/markdown.mdwn index 3bebaef65..684191929 100644 --- a/doc/ikiwiki/markdown.mdwn +++ b/doc/ikiwiki/markdown.mdwn @@ -4,10 +4,7 @@ is a minimal markup language that resembles plain text as used in email messages. It is the markup language used by this wiki by default. For documentation about the markdown syntax, see [[formatting]] and -[Markdown: syntax](http://daringfireball.net/projects/markdown/syntax). A -[markdown mode](http://jblevins.org/projects/markdown-mode/) for -emacs can help in editing, as can this -[syntax file](http://plasticboy.com/markdown-vim-mode/) for vim. +[Markdown: syntax](http://daringfireball.net/projects/markdown/syntax). Note that [[WikiLinks|WikiLink]] and [[directives|directive]] are not part of the markdown syntax, and are the only bit of markup that this wiki diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index cc19c53b3..4ad0fa063 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -118,6 +118,10 @@ Any thoughts on this? >>> accordingly, but I forgot to update this page at the same time. >>> Hoping it's not too complicated to relocated an existing remote... >>> (never done that, I'm a Git beginner as well as a Perl ->>> newbie) --[[intrigeri]]a +>>> newbie) --[[intrigeri]] >>>> >>>> Just a matter of editing .git/config, thanks for the heads up. +>>>>> +>>>>> Joey, please have a look at my branch, your help would be really +>>>>> welcome for the security research, as I'm almost done with what +>>>>> I am able to do myself in this area. --[[intrigeri]] diff --git a/doc/plugins/format/discussion.mdwn b/doc/plugins/format/discussion.mdwn index b7d6ca71c..df8448ed6 100644 --- a/doc/plugins/format/discussion.mdwn +++ b/doc/plugins/format/discussion.mdwn @@ -3,3 +3,13 @@ Is there any way to tell if an htmlize hook have been called from a format direc I am currently modifying the [[contrib/highlightcode]] plugin by [[sabr]] and I wanted to have a different behavior depending on the fact that the htmlize hook is called from a format directive or not. For instance, this could disable the raw copy of the highlighted code. Since I have enabled the keepextension option, I tried to rely on the page extension to decide whenever I have to create the raw file or not but this does not seems a reliable approach. One possible solution is to add an optional parameter to the htmlize hook (and thus to htmlize function in IkiWiki.pm) which could tell if this is the format directive that called the function but I am not sure that is a good way to do this. + +> It's (probably) not just the format directive that has a potential problem here. +> Imagine a syntax highlighted source code file that contains some other +> directive, such as table or meta. Such a directive calls `htmlize` on the +> parameters passed to it. +> +> There is one way to detect this ATM. If `%IkiWiki::preprocessing` has +> anything in it, then ikiwiki is in the middle of handling a preprocessing +> directive. So you could check that. It's getting into internals, so not +> ideal.. --[[Joey]] diff --git a/doc/robots.txt b/doc/robots.txt new file mode 100644 index 000000000..7be87f9bd --- /dev/null +++ b/doc/robots.txt @@ -0,0 +1,2 @@ +User-Agent: * +Disallow: /ikiwiki.cgi diff --git a/doc/tips/convert_mediawiki_to_ikiwiki/discussion.mdwn b/doc/tips/convert_mediawiki_to_ikiwiki/discussion.mdwn new file mode 100644 index 000000000..6e5f1668a --- /dev/null +++ b/doc/tips/convert_mediawiki_to_ikiwiki/discussion.mdwn @@ -0,0 +1,14 @@ +The u32 page is excellent, but I wonder if documenting the procedure here +would be worthwhile. Who knows, the remote site might disappear. But also +there are some variations on the approach that might be useful: + + * using a python script and the dom library to extract the page names from + Special:Allpages (such as + <http://www.staff.ncl.ac.uk/jon.dowland/unix/docs/get_pagenames.py>) + * Or, querying the mysql back-end to get the names + * using WWW::MediaWiki for importing/exporting pages from the wiki, instead + of Special::Export + +Also, some detail on converting mediawiki transclusion to ikiwiki inlines... + +-- [[JonDowland]] diff --git a/doc/tips/emacs_syntax_highlighting.mdwn b/doc/tips/emacs_syntax_highlighting.mdwn new file mode 100644 index 000000000..941cf5415 --- /dev/null +++ b/doc/tips/emacs_syntax_highlighting.mdwn @@ -0,0 +1,3 @@ +A [markdown mode](http://jblevins.org/projects/markdown-mode/) for +emacs can help in editing of ikiwiki +[[ikiwiki/markdown]] files. diff --git a/doc/tips/untrusted_git_push/discussion.mdwn b/doc/tips/untrusted_git_push/discussion.mdwn new file mode 100644 index 000000000..e85625a1b --- /dev/null +++ b/doc/tips/untrusted_git_push/discussion.mdwn @@ -0,0 +1,33 @@ +I've just tried this (commit c1fa07a). Recent changes shows: + +<div id="change-c1fa07ad4f165b42c962ba2a310681107f38c4f7" class="metadata"> +<span class="desc"><br />Changed pages:</span> +<span class="pagelinks"> + +<a href="http://git.ikiwiki.info/?p=ikiwiki;a=blobdiff;h=8bfa3dd7601a09b11ecbd20026849a777dc4b1b9;hp=c6302616f52ec058de5a8f5956fc512149a2f1a3;hb=1ea66c3d3f0a33bc3f04d073457b525a70380c37;f=doc/users/jondowland.mdwn"><img src="/wikiicons/diff.png" alt="diff" /></a><a href="http://ikiwiki.info/ikiwiki.cgi?page=users%2Fjondowland&do=recentchanges_link">users/jondowland</a> + + +</span> +<span class="desc"><br />Changed by:</span> +<span class="committer"> + +<a href="http://ikiwiki.info/ikiwiki.cgi?page=users%2Fjon&do=recentchanges_link">jon</a> + +</span> +<span class="desc"><br />Commit type:</span> +<span class="committype">git</span> +<span class="desc"><br />Date:</span> +<span class="changedate"><span class="relativedate" title="Mon, 10 Nov 2008 18:24:22 -0500">18:24:22 11/10/08</span> +</div> + +Note that the user for the commit is 'jon', and the link points at cgi to +create users/jon. I was wondering if that is configurable for users pushing +via git. It would be nice perhaps to specify it in some way, perhaps via a +git-config setting (user.name?). I'm not too familiar with exactly what the +changeset contains. -- [[JonDowland]] + +> All ikiwiki can do it look at who git has recorded as the author of +> the change (and it looks at the username part of the email address). +> You can set `user.email` in `.git/config`. --[[Joey]] + +> > Ah, excellent. In which case this *should* DTRT... -- [[JonDowland]] diff --git a/doc/tips/vim_syntax_highlighting.mdwn b/doc/tips/vim_syntax_highlighting.mdwn index 453efa8d1..172b763c3 100644 --- a/doc/tips/vim_syntax_highlighting.mdwn +++ b/doc/tips/vim_syntax_highlighting.mdwn @@ -1,2 +1,4 @@ -[[ikiwiki.vim]] is a vim syntax highlighting file for ikiwiki. Installation -instructions are at the top of the file. +[[ikiwiki.vim]] is a vim syntax highlighting file for ikiwiki +[[ikiwiki/markdown]] files. + +Installation instructions are at the top of the file. diff --git a/doc/tips/vim_syntax_highlighting/discussion.mdwn b/doc/tips/vim_syntax_highlighting/discussion.mdwn index b1637e758..038854b9f 100644 --- a/doc/tips/vim_syntax_highlighting/discussion.mdwn +++ b/doc/tips/vim_syntax_highlighting/discussion.mdwn @@ -1 +1,8 @@ I'm going to look at merging this with potwiki.vim (a vim-based personal wiki) so that you can follow wiki-links and auto-create pages etc., direct from vim. (I'm writing this incase I don't get around to it) -- [[JonDowland]] + +---- + +Another attempt at the same thing is here: +<http://plasticboy.com/markdown-vim-mode/> + +In my tests, [[ikiwiki.vim]] works better than that one, YMMV. --[[Joey]] diff --git a/doc/users/jondowland.mdwn b/doc/users/jondowland.mdwn index c6302616f..8bfa3dd76 100644 --- a/doc/users/jondowland.mdwn +++ b/doc/users/jondowland.mdwn @@ -1,5 +1,13 @@ -A new ikiwiki user, looking at ikiwiki both for his personal site but also as a team-documentation management system for a small-sized group of UNIX sysadmins. +I'm looking at ikiwiki both for my personal site but also as a +team-documentation management system for a small-sized group of UNIX +sysadmins. * My [homepage](http://jmtd.net/) is powered by ikiwiki (replacing my [older homepage](http://alcopop.org/), which was a mess of scripts) -I am giving a talk at the [UK UNIX User's Group](http://www.ukuug.org/) annual [Linux conference](http://www.ukuug.org/events/linux2008/) about organising system administrator documentation which will feature IkiWiki. +I gave a talk at the [UK UNIX User's Group](http://www.ukuug.org/) annual +[Linux conference](http://www.ukuug.org/events/linux2008/) about organising +system administrator documentation. Roughly a third of this talk was +discussing IkiWiki in some technical detail and suggesting it as a good piece +of software for this task. + + * slides at <http://www.staff.ncl.ac.uk/jon.dowland/unix/docs/>. |