Skip to content

Commit 49a7789

Browse files
author
Levi Jamt
authored
Styling figure captions and kopl titles (#72)
* Styling figcaptions and kopl titles * no need for important * html template for figures
1 parent f95026e commit 49a7789

File tree

3 files changed

+40
-26
lines changed

3 files changed

+40
-26
lines changed

_includes/figure.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<figure>
2+
<a href="{{ include.img }}">
3+
<img src="{{ include.img }}">
4+
</a>
5+
<figcaption>
6+
<b>Figure {{ include.num }}:</b>
7+
{{ include.caption }}
8+
</figcaption>
9+
</figure>

_sass/overrides.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
//
2+
// Custom overrides from a user.
3+
//
4+
figcaption {
5+
text-align: center;
6+
font-size: .8rem;
7+
color: #959396;
8+
}

kopl.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@ nav_order: 7
1010
`Kopl` is a configurator to help set up and run a simulation. It can also be used to validate the model using the [MSMI validator](./model-interface-validator).
1111
`Kopl` is not an open source software but can be freely used without any restrictions.
1212

13-
<figure>
14-
<img src="/assets/img/Kopl.png">
15-
<figcaption>Kopl configurator </figcaption>
16-
</figure>
13+
{% include figure.html
14+
img="/assets/img/Kopl.png"
15+
num="1"
16+
caption="Kopl configurator"
17+
%}
1718

18-
# Short introduction video
19+
#### Short introduction video
1920

2021
<video src="/assets/videos/Kopl.mp4" width="640" height="400" controls preload></video>
2122

2223

23-
# How to get started
24+
## How to get started
2425

2526
* Get the appropriate version of `Kopl` [here](./downloads).
2627
* Unzip somewhere on disk and double click the `Kopl` executable
@@ -31,49 +32,45 @@ Here you have two options,either to create an empty configuration or point to an
3132
* Expand the newly created configuration and double click the setup. This opens up the diagram for connecting several FMUs together.
3233
* Use the palette on the right hand side to drag and drop components onto the diagram
3334

34-
# Adding a new FMU
35+
## Adding a new FMU
3536
* It is possible to drag an FMU from the file explorer onto the diagram or drag the FMU element from the Components menu in the Palette.
3637
* When an FMU block is added to the diagram, you can double click it to open the editor for it.
3738
* When creating a FMU block from the palette you need to point to the fmu on disk.
3839
* Press the "load variables" action to read the model description within the FMU. The relevant variables should then be shown in the definitions tab
3940
* It is now possible to make variables available as input or output. Press the plus button and select the wanted variable to use as input/output within the under the "Input" or "output" tabs.
4041

41-
# Connecting the FMUs
42+
## Connecting the FMUs
4243
* Once two or more FMUs are added to the diagram it is possible to add connections between the blocks.
4344
Just start dragging from an output or input slot and drop when hovering over the correct terminal.
4445

45-
# Variable groups (MSMI)
46+
## Variable groups (MSMI)
4647
* If you want to follow the MSMI standard, you can start creating variable groups in the definitions tab within the variable groups tab.
4748
* Click the green button or right click an empty space in the local navigator/tree widget
4849
* Created variable groups may then be choosen as input or output to the FMU
4950

50-
<figure>
51-
<img src="/assets/img/Kopl-variablegroups.png">
52-
<figcaption class="caption" >Definition of nested variable groups</figcaption>
53-
</figure>
51+
{% include figure.html
52+
img="/assets/img/Kopl-variablegroups.png"
53+
num="2"
54+
caption="Definition of nested variable groups"
55+
%}
5456

55-
# MSMI validation
57+
## MSMI validation
5658

5759
Right click the configuration and choose validate in the context menu to let the [MSMI validator](./model-interface-validator) validate the current setup
5860

59-
# Export
61+
## Export
6062

6163
Right click the configuration and choose export in the context menu, then choose between the different formats.
6264

63-
# Simulation
65+
## Simulation
6466

6567
Right click the configuration and choose "Simulation" in the context menu, or run simulation in the diagram.
6668
This will export the setup and use the CLI behind the scene. The CLI version can be switched (currently necessary on the Linux version) in the preferences.
6769
See main menu->Tools->Preferences->CoSim configuration.
6870
When the simulation is done you should be able to see the results in the navigator and basic ploting is available.
6971

70-
<figure>
71-
<img src="/assets/img/Kopl-results.png">
72-
<figcaption>Results after a simulation is done </figcaption>
73-
</figure>
74-
75-
76-
77-
78-
79-
72+
{% include figure.html
73+
img="/assets/img/Kopl-results.png"
74+
num="3"
75+
caption="Results after a simulation is done"
76+
%}

0 commit comments

Comments
 (0)