Bug 1028815 - Ambigious admonition for Creating a brand
Summary: Ambigious admonition for Creating a brand
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Publican
Classification: Community
Component: Publican Users Guide
Version: 3.2
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Ruediger Landmann
QA Contact: tools-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-11-10 23:01 UTC by Roman Joost
Modified: 2013-12-19 02:46 UTC (History)
2 users (show)

Fixed In Version: 4.0.0
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-12-19 02:46:33 UTC
Embargoed:


Attachments (Terms of Use)
Proposed fix to make the admonition more to the point. (1.01 KB, patch)
2013-11-10 23:01 UTC, Roman Joost
no flags Details | Diff

Description Roman Joost 2013-11-10 23:01:15 UTC
Created attachment 822208 [details]
Proposed fix to make the admonition more to the point.

Description of problem:

I found the following admonition a bit confusing:

    Brands that supply XSL files need to change the relative path to a URI.

until I looked into the source code to see what's going on.

It would be better if it describes where the relative path has to be changed (maybe even an Example?). In case it is assumed that people know what they are doing with the XSL it is perhaps better to drop the admonition entirely, since they'll figure it out by looking at the source.


Patch attached with my clumsy attempt to make it clearer.


Version-Release number of selected component (if applicable):

3.2

Comment 2 Ruediger Landmann 2013-11-14 07:00:16 UTC
Thanks Roman; I've committed your improved wording as-is, but there's no question that this whole section could do with improvement and greater clarification: I'll do that for bug 701929

91088cb..ce244da  devel -> devel


Note You need to log in before you can comment on or make changes to this bug.