[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Re: [equinox-dev] Fw: [cross-project-issues-dev] Wiki "standardization"?
|
Hi,
If the Equinox team wants to investigate the creation of their own
templates, you can take a look at what Platform UI has done.
http://wiki.eclipse.org/Template:Platform_UI
Just create a new page called Template:Equinox with the necessary wiki
code and you can then reference it by embedding '{{Equinox}}' in your
wiki pages.
Alternatively, you can try out the Template:Infobox I created. You can
see it in action on ECF's wiki page.
http://wiki.eclipse.org/Template:Infobox
http://wiki.eclipse.org/ECF
The code below will demonstrate how it can be embedded into Equinox pages.
{{Infobox
| name = Equinox
| download = http://download.eclipse.org/eclipse/equinox/
| website = http://www.eclipse.org/equinox
| list = equinox-dev
| newsgroup = eclipse.technology.equinox
| product = Equinox
| irc = eclipse
}}
Happy wiki editing! :)
Regards,
Rem
On Dec 14, 2007 10:42 AM, Jeff McAffer <Jeff_McAffer@xxxxxxxxxx> wrote:
>
> FWIW, there was alot of followup discussion around templates and subpages
> and the use of () etc etc. I did not follow it all (reading on an ariplane
> and really needed to see the examples) but there appeared to be a number of
> good ideas. Perhaps a cruise around the PDE and UI wiki pages would help
> here? Boris and Remy both seemed to be up on the capabilities and were
> modifying their pages....
>
> Jeff
>
>
>
>
> John Arthorne/Ottawa/IBM@IBMCA
>
> Sent by: equinox-dev-bounces@xxxxxxxxxxx
>
> 11/22/2007 03:12 PM
>
>
> Please respond to
> Equinox development mailing list <equinox-dev@xxxxxxxxxxx>
>
>
> To
> Equinox development mailing list <equinox-dev@xxxxxxxxxxx>
>
> cc
>
> Subject Re: [equinox-dev] Fw: [cross-project-issues-dev] Wiki
> "standardization"?
>
>
>
>
>
>
>
> +1. Makes sense. It's not a replacement for categories since pages can have
> multiple categories and categories sometimes cross-cut projects. But, having
> all Equinox pages appear under /Equinox or /Eclipse/Equinox would make sense
> to me.
>
>
>
>
> Jeff McAffer/Ottawa/IBM@IBMCA
> Sent by: equinox-dev-bounces@xxxxxxxxxxx
>
> 11/17/2007 04:55 PM
>
>
> Please respond to
> Equinox development mailing list <equinox-dev@xxxxxxxxxxx>
>
>
>
> To equinox-dev@xxxxxxxxxxx
>
> cc
>
> Subject [equinox-dev] Fw: [cross-project-issues-dev] Wiki "standardization"?
>
>
>
>
>
>
>
>
> anyone tihnk that using / would be good in our wiki pages? The value seems
> to be in the breadcrumbs that Nick mentions. Check out the set of links at
> the top of one of the page examples he gives. I'm not proposing a rename of
> all the pages (though that is possible) but looking to bring some order to
> the wiki going forward.
>
> Jeff
>
> ----- Forwarded by Jeff McAffer/Ottawa/IBM on 11/17/2007 04:51 PM -----
> Nick Boldt/Toronto/IBM@IBMCA
> Sent by: cross-project-issues-dev-bounces@xxxxxxxxxxx
>
> 11/17/2007 12:49 PM
>
>
> Please respond to
> Cross project issues <cross-project-issues-dev@xxxxxxxxxxx>
>
>
>
> To "Cross project issues" <cross-project-issues-dev@xxxxxxxxxxx>
>
> cc
>
> Subject Re: [cross-project-issues-dev] Wiki "standardization"?
>
>
>
>
>
>
>
>
>
> When I first started writing wikis, I tended to use the [[Category:...]]
> convention to group pages into obvious categories like Releng, Java, EMF,
> Modeling, FAQ...
>
> I still do that, but having discovered the 'automatic breadcrumb' effect of
> creating subpages using "/" in titles, I've started renaming pages to use
> that new convention, as it provides a sense of page-to-project ownership and
> navigation that the categories don't provide.
>
> Consider:
>
>
> http://wiki.eclipse.org/Modeling_Project_Releng/Component_Creation/Build_Server_Setup
> http://wiki.eclipse.org/PDT/1.5_Plan
> http://wiki.eclipse.org/MDT/XSD/FAQ
> http://wiki.eclipse.org/Ganymede/Signoffs
>
> Also, category nesting is a powerful way to create component or subproject
> categories:
>
> http://wiki.eclipse.org/Category:Dash_Project
> http://wiki.eclipse.org/Category:Modeling
> http://wiki.eclipse.org/Category:Releng
>
> Personally, I recommend using both. Oh, and as Remy taught me a while back,
> if you need to redirect a page to another page (and can't do a Move because
> there are already two existing pages, or because you want to have a landing
> page direct to a Category [1]), just do something like this:
>
> #REDIRECT [[:Category:Eclipse_Web_Tools_Platform_Project]]
>
> [1] http://wiki.eclipse.org/Web_Tools_Project
>
> Of course one aspect of naming that Remy didn't mention is the over-verbose
> page titles like "Eclipse Web Tools Platform Project" when "Web Tools
> Project" would work just as well. ;-)
>
> $0.02,
>
> Nick
>
> On Nov 17, 2007 12:17 PM, Remy Chi Jian Suen <remy.suen@xxxxxxxxx> wrote:
> I know a wiki is supposed to be open and free, but I think that
> standardizing a couple of things here and there would be helpful and
> make it look a lot more uniform. The primary issue I have is with the
> naming convention of pages. There are probably other things that needs
> to be changed too, but I think that this inconsistency looks bad and
> is kind of annoying.
>
> There are a couple of projects that have adopted the subpages concept
> by using slashes in their page names like...
>
> CDT/Developer/FAQ
> PDT/FAQ
>
> ...and then we have those that go about with the full article name like...
>
> GMF Development Guidelines
> Equinox p2 Getting Started
> ECF Ganymede Roadmap
> Mylyn Contributor Reference
>
> ...and next, we have RAP and Bug Day kind of doing its own thing (as
> far as I know) with limiting the use of spaces (for no technical
> reason, mind you, since spaces in titles are perfectly valid)...
>
> RapFaq
> RapPlan
> Rap10M3 News
> BugDay/November 2007
>
> ...and BIRT that's decided to use suffixes for identification purposes
> on a few of their pages like...
>
> Contributing Examples (BIRT)
> Logging The Events - Show the Typical Log Stack (BIRT)
>
> ...and finally, we have some pages that come out of nowhere with no
> context like...
>
> Components
> Deployments
> CodingConventions
> Shared Editing
>
> There may be other naming conventions that are being employed, but
> since there are so many Eclipse projects and so many wiki pages, I
> have only presented a sample of what I have seen while clicking
> around.
>
> I would personally vouch for the first option of using subpages
> (PDT/FAQ) as I feel that that would make organizing things a little
> easier and makes it immediately clear as to what a page is under.
>
> Does anyone have any opinions or thoughts about this, what are your
> preferences? Does anyone even care or am I making this inconsistency
> problem sound bigger than it really is?
>
> Regards,
> Rem
> _______________________________________________
> cross-project-issues-dev mailing list
> cross-project-issues-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev
> _______________________________________________
> cross-project-issues-dev mailing list
> cross-project-issues-dev@xxxxxxxxxxx
>
> https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev_______________________________________________
> equinox-dev mailing list
> equinox-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/equinox-dev
> _______________________________________________
> equinox-dev mailing list
> equinox-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/equinox-dev
>
>
> _______________________________________________
> equinox-dev mailing list
> equinox-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/equinox-dev
>
>