Tag Definition: placedStory

Generated by rlextra version 4.4.0

Attributes

Name	Required?	Default_Value	Values
anchor	implied	None	['nw', 'n', 'ne', 'nwl', 'nl', 'nel', 'nwb', 'nb', 'neb', 'e', 'c', 'w', 'swt', 'st', 'set', 'swl', 'sl', 'sel', 'sw', 's', 'se']
fakeWidth	implied	None	['yes', 'no', '0', '1']
id	implied	None
maxHeight	required	None
maxWidth	required	None
mergeSpace	implied	None
onOverflow	implied	None	['error', 'overflow', 'shrink', 'truncate']
origin	implied	None	['page', 'frame', 'local']
showBoundary	implied	None
x	implied	None
y	implied	None
Can contain (para \| p \| title \| h1 \| h2 \| h3 \| h4 \| h5 \| h6 \| pre \| xpre \| blockTable \| spacer \| ul \| ol \| dl \| illustration \| graphicsMode \| storyPlace \| codesnippet \| plugInFlowable \| drawing \| outlineAdd \| namedString \| bookmarkPage \| bookmark \| name \| hr \| indent \| frameBackground \| fixedSize \| keepInFrame \| imageAndFlowables \| imageFigure \| figure \| barCodeFlowable \| keepTogether \| docWhile \| docIf \| docAssign \| docExec \| docAssert \| docPara \| showIndex \| topPadder \| pto \| placeString \| placeRightString \| placeCentredString \| placeCenteredString \| placePara \| placeXPre \| setTopFlowables \| setPageTopFlowables \| balancedColumns \| markedContent \| placedStory \| caption \| loop_b \| switch_b \| assign_b \| if_b \| script_b \| doclet \| alias \| nextPage \| nextPageIfNotEmpty \| nextFrame \| setNextFrame \| setNextTemplate \| switchTemplate \| condPageBreak \| includePdfPages \| log \| warn \| debug \| info \| error \| critical)*

Purpose

This lets you create a story at a fixed location relevant to the provided origin, and adhering to a provided limit on the maximum width and height. This content expands to those limits based on the anchor position, and you can set rules on how it behaves when overflowing.

Elements within placedStory can overlap with story elements outside of it.

See the relevant rml sample here. And the relevant pdf here.

Example usage

<placedStory x="7" y="7" origin="page" anchor="sw" maxWidth="3in" maxHeight="2.5in"
    showBoundary="border(color='blue',width=0.2)" onOverflow="shrink">
    <h3>Placed Story</h3>
    <para>This is a longer paragraph used to test the behaviour of the placed story overflow handling etc etc.</para>
    <h2>Table 1 Example</h2>
    <blockTable  style="basic" align="LEFT" tagType="Table">
        <tr><td><para><b>Parameter</b></para></td><td><para><b>Value</b></para></td></tr>
        <tr><td>(x,y)</td><td>(7,7)</td></tr>
        <tr><td>max width height</td><td>3in x 2.5in</td></tr>
        <tr><td>origin</td><td>page</td></tr>
        <tr><td>anchor</td><td>sw</td></tr>
    </blockTable>
</placedStory>

Note: Only relevant sections are used in this snippet. Some tags were not included. See some of our samples for further insight of how you may go about setting up a full document using rml.

Example of nesting path from the parent tags to the current tag