From f57888284f6d3cee8b7f7e96781450445f85fe45 Mon Sep 17 00:00:00 2001 From: "Achim D. Brucker" Date: Sat, 27 Jul 2019 19:05:45 +0100 Subject: [PATCH] Minor changes for demonstrating document support for SRAC, EC, assumption, and hypthesis. --- examples/CENELEC_50128/mini_odo/mini_odo.thy | 42 ++++++-------------- 1 file changed, 13 insertions(+), 29 deletions(-) diff --git a/examples/CENELEC_50128/mini_odo/mini_odo.thy b/examples/CENELEC_50128/mini_odo/mini_odo.thy index 0d00ec31..d63f94c5 100644 --- a/examples/CENELEC_50128/mini_odo/mini_odo.thy +++ b/examples/CENELEC_50128/mini_odo/mini_odo.thy @@ -11,7 +11,6 @@ declare[[strict_monitor_checking=true]] title*[title::title]\The CENELEC 50128 Ontology\ subtitle*[subtitle::subtitle]\Case Study: An Odometer-Subsystem\ - chapter*[casestudy::technical]\A Case-Study: An Odometer-Subsystem\ text\ In our case study, we will follow the phases of analysis, design, and implementation of the @@ -521,16 +520,24 @@ text\ text\Examples for declaration of typed doc-items "assumption" and "hypothesis", concepts defined in the underlying ontology @{theory "Isabelle_DOF.CENELEC_50128"}. \ -text*[ass1::assumption] \ The subsystem Y is safe. \ +text*[ass1::assumption, long_name="Some ''assumption one''"] \ The subsystem Y is safe. \ text*[hyp1::hypothesis] \ P not equal NP \ text\A real example fragment from a larger project, declaring a text-element as a "safety-related application condition", a concept defined in the @{theory "Isabelle_DOF.CENELEC_50128"} ontology:\ -text*[new_ass::hypothesis]\Under the assumption @{assumption \ass1\} we establish the following: ... \ +text*[hyp2::hypothesis]\Under the assumption @{assumption \ass1\} we establish the following: ... \ -text*[ass122::SRAC] \ The overall sampling frequence of the odometer +text*[ass122::SRAC, long_name="Some ''ass122''"] \ The overall sampling frequence of the odometer +subsystem is therefore 14 khz, which includes sampling, computing and +result communication times... \ + +text*[ass123::SRAC] \ The overall sampling frequence of the odometer +subsystem is therefore 14 khz, which includes sampling, computing and +result communication times... \ + +text*[ass124::EC, long_name="Some ''ass124''"] \ The overall sampling frequence of the odometer subsystem is therefore 14 khz, which includes sampling, computing and result communication times... \ @@ -539,7 +546,6 @@ that governs the external test-execution via, eg., a makefile or specific calls to a test-environment or test-engine \ -section\ References to doc-items.\ text\Finally some examples of references to doc-items, i.e. text-elements with declared meta-information and status. \ text \ As established by @{docref (unchecked) \t10\}, @@ -549,28 +555,6 @@ text \ the @{docref \t10\} text \ represent a justification of the safety related applicability condition @{SRAC \ass122\} aka exported constraint @{EC \ass122\}.\ - -section\ Some Tests for Ontology Framework and its CENELEC Instance \ - -declare_reference* [lalala::requirement, alpha="main", beta=42] -declare_reference* [blablabla::cid, alpha="beta sdf", beta=gamma, delta=dfg_fgh\<^sub>1] - - -section*[h::example]\ Some global inspection commands for the status of docitem and - doc-class tables ... \ - - -section*[i::example]\ Text Antiquotation Infrastructure ... \ - -(*<*) -text\ @{docitem \lalala\} -- produces warning. \ -text\ @{docitem (unchecked) \lalala\} -- produces no warning. \ -(*>*) - -text\ @{EC \ass122\} -- global reference to a exported constraint in another file. - Note that the link is actually a srac, which, according to - the ontology, happens to be an "ec". \ - +(*<*) end - - +(*>*)