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 JavaWoman
2004-12-16 16:18:53
Nils, don't spend too much time writing descriptions for the actions: I've already promised create an action to pull all that from documentation blocks in the actions themselves! (And to at least make a start with writing the documentation as well.) It will be similar to my {{highlighter}} action which in a sense was getting my feet wet for this type of autodoc action.
Comment by PetKle
2004-12-21 20:20:46
Where can I find the paremeters for those actions. For example I would like to display 5 recent comments and changes on my home page?
Comment by JavaWoman
2004-12-21 20:52:45
PetKle, (automatic) documentation of the actions is one of the projects for the next version after 1.1.6.0 (which is still in beta) - see my previous comment. Unfortinately, currently many actions aren't all that well documented. If you can read PHP code...

As to displaying 5 recent comments and changes on your page, that is not (yet) possible (no way to set a limit in the action - only users can set a limit in their profile). What might help a little (just to get quick access to the information) is to enter the following page names on your homepage:
RecentChanges - RecentlyCommented - RecentComments
The first two are already in the default page menu as installed.
Comment by JavaWoman
2004-12-21 21:09:41
For those actions for which there is some public information I've added a link to those pages in the list.
Comment by JavaWoman
2004-12-22 11:00:09
Gearing up for formal documentation... naming proposal:
1) NameAction - original for an action called "name", with sourcecode
2) Mod...NameAction - page classifying and describing the action as having been included in Wikka
3) NameActionInfo - user documentation for the action "name"

The list above could then be generated, incuding a short descriptions, and link to individual NameActionInfo pages which could also include generated content, both based on a documentation block in the action in phpDocumentor format.
Comment by NilsLindenberg
2004-12-22 11:41:09
"2) Mod...NameAction - page classifying and describing the action as having been included in Wikka" and whats the difference to 1) ?
Comment by JavaWoman
2004-12-22 12:02:38
Mod...NameAction is a Mod page, classifying it, stating it is part of the official Wikka distribution (and since when); it should not include source code. Whereas NameAction would be the "development" page giving history, discussion and sourcecode. NameActionInfo would contain end-user documentation for an action included in the distribution.

Three different goals, three different pages - squishing it all together would make it hard to find the specific information you need.

And yes, this requires some refactoring of existing pages. :)
Comment by NilsLindenberg
2004-12-22 12:32:51
ok, that would mean following for the files-action (example):

1)FilesAction with the sourcecode (i have created it)

2)Mod15FilesAction about the integration in wikka (sourcecode removed)

3)FilesActionInfo with a end-user documentation (needs to be created)

is this what you mean?
Comment by JavaWoman
2004-12-22 13:23:42
@Nils,
Yes, that's what I mean. :)

[Of course, a proper rename handler would come in really handy to standardize page name...]
Comment by DarTar
2004-12-22 13:52:56
JavaWoman, Nils,
I totally agree with these documentation guidelines :) but there are still many inconsistencies on this server that should be fixed.
I propose, then, a major cleanup/rename operation, following your scheme:

* We should start removing from WikkaDocumentation and from WikkaFeatures all the links pointing to ModXxXxxxx and to original code proposal pages like XxXxxxx.

* ModXxXxxxx pages should only be linked from WikkaModifications and belong only to CategoryDevelopment (not CategoryDocumentation)

* Source code should only appear in XxXxxxx, be removed from both ModXxXxxxx and XxXxxxxInfo and belong only to CategoryDevelopment

* If documentation is missing for specific features/actions new pages should be created with "Info" appended and a CategoryDocumentation link added.

* Feature/Action documentation pages that do not end with "Info" should be consequently renamed
Comment by JavaWoman
2004-12-23 16:29:24
DarTar,
Yes to all your points - thanks for spelling out my thoughts! :)
Comment by JasRandal
2005-04-15 11:37:18
Is there an action to show a list of all users? I didn't see it. Just the lastusers action.
Comment by DarTar
2005-04-15 11:54:32
There is a beta plugin that allows user administration:
http://wikka.jsnx.com/UserAdmin
Comment by JasRandal
2005-04-15 14:38:43
DarTar, not exactly what I was thinking, but beautifully done. I like it. Installed it with no problems. Should I now delete feedback.php from /actions now that I have userfeedback.php uploaded?
Comment by DarTar
2005-04-16 12:03:40
As you wish. Chances are the official feedback action will be improved in the next releases.
Comment by FaiF
2006-07-09 13:44:12
does "emailpassword" still in use? it seems now in version 1.1.6.2 we use email password reminder?
Comment by DarTar
2006-07-10 04:02:19
FaiF, yes - emailpassword is still in use, but the login page now provides a more accurate description of what this action does.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki