OwS Style Sheet Directive: heading - Versionsgeschichte

Caumanns: /* Examples */

2016-12-30T10:17:35Z

‎Examples

Caumanns: /* Examples */

2016-12-30T10:07:08Z

‎Examples

Caumanns: /* Linking MS Word Sections and Definition Scopes */

2016-12-30T10:02:49Z

‎Linking MS Word Sections and Definition Scopes

Caumanns: /* Description */

2016-12-30T09:14:25Z

‎Description

Caumanns: /* Examples */

2016-12-30T08:27:56Z

‎Examples

Caumanns: Die Seite wurde neu angelegt: „== Syntax == {|border="0" |- style="vertical-align:top" | style="width:10em" | ''HeadingDirective'' | style="width:3em" | := | style=…“

2016-09-21T19:07:15Z

Die Seite wurde neu angelegt: „== Syntax == {|border="0" |- style="vertical-align:top" | style="width:10em" | ''HeadingDirective'' | style="width:3em" | := | style=…“

Neue Seite

== Syntax ==

{|border="0"
|- style="vertical-align:top"
| style="width:10em" | ''HeadingDirective''
| style="width:3em" | :=
| style="width:36em" | '''#heading''' ''Level'' [[OwS Statement: Base Types|''TypeName'']] [[OwS Statement: Base Types|''Mask'']]
| style="width:1em" |  
| 
|- style="vertical-align:top"
|
| style="text-align:right" | |
| '''#heading''' ''Level''
|
|
|- style="vertical-align:top"
| ''Level''
| :=
| [1-9]('''-'''[1-9])?
|
|
|}

<hr>

== Description ==

== Examples ==

<hr>
{|
|-
! style="text-align:left; width:6em" | Style Sheet !!      !! style="text-align:left; width:35em" | Text !!      !! style="text-align:left" | ''Comment''
|- style="vertical-align:top"
| OwS|| ||style="background:#fff588"| #heading 2 codesystem .Name ( .URI)|| || Level 2 chapters are terminology definitions. The heading gives the name of the terminology and (in parentheses) the URI of the terminology.
|- style="vertical-align:top"
| OwS|| ||style="background:#fff588"| #heading 3-4 concept .Display ( .Name )|| || Level 3 sections are concept definitions within the terminology that coresponds to the superordinate level 2 chapter. Level 4 sections define subconcepts within the concepts defined by level 3 section. Level 3 and 4 headlines provide the display text of a concept together with its code (in parentheses).
|- style="vertical-align:top"
| Überschrift 2|| ||style="background:#fff588"| '''Clinics and Wards (http://hospital.com/clinics)'''|| || A terminology "Clinics and Wards" is defined. The definition scope of the codesystem objects reaches until the end of the level-2 chapter.
|- style="vertical-align:top"
| Überschrift 3|| ||style="background:#fff588"| '''Cardiologic Clinic, Prof. Smyth (cardiologic clinic) '''|| || A concept "cordiologic clinic" is defined. The definiton scope of this concept reaches until the end of the level-3 section.
|- style="vertical-align:top"
| Überschrift 4|| ||style="background:#fff588"|    '''''Cardiologic care ward for Women and Children (ward 51.1) '''''|| || A concept "ward 51.1" is defined as a subconcept of "cardiologic clinic".
|- style="vertical-align:top"
| Überschrift 4|| ||style="background:#fff588"|    '''''Cardiologic care ward for Intensive Care (ward 51.2) '''''|| ||
|- style="vertical-align:top"
| Überschrift 3|| ||style="background:#fff588"| '''Orthopedic Clinic, Prof. Miller (orthopedic clinic) '''|| || Another concept within the terminology "Clinics and Wards". This concept sets up a new definition scope within the definition scope of "Clinics and Wards".
|- style="vertical-align:top"
| Überschrift 4|| ||style="background:#fff588"|    '''''Orthopedic care ward for knee and hip patients (ward 52.1)'''''|| ||
|}
<hr>

@@ Zeile 154: / Zeile 154: @@
 || || <font face="courier">}&nbsp;}&nbsp;} </font> || The text ends. All open definition scopes ("Penguin", "Birds" and "Animals") are closed.
 |}
 == Examples ==

@@ Zeile 157: / Zeile 157: @@
 == Examples ==
