Breakdown of example parts (do not publish)

Illustrates Domains

XX

Illustrates Variables

XXVAR

Illustrates Data Structures

ADAM OTHER


Content

This can be taken as a style sheet of sorts, because it attempts to include all the kinds of pieces that might be found in an example. It exists for testing purposes and is not intended for public consumption. 

Things that are not part of the example's content, but are on the page, should not be included on publication (including to the Examples Collection). This includes summaries of changes, hidden excerpts, and metadata about the example. Such content can be identified by being in an enclosing <div> element with the class "NoPrint".

This is an info box inside an Excerpt macro, used for summarizing changes made to the content on the page since it was last published.

The following table is inside a Page Properties macro, which means it contains metadata about the example. The macro can be identified in the view format by an enclosing <div> element with the class "

plugin-tabmeta-details".

Components that are part of the example's content should be included in publication. This includes narrative, code blocks, aCRFs, dataset tables, and metadata tables. They are listed in more detail below. 

Narrative is anything that doesn't directly illustrate the use of CDISC standards. Most often it's one or more paragraphs of text, which may or may not contain formatting, but it can also include bulleted or numbered lists, text called out into panels or notice boxes, images, generic tables, and blocks of plain text. 

  • This is a bulleted list. 
    • It may or may not have multiple levels to it. 
  1. This is a numbered list. 
    1. This is the second level of a numbered list.
      1. This is the third level of a numbered list.
        1. The fourth level of a numbered list uses the same numbering style as the first level, the fifth the same as the second, the sixth the same as the third, etc.

Notice boxes like this one are indicated in the storage format and edit mode by the use of the Tip, Info, Note, or Warning macro, and in the rendered format for view mode as enclosing <div> elements with a class of "confluence-information-macro".

Images should be treated as figures and therefore included using an Excerpt Include macro. 

sample nonsense figure

However, an image might also be included directly in part of the page.

A generic table is distinguishable from other tables by virtue of not being in a macro. 

Generic TableHeading Row
This is a generic table.There is no restriction on how many rows or columns it is.

Some of the cells may be empty.

Other cells may contain multiple paragraphs.

Blocks of plain text, like images, should be treated as figures and included from another page, but there's always the possibility that they appear directly on the page as well. 

This is a block of plain text. Spacing matters!
----------------------------------------
                    A      B      C
----------------------------------------
One
   ichi             xx     xx     xx
   eins             xx     xx     xx
Two
   ni               xx     xx     xx
   zwei             xx     xx     xx

A code block appears in examples based on Define-XML (and other members of the ODM family). It looks like this:

Code block title
<element attribute="value">Text value</element>
<!-- This is a comment -->

aCRFs built with CRF Maker are tables of four columns and one row per field. The first column contains any completion instructions for the field; if the entire CRF has no completion instructions, this column is omitted. The second column contains the field's query, phrased as either question text or a prompt; the variable annotations; and sometimes an annotation about the field's status as pre-populated and/or hidden. The third column contains the field's input, which may take the form of a text box, a set of radio buttons or check boxes, or a drop-down list; and sometimes an annotation about controlled terminology. The fourth column is reserved for displaying JIRA issues and debugging logs, and should be omitted in publication. All CRF Maker aCRFs are followed an expanding section containing a metadata table with the metadata used to build the aCRF.

Older aCRFs not built with CRF Maker are less predictable in their structure and format, and may not be accompanied by a metadata table. In general, the following formatting rules apply:

  • If the first row is a heading row that spans the entire table, it is the aCRF's title.
  • If all the cells in a row are highlighted grey, it represents a hidden field. 
  • Annotations (excepting variable annotations) are in italics.
  • Variable annotations are distinctly styled to show not only that they are variables but also what kind of variables they are. The classes used by CRF Maker and its predecessor are "variable" to indicate a variable annotation; plus "cdash", "cdash-sdtm", "sdtm", or "no-sdtm" to indicate which kind of variable (or non-variable) it is. If the CRF has been built using Status macros for variable annotations, VARIABLE is equivalent to the "cdash" class, VARIABLE to "cdash-sdtm" and "sdtm", and NOT SUBMITTED to "no-sdtm". 

If the example is primarily CDASH-based, the aCRF will be on the page proper. 

These are completion instructions.
BVAR
_________________
CVAR SVAR Pre-populated
Pre-populated value
THING Hidden/pre-populated
Hidden value
Are you reading this?
CHECK Not submitted
This is a field with permissible values taken from controlled terminology. What is the subject's sex?
SEX

<From SEX codelist>

Field with its value pre-populated from an enumerated value domain
VAR4 VAR5 Pre-populated
Color
COLOR
View CRF Metadata
OrderInput TypeCDASHIG VariableQuestion TextPromptCRF Completion InstructionsSDTMIG TargetMapping InstructionsControlled Terminology Codelist NamePermissible ValuesPre-populated ValueQuery DisplayList StyleHidden

textBVARThis is question text
These are completion instructions.BVARMaps directly to the SDTMIG target






textCVAR
This is a prompt
SVARMaps indirectly to the SDTMIG target

Pre-populated value



textTHINGN/AN/A
THING


Hidden value

true

textCHECKAre you reading this?




Yes!




