Update documentation style.

This commit is contained in:
kovacsv 2023-01-07 09:35:34 +01:00
parent bd10b196d9
commit f70df72e1f
18 changed files with 213 additions and 77 deletions

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - Camera</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>Camera</h1>
<div class="description">Camera object.</div>
<h2>Constructor</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - CameraMode</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>CameraMode</h1>
<div class="description">Camera projection mode.</div>
<h2>Values</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - EdgeSettings</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>EdgeSettings</h1>
<div class="description">Edge settings object.</div>
<h2>Constructor</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - EmbeddedViewer</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>EmbeddedViewer</h1>
<div class="description">This is the main object for embedding the viewer on a website.</div>
<h2>Constructor</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - EnvironmentSettings</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>EnvironmentSettings</h1>
<div class="description">Environment settings object.</div>
<h2>Constructor</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - FileSource</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>FileSource</h1>
<div class="description">File source identifier for import.</div>
<h2>Values</h2>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - Init3DViewerElement</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>Init3DViewerElement</h1>
<div class="method_container">
<div id="Init3DViewerElement" class="method_signature">Init3DViewerElement (parentElement, modelUrls, parameters)</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - Init3DViewerElements</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>Init3DViewerElements</h1>
<div class="method_container">
<div id="Init3DViewerElements" class="method_signature">Init3DViewerElements (onReady)</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - InputFile</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>InputFile</h1>
<div class="description">File representation class for importers.</div>
<h2>Constructor</h2>
@ -72,7 +72,7 @@
<span class="type parameter_type">*</span>
</div>
<div class="parameter_main">
<div class="parameter_description">If the file source is url, this must be the url string. If the file source is file, this must be a File object.</div>
<div class="parameter_description">If the file source is url, this must be the url string. If the file source is file, this must be a <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> object.</div>
</div>
</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - RGBAColor</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,9 +46,9 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>RGBAColor</h1>
<div class="description">Class to store an RGBA color. Components are integers in the range of 0..255.</div>
<div class="description">RGBA color object. Components are integers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="RGBAColor" class="method_signature">new RGBAColor (r, g, b, a)</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - RGBColor</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,9 +46,9 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>RGBColor</h1>
<div class="description">Class to store an RGB color. Components are integers in the range of 0..255.</div>
<div class="description">RGB color object. Components are integers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="RGBColor" class="method_signature">new RGBColor (r, g, b)</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - SetExternalLibLocation</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<h1>SetExternalLibLocation</h1>
<div class="method_container">
<div id="SetExternalLibLocation" class="method_signature">SetExternalLibLocation (newExternalLibLocation)</div>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - Home</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,8 +16,8 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
<div class="navigation_section">
<div class="navigation_title">Pages</div>
<div id="nav-Home" class="navigation_item"><a href="index.html" target="_self">Home</a></div>
@ -46,7 +46,7 @@
</div>
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
<div class="page">
<h1>Online 3D Viewer Engine</h1>

View File

@ -8,7 +8,7 @@
<title>Online 3D Viewer - $$$TITLE$$$</title>
<link rel="stylesheet" href="static/highlightjs/styles/github-dark-dimmed.min.css"/>
<link rel="stylesheet" href="static/highlightjs/styles/github.min.css"/>
<script src="static/highlightjs/highlight.min.js"></script>
<link rel="stylesheet" type="text/css" href="static/style.css"/>
@ -16,11 +16,11 @@
</head>
<body>
<div class="navigation_toggle" id="navigation_toggle"></div>
<div class="navigation thin_scrollbar" id="navigation">
<div id="navigation_toggle" class="navigation_toggle"><img id="navigation_icon" src="static/menu.svg"/></div>
<div id="navigation" class="navigation thin_scrollbar">
$$$NAVIGATION$$$
</div>
<div class="main thin_scrollbar" id="main">
<div id="main" class="main">
$$$MAIN$$$
</div>
<script type="text/javascript">Init ('$$$TITLE$$$')</script>

48
docs/static/close.svg vendored Normal file
View File

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
viewBox="0 0 18 18"
xml:space="preserve"
version="1.1"
id="svg4"
sodipodi:docname="close.svg"
inkscape:version="1.2.1 (9c6d41e410, 2022-07-14)"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"><defs
id="defs8" /><sodipodi:namedview
id="namedview6"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
showgrid="true"
inkscape:zoom="30.60201"
inkscape:cx="8.4798351"
inkscape:cy="8.3981412"
inkscape:window-width="1920"
inkscape:window-height="1009"
inkscape:window-x="-8"
inkscape:window-y="-8"
inkscape:window-maximized="1"
inkscape:current-layer="svg4"
inkscape:showpageshadow="2"
inkscape:deskcolor="#d1d1d1"><inkscape:grid
type="xygrid"
id="grid821" /></sodipodi:namedview><rect
style="fill:#263238;fill-opacity:1;stroke:none;stroke-width:1.12793;stroke-dasharray:none"
id="rect1003"
width="14.00018"
height="2.0000257"
x="5.5962071"
y="-0.99995375"
transform="matrix(0.70711587,0.70709769,-0.70711587,0.70709769,0,0)" /><rect
style="fill:#263238;fill-opacity:1;stroke:none;stroke-width:1.12792;stroke-dasharray:none"
id="rect2364"
width="14.00018"
height="2.0000257"
x="-7.0000305"
y="11.596286"
transform="matrix(-0.70711587,0.70709769,0.70711587,0.70709769,0,0)" /></svg>

