Doni/ModelHandle
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add frequently asked questions page.

Browse Source
This commit is contained in:
kovacsv 2021-12-13 11:09:55 +01:00
parent c698117302
commit b333d9cadc
5 changed files with 154 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tools/build.py
View File

@ -76,7 +76,8 @@ def CreateDestinationDir (config, rootDir, websiteDir, version, testBuild):
'index.html',
'embed.html',
os.path.join ('info', 'index.html'),
os.path.join ('info', 'cookies.html')
os.path.join ('info', 'cookies.html'),
os.path.join ('info', 'faq.html')
]
for htmlFileName in htmlFileNames:
htmlFilePath = os.path.join (websiteDir, htmlFileName)

2
website/info/cookies.html
View File

@ -20,7 +20,7 @@
<body>
<div class="main">
<h1><a href=".">Online 3D Viewer Cookies Policy</a></h1>
<h1><a href="cookies.html">Online 3D Viewer Cookies Policy</a></h1>
<p>
Like most similar websites, <a href="https://3dviewer.net">Online 3D Viewer</a> (the "Website") uses cookies.

115
website/info/faq.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<meta name="viewport" content="width=device-width, user-scalable=no">
<link rel="icon" type="image/png" href="../assets/images/3dviewer_net_favicon.ico">
<title>Online 3D Viewer Frequently Asked Questions</title>
<link rel="stylesheet" type="text/css" href="../o3dv/css/icons.css">
<link rel="stylesheet" type="text/css" href="info.css">
<!-- meta start -->
<!-- meta end -->
<!-- analytics start -->
<!-- analytics end -->
<script type="text/javascript">
window.addEventListener ('load', function () {
let questions = document.getElementsByClassName ('question');
let answers = document.getElementsByClassName ('answer');
for (let questionIndex = 0; questionIndex < questions.length; questionIndex++) {
let question = questions[questionIndex];
let answer = answers[questionIndex];
question.addEventListener ('click', () => {
if (answer.style.display === 'block') {
answer.style.display = 'none';
} else {
answer.style.display = 'block';
}
});
}
});
</script>
</head>
<body>
<div class="main">
<h1><a href="faq.html">Online 3D Viewer Frequently Asked Questions</a></h1>
<p>
Here you can find the frequently asked questions for <a href="https://3dviewer.net">Online 3D Viewer</a>.
Click on a question to see the answer. If you can't find your answer here, feel free to
<a href="https://github.com/kovacsv/Online3DViewer/issues">create an issue on GitHub</a>.
</p>
<h2>Model Loading</h2>
<h3 class="question">No importable file found - what does that mean?</h3>
<div class="answer">
<p>
It means that none of your files are importable. Online 3D Viewer tries to detect importable files
by extension. Check if your format in the <a href="index.html#supported_file_formats">supported file formats list</a>, and make sure that you use the
proper extension.
</p>
</div>
<h3 class="question">Failed load file for import - what does that mean?</h3>
<div class="answer">
<p>
It means that an importable file format is detected, but the website failed to load the file. It usually
happens when you try to load a model from an external url.
</p>
<p>
To resolve this issue, check if your url works in a browser window.
<ul>
<li>
If it works, it means that your url is ok, but the website can't access it. Usually it's caused by a <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">CORS (Cross-Origin Resource Sharing)</a> policy violation.
It means that the server that hosts the model doesn't allow requests from a different origin. To resolve this issue, allow CORS requests on the server.
</li>
<li>
If it doesn't work, it means that your url is wrong. Fix the url.
</li>
</ul>
</p>
</div>
<h3 class="question">Failed to import model - what does that mean?</h3>
<div class="answer">
<p>
It means that an importable file is found, the import process is started, but failed for some reason.
If the error message doesn't help, <a href="https://github.com/kovacsv/Online3DViewer/issues">create an issue on GitHub</a>.
</p>
</div>
<h3 class="question">Why does my model works fine locally, but not from an url?</h3>
<div class="answer">
<p>
Usually it's caused by a <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">CORS (Cross-Origin Resource Sharing)</a> policy violation.
It means that the server that hosts the model doesn't allow requests from a different origin. To resolve this issue, allow CORS requests on the server.
</p>
</div>
<h2>Model Display</h2>
<h3 class="question">Why is my model completely gray?</h3>
<div class="answer">
<p>
Some file formats are coming with no material information (e.g. stl). These models will be visualized
with a default gray color. You can easily change this color in the settings panel (<i class="icon icon-settings"></i>) on the right.
</p>
<p>
Some file formats are coming in multiple files, and material information can be in a separate file
(e.g. obj files are usually working with mtl files). Check the files panel for any missing files (<i class="icon icon-missing_files"></i>), and if you
have the file, import it together with the main file.
</p>
</div>
</div>
</body>
</html>

