Skip to content

Commit b7d51f5

Browse files
author
MFC Action
committed
Docs @ 0131901
1 parent ed81528 commit b7d51f5

29 files changed

+451
-330
lines changed

documentation/cookie.js

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*!
2+
Cookie helper functions
3+
Copyright (c) 2023 Dimitri van Heesch
4+
Released under MIT license.
5+
*/
6+
let Cookie = {
7+
cookie_namespace: 'doxygen_',
8+
9+
readSetting(cookie,defVal) {
10+
if (window.chrome) {
11+
const val = localStorage.getItem(this.cookie_namespace+cookie) ||
12+
sessionStorage.getItem(this.cookie_namespace+cookie);
13+
if (val) return val;
14+
} else {
15+
let myCookie = this.cookie_namespace+cookie+"=";
16+
if (document.cookie) {
17+
const index = document.cookie.indexOf(myCookie);
18+
if (index != -1) {
19+
const valStart = index + myCookie.length;
20+
let valEnd = document.cookie.indexOf(";", valStart);
21+
if (valEnd == -1) {
22+
valEnd = document.cookie.length;
23+
}
24+
return document.cookie.substring(valStart, valEnd);
25+
}
26+
}
27+
}
28+
return defVal;
29+
},
30+
31+
writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
32+
if (window.chrome) {
33+
if (days==0) {
34+
sessionStorage.setItem(this.cookie_namespace+cookie,val);
35+
} else {
36+
localStorage.setItem(this.cookie_namespace+cookie,val);
37+
}
38+
} else {
39+
let date = new Date();
40+
date.setTime(date.getTime()+(days*24*60*60*1000));
41+
const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
42+
document.cookie = this.cookie_namespace + cookie + "=" +
43+
val + "; SameSite=Lax;" + expiration + "path=/";
44+
}
45+
},
46+
47+
eraseSetting(cookie) {
48+
if (window.chrome) {
49+
if (localStorage.getItem(this.cookie_namespace+cookie)) {
50+
localStorage.removeItem(this.cookie_namespace+cookie);
51+
} else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
52+
sessionStorage.removeItem(this.cookie_namespace+cookie);
53+
}
54+
} else {
55+
this.writeSetting(cookie,'',-1);
56+
}
57+
},
58+
}

documentation/index.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@
123123
<div class="textblock"><p><a class="anchor" id="md_readme"></a> </p>
124124
<h1><a class="anchor" id="autotoc_md76"></a>
125125
User Documentation</h1>
126-
<p>- <a class="el" href="md_getting-started.html">Getting Started</a></p><ul>
126+
<ul>
127+
<li><a class="el" href="md_getting-started.html">Getting Started</a></li>
127128
<li><a class="el" href="md_testing.html">Testing MFC</a></li>
128129
<li><a class="el" href="md_case.html">Case Files</a></li>
129130
<li><a class="el" href="md_examples.html">Example Cases</a></li>
@@ -136,7 +137,11 @@ <h1><a class="anchor" id="autotoc_md76"></a>
136137
<h1><a class="anchor" id="autotoc_md77"></a>
137138
Code/API Documentation</h1>
138139
<p>MFC's three codes have their own documentation:</p>
139-
<p>- <a href="../pre_process/">Pre-Process</a> - <a href="../simulation/">Simulation</a> - <a href="../post_process/">Post-Process</a> </p>
140+
<ul>
141+
<li><a href="../pre_process/">Pre-Process</a></li>
142+
<li><a href="../simulation/">Simulation</a></li>
143+
<li><a href="../post_process/">Post-Process</a> </li>
144+
</ul>
140145
</div></div><!-- PageDoc -->
141146
</div><!-- contents -->
142147
</div><!-- doc-content -->

documentation/jquery.js

Lines changed: 1 addition & 58 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

documentation/md_CODE__OF__CONDUCT.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,21 @@ <h1><a class="anchor" id="autotoc_md24"></a>
128128
<h1><a class="anchor" id="autotoc_md25"></a>
129129
Our Standards</h1>
130130
<p>Examples of behavior that contributes to a positive environment for our community include:</p>
131-
<p>* Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community</p>
131+
<ul>
132+
<li>Demonstrating empathy and kindness toward other people</li>
133+
<li>Being respectful of differing opinions, viewpoints, and experiences</li>
134+
<li>Giving and gracefully accepting constructive feedback</li>
135+
<li>Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience</li>
136+
<li>Focusing on what is best not just for us as individuals, but for the overall community</li>
137+
</ul>
132138
<p>Examples of unacceptable behavior include:</p>
133-
<p>* The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting</p>
139+
<ul>
140+
<li>The use of sexualized language or imagery, and sexual attention or advances of any kind</li>
141+
<li>Trolling, insulting or derogatory comments, and personal or political attacks</li>
142+
<li>Public or private harassment</li>
143+
<li>Publishing others' private information, such as a physical or email address, without their explicit permission</li>
144+
<li>Other conduct which could reasonably be considered inappropriate in a professional setting</li>
145+
</ul>
134146
<h1><a class="anchor" id="autotoc_md26"></a>
135147
Enforcement Responsibilities</h1>
136148
<p>Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.</p>

0 commit comments

Comments
 (0)