On 5/15/07, Gary Johnson <[EMAIL PROTECTED]> wrote:
On 2007-05-15, Tom Purl <[EMAIL PROTECTED]> wrote:
> Task: Wiki Format Sign-Off
> Deadline: Monday, May 21st (arbitrary, I know)
>
> Overview
> ========
>
> We've had some great, constructive discussions lately regarding how we
> will be creating and editing tips in the future. Before we can finally
> decide how this is going to work, however, we need to decide upon a page
> format for tips.
>
> The most recently-updated wiki tip examples can be found at the
> following URL:
>
> * http://scratchpad.wikia.com/wiki/VimTest
>
> The following tips should stand out:
>
> * http://scratchpad.wikia.com/wiki/VimTip1
> * http://scratchpad.wikia.com/wiki/VimTip1_v2
>
> This first tip uses the Template:Tip template
> (http://scratchpad.wikia.com/wiki/Template:Tip), and the second tip uses
> the Template:Tip2 template
> (http://scratchpad.wikia.com/wiki/Template:Tip2).
>
> Requested Actions
> =================
>
> Please take a look at these tips, decide which one you prefer, and then
> provide constructive criticism for that tip's format. There's no such
> thing as a dumb comment.
I much prefer "VimTip1 v2". Whether just browsing tips or reading
tips I've searched for, I want to be able to read it quickly without
having to scan through a bunch of boilerplate. I would even
advocate a Synopsis line that would summarize the tip if the title
didn't already do so. I like having the meta data collected as it
is in one line at the bottom of the tip: it's concise and in an
unobtrusive yet consistent and easy-to-find location.
In the table of contents, each tip really needs to have the title
alongside its number. The first page,
http://scratchpad.wikia.com/wiki/VimTest, is lacking that, unless
the names there (e.g., VimTip123) are just place holders for real
titles. I really don't want to have to load each tip page one at a
time to browse the latest contributions.
My $0.02.
Regards,
Gary
--
Gary Johnson | Agilent Technologies
[EMAIL PROTECTED] | Mobile Broadband Division
| Spokane, Washington, USA
I don't know how to add pages to that dynamic page there if they have
already been created, but I made [1] with template [2] so that it
would work better if you just wanted to see the titles of pages. The
only problem is that this would require more work if we wanted to
scrape the wiki at some point. Anyway, if we WERE to do this, this is
how I envision it working:
1: User creates a new page using Template:Tip3 (or 2 or whatever)
2: They leave the id blank because it will be ignored
3: At some specified interval, a cron job runs that will scrape the
source of any newly created pages and sort them in a chronological
list
4: The program in the cron job moves each new tip to: #{generated id} - #{title}
And then we could probably have another program that would run say,
once a week that would iterate through the entire tip list ensuring
that people didn't do something silly, like change the numbers. I
presume that we would have to use the history and then look at the
initial creation of the page to ensure correct times and whatnot.
I can still see why we would want to use the format:
Tip1
Tip2
...
Tip10
...
but it makes sense to have the names show the titles (or more
obviously, the titles should BE the names).
What do you guys think?
[1] http://scratchpad.wikia.com/wiki/1_-_the_super_star
[2] http://scratchpad.wikia.com/wiki/Template:Tip3
