Wiki tips

[Mike Hearn]

A few tips on how to use the Wiki:

- Embedding a block of code is best done like this:

{{{
#!cplusplus
if (foo) 
{ 
    bar;
}
}}}

This will give it nice syntax highlighting, a monospace font and line
  numbers.

- Unfortunately StudlyCaps as the Win32 API uses them is the same style
  that triggers WikiWording. To fix this surround Win32 API names like 
  CreateWindow or IShellLink with backticks: eg `IShellLink`. This will
  disable WikiWording in that section and also format them with a 
  monospace font.

- If you have a word that it wants to WikiWord, prefix it with a ! mark.
  Don't do this just because there's no page for it yet, somebody may
  create one in future. Also don't do it for Win32 API names, use
  backticks instead. But it can be useful for some things.

Those Wine developers who haven't yet made a todo list, go do it! It's
really informative to be able to see what people are working on (not to
mention interesting) and this way we can help cut down on duplication of
effort.

thanks -mike

[Dimitrie Paun]

These are good tips. Maybe we should collect them on the Wiki :)

Couple more:
  -- if you want to put your email on your page, but are afraid
     of spam, use the MailTo macro like so:
    [[MailTo(dimi AT SPAMFREE lattica DOT com)]]
     This will still show the address properly in the browser, 
    and avoids email harvesting just fine.

-- please try to provide a comment when you change a page.
     It takes very little effort (just a few words will do), and helps
     a lot when you look at RecentChanges.

I'm glad people like the Wiki. It can become an amazing resource,
but only if people contribute and take care of it. I think it's already
on it's way of being a great development resource.

If you have any complaints, needs or wants, please don't hesitate
to voice them -- I'd be more then happy to address them.

[Michael Stefaniuc]

Dimitrie Paun wrote:
> These are good tips. Maybe we should collect them on the Wiki :)
>
> Couple more:
>   -- if you want to put your email on your page, but are afraid
>      of spam, use the MailTo macro like so:
>     [[MailTo(dimi AT SPAMFREE lattica DOT com)]]
>      This will still show the address properly in the browser,

Only if you are logged in. If not you get the SPAMFREE stuff.
> and avoids email harvesting just fine.

bye
    michael

[Dustin Navea]

It _would_ be nice if we could possibly move all of the FAQ's and 
users/development guides to the wiki..  That way it would be easier to 
maintain, as you could do it from any computer, and not have to edit 
sgml, submit a patch, etc..

I could help with porting it all in my free time, now that the bug 
submits have calmed down somewhat..  This would give me a chance to 
update some of the outdated information and just do general cleanups..

Any objections?  If not Ill start work on it on Monday, and just put it 
under new users called FrequentQuestions UserGuides and DevelGuides with 
a password we can all remember, something like 1234, who knows?

Dustin

Dimitrie Paun wrote:
> These are good tips. Maybe we should collect them on the Wiki :)
>
> Couple more:
>   -- if you want to put your email on your page, but are afraid
>      of spam, use the MailTo macro like so:
>     [[MailTo(dimi AT SPAMFREE lattica DOT com)]]
>      This will still show the address properly in the browser, 
>     and avoids email harvesting just fine.
>
> -- please try to provide a comment when you change a page.
>      It takes very little effort (just a few words will do), and helps
>      a lot when you look at RecentChanges.
>
> I'm glad people like the Wiki. It can become an amazing resource,
> but only if people contribute and take care of it. I think it's already
> on it's way of being a great development resource.
>
> If you have any complaints, needs or wants, please don't hesitate
> to voice them -- I'd be more then happy to address them.

[Dimi Paun]

On Thu, 2005-05-19 at 23:25 -0500, Dustin Navea wrote:
> It _would_ be nice if we could possibly move all of the FAQ's and 
> users/development guides to the wiki..

No, they are just fine where they are. We just moved them to new
repository. We have translations, we can generate different output
formats, etc. Plus they don't change often.