README.md
1# Dokuwiki STL Viewer plugin
2
3
4Embed STL render using Viewstl.com excellent library v1.13
5
6## Options
7
8Options are URL encoded a=1&b=2 etc
9
10- manual: Do not render automatically
11 - Example: ``manual=true`` to show a link that triggers the loading of the model
12- noop: Disable rendering
13 - Example: ``noop=true`` to show only a link of the .stl file
14- s: Size in pixel (defines height and width in one call)
15 - Example: ``s=400`` for a frame 400 x 400 pixels
16- h: Height in pixel
17 - Example: ``h=400`` for a height of 400 pixels
18- w: Width in pixel
19 - Example: ``w=400`` for a width of 400 pixels
20- color: Color of the model
21 - Example: ``color=#00ff00`` for a green model
22- bgcolor: Background color
23 - Example: ``color=#ffffff`` for a white background
24- display: Set model display/shading ("flat", "smooth" or "wireframe")
25 - Example: ``display=wireframe``
26
27Example for a complete syntax: ``{{my_model.stl?h=400&w=600&bgcolor=#cccccc&color=#eb984e&display=wireframe&noop=true|My model title}}``
28
29## Rendering examples
30
31
32
33## Changelog
34
35* **2025-03-20**
36 * model display options added (@Ragos81)
37* **2024-04-09**
38 * fix background color (@Ragos81)
39* **2022-09-07**
40 * update stlviewer to v1.13 (@KaiMartin)
41 * short download link (@Laserlicht)
42* **2022-01-25**
43 * Fix for subfolder path (@Juergen-aus-Zuendorf)
44* **2020-04-25**
45 * Initial release
46
){kind=link}