textSEXWhat is the subject's sex?SexThis is a field with permissible values taken from controlled terminology.SEX
SEXM=Male; F=Female; UNDIFFERENTIATED=Intersex; U=Unknown




textVAR4Field with its value pre-populated from an enumerated value domain

VAR5

Values; not from; controlled terminology; one of which is; pre-selectedpre-selected



textCOLOR
Color
COLOR

RED; ORANGE; YELLOW; GREEN; BLUE; INDIGO; VIOLET



If the example is also SDTM-based, the aCRF will be in an expanding and included from another page using the Include Page macro. 

Annotated CRF: Some Title


XXTOPIC XXTERM Hidden/pre-populated
THING
XXPRESP Hidden/pre-populated
Select "Yes" or "No" to indicate if the subject experienced this thing. Did the subject have the thing?
XXOCCUR

<From NY codelist>

Enter the date the thing started.
XXSTDAT XXSTDTC
_ _ / _ _ _ / _ _ _ _
View CRF Metadata
OrderInput TypeCDASHIG VariableQuestion TextPromptCRF Completion InstructionsSDTMIG TargetMapping InstructionsControlled Terminology Codelist NamePermissible ValuesPre-populated ValueQuery DisplayList StyleHidden
10textXXTOPICWhat is the thing?Topic

Pre-populated = THING 

XXTERMMap directly to SDTMN/AN/ATHINGnoneN/Ahidden
20booleanXXPRESPIs the term pre-specified?Pre-specifiedPre-populated = YXXPRESPMap directly to SDTMNYN/AYnoneN/Ahidden
30textXXOCCURDid the subject have the thing?ThingSelect "Yes" or "No" to indicate if the subject experienced this thing. XXOCCURMap directly to SDTMNYY=Yes; N=No; U=UnknownN/Aqtextradiovisible
40dateXXSTDATWhat is the start date?Start DateEnter the date the thing started.XXSTDTCMap directly to MHSTDTC in SDTMN/AN/AN/ApromptN/Avisible

A dataset table is indicated in the storage format and edit mode by being inside of a Dataset macro. In the rendered format and view mode, the table has a class of "dataset". Each dataset table is preceded by the table's title, which is a line in italics most often provided by either the Dataset macro or the Dataset Wrapper macro. If not, it may be included manually. If the table title has been provided by a macro, it will be a <p> element with a class of "table-title". 

xx.xpt

VAR1VAR2VAR3VAR4
Value237UThis table has a manual table title.
Another value283
Value that contains a non-forbidden, non-ascii character like ¥

The first column may be a row-numbering column, which is formatted differently from the rest of the table. 

xx.xpt

RowDOMAINVAR1VAR2VAR3VAR4
1XXValue237UThis table has a table title provided by the Dataset macro.
2XXAnother value283
Value that contains a non-forbidden, non-ascii character like ¥

There may also be non-standard variables included, which follow an empty spacer column. Both the spacer column and the cells in the heading row for non-standard variables are also formatted differently from the rest of the table. 

xx.xpt

DOMAINVAR1VAR2
NSV
XXValue237
value for a non-standard variable
XXAnother value283

Each dataset table may or may not be preceded by a table containing captions for individual rows or groups of rows in the dataset table. Row caption tables are always two columns wide. The first column indicates which row(s) in the dataset table the caption in the second column applies to. 

Rows 1-3:A caption for a set of rows in the dataset table.
Rows 4, 6-8:A caption for a set of rows in the dataset table that are not fully sequential.
Row 5:A caption for a single row in the dataset table.

Each dataset table also may or may not be followed by tables representing Define metadata rendered in a tabular format, which are covered in more detail under the sub-section of this page dedicated to metadata tables

Every dataset table plus its attending (row captions and/or metadata) tables, if it has any, should be inside a Dataset Wrapper macro. The primary purpose of the Dataset Wrapper macro is to keep these bits together. In the Wiki, it most often puts its contents into an expanding section. For publication, the expanding section should be removed and its contents exposed. In the rendered format for view mode, a dataset wrapper takes the form of a <div> element with a class of "dataset-wrap". 

xx.xpt
Row 1:Shows a record including data that requires the use of a non-standard variable.
Row 2:Shows a record that doesn't use the NSV.

xx.xpt

RowDOMAINVAR1VAR2
MORE
1XXValue237
value for a non-standard variable
2XXAnother value283

XX NSV Metadata

Metadata tables

may follow after (and belong to) aCRFs or dataset tables, or stand on their own. 

CRF metadata tables are placed inside a Metadata/Specification Table macro, which renders in view mode as an enclosing <div> element with a class of "metaspec". 

OrderInput TypeCDASHIG VariableQuestion TextPromptCRF Completion InstructionsSDTMIG TargetMapping InstructionsControlled Terminology Codelist NamePermissible ValuesPre-populated ValueQuery DisplayList StyleHidden







The Metadata/Specification Table macro is the more generic relative of the Define-XML Metadata Table macro. Among other things, it's intended to be used with tables that are very wide.





Metadata tables associated with a dataset are placed inside a Define-XML Metadata Table macro, which renders in view mode as adding the class "defineMetadata" to the table. Each of these metadata tables are preceded by a table title, which is a line in bold, and which is provided by the macro. As with the table title for dataset tables, it is a <p> element with a class of "table-title".  testing data for confluence updates.

XX Variable Metadata