ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / forum / Regex_for_Valid_Characters_in_Filenames.mdwn
1 I'm sure that this is documented somewhere but I've ransacked the wiki and I can't find it.  :-(  What are the allowed characters in an ikiwiki page name?  I'm writing a simple script to make updating my blog easier and need to filter invalid characters (so far I've found that # and , aren't allowed ;-)).  Thanks for any pointers.  -- [[AdamShand]]
2
3 > The default `wiki_file_regexp` matches filenames containing only
4 > `[-[:alnum:]_.:/+]`
5
6 > The titlepage() function will convert freeform text to a valid
7 > page name. See [[todo/should_use_a_standard_encoding_for_utf_chars_in_filenames]]
8 > for an example. --[[Joey]]
9
10 >> Perfect, thanks! 
11 >>
12 >> In the end I decided that I didn't need any special characters in filenames and replaced everything but alphanumeric characters with underscores.  In addition to replacing bad characters I also collapse multiple underscores into a single one, and strip off trailing and leading underscores to make tidy filenames.  If it's useful to anybody else here's a sed example:
13 >>
14 >>     # echo "++ Bad: ~@#$%^&*()_=}{[];,? Iki: +_-:./ Num: 65.5 ++" | sed -e 's/[^A-Za-z0-9_]/_/g' -e 's/__*/_/g' -e 's/^_//g' -e 's/_$//g'
15 >>     Bad_Iki_Num_65_5
16 >>
17 >>--[[AdamShand]]
18
19 [[!meta date="2008-01-18 23:40:02 -0500"]]