After

Width:  |  Height:  |  Size: 1.7 KiB

52
docs/static/menu.svg vendored Normal file
View File

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
viewBox="0 0 18 18"
xml:space="preserve"
version="1.1"
id="svg4"
sodipodi:docname="menu.svg"
inkscape:version="1.2.1 (9c6d41e410, 2022-07-14)"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"><defs
id="defs8" /><sodipodi:namedview
id="namedview6"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
showgrid="true"
inkscape:zoom="30.60201"
inkscape:cx="8.4798351"
inkscape:cy="8.3981412"
inkscape:window-width="1920"
inkscape:window-height="1009"
inkscape:window-x="-8"
inkscape:window-y="-8"
inkscape:window-maximized="1"
inkscape:current-layer="svg4"
inkscape:showpageshadow="2"
inkscape:deskcolor="#d1d1d1"><inkscape:grid
type="xygrid"
id="grid821" /></sodipodi:namedview><rect
style="fill:#263238;fill-opacity:1;stroke:none;stroke-width:1.12791;stroke-dasharray:none"
id="rect1003"
width="14"
height="2"
x="2"
y="3" /><rect
style="fill:#263238;fill-opacity:1;stroke:none;stroke-width:1.1279;stroke-dasharray:none"
id="rect1003-8"
width="14"
height="2"
x="2"
y="8" /><rect
style="fill:#263238;fill-opacity:1;stroke:none;stroke-width:1.1279;stroke-dasharray:none"
id="rect1003-89"
width="14"
height="2"
x="2"
y="13" /></svg>

After

Width:  |  Height:  |  Size: 1.6 KiB

13
docs/static/script.js vendored
View File

@ -12,8 +12,8 @@ function Resize ()
navToggleDiv.style.display = 'block';
navDiv.style.display = 'none';
} else {
navDiv.style.width = '300px';
mainDiv.style.marginLeft = '300px';
navDiv.style.width = '250px';
mainDiv.style.marginLeft = '250px';
navToggleDiv.style.display = 'none';
navDiv.style.display = 'block';
@ -24,10 +24,10 @@ function Init (menuName)
{
Resize ();
let menuItem = document.getElementById ('nav-' + menuName);
if (menuItem === null) {
return;
if (menuItem !== null) {
menuItem.classList.add ('selected');
menuItem.scrollIntoView ({ block : 'center' });
}
menuItem.scrollIntoView ({ block : 'center' });
hljs.highlightAll ();
}
@ -38,12 +38,15 @@ window.addEventListener ('load', () => {
})
let navToggleDiv = document.getElementById ('navigation_toggle');
let navIconDiv = document.getElementById ('navigation_icon');
let navDiv = document.getElementById ('navigation');
navToggleDiv.addEventListener ('click', () => {
if (navDiv.style.display === 'none') {
navDiv.style.display = 'block';
navIconDiv.src = 'static/close.svg';
} else {
navDiv.style.display = 'none';
navIconDiv.src = 'static/menu.svg';
}
});
});

59
docs/static/style.css vendored
View File

@ -96,31 +96,39 @@ li
.navigation
{
background: #ffffff;
width: 300px;
width: 250px;
height: 100%;
padding: 20px;
position: absolute;
top: 0px;
left: 0px;
box-sizing: border-box;
border-right: 1px solid #dddddd;
overflow: auto;
z-index: 900;
}
.navigation_toggle
{
font-size: 40px;
text-align: center;
margin: 12px;
background: #dddddd;
width: 30px;
height: 30px;
padding: 10px;
position: fixed;
top: 0px;
right: 0px;
bottom: 20px;
right: 20px;
display: none;
user-select: none;
border-radius: 50px;
cursor: pointer;
z-index: 1000;
}
.navigation_toggle img
{
width: 30px;
height: 30px;
}
.navigation_section
{
margin-bottom: 20px;
@ -133,13 +141,18 @@ li
.navigation_item
{
margin-bottom: 5px;
padding: 5px 10px;
}
.navigation_item.selected
{
font-weight: bold;
}
.main
{
height: 100%;
padding: 20px;
padding: 20px 30px;
margin-left: 300px;
box-sizing: border-box;
overflow: auto;
@ -152,11 +165,12 @@ li
.method_signature
{
background: #c9e5f8;
background: #eeeeee;
font-size: 18px;
margin: 10px 0px;
padding: 10px;
border-radius: 5px;
padding: 10px 10px;
border-radius: 0px 5px 5px 0px;
border-left: 4px solid #bbbbbb;
}
.method_description
@ -166,6 +180,7 @@ li
.method_title
{
font-size: 16px;
font-weight: bold;
margin-top: 15px;
margin-bottom: 10px;
@ -226,5 +241,23 @@ code.inline
.hljs
{
border-radius: 5px;
background: #f0f0f0;
border-radius: 0px 5px 5px 0px;
border-left: 4px solid #c0c0c0;
}
@media only screen and (max-width: 600px)
{
.navigation
{
border-right: 0px;
}
.main
{
padding: 10px;
}
}