[vtk-developers] Wiki Naming Conventions

[Andrew Maclean]

I strongly agree that we should keep the same organisation in the Wiki
as VTK. It just makes thinks more consistent and easier in the long
run.

Regards
   Andrew


On Tue, Dec 15, 2009 at 9:46 AM, Bill Lorensen <bill.lorensen at gmail.com> wrote:
> I agree. I did'nt know about the bread crumbs. I'll start changing
> them as I move examples into the VTK/Examples repository. Fortunately,
> the Wiki makes the move transparent.
>
> Should we keel the same organization in the Wiki as in the source tree:
>
> VTK/Examples/Cxx/Example.cxx
>
> Seem like a nice match.
>
> Bill
>
> On Mon, Dec 14, 2009 at 5:41 PM, David Cole <david.cole at kitware.com> wrote:
>> +1
>> Bread crumbs rule!
>>
>> On Mon, Dec 14, 2009 at 5:35 PM, Andrew Maclean <andrew.amaclean at gmail.com>
>> wrote:
>>>
>>> I agree, I like the "/" it makes navigation easier and I also like the
>>> breadcrumbs it leaves.
>>>
>>> Andrew
>>>
>>>
>>> On Tue, Dec 15, 2009 at 9:30 AM, David Gobbi <david.gobbi at gmail.com>
>>> wrote:
>>> > This is kind of a late reply, but I'm very much in favor of using "/"
>>> > as the separator for wiki pages instead of any other method:
>>> >
>>> > Wiki/VTK/Examples
>>> > Wiki/VTK/Examples/My_Example
>>> >
>>> > This has three advantages over other naming schemes:
>>> >
>>> > a) The "/" makes the hierarchical organization explicit and obvious.
>>> > Everyone knows what slash means.
>>> >
>>> > a) The wiki leaves breadcrumbs if you use a slash.  See
>>> > http://www.vtk.org/Wiki/VTK/Volume_Picking for example.  It has a
>>> > "back to VTK" link at the top.  Very useful.
>>> >
>>> > b) Slash is distinct from underscore.  Typically a wiki underscore is
>>> > just a placeholder for a space.  A slash says "this is how things are
>>> > organized".
>>> >
>>> > Just my 2 cents.  Another comment I would like to make is that the
>>> > usefulness of the wiki has definitely improved over the past few
>>> > weeks.
>>> >
>>> >   David
>>> >
>>> >
>>> > On Tue, Nov 24, 2009 at 4:22 PM, Andrew Maclean
>>> > <andrew.amaclean at gmail.com> wrote:
>>> >> Hi Bill,
>>> >> This is a really good idea. it will dramatically improve the usability
>>> >> of the site.
>>> >>
>>> >> Andrew
>>> >>
>>> >> On Wed, Nov 25, 2009 at 3:05 AM, Bill Lorensen
>>> >> <bill.lorensen at gmail.com> wrote:
>>> >>> Folks,
>>> >>>
>>> >>> We need some consistent convention to name pages on the vtk wiki.
>>> >>> http://www.vtk.org/Wiki/VTK
>>> >>>
>>> >>> VTK, itk, cmake, paraview, cdash, ... all share the same wiki.
>>> >>>
>>> >>> Looking through a sample of these wikis you will see a variety of
>>> >>> naming conventions. For example a page describing "My Stuff" might be
>>> >>> called:
>>> >>>
>>> >>> 1) My_Stuff
>>> >>>    Not a good convention, but there are lots of pages named liked
>>> >>> this.
>>> >>>
>>> >>> 2) VTK:My_Stuff
>>> >>>   This uses (misuses) the concept of namespace. Wikimedia namespaces
>>> >>> are described here:
>>> >>>   http://en.wikipedia.org/wiki/Main_namespace
>>> >>>   CDash uses this consistently
>>> >>>
>>> >>> 3) VTK_My_Stuff
>>> >>>    itk uses this pretty consistently. CMake uses it frequently
>>> >>> although it also uses 1, 2, and 4.
>>> >>>
>>> >>> 4) VTK/My_Stuff
>>> >>>    Used occasionally in VTK. As well as 1,2 and 3.
>>> >>>
>>> >>> My main immediate concern is to have the Examples on the wiki conform
>>> >>> to a single convention.
>>> >>> http://www.vtk.org/Wiki/VTK:Examples
>>> >>>
>>> >>> Note, the wiki has a rename (move) mechanism so that old link will not
>>> >>> be broken.
>>> >>>
>>> >>> Bill
>>> >>> _______________________________________________
>>> >>> Powered by www.kitware.com
>>> >>>
>>> >>> Visit other Kitware open-source projects at
>>> >>> http://www.kitware.com/opensource/opensource.html
>>> >>>
>>> >>> Follow this link to subscribe/unsubscribe:
>>> >>> http://www.vtk.org/mailman/listinfo/vtk-developers
>>> >>>
>>> >>>
>>> >>
>>> >>
>>> >>
>>> >> --
>>> >> ___________________________________________
>>> >> Andrew J. P. Maclean
>>> >> Centre for Autonomous Systems
>>> >> The Rose Street Building J04
>>> >> The University of Sydney  2006  NSW
>>> >> AUSTRALIA
>>> >> Ph: +61 2 9351 3283
>>> >> Fax: +61 2 9351 7474
>>> >> URL: http://www.acfr.usyd.edu.au/
>>> >> ___________________________________________
>>> >> _______________________________________________
>>> >> Powered by www.kitware.com
>>> >>
>>> >> Visit other Kitware open-source projects at
>>> >> http://www.kitware.com/opensource/opensource.html
>>> >>
>>> >> Follow this link to subscribe/unsubscribe:
>>> >> http://www.vtk.org/mailman/listinfo/vtk-developers
>>> >>
>>> >>
>>> > _______________________________________________
>>> > Powered by www.kitware.com
>>> >
>>> > Visit other Kitware open-source projects at
>>> > http://www.kitware.com/opensource/opensource.html
>>> >
>>> > Follow this link to subscribe/unsubscribe:
>>> > http://www.vtk.org/mailman/listinfo/vtk-developers
>>> >
>>> >
>>>
>>>
>>>
>>> --
>>> ___________________________________________
>>> Andrew J. P. Maclean
>>> Centre for Autonomous Systems
>>> The Rose Street Building J04
>>> The University of Sydney  2006  NSW
>>> AUSTRALIA
>>> Ph: +61 2 9351 3283
>>> Fax: +61 2 9351 7474
>>> URL: http://www.acfr.usyd.edu.au/
>>> ___________________________________________
>>> _______________________________________________
>>> Powered by www.kitware.com
>>>
>>> Visit other Kitware open-source projects at
>>> http://www.kitware.com/opensource/opensource.html
>>>
>>> Follow this link to subscribe/unsubscribe:
>>> http://www.vtk.org/mailman/listinfo/vtk-developers
>>>
>>
>>
>> _______________________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.vtk.org/mailman/listinfo/vtk-developers
>>
>>
>>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>



-- 
___________________________________________
Andrew J. P. Maclean
Centre for Autonomous Systems
The Rose Street Building J04
The University of Sydney  2006  NSW
AUSTRALIA
Ph: +61 2 9351 3283
Fax: +61 2 9351 7474
URL: http://www.acfr.usyd.edu.au/
___________________________________________