urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move inline docs to ikiwiki/directive/inline 

ikiwiki/blog will be going away
master
Joey Hess 2008-09-11 19:39:05 -04:00
parent 8a3d15141c
commit 135628f6d4
20 changed files with 31 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/TourBusStop.mdwn
View File

@ -6,7 +6,7 @@ This wiki serves as the home for the ikiwiki wiki engine, providing collaborativ
* Rather than inventing yet another simplistic, linear version control system, ikiwiki uses a standard version control system such as [[Subversion|rcs/svn]] or [[rcs/Git]]. You can edit a wiki by committing to your repository, as well as through a traditional web interface. This makes ikiwiki ideal for collaborative software development; just keep your wiki in version control next to your software. You can also take full advantage of the features of these systems; for instance, you can keep a local branch of your wiki via [[rcs/Git]].
* You can turn any set of pages into a [[ikiwiki/blog]] or similar news feed,
* You can turn any set of pages into a [[blog]] or similar news feed,
* complete with RSS and Atom support. You can run your weblog on ikiwiki (and [[many_people_do|ikiwikiusers]]), run a Planet-like [[aggregator|plugins/aggregate]] for external feeds, or keep a [[TODO]] and [[bug|bugs]] list with tags for completed items.
* ikiwiki provides a wiki compiler, designed to transform your wiki content into a set of static pages. You can then serve these pages as static content. ikiwiki will not fall over during a Slashdotting, because page views don't require the ikiwiki CGI; as long as your web server can keep up, your site will survive. Furthermore, you can choose whether you want to run the ikiwiki CGI for web edits or only handle commits to the underlying version control system; you can even run ikiwiki privately and just manually copy the content to another server. So if you want to put a wiki up on a server without installing any software on that server, try ikiwiki.

1
doc/basewiki.mdwn
View File

@ -8,7 +8,6 @@ It currently includes these pages:
* [[sandbox]]
* [[shortcuts]]
* [[templates]]
* [[ikiwiki/blog]]
* [[ikiwiki/formatting]]
* [[ikiwiki/markdown]]
* [[ikiwiki/openid]]

4
doc/blog.mdwn 100644
View File

@ -0,0 +1,4 @@
Ikiwiki allows turning any page into a weblog, by using the
[[ikiwiki/directive/inline]] [[ikiwiki/directive]]. For example:
\[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]

2
doc/features.mdwn
View File

@ -47,7 +47,7 @@ program, or other special file and link to it from your wiki pages.
## Blogging
You can turn any page in the wiki into a [[ikiwiki/blog]]. Pages matching a
You can turn any page in the wiki into a [[blog]]. Pages matching a
specified [[ikiwiki/PageSpec]] will be displayed as a weblog within the blog
page. And RSS or Atom feeds can be generated to follow the blog.

1
doc/ikiwiki.mdwn
View File