-<hr>
+Within the context of the tutorial examples and hints for using the #heading directive are given in these lessons:
-{|style="background:#fcfcfc"
+* [[OwS Tutorial: Mapping Concept Hierarchies onto Word Sections|Using Heading Styles]]: some general information and examples
-|- style="background:#e8e8e8"
+* [[OwS Tutorial: Defining Custom Types|Defining Custom Types]]: example for using the #heading directive for creating objects of a custom type

← Nächstältere Version		Version vom 30. Dezember 2016, 10:02 Uhr
Zeile 76:		Zeile 76:

	=== Linking MS Word Sections and Definition Scopes ===		=== Linking MS Word Sections and Definition Scopes ===
		+	Each object definition has its definition scope. When defining an object through the #heading directive the defined object's definition scope corresponds to the scope of the section that was opened with the heading.
		+
		+	The example below shows this correspondence of MS Word sections/chapters and OwS definition scopes.
		+	<hr>
		+	{\|style="background:#fcfcfc"
		+	\|- style="background:#e8e8e8"
		+	! style="text-align:left; width:6em" \| Style Sheet !!   !! style="text-align:left; width:20em" \| Text !!   !! style="text-align:left; width:24em" \| ''Translates to'' !! style="text-align:left" \| ''Comment''
		+	\|- style="vertical-align:top"
		+	\| OwS\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">#heading 2 codesystem .Name</span>
		+	\|}
		+	\|\| \|\| \|\| The OwS Macro interpreter is advised to generate codesystem definitions from level-2 headings. The text of the respective headlines shall be taken as the value of the codesystem's ''Name'' property (which is as well the name of the codesystem).
		+	\|- style="vertical-align:top"
		+	\| OwS\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">#heading 3-4 concept .Name</span>
		+	\|}
		+	\|\| \|\| \|\| The OwS Macro interpreter is advised to generate concept definitions from level-3 and level-4 headings. The text of the respective headlines shall be taken as the value of the concept's ''Name'' property (which is as well the name of the concept).
		+	\|- style="vertical-align:top"
		+	\| OwS\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%"></span>
		+	\|}
		+	\|\| \|\| \|\|
		+	\|- style="vertical-align:top"
		+	\| Überschrift 2\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Arial;font-size:118%">'''Animals'''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">define codesystem (Animals) {</font> \|\| We are entering a level-2 chapter within the document. Everything within this chapter is part of the definition scope of the corresponding codesystem definition.
		+	\|- style="vertical-align:top"
		+	\| Überschrift 3\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:1em"\|
		+	\|<span style="font-family:Arial;font-size:100%">'''Mammals'''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">  define concept (Mammals) { </font> \|\| We are entering a level-3 section within the document. Everything within this section is part of the definition scope of the concept named "Mammals".
		+	\|- style="vertical-align:top"
		+	\| Überschrift 4\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:3em"\|
		+	\|<span style="font-family:Arial;font-size:100%">'''''Lion'''''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">    define concept (Lion) {</font> \|\| We are entering a level-4 section within the document. Everything within this section is part of the definition scope of the concept "Lion". As the level-4 section is within the level-3 section the concept "Lion" is defined within the definition scope oft he concept "Mammals" which makes it a sub-concept of "Mammals".
		+	\|- style="vertical-align:top"
		+	\| Überschrift 4\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:3em"\|
		+	\|<span style="font-family:Arial;font-size:100%">'''''Elephant'''''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">    }<br>    define concept (Elephant) {</font> \|\| The definiton scope of "Lion" is closed due to the beginning of a new level-4 section. The concept "Elephant" is defined within the definition scope of the concept "Mammals" which makes it another sub-concept of this concept.
		+	\|- style="vertical-align:top"
		+	\| Überschrift 3\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:1em"\|
		+	\|<span style="font-family:Arial;font-size:100%">'''Birds'''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">  } } <br>  define concept (Birds) { </font> \|\| While beginning a new level-3 section, the definition scopes associated to the open level-4 section ("Elephant") and level-3 section ("Mammals") are closed.
		+	\|- style="vertical-align:top"
		+	\| Überschrift 4\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:3em"\|
		+	\|<span style="font-family:Arial;font-size:100%">'''''Penguin'''''</span>
		+	\|}
		+	\|\| \|\| <font face="courier">    define concept (Penguin) { </font> \|\|
		+	\|- style="vertical-align:top"
		+	\| Standard\|\| \|\|style="background:#f4f6f6"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Arial;font-size:100%"></span>
		+	\|}
		+	\|\| \|\| <font face="courier">} } } </font> \|\| The text ends. All open definition scopes ("Penguin", "Birds" and "Animals") are closed.
		+	\|}

	== Examples ==		== Examples ==

