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

* Add softwaresite example.

master
joey 2006-11-22 14:59:26 +00:00
parent 04a9dbfe7d
commit 82ab2ebb08
15 changed files with 124 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
debian/changelog vendored
View File

@ -43,8 +43,9 @@ ikiwiki (1.34) UNRELEASED; urgency=low
* Change rcs_commit, it is now passed the name of the user doing the commit
and their IP address, and needs to construct its own commit message
containing them, or do something more appropriate for the given RCS.
* Add softwaresite example.
-- Joey Hess <joeyh@debian.org> Wed, 22 Nov 2006 09:08:37 -0500
-- Joey Hess <joeyh@debian.org> Wed, 22 Nov 2006 09:59:12 -0500
ikiwiki (1.33) unstable; urgency=low

2
doc/examples.mdwn
View File

@ -2,6 +2,8 @@ To make it easier to get started using ikiwiki for some common tasks, this
page gives some examples of ways to use ikiwiki.
* [[blog]] - a weblog with tags, a tag cloud, archives, and an optional sidebar
* [[softwaresite]] - a website for some software package, the package
can also build static html docs from its wiki
Each example is contained in its own subdirectory; just copy the source
files into your wiki to start using one of the examples.

13
doc/examples/softwaresite.mdwn 100644
View File

@ -0,0 +1,13 @@
This is an [[example_software_package_website|index]].
Just copy the softwaresite subdirectory into your wiki to quickly produce
a website for a piece of software.
Some additional configuration you might want to do:
* Make sure to configure ikiwiki to generate RSS or Atom feeds.
* The softwaresite/doc subdirectory is intended to hold docs about your
software package. These docs can be included in the package itself;
there is a [[softwaresite/doc/Makefile]] that will use ikiwiki to build
static html documentation from the docs directory. ikiwiki itself uses a
similar system to build its documentation.

7
doc/examples/softwaresite/contact.mdwn 100644
View File

