Talk:Documentation

From Wiki
Jump to: navigation, search

Headings

PS: I changed this discussion page to contain headings. If more people talk about different things then you can use subheadings to reply to a special heading, thus creating a reply-tree structure (you may have to insert text in the middle to reply to a heading in the middle of the discussion page). I've got the idea from here: http://www.wowwiki.com/Talk:Main_Page

--Cheffe 03:59, 7 Aug 2005 (PDT)



Much better like this. Need to keep in mind that this is not the forums. --Kedrick Valorite 07:08, 7 Aug 2005 (PDT)

Variables and Commands

There's still the problem that you may have several entries resulting in the same wiki link.

"name --Cheffe 18:33, 6 Aug 2005 (PDT)


I'm assuming then that you can't preface a page name with a # somehow?

tests:

#
#true
& #x0023;
& #x0023;true

(without the space between & and #)

--Kedrick Valorite 18:59, 6 Aug 2005 (PDT)


No, you simply can't make pages that are named #something. You can hide the real links by using piped links.

E.g. [[Help:Sandbox|BlaBla]] = BlaBla

--Cheffe 19:21, 6 Aug 2005 (PDT)


humm...

namespaces for commands and sysvars?

e.g [[Commands:str]] and [[SysVars:str]]

--Kedrick Valorite 19:49, 6 Aug 2005 (PDT)


I see CEO has already used a namespace Tutorials. Are you guys sure you understand how namespaces work? It seems to me you can't just pick any namespace you like:

http://meta.wikimedia.org/wiki/Help:Custom_namespaces http://meta.wikimedia.org/wiki/Help:Namespaces#Custom_namespaces

There's a maximum of 78 custom namespaces (article+talk). That may change in MediaWiki 1.5.

--Cheffe 03:59, 7 Aug 2005 (PDT)


Read both last night. I'm not capable of adding a custom namespace, but I think that that will be our solution to avoiding naming conflicts. --Kedrick Valorite 07:17, 7 Aug 2005 (PDT)


Hey, that's just experimenting. Certainly if there's some limitation like that then we'll have to conserve how to use it. Odd, that seems like a common link type thing, but I'm sure there are dozens of other ways to do it I assume rather then use a limited resource.

--CEO 23:47, 7 Aug 2005 (PDT)

Formatting

FYI: as a convention, I used an arrow for 'read only' variables and planned on using a double arrow for read/write variables (within the sysVar page itself)

good, bad, indifferent?


→ = → = "ReadOnly"

↔ = ↔ = "ReadWrite"

--Kedrick Valorite 19:59, 6 Aug 2005 (PDT)

Languages

Here are a few language abbreviations:

http://safariexamples.informit.com/073571150X/Chapters/AppendixB.html

I'd like to have it multilingual.

--Cheffe 03:59, 7 Aug 2005 (PDT)


yes, this should definately be multilingual! --Kedrick Valorite 07:10, 7 Aug 2005 (PDT)

Syntax

I wouldn't use a syntax section for variables. --Cheffe 04:56, 7 Aug 2005 (PDT)


I was looking at that myself last night. thinking on it, the section could simply be removed I think. there's the description and the example. humm...--Kedrick Valorite 06:56, 7 Aug 2005 (PDT)

Community Portal

Let's use the Talk page of the Community Portal to discuss Wiki and formatting. Only use the article's talk page to attach certain notes that may be important if more than a single person are editing an aricle. Otherwise a note may not get read for a while. --Cheffe 07:41, 7 Aug 2005 (PDT)

I think once the documentation is done, we can protect those pages as the official documentation. Then people can click on the discussion link of any particular documentation topic and easily add their input/code to the docs.