[DOCS-76] Cannot copy/paste examples from PDF Created: 13/May/13
Updated:
10/Mar/14 Resolved: 10/Mar/14
Status:
Project:
Component/s:
Affects
Version/s:
Fix Version/s:
Resolved
Commons - Documentation
forgerock-doc-maven-plugin
1.2.0
Type:
Reporter:
Resolution:
Labels:
Remaining
Estimate:
Time Spent:
Original
Estimate:
Bug
Mark
Fixed
None
Not Specified
Issue Links:
Depends
is required
by
is required
by
is required
by
is required
by
is required
by
Sprint:
2.1.0
Priority:
Assignee:
Votes:
Major
Mark
0
Not Specified
Not Specified
OPENAM-2636 Allow copy/paste of formatted shell
c...
OPENDJ-980 Allow copy/paste of formatted shell
c...
OPENICF-122 Allow copy/paste of formatted shell
c...
OPENIDMAllow copy/paste of formatted shell
1401
c...
OPENIG-45
Allow copy/paste of formatted shell
c...
Resolved
Resolved
Closed
Closed
Closed
Sprint 13
Description
<screen> content is formatted for readability, but without backslashes before newlines, so
cannot be copy/pasted directly from the PDF.
Workaround: Access the HTML version, click on the [-] icon to flatten the formatted example,
and then copy the resulting content.
As those [+][-] icons likely hurt accessibility, we should probably revert to using backslashes,
even though they make the examples harder to read.
Comments
Comment by Mike2 [ 13/May/13 ]
Unfortunately, backslashes () do not "escape" the carriage return on the Windows command line
or the power shell. (It is interpreted as the start of a URI, I think normally for a shared
SMB/CIFS directory. It looks like the Windows power shell may use a back quote (`) or a carat
(^) depending on the context, but neither works on Linux (or the Mac) command line.
So if we go to backslashes, we will need to note the issues related to Windows accessibility.
Comment by Mark [ 08/Jun/13 ]
Summary:



[+][-] added in with JavaScript are not accessible, and do not work in PDF.
\ is the correct continuation character on Linux/Mac/UNIX/BSD, and most examples are
copied from Bash shells on those platforms anyway. \ is not a continuation character on
Windows.
^ should work on the Windows platforms we support. We do not have too many
Windows examples, but we do have some. Consider the Adding Users Through REST in
the OpenIDM Installation Guide.
My recommendation would be that we eliminate the [+][-] icons in the next release of the doc
build tool, and update our documentation sets to use correct continuation characters for the
platform where the example was developed. In other words, if you copied the example from a
Bash shell, you would use \ . If you copied the example from Windows, you would use ^.
Comment by Mark [ 04/Jul/13 ]
Created tasks for individual projects and linked them as required for this issue. We'll no doubt
want to coordinate so that the output doesn't include both backslashes for line continuation and
also the expand/collapse icons for released documentation.
Comment by Mark [ 10/Dec/13 ]
Targeting the next release
Workaround is still to copy from the "flat" layout in the HTML
Comment by Mark [ 10/Mar/14 ]
Before eliminating the [+][-] icons, it would be nice to allow flattening also when the line ends
in \ or ^.
The \ or ^ should disappear when flattening the line, but leave it to appear in folded lines.
So the original, folded version for example might look like this:
[-] $ ls -1 | \
grep -v target
And the flattened version might look like this:
[+] $ ls -1 |
grep -v target
Note the extra space in this latter example. My hope is that an extra space is not significant in
any of the cases where we split lines using a continuation character.
Generated at Sun Mar 06 09:26:45 GMT 2016 using JIRA 6.3.9#6339sha1:46fa26140bf81c66e10e6f784903d4bfb1a521ae.