Bug 968863 - RFE: Enable remarks to show up in docbuilder output
Summary: RFE: Enable remarks to show up in docbuilder output
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: PressGang CCMS
Classification: Community
Component: DocBook-builder
Version: 3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: pressgang-ccms-dev
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-05-30 07:13 UTC by lcarlon
Modified: 2013-05-31 02:20 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-05-31 01:08:38 UTC
Embargoed:


Attachments (Terms of Use)

Description lcarlon 2013-05-30 07:13:43 UTC
Description of problem:

I'd like to be able to included highlighted remarks in docbuilder output by including show_remarks = 1 in content spec files, and <remark>This is a remark</remark> in a topic.

Comment 1 Stephen Gordon 2013-05-30 14:01:09 UTC
Lee, does this not work if you include the show_remarks: 1 in the publican.cfg section of the spec file?

Comment 2 Lee Newson 2013-05-30 22:44:30 UTC
Yeah what Steve said would work. The reason we never added it as a metadata property was to try and make it more difficult to include in a final build and ideally when you wanted a build with remarks enabled, you'd build with the "--show-remarks" option. So perhaps the docbuilder should be configured to use that option as well when building?

Otherwise I really don't see any issue with adding it as a metadata field. In saying that though, it'd be something more along the lines of "Show Remarks = ON" or "Remarks = ON" just to keep with consistency.

Comment 3 lcarlon 2013-05-31 01:08:38 UTC
Thanks Steve, Thanks Lee.

No it's fine as it is. I didn't realize we need to add it to the publican.cfg.

Closing the bug to save you the trouble of doing.

Lee

Comment 4 Stephen Gordon 2013-05-31 02:20:17 UTC
(In reply to Lee Newson from comment #2)
> ...you'd build with the "--show-remarks" option. So perhaps the docbuilder should be configured to use that option as well when building?

To be honest that actually seems like a pretty reasonable idea.


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