21
website/info/index.html
View File

@ -8,6 +8,7 @@
<title>Online 3D Viewer Manual</title>
<link rel="stylesheet" type="text/css" href="../o3dv/css/icons.css">
<link rel="stylesheet" type="text/css" href="info.css">
<!-- meta start -->
@ -40,6 +41,7 @@
<li><a href="#sharing_and_embedding_models">Sharing and embedding models</a></li>
<li><a href="#settings_panel">Model and visualization settings</a></li>
<li><a href="#exporting_models">Exporting models</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#embed_selfhost">Self-hosted viewer</a></li>
<li><a href="#cookies_policy">Cookies policy</a></li>
</ol>
@ -212,7 +214,7 @@
There are two ways to load models from your computer:
<ol>
<li>
Use the open button on the toolbar. Here you can select all the relevant files.
Use the open button (<i class="icon icon-open"></i>) on the toolbar. Here you can select all the relevant files.
</li>
<li>
Drag and drop all the relevant files into the browser window.
@ -229,7 +231,7 @@
<h3 id="loading_models_server">Loading models hosted on a web server</h3>
<p>
You can load models by url with the open url button on the toolbar.
You can load models by url with the open url button (<i class="icon icon-open_url"></i>) on the toolbar.
Here you can list all of the model files. You should place every file in a separate line.
</p>
<p class="info">
@ -243,7 +245,7 @@
<p>
<ol>
<li>Commit models to GitHub with all the required files.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button in the toolbar.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button (<i class="icon icon-open_url"></i>) on the toolbar.</li>
<li>
Open the files on GitHub, copy the link of the file from the address bar, and paste it in the dialog. See the example below.
<div class="code">
@ -262,7 +264,7 @@
<p>
<ol>
<li>Upload models to DropBox with all the required files.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button in the toolbar.</li>
<li>Go to <a href="https://3dviewer.net">3dviewer.net</a>, and click on the open url button (<i class="icon icon-open_url"></i>) on the toolbar.</li>
<li>
Get the sharing link from DropBox for all of the files, and paste it in the dialog. See the example below.
<div class="code">
@ -284,12 +286,12 @@
<h2 id="sharing_and_embedding_models">Sharing and embedding models</h2>
<p>
If your models are hosted on a web server, you can share the link with others, or you can generate embedding code to integrate the viewer in your website.
To get the sharing link or the embedding code, click on the share model button in the toolbar.
To get the sharing link or the embedding code, click on the share model button (<i class="icon icon-share"></i>) on the toolbar.
</p>
<h2 id="settings_panel">Model and visualization settings</h2>
<p>
You can access model and visualization settings by clicking on the settings icon on the toolbar.
You can access model and visualization settings by opening the settings panel (<i class="icon icon-settings"></i>) on the right.
</p>
<p>
<ul>
@ -313,9 +315,14 @@
</ul>
</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>
If you have issues, you can check the <a href="faq.html">Frequently Asked Questions</a> page, or you can <a href="https://github.com/kovacsv/Online3DViewer/issues">create an issue on GitHub</a>.
</p>
<h2 id="exporting_models">Exporting models</h2>
<p>
You can export your model in several file formats. To achieve this, click on the export button in the toolbar.
You can export your model in several file formats. To achieve this, click on the export button (<i class="icon icon-export"></i>) on the toolbar.
After that, select the format you would like to export to, and download the resulting files one by one.
</p>

33
website/info/info.css
View File

@ -37,16 +37,13 @@ div.inline
line-height: inherit;
}
i
i.icon
{
width: 18px;
height: 18px;
display: block;
}
i[class^="icon-"]:before, i[class*=" icon-"]:before {
height:18px;
margin-bottom: -4px;
font-size: 16px;
margin: 0px 2px;
display: inline-block;
position: relative;
bottom: -4px;
}
h1
@ -103,13 +100,14 @@ p.info
ol, ul
{
padding: 0px 25px;
padding: 0px 0px 0px 25px;
}
li
{
margin: 10px 0px;
text-align: justify;
line-height: 25px;
margin: 10px 0px;
}
table
@ -162,6 +160,19 @@ div.code
white-space: nowrap;
}
h3.question
{
cursor: pointer;
margin-top: 15px;
margin-bottom: 20px;
}
div.answer
{
display: none;
margin-bottom: 30px;
}
@media only screen and (max-width: 1000px)
{