← Nächstältere Version		Version vom 30. Dezember 2016, 09:14 Uhr
Zeile 25:		Zeile 25:

	== Description ==		== Description ==
		+	The #heading directive considers a MS Word chapter or section as an OwS object definition. The #heading directive takes 3 arguments:
		+	{\|style="background:#fcfcfc"
		+	\|- style="background:#e8e8e8"
		+	!argument !! description
		+	\|-
		+	\|style="background:#e8e8e8"\|Level \|\| The heading levels that trigger the directive. E.g. if "2-4" is provided for this argument, the directive only applies to MS Word headlines which are formatted by style sheets that are registered as level-2, level-3 and level-4 headings.
		+	\|-
		+	\|style="background:#e8e8e8"\|TypeName \|\| The type of the object that shall be created and defined by the headline text and the section/chapter assigned to that headline. As well OwS buildin types as custom types may be devined through the #heading directive.
		+	\|-
		+	\|style="background:#e8e8e8"\|Mask \|\| Pattern that defines how properties of the newly defined object are provided within the headline text.
		+	\|}
		+
		+	=== Defining the Headline Text Pattern ===
		+	The ''Mask'' argument is a sequence of OwS property names and non-interpreted text. Property names shall start with a dot ('''.''') and denote a property that is defined for the object that is to be created. Property names and non-interpreted text shall alternate within the mask. Non-interpreted text shall not include dots (because otherwise the OwS Tokenizer would consider the word following the dot as a property name). The table below gives some examples for valid mask definitions:
		+
		+	{\|style="background:#fcfcfc; valign:top"
		+	\|- style="background:#e8e8e8"
		+	!style="text-align:left; width:24em"\|mask !!style="text-align:left; width:6em"\|typename !!style="text-align:left; width:16em"\|example headline text !!style="text-align:left"\| equivalent to
		+	\|-
		+	\|\| .Name \|\| codesystem \|\| Ingredients and Tools
		+	\| <pre>define codesystem (Ingredients and Tools) { ... } </pre>
		+	\|-
		+	\|\| .Name and Tools\|\| codesystem \|\| Ingredients and Tools
		+	\| <pre>define codesystem (Ingredients) { ... } </pre>
		+	\|-
		+	\|\| Ingredients and .Name \|\| codesystem \|\| Ingredients and Tools
		+	\| <pre>define codesystem (Tools) { ... } </pre>
		+	\|-
		+	\|\| .Name ( .Display )\|\| concept \|\| sugar white (White Sugar)
		+	\| <pre>
		+	define concept (sugar white) {
		+	set .Display = (White Sugar)
		+	...
		+	}
		+	</pre>
		+	\|-
		+	\|\| .Name : .Code ( .Designation[Language=de] )\|\| concept \|\| sugar white:37 (Zucker)
		+	\| <pre>
		+	define concept (sugar white) {
		+	set .Code = (37)
		+	set .Designation[Language=de] = (Zucker)
		+	...
		+	}
		+	</pre>
		+	\|}
		+
		+	The following restrictions apply:
		+	* when defining a codesystem, property, predicate or type, the ''Name''-property shall be provided as part of the headline text
		+	* when defining a concept, either the ''Name''- or the ''Code''-property shall be provided as part of the headline text. If only a ''Code'' is provided, the code of the concept is also used as the name of the concept.
		+
		+	=== Linking MS Word Sections and Definition Scopes ===

	== Examples ==		== Examples ==

@@ Zeile 29: / Zeile 29: @@
 <hr>
