This page has moved


This page can now be found on the Wikka Documentation Server.
Thanks for updating your bookmarks!

An archive of old revisions of this page is still available for reference.

 


CategoryMigratedDocs
Comments
Comment by NilsLindenberg
2005-05-20 15:18:06
We do use some of this "rules" already s oi thought i'd better write them down somewhere. Comments?
Comment by OnegWR
2005-05-20 17:47:29
The difference between user contributions an official code was not very clear to me when I first started adding pages, so a page like this would have been helpful
- unofficial actions/handlers/formatters in CategoryUserContributions? (maybe also make references to what category to add?)
- What about code changes and workarounds? Same style?
Comment by DarTar
2005-05-20 18:25:05
ils, thanks for making this explicit. I welcome the initiative but have two remarks:
1) I had never heard of an EN suffix for doc pages in English: I thought there was a tacit agreement on the fact that English Documentation should have no language id, while translations of the English documentation would be named after the source with an extra two-letter code-language tail. Are you proposing we should rename the current docs?
2) JW suggested in #wikka we should create two distinct groups of general doc pages on Actions, Formatters and Handlers; the first on *how to use them*, for end-users, already exist (ActionInfo, FormatterInfo and HandlerInfo), the second on *how to develop them*, for developers, should be created (ActionDevInfo, FormatterDevInfo and HandlerDevInfo). The current descriptions on WikkaDocumentation give the wrong idea that the former contain developer-related info.
Comment by JavaWoman
2005-05-20 20:57:53
To further clarify what DartTar reported I suggested ;) :
- ActionInfo, HandlerInfo and FormatterInfo would be end-user documentation and have *three* sections:
1) explain what the feature *is* (what exactly is an action, what does/can it do)
2) general usage
3) list all available (name, short description)
- ActionDevInfo etc. would be developer documentation and consist of (at least):
1) how an action (etc.) works, technically
2) general pattern for writing one yourself
Comment by JavaWoman
2005-05-20 21:04:38
I was under the same impression as DarTar that documentation pages *without* a language suffix are by definition the official (English) version and only (unofficial) translations get a two-letter (ISO) language suffix.
Comment by NilsLindenberg
2005-05-23 11:33:07
@onegWR: yes, every unofficial code (i.e. code which is not part of the official wikka-release) should go into CategoryUserContributions and being listed on CodeContributions. But publishing code on this wiki should be as easy as possible - better adding the Category and doing the listing afterwards then scaring users away from posting.

Workarounds will be mentioned on this page, too (i'll add a stub for now).

code changes? I say depends on what code is changed. But you remind me that there can be more then one development page (different suggestions) for something (like for the files action).
Comment by NilsLindenberg
2005-05-23 11:36:39
Splitting up the general info pages: very good idea (makes me wonder only what an end user needs to know about the formatters? I'll think about it).
Comment by NilsLindenberg
2005-05-23 12:12:38
About a suffix for the english pages:
it seemed more logical to me and would prevent "false positives" with automatic interlinking (ie. an english page ending with de or fr) also its unlikely.

But i see that this opage needs more work
Comment by DarTar
2007-02-03 06:56:54
Hi Brian, I welcome the new proposal - in the end all the official documentation pages will be removed from this server and the links redirected to the documentation server, so it's good to normalize page names for code contributions. We shouldn't forget to encourage people to create tickets and upload patches to the tracker though (especially if they are meant as changes to the nativa package and not as plugins). We'll take care of this as soon as we setup a new main website and make this server the developer community wiki.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki