Bug 996093 - Docs: indentation in code examples corrupted
Summary: Docs: indentation in code examples corrupted
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss BRMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.0.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: CR1
: 6.0.0
Assignee: Douglas Hoffman
QA Contact: Lukáš Petrovický
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-08-12 11:51 UTC by Geoffrey De Smet
Modified: 2014-10-26 20:34 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2014-08-06 20:17:46 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Geoffrey De Smet 2013-08-12 11:51:18 UTC
The community docs have XML code examples with correct indentation:

"If you use Maven, just add a dependency to optaplanner-core in your project's pom.xml:
(4 spaces)    <dependency>
(6 spaces)      <groupId>org.optaplanner</groupId>"


http://docs.jboss.org/drools/release/6.0.0.CR1/optaplanner-docs/html_single/index.html#useWithMavenGradleEtc


However, the productized docs have XML code examples with corrupted indentation:

"If you use Maven, add a dependency to drools-planner-core in your project's pom.xml:
(1 spaces) <dependency>
(6 spaces)      <groupId>org.drools.planner</groupId>"

http://documentation-devel.engineering.redhat.com/docs/en-US/Red_Hat_JBoss_BRMS/6-Beta/html/Business_Resource_Planner_Guide/Run_the_Examples.html


Wrong indentation makes the content harder to understand
and it is harder to copy-paste.

Comment 2 lcarlon 2013-08-13 01:42:12 UTC
Hi Geoffrey,

Thanks for reporting. This appears to be an issues with a tab/space conversion in the tool we're using. Will correct and investigate.

Assigning to Doug.

Thanks

Comment 4 Marek Winkler 2014-01-16 11:30:58 UTC
Verified that the indentation in the example is correct.


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