-{|
+{|style="background:#fcfcfc"
-|-
+|- style="background:#e8e8e8"
 ! style="text-align:left; width:6em" | Style Sheet !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left; width:35em" | Text !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left" | ''Comment''
 |- style="vertical-align:top"
-| OwS|| ||style="background:#fff588"| <span style="font-family:Courier;font-size:110%">#heading 2 codesystem .Name ( .URI)</span>|| || Level 2 chapters are terminology definitions. The heading gives the name of the terminology and (in parentheses) the URI of the terminology.
+| OwS|| ||style="background:#f4f6f6"| <span style="font-family:Courier;font-size:110%">#heading 2 codesystem .Name ( .URI)</span>|| || Level 2 chapters are terminology definitions. The heading gives the name of the terminology and (in parentheses) the URI of the terminology.
 |- style="vertical-align:top"
-| OwS|| ||style="background:#fff588"| <span style="font-family:Courier;font-size:110%">#heading 3-4 concept .Display ( .Name )</span>|| || Level 3 sections are concept definitions within the terminology that coresponds to the superordinate level 2 chapter. Level 4 sections define subconcepts within the concepts defined by level 3 section. Level 3 and 4 headlines provide the display text of a concept together with its code (in parentheses).
+| OwS|| ||style="background:#f4f6f6"| <span style="font-family:Courier;font-size:110%">#heading 3-4 concept .Display ( .Name )</span>|| || Level 3 sections are concept definitions within the terminology that coresponds to the superordinate level 2 chapter. Level 4 sections define subconcepts within the concepts defined by level 3 section. Level 3 and 4 headlines provide the display text of a concept together with its code (in parentheses).
 |- style="vertical-align:top"
-| Überschrift 2|| ||style="background:#fff588"| <span style="font-family:Arial;font-size:120%">'''Clinics and Wards  (http://hospital.com/clinics)'''</span>|| || A terminology "Clinics and Wards" is defined. The definition scope of the codesystem objects reaches until the end of the level-2 chapter.
+| Überschrift 2|| ||style="background:#f4f6f6"| <span style="font-family:Arial;font-size:120%">'''Clinics and Wards  (http://hospital.com/clinics)'''</span>|| || A terminology "Clinics and Wards" is defined. The definition scope of the codesystem objects reaches until the end of the level-2 chapter.
 |- style="vertical-align:top"
-| Überschrift 3|| ||style="background:#fff588"| <span style="font-family:Arial;font-size:110%">'''Cardiologic Clinic, Prof. Smyth (cardiologic clinic) '''</span>|| || A concept "cordiologic clinic" is defined. The definiton scope of this concept reaches until the end of the level-3 section.
+| Überschrift 3|| ||style="background:#f4f6f6"| <span style="font-family:Arial;font-size:110%">'''Cardiologic Clinic, Prof. Smyth (cardiologic clinic) '''</span>|| || A concept "cordiologic clinic" is defined. The definiton scope of this concept reaches until the end of the level-3 section.
 |- style="vertical-align:top"
-| Überschrift 4|| ||style="background:#fff588"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Cardiologic care ward for Women and Children (ward 51.1) 	'''''</span>|| || A concept "ward 51.1" is defined as a subconcept of "cardiologic clinic".
+| Überschrift 4|| ||style="background:#f4f6f6"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Cardiologic care ward for Women and Children (ward 51.1) 	'''''</span>|| || A concept "ward 51.1" is defined as a subconcept of "cardiologic clinic".
 |- style="vertical-align:top"
-| Überschrift 4|| ||style="background:#fff588"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Cardiologic care ward for Intensive Care (ward 51.2) '''''</span>|| ||
+| Überschrift 4|| ||style="background:#f4f6f6"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Cardiologic care ward for Intensive Care (ward 51.2) '''''</span>|| ||
 |- style="vertical-align:top"
-| Überschrift 3|| ||style="background:#fff588"| <span style="font-family:Arial;font-size:110%">'''Orthopedic Clinic, Prof. Miller (orthopedic clinic) '''</span>|| || Another concept within the terminology "Clinics and Wards". This concept sets up a new definition scope within the definition scope of "Clinics and Wards".
+| Überschrift 3|| ||style="background:#f4f6f6"| <span style="font-family:Arial;font-size:110%">'''Orthopedic Clinic, Prof. Miller (orthopedic clinic) '''</span>|| || Another concept within the terminology "Clinics and Wards". This concept sets up a new definition scope within the definition scope of "Clinics and Wards".
 |- style="vertical-align:top"
-| Überschrift 4|| ||style="background:#fff588"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Orthopedic care ward for knee and hip patients (ward 52.1)'''''</span>|| ||
+| Überschrift 4|| ||style="background:#f4f6f6"| &nbsp;&nbsp;&nbsp;<span style="font-family:Arial;font-size:100%">'''''Orthopedic care ward for knee and hip patients (ward 52.1)'''''</span>|| ||
 |}
 <hr>