Skip to content

Commit 582115c

Browse files
committed
Use code block for manifest.xml example
1 parent b3154dd commit 582115c

File tree

1 file changed

+49
-98
lines changed

1 file changed

+49
-98
lines changed

Diff for: RationaleMCP/0039/manifest-example.md

+49-98
Original file line numberDiff line numberDiff line change
@@ -3,126 +3,77 @@
33
This is an example of what the “manifest.xml” file could look like for
44
an example encrypted library:
55

6-
<?xml version=*"1.0"* encoding=*"utf-8"*?>
6+
```
7+
<?xml version=*"1.0"* encoding=*"utf-8"*?>
8+
<archive>
79
8-
&lt;archive&gt;
10+
<!-- All paths in the file are interpreted as relative to the directory of the top-level
11+
package (e.g., the path to this file would be ".library/manifest.xml"), and allows
12+
only forward slashes as directory separators. -->
913
10-
&lt;!-- All paths in the file are interpreted as relative to the
11-
directory of the top-level
14+
<manifest version=*"1.0"*/>
1215
13-
package (e.g., the path to this file would be ".library/manifest.xml"),
14-
and allows
16+
<!-- The id attribute is the actual Modelica identifier of the library. The file attribute
17+
from SMA is no longer needed, as it will always be "package.mo" or "package.moc"
18+
(and the tool will need the logic of checking for both .mo and .moc anyway).
19+
The enabled attribute (optional, default value is true) indicates whether the library
20+
should be enabled/loaded by default. -->
1521
16-
only forward slashes as directory separators. --&gt;
22+
<library id=*"ExampleLib"* enabled=*"true"*>
1723
18-
&lt;manifest version=*"1.0"*/&gt;
24+
<!-- Official title of the library (optional) -->
25+
<title>Example Encrypted Library</title>
1926
20-
&lt;!-- The id attribute is the actual Modelica identifier of the
21-
library. The file attribute
27+
<!-- Description (optional) -->
28+
<description>
29+
Dummy library showing directory structure for an encrypted library (with empty files)
30+
</description>
2231
23-
from SMA is no longer needed, as it will always be "package.mo" or
24-
"package.moc"
32+
<!-- The version of the library. Version information is formatted according to the
33+
Modelica language specification. The build and date attributes are optional. -->
34+
<version number=*"1.0"* build=*"1"* date=*"2013-08-04"*/>
2535
26-
(and the tool will need the logic of checking for both .mo and .moc
27-
anyway).
28-
29-
The enabled attribute (optional, default value is true) indicates
30-
whether the library
31-
32-
should be enabled/loaded by default. --&gt;
33-
34-
&lt;library id=*"ExampleLib"* enabled=*"true"*&gt;
35-
36-
&lt;!-- Official title of the library (optional) --&gt;
37-
38-
&lt;title&gt;Example Encrypted Library&lt;/title&gt;
39-
40-
&lt;!-- Description (optional) --&gt;
41-
42-
&lt;description&gt;
43-
44-
Dummy library showing directory structure for an encrypted library (with
45-
empty files)
46-
47-
&lt;/description&gt;
48-
49-
&lt;!-- The version of the library. Version information is formatted
50-
according to the
51-
52-
Modelica language specification. The build and date attributes are
53-
optional. --&gt;
54-
55-
&lt;version number=*"1.0"* build=*"1"* date=*"2013-08-04"*/&gt;
56-
57-
&lt;!-- Version of the Modelica language that is used in this library.
58-
--&gt;
59-
60-
&lt;language version=*"3.2"* /&gt;
61-
62-
&lt;!-- Copyright notice (optional)--&gt;
63-
64-
&lt;copyright&gt;
36+
<!-- Version of the Modelica language that is used in this library. -->
37+
<language version=*"3.2"* />
6538
39+
<!-- Copyright notice (optional)-->
40+
<copyright>
6641
Copyright © 2014, Modelon AB.
42+
</copyright>
6743
68-
&lt;/copyright&gt;
69-
70-
&lt;!-- License information (optional) --&gt;
71-
72-
&lt;license&gt;
73-
44+
<!-- License information (optional) -->
45+
<license>
7446
Some license information.
47+
</license>
7548
76-
&lt;/license&gt;
77-
78-
&lt;!-- Encryption/license check information (only for proprietary
79-
libraries).
80-
81-
If this is present, then the library is encrypted. --&gt;
82-
83-
&lt;encryption&gt;
84-
85-
&lt;!-- Library vendor executable. May be repeated - one for each
86-
supported platform.
49+
<!-- Encryption/license check information (only for proprietary libraries).
50+
If this is present, then the library is encrypted. -->
51+
<encryption>
8752
53+
<!-- Library vendor executable. May be repeated - one for each supported platform.
8854
path: the path to the executable
89-
90-
platform: the OS/platform to use this executable on, must be unique
91-
among
92-
93-
executable nodes
94-
95-
licensing: if this executable handles licensing (optional, default is
96-
true)
55+
platform: the OS/platform to use this executable on, must be unique among executable nodes
56+
licensing: if this executable handles licensing (optional, default is true)
9757
9858
The executable shall be placed under the vendor-specific directory
59+
(i.e. .library/VENDORNAME/). The normal case is that licensing has the same
60+
value for each executable node, but it is allowed to have different values
61+
for different platforms. -->
9962
100-
(i.e. .library/VENDORNAME/). The normal case is that licensing has the
101-
same
102-
103-
value for each executable node, but it is allowed to have different
104-
values
105-
106-
for different platforms. --&gt;
107-
108-
&lt;executable path=*".library/Modelon/vendor.exe"* platform=*"win32"*
109-
licensing=*"true"* /&gt;
110-
111-
&lt;executable path=*".library/Modelon/vendor32"* platform=*"linux32"*
112-
licensing=*"true"* /&gt;
63+
<executable path=*".library/Modelon/vendor.exe"* platform=*"win32"* licensing=*"true"* />
11364
114-
&lt;executable path=*".library/Modelon/vendor64"* platform=*"linux64"*
115-
licensing=*"true"* /&gt;
65+
<executable path=*".library/Modelon/vendor32"* platform=*"linux32"* licensing=*"true"* />
11666
117-
&lt;/encryption&gt;
67+
<executable path=*".library/Modelon/vendor64"* platform=*"linux64"* licensing=*"true"* />
11868
119-
&lt;!-- Icon for the library (PNG format) (optional) --&gt;
69+
</encryption>
12070
121-
&lt;icon file=*"Resources/Images/el.png"* /&gt;
71+
<!-- Icon for the library (PNG format) (optional) -->
72+
<icon file=*"Resources/Images/el.png"* />
12273
123-
&lt;/library&gt;
74+
</library>
12475
125-
&lt;!-- Leaving out optional compatibility and dependencies in this
126-
example. --&gt;
76+
<!-- Leaving out optional compatibility and dependencies in this example. -->
12777
128-
&lt;/archive&gt;
78+
</archive>
79+
```

0 commit comments

Comments
 (0)