Skip to content

Commit ab0e244

Browse files
pmaipmai
committed
Add initial empty LS-BUS guide
1 parent 4ffc46c commit ab0e244

10 files changed

+765
-6
lines changed

Diff for: ‎.github/workflows/build-guides.yml

+12-2
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,33 @@ jobs:
1616
- name: checkout
1717
uses: actions/checkout@v3
1818
- name: prepare
19-
run: mkdir build && mkdir build/fmi-guide && mkdir build/fmi-profiles
19+
run: mkdir build && mkdir build/fmi-guide && mkdir build/ls-bus-guide && mkdir build/fmi-profiles
2020
- name: build implementers guide
2121
uses: avattathil/asciidoctor-action@master
2222
with:
2323
program: "asciidoctor -D build/fmi-guide --backend=html5 --attribute=revnumber=${GITHUB_REF#refs/heads/}-$GITHUB_SHA --attribute=revdate=$(date +%F) fmi-guide/index.adoc"
24+
- name: build LS-BUS implementers guide
25+
uses: avattathil/asciidoctor-action@master
26+
with:
27+
program: "asciidoctor -D build/ls-bus-guide --backend=html5 --attribute=revnumber=${GITHUB_REF#refs/heads/}-$GITHUB_SHA --attribute=revdate=$(date +%F) ls-bus-guide/index.adoc"
2428
- name: build FMI profiles
2529
uses: avattathil/asciidoctor-action@master
2630
with:
2731
program: "asciidoctor -D build/fmi-profiles --backend=html5 --attribute=revnumber=${GITHUB_REF#refs/heads/}-$GITHUB_SHA --attribute=revdate=$(date +%F) fmi-profiles/index.adoc"
2832
- name: copy images
29-
run: tar cf - fmi-guide/images fmi-profiles/images | tar xfC - build
33+
run: tar cf - fmi-guide/images ls-bus-guide/images fmi-profiles/images | tar xfC - build
3034
- name: archive implementers guide
3135
uses: actions/upload-artifact@v3
3236
with:
3337
name: FMI-Guide
3438
path: build/fmi-guide/*
3539
if-no-files-found: error
40+
- name: archive LS-BUS implementers guide
41+
uses: actions/upload-artifact@v3
42+
with:
43+
name: LS-BUS-Guide
44+
path: build/ls-bus-guide/*
45+
if-no-files-found: error
3646
- name: archive FMI profiles
3747
uses: actions/upload-artifact@v3
3848
with:

Diff for: ‎README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
[![Build Specification](https://github.com/modelica/fmi-guides/actions/workflows/build-guides.yml/badge.svg)](https://github.com/modelica/fmi-guides/actions/workflows/build-guides.yml)
44

55
This repository contains a number of current prototype draft guides
6-
for the current [Functional Mock-up Interface][FMI] 2.0 and upcoming
7-
3.0 standard for the exchange of simulation models. Note that these
8-
drafts are being worked on actively, and thus are subject to change
9-
without notice.
6+
for the current [Functional Mock-up Interface][FMI] 3.0 standard for
7+
the exchange of simulation models, as well as upcoming layered
8+
standards on top of it. Note that these drafts are being worked on
9+
actively, and thus are subject to change without notice.
1010

1111
They are not normative, nor are they to be considered officially
1212
endorsed by the Modelica Association or other involved organisations
@@ -16,13 +16,21 @@ The [FMI 3.0 Implementer's Guide][guide] is currently maintained on
1616
[GitHub][githubguide] and is published [here][guide]. It is based on
1717
the [FMI][] standard.
1818

19+
The [FMI LS BUS Implementer's Guide][ls-bus-guide] is currently
20+
maintained on [GitHub][github-ls-bus-guide] and is published
21+
[here][ls-bus-guide]. It is based on the [FMI-LS-BUS][] layered
22+
standard for Network Communication.
23+
1924
The [FMI 2.0/3.0 Profiles][profile] are currently maintained on
2025
[GitHub][githubprofile] and is published [here][profile].
2126

2227
In future additional guides might be integrated into this repository.
2328

2429
[FMI]: https://fmi-standard.org/
30+
[FMI-LS-BUS]: https://github.com/modelica/fmi-ls-bus/
2531
[githubguide]: fmi-guide/index.adoc
2632
[guide]: https://modelica.github.io/fmi-guides/main/fmi-guide/
33+
[github-ls-bus-guide]: ls-bus-guide/index.adoc
34+
[ls-bus-guide]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/
2735
[githubprofile]: fmi-profiles/index.adoc
2836
[profile]: https://modelica.github.io/fmi-guides/main/fmi-profiles/

Diff for: ‎ls-bus-guide/0___preamble.adoc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
The FMI LS Bus Implementers' Guide is a free resource intended to give non-normative recommendations and guidance to implementers of the Functional Mock-up Interface layered standard Network Communication (FMI-LS-BUS).
2+
This document is continually revised based on implementer and user feedback and input.
3+
All of the content is to be considered non-normative and shall not be considered to supplant any normative statement in the FMI 3.0 standard, the FMI-LS-BUS layered standard, or any other standard or layered standard.
4+
https://github.com/modelica/fmi-guides/releases[Releases] and https://github.com/modelica/fmi-guides/issues[issues] can be found on https://github.com/modelica/fmi-guides[github.com/modelica/fmi-guides].
5+
6+
{empty} +
7+
{empty}
8+
9+
Copyright (C) 2021-2023 The Modelica Association Project FMI.
10+
11+
This document is licensed under the Attribution-ShareAlike 4.0 International license.
12+
The code is released under the 2-Clause BSD License.
13+
The licenses text can be found in the https://raw.githubusercontent.com/modelica/fmi-guides/main/LICENSE.txt[LICENSE.txt] file that accompanies this distribution.
14+
15+
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights.
16+
Modelica Association shall not be held responsible for identifying such patent rights.
17+
18+
{empty}

Diff for: ‎ls-bus-guide/1___introduction.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
== Introduction
2+
3+
TODO

Diff for: ‎ls-bus-guide/A___literature.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[bibliography]
2+
== References
3+
4+
- [[[RFC2119]]] Bradner, S.: **Key words for use in RFCs to Indicate Requirement Levels**. RFC 2119, March 1997. https://www.ietf.org/rfc/rfc2119.txt
5+
6+
- [[[SEMVER200]]] Preston-Werner, T.: **Semantic Versioning 2.0.0**. https://semver.org/spec/v2.0.0.html

Diff for: ‎ls-bus-guide/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# FMI LS BUS Implementers' Guide
2+
3+
[![Build Specification](https://github.com/modelica/fmi-guides/actions/workflows/build-guides.yml/badge.svg)](https://github.com/modelica/fmi-guides/actions/workflows/build-guides.yml)
4+
5+
This directory contains the current prototype draft Implementers'
6+
Guide for the upcoming [FMI-LS-BUS][FMI-LS-BUS] layered standard for
7+
the exchange of simulation models employing bus communication. Note
8+
that this draft is being worked on actively, and thus subject to change
9+
without notice.
10+
11+
It is not normative, nor is it to be considered officially endorsed
12+
by the Modelica Association prior to official adoption.
13+
14+
The [guide][] is currently maintained on [GitHub][github] and is
15+
published [here][guide]. It is based on the [FMI-LS-BUS][] layered
16+
standard.
17+
18+
[FMI-LS-BUS]: https://github.com/modelica/fmi-ls-bus/
19+
[github]: index.adoc
20+
[guide]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/

Diff for: ‎ls-bus-guide/docinfo.html

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<script>
2+
// hide / show the Table of Contents (TOC)
3+
function toggleTOC() {
4+
var toc = document.getElementById("toc");
5+
var body = document.getElementsByTagName("body")[0];
6+
7+
if (toc.style.display === "none") {
8+
toc.style.display = "block";
9+
body.classList.remove("toc-hidden");
10+
} else {
11+
toc.style.display = "none";
12+
body.classList.add("toc-hidden");
13+
}
14+
}
15+
16+
// toggle the TOC when "t" key is pressed
17+
document.addEventListener('keydown', (event) => {
18+
if (event.key == 't') {
19+
toggleTOC();
20+
}
21+
});
22+
</script>
23+
24+
<!-- Generate a nice TOC -->
25+
<script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
26+
<script src="https://code.jquery.com/ui/1.11.4/jquery-ui.min.js"></script>
27+
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
28+
<!-- We do not need the tocify CSS because the asciidoc CSS already provides most of what we neeed -->
29+
30+
<style>
31+
.tocify-header {
32+
font-style: italic;
33+
}
34+
35+
.tocify-subheader {
36+
font-style: normal;
37+
font-size: 90%;
38+
}
39+
40+
.tocify ul {
41+
margin: 0;
42+
}
43+
44+
.tocify-focus {
45+
color: #7a2518;
46+
background-color: rgba(0, 0, 0, 0.1);
47+
}
48+
49+
.tocify-focus > a {
50+
color: #7a2518;
51+
}
52+
</style>
53+
54+
<script type="text/javascript">
55+
$(function () {
56+
// Add a new container for the tocify toc into the existing toc so we can re-use its
57+
// styling
58+
$("#toc").append("<div id='generated-toc'></div>");
59+
$("#generated-toc").tocify({
60+
extendPage: true,
61+
context: "#content",
62+
highlightOnScroll: true,
63+
// don't hide the sections in the TOC
64+
showAndHide: false,
65+
hideEffect: "slideUp",
66+
// Use the IDs that asciidoc already provides so that TOC links and intra-document
67+
// links are the same. Anything else might confuse users when they create bookmarks.
68+
hashGenerator: function(text, element) {
69+
return $(element).attr("id");
70+
},
71+
// Smooth scrolling doesn't work properly if we use the asciidoc IDs
72+
smoothScroll: false,
73+
// Set to 'none' to use the tocify classes
74+
theme: "none",
75+
// Handle book (may contain h1) and article (only h2 deeper)
76+
selectors: $( "#content" ).has( "h1" ).size() > 0 ? "h1,h2,h3" : "h2,h3,h4",
77+
ignoreSelector: ".discrete"
78+
});
79+
80+
// Switch between static asciidoc toc and dynamic tocify toc based on browser size
81+
// This is set to match the media selectors in the asciidoc CSS
82+
// Without this, we keep the dynamic toc even if it is moved from the side to preamble
83+
// position which will cause odd scrolling behavior
84+
var handleTocOnResize = function() {
85+
if ($(document).width() < 768) {
86+
$("#generated-toc").hide();
87+
$(".sectlevel0").show();
88+
$(".sectlevel1").show();
89+
}
90+
else {
91+
$("#generated-toc").show();
92+
$(".sectlevel0").hide();
93+
$(".sectlevel1").hide();
94+
}
95+
}
96+
97+
$(window).resize(handleTocOnResize);
98+
handleTocOnResize();
99+
});
100+
</script>
101+
102+
<img style="display: block; margin: 2em auto; width: 30em;" src="images/FMI_logo_horizontal.svg" alt="FMI logo">

0 commit comments

Comments
 (0)