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

add a tips page

master
joey 2007-02-14 03:58:05 +00:00
parent 3577350846
commit 3d163c03dd
3 changed files with 23 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/examples.mdwn
View File

@ -8,4 +8,4 @@ page gives some examples of ways to use ikiwiki.
Each example is contained in its own subdirectory; just copy the source
files into your wiki to start using one of the examples.
The [[tips]] page has some other ideas for ways to use ikiwiki.

48
doc/examples/softwaresite/templates/release/discussion.mdwn
View File

@ -1,48 +0,0 @@
I'd rather not use a template for my release announcements, because these announcements are generated by the same script I use to release many other projects, and it already automates things fine. The template would need changes to my script and would only complicate the setup I have now. --[[Joey]]
> No problem; sorry for the inconvenience.
>
> Since page moves currently require direct repository access, could you
> please move this release template to
> `examples/softwaresite/templates/release`, and s/ikiwiki/FooBar/g?
>
> Also, would you consider posting your project release scripts somewhere? If
> you have already done so, then could you post a link to them?
>
> --[[JoshTriplett]]
>> No problem. My release script is here:
>> <http://svn.kitenet.net/trunk/bin/wikiannounce> --[[Joey]]
>>> Thanks for moving the page.
>>>
>>> Very nice announcement script.
>>>
>>> Minor typo report: s/Wili/Wiki/ :).
>>>
>>> Also, why do you subst `&`, `<`, and `>`? Markdown already replaces those
>>> with entities.
>>>
>>> Finally, have you considered using an [[cpan HTML::Template]] in the
>>> script itself? Not on the wiki, just as a means for easy customization.
>>> Seems like that would simplify any edits to the format, and make the Perl
>>> code easier to work with at the same time.
>>>
>>> --[[JoshTriplett]]
>>> Also, will this discussion page end up in the softwaresite example? If
>>> so, perhaps it should go elsewhere. --[[JoshTriplett]]
>>>> I escape html because markdown does not escape fully formed html tags
>>>> and I want to be able to mention such tags in my changelogs.
>>>>
>>>> This page should probably be moved somewhere else, or just deleted..
>>>> --[[Joey]]
>>>>> Ah, that didn't occur to me, and it makes perfect sense.
>>>>>
>>>>> Apart from the link to your `wikiannounce` script, feel free to just
>>>>> delete this page. Perhaps you could link to that script from elsewhere
>>>>> on the ikiwiki ikiwiki?
>>>>>
>>>>> Thanks again. --[[JoshTriplett]]

22
doc/tips.mdwn 100644
View File

@ -0,0 +1,22 @@
This page is a place to document tips and techniques for using ikiwiki.
----
One thing I use ikiwiki for is the web pages for software projects I
maintain. Each of my projects has a news page with an announcements feed,
and to automatically update this when I release a new version, generating
an announcement from the debian/changelog and debian/NEWS files, I use a
[wikiannounce](http://svn.kitenet.net/trunk/bin/wikiannounce) program. It's
somewhat specific to dealing with Debian packages, and uses a special
`announcedir` target in debian/rules, but the general idea could be useful.
--[[Joey]]
----
I should mention that I also have a
[blog](http://svn.kitenet.net/trunk/bin/wikiannounce) program that I use to
write blog posts in a text editor. The first line I enter is used as the
title, and it automatically comes up with a unique page name based on the
title and handles all the details of posting to my blog. --[[Joey]]
----