@ -7,7 +7,6 @@ This wiki is powered by [ikiwiki](http://ikiwiki.info/).
Some documentation on using ikiwiki:
* [[ikiwiki/formatting]]
* [[ikiwiki/blog]]
* [[ikiwiki/pagespec]]
* [[ikiwiki/directive]]
* [[ikiwiki/wikilink]]

12
doc/ikiwiki/blog.mdwn
View File

@ -1,12 +0,0 @@
[[!meta robots="noindex, follow"]]
[[!if test="enabled(inline)"
then="This wiki has the inline plugin **enabled**."
else="This wiki has the inline plugin **disabled**."]]
[[!if test="enabled(inline)"
then="You can"
else="If this wiki had the inline plugin enabled, you could"]]
turn any page on this wiki into a weblog by using the [[directive/inline]]
[[directive]]. For example:
\[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]

2
doc/ikiwiki/directive/aggregate.mdwn
View File

@ -14,7 +14,7 @@ more frequently than once every 15 minutes (though possibly less
frequently, if the cron job runs less frequently than that), and puts a
page per post under the example/ directory in the wiki.
You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or
You can then use ikiwiki's [[inline]] directive to create a blog of one or
more aggregated feeds. For example:
\[[!inline pages="internal(example/*)"]]

2
doc/ikiwiki/formatting.mdwn
View File

@ -95,7 +95,7 @@ you use the following additional features:
"""]]
[[!if test="enabled(inline) and blog" then="""
* Create a [[blog]] by inlining a set of pages:
* Create a blog by inlining a set of pages:
\[[!inline pages="blog/*"]]
"""]]

2
doc/index.mdwn
View File

@ -2,7 +2,7 @@ Ikiwiki is a **wiki compiler**. It converts wiki pages into HTML pages
suitable for publishing on a website. Ikiwiki stores pages and history in a
[[revision_control_system|rcs]] such as [[Subversion|rcs/svn]] or [[rcs/Git]].
There are many other [[features]], including support for
[[blogging|ikiwiki/blog]], as well as a large array of [[plugins]].
[[blogging|blog]], as well as a large array of [[plugins]].
[[!template id=links]]

2
doc/roadmap.mdwn
View File

@ -55,8 +55,6 @@ Release is planned for fall, 2008.
# future goals
* More documentation in the basewiki, including documentation for all enabled
plugins.
* Conversion support for existing other wikis.
(Being worked on for MoinMoin and TWiki by [[Josh_Triplett|JoshTriplett]]
and Jamey Sharp; support for other wikis should fit into the same

2
doc/sandbox.mdwn
View File

@ -78,6 +78,6 @@ The haiku will change after every save, mind you.
-----
This SandBox is also a [[ikiwiki/blog]]!
This SandBox is also a [[blog]]!
[[!inline pages="sandbox/* and !*/Discussion" rootpage="sandbox" show="4" archive="yes"]]

2
doc/tags.mdwn
View File

@ -17,7 +17,7 @@ You can also tag a page with a visible link:
This tag will be displayed just like a regular [[ikiwiki/WikiLink]].
One way to use these tags is to create a [[ikiwiki/blog]] of pages that have a
One way to use these tags is to create a [[blog]] of pages that have a
particular set of tags. Or just look at the [[BackLinks]] to a tag page to
see all the pages that are tagged with it. [[Plugins]] can be written to do
anything else with tags that you might desire.

2
doc/tips/howto_avoid_flooding_aggregators.mdwn
View File

@ -1,4 +1,4 @@
If you have a [[ikiwiki/blog]] that is aggregated, either on a site like Planet
If you have a [[blog]] that is aggregated, either on a site like Planet
Debian, or just through user subscriptions, one common problem is that
changes to the guids of items in the blog can "flood" the aggregator,
causing all recent blog entries to be posted to the top of it.

2
doc/todo/ability_to_force_particular_UUIDs_on_blog_posts.mdwn
View File

@ -2,7 +2,7 @@ When converting an existing blog to ikiwiki it would be useful to be able to pre
Also, it should be possible to change the permalink (the Atom `<link>`) of a post (e.g. moving the content and leaving a redirector behind), while keeping the same Atom `<id>` (so that aggregators don't get confused).
Ideally UUIDs for [blog posts](/ikiwiki/blog/) should be chosen when the post is created, and frozen permanently by checking them in along with the content.
Ideally UUIDs for [[blog]] posts should be chosen when the post is created, and frozen permanently by checking them in along with the content.
Perhaps ikiwiki's blogging functionality could be hooked up to the [meta plugin](/meta/plugin/), with a new meta keyword (uuid? feed-uuid? atom-uuid?) to achieve this.

2
doc/todo/conditional_text_based_on_ikiwiki_features.mdwn
View File

@ -75,7 +75,7 @@ Syntax could vary greatly here, both for the
>> pages."""]]. The help text would then only appear on the sidebar page
>> itself, not the sidebar included on all pages.
>>
>> * On [[ikiwiki/blog]] entries, you could use `included` to implement a cut.
>> * On [[blog]] entries, you could use `included` to implement a cut.
>> (Please don't take that as an argument against. :) ) For instance, you
>> could use included rather than [[plugins/toggle]] for the detailed
>> changelogs of ikiwiki, or to embed an image as a link in the feed rather

2
doc/todo/ctime_on_blog_post_pages_.mdwn
View File

@ -1,4 +1,4 @@
[[Blog|ikiwiki/blog]] feeds and index pages show the posted time (ctime), the actual blog entry pages only show the modified time.
[[Blog]] feeds and index pages show the posted time (ctime), the actual blog entry pages only show the modified time.
The user has to look at the history link to find when a blog item was posted.

2
doc/todo/multiple_templates.mdwn
View File

@ -1,5 +1,5 @@
> Another useful feature might be to be able to choose a different [[template|wikitemplates]]
> file for some pages; [[blog|ikiwiki/blog]] pages would use a template different from the
> file for some pages; [[blog]] pages would use a template different from the
> home page, even if both are managed in the same repository, etc.
Well, that would probably be fairly easy to add if it used [[pagespecs|ikiwiki/pagespec]] to

12
doc/usage.mdwn
View File

@ -166,24 +166,24 @@ configuration options of their own.
* --rss, --norss
If rss is set, ikiwiki will default to generating RSS feeds for pages
that inline a [[ikiwiki/blog]].
that inline a [[blog]].
* --allowrss
If allowrss is set, and rss is not set, ikiwiki will not default to
generating RSS feeds, but setting `rss=yes` in the blog can override
this default and generate a feed.
generating RSS feeds, but setting `rss=yes` in the inline directive can
override this default and generate a feed.
* --atom, --noatom
If atom is set, ikiwiki will default to generating Atom feeds for pages
that inline a [[ikiwiki/blog]].
that inline a [[blog]].
* --allowatom
If allowatom is set, and rss is not set, ikiwiki will not default to
generating Atom feeds, but setting `atom=yes` in the blog can override
this default and generate a feed.
generating Atom feeds, but setting `atom=yes` in the inline directive can
override this default and generate a feed.
* --pingurl URL

2
doc/wikitemplates.mdwn
View File

@ -14,7 +14,7 @@ located in /usr/share/ikiwiki/templates by default.
* `change.tmpl` - Used to create a page describing a change made to the wiki.
* `passwordmail.tmpl` - Not a html template, this is used to
generate a mail with an url the user can use to reset their password.
* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|ikiwiki/blog]].
* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|blog]].
* `rssitem.tmpl` - Used for generating individual items on rss feeds.
* `atompage.tmpl` - Used for generating atom feeds for blogs.
* `atomitem.tmpl` - Used for generating individual items on atom feeds.

1
underlays/basewiki/ikiwiki/blog.mdwn
View File

@ -1 +0,0 @@
../../../doc/ikiwiki/blog.mdwn

8
underlays/basewiki/ikiwiki/blog.mdwn 100644
View File

@ -0,0 +1,8 @@
[[!meta robots="noindex, follow"]]
This page has been removed from ikiwiki's basewiki. For documentation about
creating a blog with ikiwiki, see the documentation of the
[[!iki ikiwiki/directive/inline desc=inline]] directive.
Please update your links, as this redirection page will be removed in a
future ikiwiki release.