Community
Participate
Working Groups
As per https://bugs.eclipse.org/bugs/show_bug.cgi?id=125497#c18I'm opening a new bug on this same issue: [Old words] The wiki (http://wiki.eclipse.org/index.php/Main_Page) is similar, but not the same, as the other pages (http://www.eclipse.org/). Because projects are incorporating wiki pages into their websites, it would be best to have a consistent UI. [New words clarifying the old words] The wiki left nav that combines actions (edit), meta-links (related changes), and navigation (main page) is not consistent with the rest of the eclipse.org website. [Revised words clarifying old words] There needs to be a way to specify the left menu for a wiki page so that one could say "make the left menu of this page be the same as the Web Tools left menu" - then the wiki pages could be even more integrated with a project's website.
If I understand correctly, that would be great. What I would ideally want for a Wiki page that was categorized as "Mylar" would have Mylar project contents in the left menu, and a separate section of that menu (or top of the wiki page) for the wiki operations. For pages categorized under a Project the "Navigation" section could be axed since it offers almost nothing of use. Most of the "Toolbox" could probalby go away too, making room for project-specific navigation.
I updated the title to better reflect my understanding of comment 0. A proposed solution would be: a) for projects to identify Wiki pages as belonging to their project by adding a tag to them (for instance, {{PROJECT:technology.phoenix}} or something along those lines). We need to decide on a standard tag. b) for the Phoenix team to hack the Wiki skin or create a plugin that, upon detecting the {{PROJECT}} tag, queries the ProjectInfo in the same manner as Phoenix does and generates the left nav identical to the website. While implementing this, it also means that: a) the 'default' left nav for non-project wiki pages should also be the same left nav as the eclipse.org website (the four links) b) the Edit/History/Recent Changes wiki knobs need to be moved, possibly to the bottom of the page. I've cc'd the folks on the Higgins project, as they have expressed interest in this. I also changed this to a bug, as it's a source of pain for our community. Mik, Paul and Mary, would the proposed solution (you add a tag to all your Wiki pages, and we put the same left navigation as your project website) work for you?
(In reply to comment #2) Could we tweak this a little to do the following: 1. Once a day (or something) a background job does a fetch of each project's root home page. It extracts the HTML for the left nav from that fetched page and stores that HTML in a database keyed by the project. 2. The wiki pages then use that HTML for the left nav of the {{PROJECT:}} tagged pages. This would allow projects to have customized left navs rather than just one left nav. This would allow Mylyn to have a different left nav (http://www.eclipse.org/mylyn/) and EMF to have a different left nav (http://www.eclipse.org/modeling/emf/) and Dash to have a different left nav (http://www.eclipse.org/dash/), etc.
Being able to label pages as belonging to a particular project (comment 2)is great. Also being able to have the project specific nav show on the wiki nav would be tremendous. This would greatly reduce the "getting lost" problem. (comment 3) Note that Higgins is currently trying to remove the 4 default nav options at the top of the Higgins home page (like ECF has to reduce the "getting lost" problem), but I'm having trouble making this work as this seems to be a delicate area. So when the default the project web nav to the wiki nav part is done, it will need to be done carefully. How quickly could this be implemented?
I've built a semi-functional prototype that you can see here: build.eclipse.org/testwiki/Testpage The solution I'm working on involves an extension module and modifications to the default Eclipse Wiki skin. When this is complete you will be able to add the following to the top of an article and it will generate the 'project' skin: {{#eclipseproject:foundation.test}} So how does it work? Well the extension module will take the first(and only) parameter and use it to preform a lookup on the ProjectInfo DB looking for keys of type 'projectleftnav' which you will be able to edit via the portal. These keys will be used to generate a custom left nav bar(or generic one if you haven't added any). Once the extension module has re-written the page the skin will detect those changes on render and will insert the custom left nav as well as updating the header and footer to resemble the Eclipse.org site. The skin will also append an 'edit' link to the bottom of the left nav, but *only* if you are currently logged into the Eclipse Wiki, if not you will never see the edit option. -M.
This approach would make a big improvement in Eclipse website/wiki usability. Thank you for putting this together. How soon can we have it in production? Just two questions, 1) When you say article, do you mean wiki page? 2) Assume that in the production version, there would still be a login link in the upper right hand corner of the wiki page.
Mary, Yes in this context 'article' and 'page' are synonymous. Adding the login link to the top right of the page presents a style issue since the eclipse.org skin uses that space to contain the 'legal' and 'contact' and it doesn't quite look right(breaks the same website illusion) with the login tab there as well. -M.
So how does someone login so that they get the edit capability?
Just hit wiki.eclipse.org, same as now. -M.
So after thinking more about Marys comment I think a solution is to always append the 'Edit' option to the bottom of the left nav. This would mean that if you were logged into the wiki you would go straight to the edit page, if not it takes you to the 'view source' page and that has a login link. I'm still concerned that this solution much like adding the 'login' link in the top left will result in confusion for 'casual' users of the site('why do some pages say edit and others don't?'). If people have suggestions or ideas to solve this possible problem here's the place to post them. -M.
Ok, so the new skin and plugin are live on wiki.eclipse.org, and you can check out what it looks like here: http://wiki.eclipse.org/Phoenix There are of course a couple of caveats, the first is that all of the urls you enter into the projectleftnav field in the project meta-data must be fully qualified(http(s)://eclipse.org/page) and they must point at an eclipse.org site, if either of these is not true then the link will be ignored. Secondly if you use the 'separator' option then only the next link that follows the separator will be idented. Lastly there is no 'default' menu, so if you don't have any entries in the meta-data the only link on your left nav will be the edit link. Just add {{#eclipseproject:technology.higgins}} to the top of a Wiki article and you should be set. -M.
Where is the documentation for the projects? I go here http://www.eclipse.org/projects/ and click on "What's New" and there's nothing about this. I go back and click on "Help me lead my project" and navigate to the "guidelines for a mature project" http://www.eclipse.org/projects/dev_process/mature-phase.php and I see nothing. I even go to the "project status infrastructure" documentation page, the page that lists all the meta-information fields and what they affect - still nothing. The bug isn't fixed until the documentation is written.
(In reply to comment #12) > Where is the documentation for the projects? http://wiki.eclipse.org/Using_Phoenix > I go here > http://www.eclipse.org/projects/ and click on "What's New" and there's nothing > about this. I go back and click on "Help me lead my project" and navigate to > the "guidelines for a mature project" > http://www.eclipse.org/projects/dev_process/mature-phase.php and I see nothing. > I even go to the "project status infrastructure" documentation page, the page > that lists all the meta-information fields and what they affect - still > nothing. Oh, those seem to be under your jurisdiction. Can you add a blurb about this to those pages? Thanks. > The bug isn't fixed until the documentation is written. The documentation was written before the bug was closed -- it's just not where *you* looked for it.
(In reply to comment #13) > The documentation was written before the bug was closed -- it's just not where > *you* looked for it. Sorry -- I totally missed this page: http://www.eclipse.org/projects/dev_process/project-status-infrastructure.php I'm scanning for others that may need updating.
(In reply to comment #13) > The documentation was written before the bug was closed -- it's just not where > *you* looked for it. I take back my criticism: the committer documentation is so poorly organized that nobody can find anything, much less find the places that it should be updated when systems change. And by "nobody", I mean even the committers can't find anything - there's just no excuse: it's confusing and convoluted. Sigh. I have opened bug 221934 to reorganize the committer-facing documentation.
(In reply to comment #11) > ... > > Just add {{#eclipseproject:technology.higgins}} to the top of a Wiki article > and you should be set. > This is a fantastic new feature! It really makes the wiki navigation much more user friendly. One problem though - adding the tag breaks the "show preview" mode during wiki editing. Not sure if I should post this here or as its own bug, but here it is for now.
Thanks to finding that! There was a computation error in the string replacement routine. I've fixed it and after testing that the page looks ok I've rolled it out. -M.
Still having odd behavior. I deleted the Higgins Home nav again (which is the one that was causing the trouble) waited until it didn't display any more, then readded it. Now the Higgins solutions wiki page shows no Higgins Home and the Components wiki page shows it at the bottom. Any suggestions???
Hi Mary, I believe we fixed your issue as bug 223008 correct? -M.
Yes. I currently consider this resolved.
Closing. -M.
Verified. Closing.
