8f64c69e08
"local" here is short for "locally valid" - the idea is that we can use
URLs that are relative in the sense of only having the path part, but
absolute in the sense that they start from '/', such as
'/~smcv/ikiwiki.cgi'. There's no particularly good name that I can find
for these between-relative-and-absolute URLs.
They're useful because in the common case where the pages and the CGI
script have the same scheme and authority component, each page is
identified by the same locally-valid URL when linking from any page or
from the CGI, without hard-coding a choice between HTTP and HTTPS, or
between multiple virtual hostnames with the same path layout. As such,
we can use them in many situations that previously used an absolute URL.
If there's no suitable semi-absolute value for local_url (for instance,
if your pages and your CGI reside on different servers), we can just fall
back to using the absolute URL. I append '/' because $config{url} doesn't
end with '/', but the common case for local_url (on all branchable.com
sites, for instance) is that it's just '/'.
|
||
|---|---|---|
| Bundle | ||
| IkiWiki | ||
| cpan | ||
| debian | ||
| doc | ||
| plugins | ||
| po | ||
| t | ||
| templates | ||
| themes | ||
| underlays | ||
| .gitattributes | ||
| .gitignore | ||
| .perlcriticrc | ||
| CHANGELOG | ||
| IkiWiki.pm | ||
| Makefile.PL | ||
| NEWS | ||
| README | ||
| auto-blog.setup | ||
| auto.setup | ||
| docwiki.setup | ||
| gitremotes | ||
| ikiwiki-calendar.in | ||
| ikiwiki-makerepo | ||
| ikiwiki-mass-rebuild | ||
| ikiwiki-transition.in | ||
| ikiwiki-update-wikilist | ||
| ikiwiki-w3m.cgi | ||
| ikiwiki.in | ||
| ikiwiki.spec | ||
| mdwn2man | ||
| pm_filter | ||
| wikilist | ||
README
Use ./Makefile.PL to generate a Makefile, "make" will build the documentation wiki and a man page, and "make install" will install ikiwiki. All other documentation is in the ikiwiki documentation wiki, which is also available online at <http://ikiwiki.info/> A few special variables you can set while using the Makefile.PL: PROFILE=1 turns on profiling for the build of the doc wiki. (Uses Devel::NYTProf) NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended unless your perl is less buggy than mine -- see http://bugs.debian.org/411786) MAKE, FIND, and SED can be used to specify where you have the GNU versions of those tools installed, if the normal make, find, and sed are not GNU. There are also other variables supported by MakeMaker, including PREFIX, INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3). In particular, INSTALL_BASE is very useful if you want to install ikiwiki to some other location, as it configures it to see the perl libraries there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to install ikiwiki and its dependencies in a home directory.