I propose we should name all pages which are proposals as such. For example, this page should be called "ProposalDocPageContent" or something. Just so that this thing does not become a mess.

We can't remove "Plugin" from those plugins which have that in their name; that will confuse people to no end. Though, with the new system, we can make them have additional aliases.

Considering that if we start to support subpages, and the separator will be a slash, e.g. "Documentation/TextFormattingRules", I don't know if it helps if we switch into one way now and another way later. Muchos confusiongos might happen.

Note also that there's a lot of goodness in the fact that you can simply refer to IndexPlugin instead having to write [IndexPlugin|Wiki.Plugins.IndexPlugin]. I am not certain whether it's a good thing that we give up the intuitiveness of linking, especially with respect to the core pages.

-- JanneJalkanen

Changed the name to ProposalDocPageNames. Sorry.

In my opinion Wiki.Plugin.Image causes less confusion than Image or Counter. How shall a user know what Wiki.About is about? I would expect it to be about the website and not about the software that was used to create the website. Wouldn't it be nice to have the possibility to automagically generate a list of all pages that have been added by the users? In our hospital intranet we don't want PingWeblogsComFilter standing between Pancreatitis and Pneumonia. And it is very confusing for non-english speaking users. It would be fine if JSPWiki was only used to produce JSPWiki documentation ;-)

-- Frank_Fischer

In general, I like the proposal with the dotted namespace style, for pages which explain about JSPWiki. (why not start with JSPWiki instead of Wiki ?) We may have to tweak the categories still a bit:

• instead of Wiki.User, maybe go for a Wiki.HowTo.xxx of which lots of pages are on jspwiki.org I think
• maybe add a category about text formatting syntax
• suggest to have a Wiki.Help.xxx pages for EditHelp, LuceneHelp etc.
• Wiki.Conf really belongs to Wiki.Admin.XXX
• Wiki.Tag really belongs to Wiki.Developer.Tag.xxx
• drop Wiki.Group since it doesnt match with JSPWiki implementation convention which is GroupXYZ
• drop the category Wiki.Info and do not change the SystemInfo, PageIndex and RecentChanges pages as there are not documentation, but real usage pages.

So here is my current namespace short-list:

Let's also define some additional WikiCategories for cross linking of related pages

• Wiki.PluginCategory
• Wiki.SecurityCategory
• Wiki.FormattingCategory

--DF

Very good points! I have modified the proposal.

Some comments:

• Wiki is shorter than JSPWiki (i am not sure what i would prefer)
• Wiki.Developer.Tag and Wiki.Admin.Conf are deep namespaces but it is good so because they are rarely needed
• Wiki.Group.*: removed
• Wiki.Syntax: would this be OK for text formatting syntax?
• SystemInfo, PageIndex, RecentChanges: provide information generated by JSPWiki (Wiki.Info)
  there might be much more in the future (ListUsers, ListSessions, ListAuthors, ...)
  a normal user probably wants to select these pages from some menu
  he probably does not want these pages standing between his own in PageIndex
• Wiki.PluginCategory: why not Wiki.Plugin or Wiki.HowTo.Plugin?
  (or if Wiki.PluginCategory: what names would you actually give to the plugins?)
  There are many pages for plugins so stuffing them into one separate namespace looks right for me.
• is 'Category' in 'Wiki.FormattingCategory' etc. desireable? Wouldn't 'Wiki.Formatting' look much nicer?

-- Frank_Fischer

Frank,

Tx for the quick reaction. I would still try to furhter make the taxonomy smaller, simpler. So it's easier to become a kind of mental map.

• agree with Wiki iso JSPWiki.
• agree with Wiki.Developer, (but you used Wiki.Devel)
• a list of HowTo pages could replace the wiki.syntax namespace
• I do not agree with the Wiki.Info namespace. Keep the original names, and your idea of ListUsers, ListAuthors are great. Let's make a category page say Wiki.Info pointing to all these pages.
• Plugins are part of HowTo pages. Again, a category page just summing up all plugins could be sufficient. (eg HowToInsertCurrentTime)

regards,

--DF

Dirk,

good points!

The proposal is updated.

How should category pages be named?

• Wiki.FormattingCategory
• Wiki.Category.Formatting
• Wiki.Formatting
• Wiki.HowTo.Formatting
• Wiki.HowTo.FormatText

Probably i would prefer the last version.

-- Frank_Fischer

Should discussions, suggestions, ... be appended to JSPWiki documentation pages (as it is done right now) or would it be better to have two pages

• Wiki.HowTo.InsertCurrentTime (up to date info) with link to
• Wiki.HowTo.InsertCurrentTime.Discussion (ideas for the future, ...) ?

-- Frank_Fischer

Hi Frank,

• Wiki.HowTo.FormatText is great
• About discussion pages: just for the sake of trying, I changed this page with tab for Discussion. However, commong practice in JSPWiki is to have a new page like this: ProposalDocPageNames Discussion (no dot, just a space)
• I would suggest to merge Wiki.GettingStarted with Wiki.HowTo. Eventually a Wiki.HowTo.GetStarted would sound logically ;-)
• The Wiki.Proposal is a namespace which should not be in the documentation ? Just like bugs, ideas, etc. These namespace do make sense in JSPWiki.org. -- so without Wiki.* prefix.
• Similarly, do we need a Wiki.Sandbox or just a Sandbox ? (sandbox is not part of the documentation; but should be linked from the Wiki.Info category.
• Idea: let's have a Wiki.Category page where all existing categories are listed, starting from the one used by the documentation.

--DF

Hello Dirk,

agree with all. The proposal tab is updated.

• Sandbox should be a namespace (Sandbox.). Users can create pages starting with this namespace.
• Wiki.Category renamed to Wiki.HowTo.FindCategories

-- Frank_Fischer

Frank,

Plse check out Wiki.DocumentationMap where I made an attempt to get an overview of current to new page mapping, possible categories, and the status. --DF

Hi guys!

In don't think it's useful to dump all of the page content into the JSPWiki distribution, and with every single JSPWiki installation. Therefore I don't think we need any real namespacing, i.e. start each page with "Wiki.". It just creates a mess on this web site, and makes it that much harder to link to pages. If anything, we will create a "Doc:" -namespace, and allow people to either use that internally or externally - you can either use it as an interwiki link, or in the future, have an internal wiki with all this stuff in it.

-- JanneJalkanen