Wiki page structure [RFC]

[Patrick W. Barnes]

On Sunday 10 December 2006 11:14, Dimitris Glezos wrote:
> O/H Karsten Wade έγραψε:
>
> I suggest a small change: to follow Wikipedia's structure to put the
>
> introduction right below the `= h1 =` and *after* that the TOC. Like this:
> > = Title of page =
> >
> > This is a description of the page. It should say what the page is about
> > (it's purpose) and be about 1-3 paragraphs long. Something like an
> > introduction.
> >
> > An example: The Fedora Project wiki has a very low barrier to entry for
> > editors. However, there can be a small learning curve when beginning to
> > use wiki, and we have a number of guidelines that all editors should
> > follow. This page provides those guidelines and a few tips to help you
> > get going.
> >
> > [[TableOfContents]]
> >
> > == First section ==
> >
> > Blah.
>

I agree with this totally.  The first shot of a page should tell the user if 
it is the page they really want to look at.  They should know what the page 
is and should get a few details before they start jumping to other sections 
of the page.  The introduction should be short enough to keep the ToC readily 
visible.

> Futhermore, I was hoping to give the authors the opportunity to put an
> image if the want (eg the Ambassadors badge etc), right behind the page
> title, floated to the right. Ideally, this should image be less than
> 250-300px wide, to make sure the most important text of the page (the first
> paragraph) is rendered OK.
>
> I've created a page that follows the above. Best viewed with the new CSS.
> ;-)
>
>   http://webtest.fedora.redhat.com/wiki/DimitrisGlezos/Sandbox
>
> Some notes:
>
>   1. The "you are here" should be handled by the wiki engine and not the
> author of the page.

I've always wondered why the "breadcrumbs" were removed when we switched to 
the current theme.  They are really useful.  They do, however, need to be 
kept in the header, not the content, which would be an automatic thing if 
they were restored to the theme.

>
>   2. We could think about disabling very deep contents on the TOC (ie make
> it include only up to level-3 headings so that it is short and sweet.
>

Generally advisable, with possible exceptions.  If we document how that is 
done, I think most people will do the right thing.

-- 
Patrick "The N-Man" Barnes
nman64 at n-man.com

http://n-man.com/

LinkedIn:
http://linkedin.com/in/nman64

Have I been helpful?  Rate my assistance!
http://rate.affero.net/nman64/
-- 

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/fedora-websites-list/attachments/20061210/a12e2d67/attachment.sig>