diff options
author | intrigeri <intrigeri@boum.org> | 2008-11-04 23:39:35 +0100 |
---|---|---|
committer | intrigeri <intrigeri@boum.org> | 2008-11-04 23:39:35 +0100 |
commit | 40978343575b1cba041c087518e5766d6ca5db82 (patch) | |
tree | c27774e2cfadf0fa3976f710941f59fd66ecaae7 /doc | |
parent | 265e857f6060b899ed6a08b5b28fe5190f056c0c (diff) | |
parent | 4c6c00ccdff71fbb8973de7d256fc987d7a2a7e0 (diff) |
Merge branch 'prv/po' into pub/po
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bugs/pagetitle_function_does_not_respect_meta_titles.mdwn | 9 | ||||
-rw-r--r-- | doc/bugs/txt_plugin_having_problems_with_meta_directives.mdwn | 17 | ||||
-rw-r--r-- | doc/forum/wiki_name_in_page_titles.mdwn | 16 | ||||
-rw-r--r-- | doc/ikiwiki/directive/inline/discussion.mdwn | 11 | ||||
-rw-r--r-- | doc/news/version_2.63.mdwn | 21 | ||||
-rw-r--r-- | doc/news/version_2.68.mdwn | 44 | ||||
-rw-r--r-- | doc/plugins/contrib/po.mdwn | 5 | ||||
-rw-r--r-- | doc/plugins/img/discussion.mdwn | 2 | ||||
-rw-r--r-- | doc/plugins/po.mdwn | 71 | ||||
-rw-r--r-- | doc/todo/New_preprocessor_directive_syntax/discussion.mdwn | 17 | ||||
-rw-r--r-- | doc/todo/syntax_highlighting.mdwn | 39 | ||||
-rw-r--r-- | doc/todo/using_meta_titles_for_parentlinks.html | 6 | ||||
-rw-r--r-- | doc/users/intrigeri.mdwn | 2 | ||||
-rw-r--r-- | doc/users/jasonblevins.mdwn | 29 |
14 files changed, 215 insertions, 74 deletions
diff --git a/doc/bugs/pagetitle_function_does_not_respect_meta_titles.mdwn b/doc/bugs/pagetitle_function_does_not_respect_meta_titles.mdwn index a30ab0fa3..77c86eba1 100644 --- a/doc/bugs/pagetitle_function_does_not_respect_meta_titles.mdwn +++ b/doc/bugs/pagetitle_function_does_not_respect_meta_titles.mdwn @@ -1,3 +1,12 @@ The `IkiWiki::pagetitle` function does not respect title changes via `meta.title`. It really should, so that links rendered with `htmllink` get the proper title in the link text. --[[madduck]] + +> Agreed. [[todo/using_meta_titles_for_parentlinks]] contains a beginning of +> solution. A few quick notes about it: + +> - Using <code>inline</code> would avoid the redefinition + code duplication. +> - A few plugins would need to be upgraded. +> - It may be necessary to adapt the testsuite in `t/pagetitle.t`, as well. + +> --[[intrigeri]] diff --git a/doc/bugs/txt_plugin_having_problems_with_meta_directives.mdwn b/doc/bugs/txt_plugin_having_problems_with_meta_directives.mdwn new file mode 100644 index 000000000..d2d5a46ed --- /dev/null +++ b/doc/bugs/txt_plugin_having_problems_with_meta_directives.mdwn @@ -0,0 +1,17 @@ +When applying my usual copyright and licensing header to a [[plugins/txt]] +page, garbled output is created. + +Here is the header: + + \[[meta copyright="Copyright © 2001, 2002, 2003, 2004, 2005, 2008 Free + Software Foundation, Inc."]] + + \[[meta license="""[[toggle id="license" text="GFDL 1.2+"]][[toggleable + id="license" text="Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free Documentation License, + Version 1.2 or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled + [[GNU_Free_Documentation_License|/fdl]]."]]"""]] + +--[[tschwinge]] diff --git a/doc/forum/wiki_name_in_page_titles.mdwn b/doc/forum/wiki_name_in_page_titles.mdwn index 385e7a3f2..01ff8d817 100644 --- a/doc/forum/wiki_name_in_page_titles.mdwn +++ b/doc/forum/wiki_name_in_page_titles.mdwn @@ -8,3 +8,19 @@ that provides a `IS_HOMEPAGE` template variable? --[[JasonBlevins]] > Hmm, one way to work around this is to put a meta title directive on the > index page. Then TITLE will be that, rather than WIKINAME, and your > template should work. --[[Joey]] + +>> I ended up writing a [path][] plugin since I had some other +>> path-specific conditional things to include in my templates. +>> +>> So now I can do things like this: +>> +>> <title> +>> <TMPL_VAR WIKINAME><TMPL_UNLESS IS_HOMEPAGE>: <TMPL_VAR TITLE></TMPL_UNLESS> +>> </title> +>> +>> But also more complicated path-specific conditionals like +>> `IN_DIR_SUBDIR` to indicate subpages of `/dir/subdir/`. I've got a +>> few other small plugins brewing so I'll try to put up some contrib +>> pages for them soon. --[[JasonBlevins]] + +[path]: http://code.jblevins.org/ikiwiki/plugins.git/plain/path.pm diff --git a/doc/ikiwiki/directive/inline/discussion.mdwn b/doc/ikiwiki/directive/inline/discussion.mdwn index 91b2ff462..e301190bf 100644 --- a/doc/ikiwiki/directive/inline/discussion.mdwn +++ b/doc/ikiwiki/directive/inline/discussion.mdwn @@ -19,3 +19,14 @@ take it as far as implementing "replies" to other comments. ## More dynamic `rootpage` parameter of inline plugin? (Moved to [[todo/dynamic_rootpage]]) + +--- + +## Excluding Images + +Is there a simple way to exclude images, stylesheets, and other +"non-page" files other than a blacklist approach like +`pages="* and !*.png and !*.css"`? --[[JasonBlevins]] + +> The [[plugins/filecheck]] plugin adds a 'ispage()' pagespec test that can do that. +> --[[Joey]] diff --git a/doc/news/version_2.63.mdwn b/doc/news/version_2.63.mdwn deleted file mode 100644 index 165f60ceb..000000000 --- a/doc/news/version_2.63.mdwn +++ /dev/null @@ -1,21 +0,0 @@ -ikiwiki 2.63 released with [[!toggle text="these changes"]] -[[!toggleable text=""" - * Set cookies HttpOnly. - * Typo. Closes: #[497003](http://bugs.debian.org/497003) - * Ignore failure to install files into /etc, in case install is running as - non-root. - * Work around perl $\_ scoping nonsense that caused breakage when loading - external plugins. - * style.css: Add missing semicolon. Closes: #[497176](http://bugs.debian.org/497176) - * filecheck: Fall back to testing for binary or plain text files - if no mime type is detected. - * table: Support header=column to make the table header be the first - column of the data. (AlexandreDupas) - * For fine control over what characters are allowed, unescaped in - source filenames, the wiki\_file\_chars setting is added. For example, - set to "-[:alnum:]+/.\_" to disable colons from being used in source files - (which can cause troubl om Windows). - * po/Makefile: update po files when the pot file has changed. - Closes: #[497951](http://bugs.debian.org/497951) - * editpage: New core plugin factoring out page editing to allow disabling it - if desired."""]]
\ No newline at end of file diff --git a/doc/news/version_2.68.mdwn b/doc/news/version_2.68.mdwn new file mode 100644 index 000000000..b7e625026 --- /dev/null +++ b/doc/news/version_2.68.mdwn @@ -0,0 +1,44 @@ +ikiwiki 2.68 released with [[!toggle text="these changes"]] +[[!toggleable text=""" + * Add support for checking pushes from untrusted git committers. This can be + used to set up anonymous git pushes, and other similar things. + * format: New plugin, allows embedding differently formatted text inside a + page (ie, otl inside a mdwn page, or syntax highlighted code inside a + page). + * relativedate: New javascript-alicious plugin that makes all dates display + relative, in a very nice way, if I say so myself. + * Optimise the no-op post-commit hook, to speed up web edits by a fraction + of a second. + * git: Allow [[sha1\_commit]] to be used in the diffurl, to support cgit. + * shortcut: Fix display of shortcuts while previewing. + * Plugins that used to override displaytime should instead override + formattime. displaytime will call that, and may wrap markup around the + formatted time. + * Add an underlay for javascript, and add ikiwiki.js containing some utility + code. + * toggle: Stop embedding the full toggle code on each page using it, and + move it to toggle.js in the javascript underlay. + * recentchanges: Make feed links point back to anchors on the recentchanges + page. (JasonBlevins) + * Fix issue with utf-8 in wikiname breaking session cookies, by + entity-encoding the wikiname in the session cookie. + * Use the pure perl Data::Dumper when generating setup files to ensure that + utf-8 characters are written out as such, and not as the encoded perl + strings the C Data::Dumper produces. + * inline: Only the last feed link was put on the page, fix this to include + all feed links. So rss will be included along with atom, and pages with + multiple feeds will get links added for all feeds. + * tag: When tagpage is set, force the links created by tagging to point at + the toplevel tagpage, and not closer subpages. The html links already went + there, but internally the links were not recorded as absolute, which could + cause confusing backlinks etc. + * Add an inject function, that can be used by plugins that want to + replace one of ikiwiki's functions with their own version. + (This is a scary thing that grubs through the symbol table, and replaces + all exported occurances of a function with the injected version.) + * external: RPC functions can be injected to replace exported functions. + * Updated French translation. Closes: #[502694](http://bugs.debian.org/502694) + * Updated Spanish translation from the ever vigilant Victor Moral. + * Updated Danish translation from Jonas Smedegaard. Closes: #[503117](http://bugs.debian.org/503117) + * Preserve syslog setting when doing `ikiwiki -setup foo -dumpsetup bar` + * Several fixes to --render mode."""]]
\ No newline at end of file diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index f60b8fbea..98cc07178 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -52,10 +52,13 @@ Any thoughts on this? >>> [[plugins/write]]. I think you can just inject wrappers about a few ikiwiki >>> functions, rather than adding hooks. The `inject` function is pretty >>> insane^Wlow level, but seems to work great. --[[Joey]] ->> +>>> >>>> Thanks a lot, it seems to be a nice interface for what I was trying to achieve. >>>> I may be forced to wait two long weeks before I have a chance to confirm >>>> this. Stay tuned. --[[intrigeri]] +>>>> +>>>>> I've updated the plugin to use `inject`. It is now fully self-contained, +>>>>> and does not modify the core anymore. --[[intrigeri]] >> >> The Discussion pages issue is something I am not sure about yet. But I will >> probably decide that "slave" pages, being only translations, don't deserve diff --git a/doc/plugins/img/discussion.mdwn b/doc/plugins/img/discussion.mdwn index 02d46e380..5bf340c56 100644 --- a/doc/plugins/img/discussion.mdwn +++ b/doc/plugins/img/discussion.mdwn @@ -5,3 +5,5 @@ logo link to \[[hurd/logo]] / <http://www.bddebian.com/~wiki/hurd/logo/> instead of linking to the PNG image file. --[[tschwinge]] > Done, use link=somepage --[[Joey]] + +It would be handy if the `class` and `id` tags were passed through to the surrounding `table` in the case of `caption` being present. Would this break anything? --[[neale]] diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index fe6b6b562..173a26ac4 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -185,12 +185,12 @@ Automatic PO files update Committing changes to a "master" page: -1. updates the POT file and the PO files for the supported languages - (this is done in the `needsbuild` hook); the updated PO files are - then put under version control +1. updates the POT file, as well as the PO files for the "slave" + languages (this is done in the `needsbuild` hook); the updated PO + files are then put under version control; 2. triggers a refresh of the corresponding HTML slave pages (this is achieved by making any "slave" page dependent on the corresponding - "master" page, in the `needsbuild` hook) + "master" page, in the `needsbuild` hook). Also, when the plugin has just been enabled, or when a page has just been declared as being translatable, the needed POT and PO files are @@ -199,33 +199,23 @@ created, and the PO files are checked into version control. Discussion pages ---------------- -Discussion should happen in the language in which the pages are written for -real, *i.e.* the "master" one. If discussion pages are enabled, "slave" pages -therefore link to the "master" page's discussion page. +Discussion should happen in the language in which the pages are +written for real, *i.e.* the "master" one. If discussion pages are +enabled, "slave" pages therefore link to the "master" page's +discussion page. Translating ----------- -One can edit the PO files using ikiwiki's CGI (a message-by-message interface -could also be implemented at some point). +One can edit the PO files using ikiwiki's CGI (a message-by-message +interface could also be implemented at some point). -If [[tips/untrusted_git_push]] is setup, one can edit the PO files in her -preferred `$EDITOR`, without needing to be online. +If [[tips/untrusted_git_push]] is setup, one can edit the PO files in +her preferred `$EDITOR`, without needing to be online. TODO ==== -OTHERLANGUAGES dependencies ---------------------------- - -Pages using `OTHERLANGUAGES` depend on any "master" and "slave" pages -whose status is being displayed. It is supposed to trigger dependency -loops, but no practical bugs were noticed yet. - -Should pages using the `OTHERLANGUAGES` template loop be declared as -linking to the same page in other versions? To be rigorous, they -should, but this may clutter the backlinks. - Security checks --------------- @@ -243,46 +233,31 @@ gettext/po4a rough corners changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers a PO update, that changes bla.fr.po in repo2; etc.; fixed in `629968fc89bced6727981c0a1138072631751fee`? -- new translations created in the web interface must get proper charset/encoding - gettext metadata, else the next automatic PO update removes any non-ascii - chars; possible solution: put such metadata into the Pot file, and let it - propagate; should be fixed in `773de05a7a1ee68d2bed173367cf5e716884945a`, time - will tell. +- new translations created in the web interface must get proper + charset/encoding gettext metadata, else the next automatic PO update + removes any non-ascii chars; possible solution: put such metadata + into the Pot file, and let it propagate; should be fixed in + `773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell. Misc. improvements ------------------ -### preview - -preview does not work for PO files. - -### automatic POT/PO update - -Use the `change` hook instead of `needsbuild`? - ### page titles -Use nice page titles from meta plugin in links, as inline already does. This is -actually a duplicate for -[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might be fixed -by something like [[todo/using_meta_titles_for_parentlinks]]. +Use nice page titles from meta plugin in links, as inline already +does. This is actually a duplicate for +[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might +be fixed by something like [[todo/using_meta_titles_for_parentlinks]]. ### websetup Which configuration settings are safe enough for websetup? -### parentlinks - -When the wiki home page is translatable, the parentlinks plugin sets -`./index.html` as its translations' single parent link. Ideally, the home page's -translations should get no parent link at all, just like the version written in -the master language. - ### backlinks If a given translatable `sourcepage.mdwn` links to \[[destpage]], -`sourcepage.LL.po` also link to \[[destpage]], and the latter has the master -page *and* all its translations listed in the backlinks. +`sourcepage.LL.po` also link to \[[destpage]], and the latter has the +master page *and* all its translations listed in the backlinks. Translation quality assurance ----------------------------- diff --git a/doc/todo/New_preprocessor_directive_syntax/discussion.mdwn b/doc/todo/New_preprocessor_directive_syntax/discussion.mdwn index dda1ff5e9..f6c0fc0ec 100644 --- a/doc/todo/New_preprocessor_directive_syntax/discussion.mdwn +++ b/doc/todo/New_preprocessor_directive_syntax/discussion.mdwn @@ -1,2 +1,19 @@ Err, is this really fixed in 2.21? I can't find it anywhere in 2.32.3 (debian unstable) + +----- + +I just did a `--dumpsetup` with the current version from the Git repository +and the default option is + + # use '!'-prefixed preprocessor directives? + prefix_directives => 0, + +My impression was that this should be enabled by default now. --[[JasonBlevins]] + +> As stated in `debian/NEWS`: +>> For backward compatibility with existing wikis, +>> refix_directives currently defaults to false. In ikiwiki 3.0, +>> prefix_directives will default to true [...] +> --[[intrigeri]] + diff --git a/doc/todo/syntax_highlighting.mdwn b/doc/todo/syntax_highlighting.mdwn index bb1c84f02..97526bae6 100644 --- a/doc/todo/syntax_highlighting.mdwn +++ b/doc/todo/syntax_highlighting.mdwn @@ -23,6 +23,8 @@ pages, as well as doing syntax highlighting as a preprocessor directive * [[sourcecode|todo/automatic_use_of_syntax_plugin_on_source_code_files/discussion]] also uses src-highlight, and operates on whole source files. Updated to work with the fix for [[bugs/multiple_pages_with_same_name]]. Untested with files with no extension, e.g. `Makefile`. +* [[user/jrblevin]]'s code plugin uses src-highlight, and supports both + while file and directive use. ## General problems @@ -32,6 +34,10 @@ pages, as well as doing syntax highlighting as a preprocessor directive we could use an external plugin..) * Currently no single plugin supports both modes of operation (directive and whole source file to page). + + > This is now fixed by the [[ikiwiki/directive/format]] directive for all + > whole-source-file plugins, right? + * Nothing seems to support [[wiki-formatted_comments|wiki-formatted_comments_with_syntax_plugin]] inside source files. Doing this probably means post-processing the @@ -45,6 +51,17 @@ pages, as well as doing syntax highlighting as a preprocessor directive One approach that's also been requested for eg, [[plugins/contrib/mediawiki]] is to allow controlling which linkification types a page type can have on it. + + > The previous two points seem to be related. One thought: instead of + > getting the source from the `content` parameter, the plugin could + > re-load the page source. That would stop directives/links from + > being processed in the source. As noted above, comments + > could then be parsed for directives/links later. + > + > Would it be worth adding a `nodirectives` option when registering + > an htmlize hook that switches off directive and link processing before + > generating the html for a page? + * The whole-file plugins all get confused if there is a `foo.c` and a `foo.h`. This is trivially fixable now by passing the keepextension option when registering the htmlize hooks, though. @@ -61,6 +78,28 @@ pages, as well as doing syntax highlighting as a preprocessor directive extensions. The workaround is to use a directive on a wiki page, pulling in the Makefile. + > I wonder how hard it would be to make a patch whereby a file with + > no `.` in the name, and a name that matches a filetype, and where + > that filetype was registered `keepextension`, then the file is just + > chosen as the appropriate type. This would allow `Makefile` to + > work. + +like this: + + diff --git a/IkiWiki.pm b/IkiWiki.pm + index 8d728c9..1bd46a9 100644 + --- a/IkiWiki.pm + +++ b/IkiWiki.pm + @@ -618,6 +618,8 @@ sub pagetype ($) { #{{{ + + if ($page =~ /\.([^.]+)$/) { + return $1 if exists $hooks{htmlize}{$1}; + + } elsif ($hooks{htmlize}{$page}{keepextension}) { + + return $page; + } + return; + } #}}} + ## format directive Rather than making syntax highlight plugins have to provide a preprocessor diff --git a/doc/todo/using_meta_titles_for_parentlinks.html b/doc/todo/using_meta_titles_for_parentlinks.html index 651b7fa0f..d04e5a300 100644 --- a/doc/todo/using_meta_titles_for_parentlinks.html +++ b/doc/todo/using_meta_titles_for_parentlinks.html @@ -114,3 +114,9 @@ diff -c /usr/share/perl5/IkiWiki/Plugin/meta.pm.distrib /usr/share/perl5/IkiWiki </pre> + +<p> +This is actually a duplicate for +[[bugs/pagetitle_function_does_not_respect_meta_titles]], where I'm +following up a bit. --[[intrigeri]] +</p>
\ No newline at end of file diff --git a/doc/users/intrigeri.mdwn b/doc/users/intrigeri.mdwn index f9a216e18..8fa9965a5 100644 --- a/doc/users/intrigeri.mdwn +++ b/doc/users/intrigeri.mdwn @@ -1,4 +1,4 @@ intrigeri AT boum.org, already loving ikiwiki. * [gnupg key](http://gaffer.ptitcanardnoir.org/intrigeri/intrigeri.asc) -* Git repository ([gitweb](http://repo.or.cz/w/ikiwiki/intrigeri.git)) with various ikiwiki {feature, bugfix}-branches : `git://repo.or.cz/ikiwiki/intrigeri.git` +* Git repository with various ikiwiki {feature, bugfix}-branches : `git://gaffer.ptitcanardnoir.org/ikiwiki.git` diff --git a/doc/users/jasonblevins.mdwn b/doc/users/jasonblevins.mdwn index f69a8040c..61c381d96 100644 --- a/doc/users/jasonblevins.mdwn +++ b/doc/users/jasonblevins.mdwn @@ -29,7 +29,8 @@ Current ikiwki issues of interest: ## Plugins These plugins are experimental. Use them at your own risk. Read the -perldoc documentation for more details. +perldoc documentation for more details. Patches and suggestions are +welcome. * [mdwn_itex][] - Works with the `mdwn` plugin to convert inline LaTeX expressions to MathML using `itex2MML`. @@ -37,6 +38,30 @@ perldoc documentation for more details. * [h1title][] - If present, use the leading level 1 Markdown header to set the page title and remove it from the page body. + * [code][] - Whole file and inline code snippet syntax highlighting + via GNU Source-highlight. The list of supported file extensions is + configurable. There is also some preliminary [documentation][code-doc]. + See the [FortranWiki](http://fortranwiki.org) for examples. + + * [metamail][] - a plugin for loading metadata from email-style + headers at top of a file (e.g., `title: Page Title` or + `date: November 2, 2008 11:14 EST`). + + * [pandoc][] - Markdown page processing via Pandoc. LaTeX and + reStructuredText are optional. + + * [path][] - Provides path-specific template conditionals such as + `IS_HOMEPAGE` and `IN_DIR_SUBDIR`. + + [mdwn_itex]: http://code.jblevins.org/ikiwiki/plugins.git/plain/mdwn_itex.pm + [h1title]: http://code.jblevins.org/ikiwiki/plugins.git/plain/h1title.pm + [code]: http://code.jblevins.org/ikiwiki/plugins.git/plain/code.pm + [code-doc]: http://code.jblevins.org/ikiwiki/plugins.git/plain/code.text + [metamail]: http://code.jblevins.org/ikiwiki/plugins.git/plain/metamail.pm + [pandoc]: http://code.jblevins.org/ikiwiki/plugins.git/plain/pandoc.pm + [path]: http://code.jblevins.org/ikiwiki/plugins.git/plain/path.pm + + ## MathML and SVG support So far, I've made some notes on sanitizing MathML and SVG via @@ -82,5 +107,3 @@ page in the first place (unless they post directly to the right URL). [template-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=blobdiff;f=templates/page.tmpl;h=380ef699fa72223744eb5c1ee655fb79aa6bce5b;hp=9084ba7e11e92a10528b2ab12c9b73cf7b0f40a7;hb=416d5d1b15b94e604442e4e209a30dee4b77b684;hpb=ececf4fb8766a4ff7eff943b3ef600be81a0df49 [cgi-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=commitdiff;h=fa538c375250ab08f396634135f7d79fce2a9d36 - [mdwn_itex]: http://code.jblevins.org/ikiwiki/plugins/mdwn_itex.pm - [h1title]: http://code.jblevins.org/ikiwiki/plugins/h1title.pm |