[vtk-developers] Request for feedback: Gitlab examples wiki

Bill Lorensen bill.lorensen at gmail.com
Mon May 8 14:18:46 EDT 2017 

Chiranjib,

If you want to be an alpha tester, try to follow the instructions for
developers here:

https://gitlab.kitware.com/lorensen/VTKExamples/wikis/Instructions/ForDevelopers

The documentation is fresh out of the oven (still warm) and it would be
great to see if it makes sense.

Andrew,

  It would be great if you could kick the tires on the developer
contributions.

Bill


On Mon, May 8, 2017 at 1:50 PM, Chiranjib Sur <sur.chiranjib at gmail.com>
wrote:

> This is fantastic effort and looks very impressive and consolidated.
> I learnt (and still learning) developing applications using VTK classes by
> writing my own examples and tests. Some of themI can contribute to the wiki
> (which are obvious but I had a hard time to figure those out through my
> interaction over the mailing list). How can I contribute and share my
> experiences in this wiki format?
>
> Thanks in advance,
> Chiranjib
>
> On Thu, May 4, 2017 at 11:24 AM, Andrew Maclean <andrew.amaclean at gmail.com
> > wrote:
>
>> Hi Bill,
>>
>> If you need to test the descriptions, this one:
>> http://www.vtk.org/Wiki/VTK/Examples/Cxx/Visualization/NamedColorPatches
>> has a lot of html links in the description. It also references the python
>> version: http://www.vtk.org/Wiki/VTK/Examples/Python/Visuali
>> zation/NamedColorPatches
>>
>> Regards
>>    Andrew
>>
>> On Thu, May 4, 2017 at 9:09 AM, Andrew Maclean <andrew.amaclean at gmail.com
>> > wrote:
>>
>>> Hi Bill,
>>>
>>> That looks really great.
>>>
>>> Thanks
>>> Andrew
>>>
>>> On Thu, May 4, 2017 at 9:05 AM, Bill Lorensen <bill.lorensen at gmail.com>
>>> wrote:
>>>
>>>> Yes I have a way to include the descriptions. Now I need to get the old
>>>> ones automatically.  I'm working on a script for that.
>>>> For example I did one of yours manually
>>>> https://gitlab.kitware.com/lorensen/VTKExamples/wikis/Cxx/Vi
>>>> sualization/ElevationBandsWithGlyphs
>>>>
>>>> On May 3, 2017 6:56 PM, "Andrew Maclean" <andrew.amaclean at gmail.com>
>>>> wrote:
>>>>
>>>>> Hi Bill,
>>>>>     I just looked at it and it is not too bad.
>>>>>
>>>>> Like you I don't like the automatic conversion of camel case e.g
>>>>> "CurvatureBandsWithGlyphs" is converted to "Curvaturebandswithglyphs". It
>>>>> certainly doesn't add to readability.
>>>>>
>>>>> I don't mind the file list on the right-hand side, I think it is
>>>>> useful.
>>>>>
>>>>> One big thing missing is the description, will you be able to
>>>>> automatically grab this too? I think it is important as it provides
>>>>> rationale and background to the examples.
>>>>>
>>>>> Thinking further along, how easy will it be to add new examples or
>>>>> update existing ones?
>>>>>
>>>>> Regards
>>>>>    Andrew
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>> ---------- Forwarded message ----------
>>>>>> From: Bill Lorensen <bill.lorensen at gmail.com>
>>>>>> To: Aron Helser <aron.helser at kitware.com>
>>>>>> Cc: VTK Developers <vtk-developers at vtk.org>, Will Schroeder <
>>>>>> will.schroeder at kitware.com>
>>>>>> Bcc:
>>>>>> Date: Wed, 3 May 2017 13:57:21 -0400
>>>>>> Subject: Re: [vtk-developers] [EXTERNAL] Re: Request for feedback:
>>>>>> Gitlab examples wiki
>>>>>> Aron,
>>>>>>
>>>>>> That is pretty cool. I think we can do some kind of image gallery to
>>>>>> navigate the examples.
>>>>>>
>>>>>> Bill
>>>>>>
>>>>>>
>>>>>> On Wed, May 3, 2017 at 1:45 PM, Aron Helser <aron.helser at kitware.com>
>>>>>> wrote:
>>>>>>
>>>>>>> The automatically generated list of examples is looking quite good -
>>>>>>> the clean look of the wiki suits the content well, I think.
>>>>>>>
>>>>>>> I pointed out two examples of an image gallery I liked during the
>>>>>>> hackathon - First https://d3js.org/, which has a hand-picked
>>>>>>> gallery of examples as the banner "image" explaining what d3.js is.
>>>>>>> The second and more applicable example was
>>>>>>> https://bl.ocks.org/mbostock, or https://bl.ocks.org/ which is an
>>>>>>> automatically generated gallery of all examples (possibly filtered to those
>>>>>>> written by the author of d3).  Once you click an example, it is
>>>>>>> interactive, because they are all done in javascript.
>>>>>>>
>>>>>>> Anyone can contribute to bl.ocks.org, and each example is backed by
>>>>>>> a github 'gist', like https://gist.github.com/mbostock/4063269
>>>>>>> This setup makes it very easy to work with single examples, and fork
>>>>>>> them to make your own versions.
>>>>>>>
>>>>>>> I don't propose that this is the right approach for VTK, but for
>>>>>>> ideas or inspiration.
>>>>>>> Thanks,
>>>>>>> Aron
>>>>>>>
>>>>>>> On Wed, May 3, 2017 at 11:35 AM, Bill Lorensen <
>>>>>>> bill.lorensen at gmail.com> wrote:
>>>>>>>
>>>>>>>> Jon,
>>>>>>>>
>>>>>>>> Thanks for the feedback. All of the pages on the wiki are generated
>>>>>>>> from the repo. I think I can generate a gallery of images. Still some
>>>>>>>> cleanup before I get to that.
>>>>>>>>
>>>>>>>> Bill
>>>>>>>>
>>>>>>>> On Wed, May 3, 2017 at 11:32 AM, Jon Haitz Legarreta <
>>>>>>>> jhlegarreta at vicomtech.org> wrote:
>>>>>>>>
>>>>>>>>> Nice job Bill. Thanks.
>>>>>>>>>
>>>>>>>>> Despite the limitations you have identified, I think transitioning
>>>>>>>>> to gitlab makes it easier for people to use the examples resource, and
>>>>>>>>> also, easier to maintain the VTK eco-system.
>>>>>>>>>
>>>>>>>>> The yet-to-come steps to add an example will also be a nice
>>>>>>>>> addition.
>>>>>>>>>
>>>>>>>>> IMHO, the right pane could be helpful if it were a true index of
>>>>>>>>> the sections so that one could easily switch between them without scrolling
>>>>>>>>> back to the top of the page, and if it could be collapsed.
>>>>>>>>>
>>>>>>>>> I think this is a step yet too distant, but having an image
>>>>>>>>> gallery instead of (or in addition to) a list would be helpful for such
>>>>>>>>> cases in which the person seeks by a visualization rather than by the
>>>>>>>>> filter name. It may happen that we have difficulties in identifying the
>>>>>>>>> right name/class in the class index. I think someone pointed an example
>>>>>>>>> during the hackathon, but as pointed then, the wiki is not well adapted to
>>>>>>>>> that.
>>>>>>>>>
>>>>>>>>> May be sharing that could be useful in case someone has a better
>>>>>>>>> idea, or else just for the records.
>>>>>>>>>
>>>>>>>>> JON HAITZ
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> --
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On 3 May 2017 at 01:00, Scott, W Alan <wascott at sandia.gov> wrote:
>>>>>>>>>
>>>>>>>>>> Very nice.  Well done.
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> *From:* vtk-developers [mailto:vtk-developers-bounces at vtk.org] *On
>>>>>>>>>> Behalf Of *Will Schroeder
>>>>>>>>>> *Sent:* Tuesday, May 2, 2017 1:03 PM
>>>>>>>>>> *To:* Bill Lorensen <bill.lorensen at gmail.com>
>>>>>>>>>> *Cc:* VTK Developers <vtk-developers at vtk.org>
>>>>>>>>>> *Subject:* [EXTERNAL] Re: [vtk-developers] Request for feedback:
>>>>>>>>>> Gitlab examples wiki
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> I am pretty impressed!
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> The file list doesn't bother me all that much. I'm not sure how
>>>>>>>>>> to address the other issues you list. I agree the Camel case problem is
>>>>>>>>>> annoying; it'd be nice if this could be fixed.
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> Great work,
>>>>>>>>>>
>>>>>>>>>> W
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Tue, May 2, 2017 at 2:46 PM, Bill Lorensen <
>>>>>>>>>> bill.lorensen at gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>> Folks,
>>>>>>>>>>
>>>>>>>>>> Time to kick the tires.
>>>>>>>>>>
>>>>>>>>>> Try https://gitlab.kitware.com/lorensen/VTKExamples/wikis/Home
>>>>>>>>>>
>>>>>>>>>> I have converted the top level example and cxx example pages.
>>>>>>>>>>
>>>>>>>>>> The wiki pages are automatically created from the gitlab repo
>>>>>>>>>> pages.
>>>>>>>>>>
>>>>>>>>>> Need feedback before proceeding.
>>>>>>>>>>
>>>>>>>>>> Things I don't like:
>>>>>>>>>> 1) Rendering of the large Cxx page is very slow.
>>>>>>>>>> 2) I can't get rid of the file list on the right of the page.
>>>>>>>>>> 3) gitlab converts the camel case to lower except for the first
>>>>>>>>>> letter.
>>>>>>>>>>
>>>>>>>>>> markdown formatting is very limited.
>>>>>>>>>>
>>>>>>>>>> Bill
>>>>>>>>>> _______________________________________________
>>>>>>>>>> Powered by www.kitware.com
>>>>>>>>>>
>>>>>>>>>> Visit other Kitware open-source projects at
>>>>>>>>>> http://www.kitware.com/opensource/opensource.html
>>>>>>>>>>
>>>>>>>>>> Search the list archives at: http://markmail.org/search/?q=
>>>>>>>>>> vtk-developers
>>>>>>>>>>
>>>>>>>>>> Follow this link to subscribe/unsubscribe:
>>>>>>>>>> http://public.kitware.com/mailman/listinfo/vtk-developers
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>>>>>
>>>>>>>>>> William J. Schroeder, PhD
>>>>>>>>>> Kitware, Inc. - Building the World's Technical Computing Software
>>>>>>>>>> 28 Corporate Drive
>>>>>>>>>> Clifton Park, NY 12065
>>>>>>>>>> will.schroeder at kitware.com
>>>>>>>>>> http://www.kitware.com
>>>>>>>>>> (518) 881-4902
>>>>>>>>>>
>>>>>>>>>> _______________________________________________
>>>>>>>>>> Powered by www.kitware.com
>>>>>>>>>>
>>>>>>>>>> Visit other Kitware open-source projects at
>>>>>>>>>> http://www.kitware.com/opensource/opensource.html
>>>>>>>>>>
>>>>>>>>>> Search the list archives at: http://markmail.org/search/?q=
>>>>>>>>>> vtk-developers
>>>>>>>>>>
>>>>>>>>>> Follow this link to subscribe/unsubscribe:
>>>>>>>>>> http://public.kitware.com/mailman/listinfo/vtk-developers
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Unpaid intern in BillsBasement at noware dot com
>>>>>>>>
>>>>>>>> _______________________________________________
>>>>>>>> Powered by www.kitware.com
>>>>>>>>
>>>>>>>> Visit other Kitware open-source projects at
>>>>>>>> http://www.kitware.com/opensource/opensource.html
>>>>>>>>
>>>>>>>> Search the list archives at: http://markmail.org/search/?q=
>>>>>>>> vtk-developers
>>>>>>>>
>>>>>>>> Follow this link to subscribe/unsubscribe:
>>>>>>>> http://public.kitware.com/mailman/listinfo/vtk-developers
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>
>>>>>>
>>>>>> --
>>>>>> Unpaid intern in BillsBasement at noware dot com
>>>>>>
>>>>>> _______________________________________________
>>>>>> Powered by www.kitware.com
>>>>>>
>>>>>> Visit other Kitware open-source projects at
>>>>>> http://www.kitware.com/opensource/opensource.html
>>>>>>
>>>>>> Search the list archives at: http://markmail.org/search/?q=
>>>>>> vtk-developers
>>>>>>
>>>>>> Follow this link to subscribe/unsubscribe:
>>>>>> http://public.kitware.com/mailman/listinfo/vtk-developers
>>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> ___________________________________________
>>>>> Andrew J. P. Maclean
>>>>>
>>>>> ___________________________________________
>>>>>
>>>>
>>>
>>>
>>> --
>>> ___________________________________________
>>> Andrew J. P. Maclean
>>>
>>> ___________________________________________
>>>
>>
>>
>>
>> --
>> ___________________________________________
>> Andrew J. P. Maclean
>>
>> ___________________________________________
>>
>> _______________________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Search the list archives at: http://markmail.org/search/?q=vtk-developers
>>
>> Follow this link to subscribe/unsubscribe:
>> http://public.kitware.com/mailman/listinfo/vtk-developers
>>
>>
>>
>


-- 
Unpaid intern in BillsBasement at noware dot com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/vtk-developers/attachments/20170508/26e8d110/attachment-0001.html>

More information about the vtk-developers mailing list