@ -0,0 +1,7 @@
To reach the authors of FooBar, join channel `#foobar` on the `examplenet`
irc network.
There's also a mailing list,
[foobar-l](http://example.com/mailman/listinfo/foobar-l).
Be sure to read the [[doc/FAQ]] first.

5
doc/examples/softwaresite/doc.mdwn 100644
View File

@ -0,0 +1,5 @@
Documentation for FooBar.
* First, you'll want to [[install]] it.
* Then you'll want to [[setup]] the config files.
* There's also a [[FAQ]].

43
doc/examples/softwaresite/doc/.ikiwiki/index 100644
View File

@ -0,0 +1,43 @@
mtime=1164207299 ctime=1146711708 src=smileys/star_off.png dest=smileys/star_off.png
mtime=1164207299 ctime=1157693331 src=pagespec.mdwn dest=pagespec.html link=SubPage
mtime=1164207299 ctime=1158340031 src=local.css dest=local.css
mtime=1164207299 ctime=1146711708 src=smileys/smile2.png dest=smileys/smile2.png
mtime=1164207283 ctime=1164122509 src=shortcuts.mdwn dest=shortcuts.html
mtime=1164207299 ctime=1146711708 src=smileys/alert.png dest=smileys/alert.png
mtime=1164207299 ctime=1156307042 src=preprocessordirective.mdwn dest=preprocessordirective.html link=WikiLink
mtime=1164207299 ctime=1146711708 src=smileys/checkmark.png dest=smileys/checkmark.png
mtime=1164207299 ctime=1146711708 src=smileys/icon-info.png dest=smileys/icon-info.png
mtime=1164207357 ctime=1164207356 src=Makefile dest=Makefile
mtime=1164207299 ctime=1150866269 src=subpage/linkingrules.mdwn dest=subpage/linkingrules.html link=SubPage link=WikiLink
mtime=1164207299 ctime=1146711708 src=smileys/smile4.png dest=smileys/smile4.png
mtime=1164207299 ctime=1164132019 src=openid.mdwn dest=openid.html
mtime=1164207357 ctime=1164206463 src=install.mdwn dest=install.html
mtime=1164207299 ctime=1146711708 src=smileys/tired.png dest=smileys/tired.png
mtime=1164207299 ctime=1146711708 src=smileys/angry.png dest=smileys/angry.png
mtime=1164207299 ctime=1146711708 src=smileys/star_on.png dest=smileys/star_on.png
mtime=1164207299 ctime=1146711708 src=smileys/ohwell.png dest=smileys/ohwell.png
mtime=1164207299 ctime=1146711708 src=smileys/biggrin.png dest=smileys/biggrin.png
mtime=1164207299 ctime=1156719536 src=wikilink.mdwn dest=wikilink.html link=WikiLink link=SubPage/LinkingRules link=SubPage link=SandBox
mtime=1164207299 ctime=1164018990 src=markdown.mdwn dest=markdown.html link=HelpOnFormatting link=WikiLink link=PreProcessorDirective
mtime=1164207299 ctime=1146711708 src=smileys/thumbs-up.png dest=smileys/thumbs-up.png
mtime=1164207299 ctime=1146711708 src=smileys/redface.png dest=smileys/redface.png
mtime=1164207299 ctime=1143078587 src=sandbox.mdwn dest=sandbox.html link=WikiLink
mtime=1164207299 ctime=1158368977 src=helponformatting.mdwn dest=helponformatting.html link=MarkDown link=WikiLink link=PreProcessorDirective link=smileys
mtime=1164207299 ctime=1142831466 src=subpage.mdwn dest=subpage.html link=SubPage link=SubPage/LinkingRules link=LinkingRules
mtime=1164207299 ctime=1156719661 src=smileys.mdwn dest=smileys.html link=smileys/smile.png link=smileys/biggrin.png link=smileys/smile2.png link=smileys/smile3.png link=smileys/smile4.png link=smileys/ohwell.png link=smileys/devil.png link=smileys/angry.png link=smileys/frown.png link=smileys/sad.png link=smileys/tongue.png link=smileys/redface.png link=smileys/tired.png link=smileys/thumbs-up.png link=smileys/icon-error.png link=smileys/checkmark.png link=smileys/idea.png link=smileys/attention.png link=smileys/alert.png link=smileys/star_on.png link=smileys/star_off.png link=WikiLink
mtime=1164207299 ctime=1146711708 src=smileys/attention.png dest=smileys/attention.png
mtime=1164207299 ctime=1146711708 src=smileys/frown.png dest=smileys/frown.png
mtime=1164207299 ctime=1163984655 src=style.css dest=style.css
mtime=1164207299 ctime=1146711708 src=smileys/devil.png dest=smileys/devil.png
mtime=1164207357 ctime=1164206582 src=faq.mdwn dest=faq.html
mtime=1164207299 ctime=1146711708 src=smileys/smile.png dest=smileys/smile.png
mtime=1164207283 ctime=1162361786 src=blog.mdwn dest=blog.html link=PreProcessorDirective link=PageSpec link=SubPage
mtime=1164207299 ctime=1146711708 src=smileys/idea.png dest=smileys/idea.png
mtime=1164207299 ctime=1146711708 src=smileys/smile3.png dest=smileys/smile3.png
mtime=1164207299 ctime=1146711708 src=smileys/tongue.png dest=smileys/tongue.png
mtime=1164207299 ctime=1146711708 src=smileys/icon-error.png dest=smileys/icon-error.png
mtime=1164207357 ctime=1164206513 src=setup.mdwn dest=setup.html
mtime=1164207357 ctime=1164206388 src=index.mdwn dest=index.html link=install link=setup link=FAQ
mtime=1164207299 ctime=1162141053 src=favicon.ico dest=favicon.ico
mtime=1164207299 ctime=1146711708 src=smileys/sad.png dest=smileys/sad.png
mtime=1164207299 ctime=1125596662 src=wikiicons/diff.png dest=wikiicons/diff.png

0
doc/examples/softwaresite/doc/.ikiwiki/lockfile 100644
View File

9
doc/examples/softwaresite/doc/Makefile 100644
View File

@ -0,0 +1,9 @@
# Build static html docs suitable for being shipped in the software
# package.
all:
ikiwiki `pwd` html -v --plugin=goodstuff \
--no-rcs --exclude=/discussion --exclude=html --no-discussion
clean:
rm -rf .ikiwiki

11
doc/examples/softwaresite/doc/faq.mdwn 100644
View File

@ -0,0 +1,11 @@
FooBar frequently asked questions.
[[toc ]]
## Is this a real program?
No, it's just an example.
## Really?
Yes, really.

10
doc/examples/softwaresite/doc/install.mdwn 100644
View File

@ -0,0 +1,10 @@
Installing FooBar is pretty straightforward:
tar xzvf foobar.tar.gz
cd foobar
./configure
make
make install
Note that you'll need `libfrobnicate` installed first. You might also want to
edit `config.h`.

4
doc/examples/softwaresite/doc/setup.mdwn 100644
View File

@ -0,0 +1,4 @@
FooBar is configured via the config file `/etc/foobarrc`, and the per-user
`~/.foobarrc`.
The file format should be self-explanatory.

5
doc/examples/softwaresite/download.mdwn 100644
View File

@ -0,0 +1,5 @@
FooBar tarballs can be downloaded from
[here](http://foobar.example.com/download/).
There's also a subversion repository, at
`svn://foobar.example.com/foobar/trunk`.

7
doc/examples/softwaresite/index.mdwn 100644
View File

@ -0,0 +1,7 @@
FooBar is an amazing example program that does not exist. Use it for all
your example program needs. This is its wiki.
* [[download]]
* [[news]]
* [[documentation|doc]]
* [[contact]]

5
doc/examples/softwaresite/news.mdwn 100644
View File

@ -0,0 +1,5 @@
This is where annoucements of new releases, features, and other news is
posted. FooBar users are recommended to subscribe to this page's RSS
feed.
[[inline pages="*softwaresite/news/* and !*/Discussion" rootpage="news" show="30"]]

1
doc/examples/softwaresite/news/version_1.0.mdwn 100644
View File

@ -0,0 +1 @@
Version 1.0 of foobar is released. [[Download]] it today!