[GRADLE-516] documentation - better titles for examples & list of examples Created: 06/Jun/09  Updated: 04/Jan/13  Resolved: 11/Jun/09

Status: Resolved
Project: Gradle
Affects Version/s: 0.6
Fix Version/s: 0.7

Type: Improvement
Reporter: Tomek Kaczanowski Assignee: Adam Murdoch
Resolution: Fixed Votes: 0

Attachments: File 516_better_titles.diff     File 516_better_titles_with_SampleElementValidator.diff    

 Description   

improve documentation by adding what was discussed here http://www.nabble.com/documentation---new-titles-of-examples-%2B-list-of-examples-td23750793.html, i.e.:

  • examples should have meaningful titles, which would allow to create a list of examples

P.S. will do it.

–
best regards
Tomek Kaczanowski
http://kaczanowscy.pl/tomek

 Comments   
Comment by Tomek Kaczanowski [ 09/Jun/09 ]

Hi,

included you will find a patch that does three things:

  • creates examples list under TOC
  • changes code of UserGuidTransformTask to support the new "title" attribute
  • updates userguide with titles to all examples

Few remarks:

  • I added titles to all examples - surely many of them can be improved, but this is something we can start with. Especially, it was hard for me to choose titles for long examples like these in section "27.6. Dependencies - Which dependencies?". Sometimes I had to change text a little big (e.g. in section "4.11. Configure by DAG")
  • I introduced some changes to UserGuidTransformTask but the code was, and still is, rather ugly and asks for major refactoring. I did some improvements (i.e. moved validation to one place), but there is still some work to do there - it is not very urgent thought.
  • output used to be rendered as "figure" - now everything ends up as an "example"

–
best regards
Tomek Kaczanowski
http://kaczanowscy.pl/tomek

Comment by Adam Murdoch [ 09/Jun/09 ]

This looks good. One small problem: it seems that class SampleElementValidator did not make it into the patch, so it does not work. Could you re-do the patch with that class in it?

Comment by Tomek Kaczanowski [ 10/Jun/09 ]

Sorry, I was not aware that I should do the "svn add" first. Hope this time it is ok.

–
best regards
Tomek Kaczanowski
http://kaczanowscy.pl/tomek

Comment by Adam Murdoch [ 11/Jun/09 ]

Thank you for this patch. I've applied it to trunk.

Generated at Wed Jun 30 11:32:07 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.