Skip to content

Commit

Permalink
Add module tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
ricktu288 committed Jun 3, 2024
1 parent fc24f13 commit 001d312
Show file tree
Hide file tree
Showing 25 changed files with 777 additions and 15 deletions.
4 changes: 2 additions & 2 deletions cn/modules/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

<div class="container">
<ul>
<li>本功能为实验性功能,用于建立模块化的物件组合,其中可包含自订参数与物件阵列</li>
<li>本功能为实验性功能,通过组合或特化本模拟器中现有的工具所建立的物件,来建立新的工具,以扩展本模拟器的功能</li>
<li>导入的模块将显示于工具->其他。欲将其加入到场景中,请选择并依照控制点顺序点击空白处(参见「规格」)。</li>
<li>导入的模块将直接嵌入于场景的资料中,所以当原作者更新时并不会自动更新。</li>
</ul>
Expand Down Expand Up @@ -210,7 +210,7 @@
</div>

<h2>客制化</h2>
<p>您可以直接在本网页程式中使用内建的 JSON 编辑器来客制化模块。变更将只会影响到该场景。参见<a href="https://github.com/ricktu288/ray-optics/discussions/145" target="_blank">此处</a>的教学。</p>
<p>您可以直接在本网页程式中使用内建的 JSON 编辑器来客制化模块。变更将只会影响到该场景。参见<a href="https://phydemo.app/ray-optics/cn/modules/tutorial" target="_blank">此处</a>的教学。</p>
<h2>贡献</h2>
<p>欢迎您贡献项目至以上的清单。请将项目加入到<a href="https://github.com/ricktu288/ray-optics/tree/master/modules" target="_blank">此资料夹</a>中并建立 pull request。如果您对 GitHub 不熟,也可直接将包含模块的档案传送至<a href="mailto:ray-optics@phydemo.app" target="_blank">ray-optics@phydemo.app</a></p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions cn/modules/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@

<div class="container">
<ul>
<li>本功能为实验性功能,用于建立模块化的物件组合,其中可包含自订参数与物件阵列</li>
<li>本功能为实验性功能,通过组合或特化本模拟器中现有的工具所建立的物件,来建立新的工具,以扩展本模拟器的功能</li>
<li>导入的模块将显示于工具->其他。欲将其加入到场景中,请选择并依照控制点顺序点击空白处(参见「规格」)。</li>
<li>导入的模块将直接嵌入于场景的资料中,所以当原作者更新时并不会自动更新。</li>
</ul>
{CATEGORIES}

<h2>客制化</h2>
<p>您可以直接在本网页程式中使用内建的 JSON 编辑器来客制化模块。变更将只会影响到该场景。参见<a href="https://github.com/ricktu288/ray-optics/discussions/145" target="_blank">此处</a>的教学。</p>
<p>您可以直接在本网页程式中使用内建的 JSON 编辑器来客制化模块。变更将只会影响到该场景。参见<a href="https://phydemo.app/ray-optics/cn/modules/tutorial" target="_blank">此处</a>的教学。</p>
<h2>贡献</h2>
<p>欢迎您贡献项目至以上的清单。请将项目加入到<a href="https://github.com/ricktu288/ray-optics/tree/master/modules" target="_blank">此资料夹</a>中并建立 pull request。如果您对 GitHub 不熟,也可直接将包含模块的档案传送至<a href="mailto:ray-optics@phydemo.app" target="_blank">ray-optics@phydemo.app</a></p>
</div>
Expand Down
235 changes: 235 additions & 0 deletions cn/modules/tutorial.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions modules/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

<div class="container">
<ul>
<li>This is an experimental feature of creating modularized combinations of objects with templates, which allow custom parameters and arrays of objects.</li>
<li>This is an experimental feature that extends the capability of this simulator by combining or specializing objects created by existing tools in this simulator to make new tools for the simulator.</li>
<li>Imported modules will appear in Tools -> Other. To add to your scene, please select and click the blank space according to the order of the control point sequence (see "Specification").</li>
<li>Imported modules are directly embedded in the data of the scene, so will not be automatically updated when the authors of the modules update them.</li>
</ul>
Expand Down Expand Up @@ -210,7 +210,7 @@
</div>

<h2>Customization</h2>
<p>You can customize the modules directly in the web app using the built-in JSON editor. The changes will only affect the current scene. See <a href="https://github.com/ricktu288/ray-optics/discussions/145" target="_blank">here</a> for the tutorial.</p>
<p>You can customize the modules directly in the web app using the built-in JSON editor. The changes will only affect the current scene. See <a href="https://phydemo.app/ray-optics/modules/tutorial" target="_blank">here</a> for the tutorial.</p>
<h2>Contribution</h2>
<p>Contributing to the list above is welcome. Please add items to <a href="https://github.com/ricktu288/ray-optics/tree/master/modules" target="_blank">this folder</a> and open a pull request, or send the file containing your module to <a href="mailto:ray-optics@phydemo.app" target="_blank">ray-optics@phydemo.app</a> if you are not familiar with GitHub.</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions modules/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@

<div class="container">
<ul>
<li>This is an experimental feature of creating modularized combinations of objects with templates, which allow custom parameters and arrays of objects.</li>
<li>This is an experimental feature that extends the capability of this simulator by combining or specializing objects created by existing tools in this simulator to make new tools for the simulator.</li>
<li>Imported modules will appear in Tools -> Other. To add to your scene, please select and click the blank space according to the order of the control point sequence (see "Specification").</li>
<li>Imported modules are directly embedded in the data of the scene, so will not be automatically updated when the authors of the modules update them.</li>
</ul>
{CATEGORIES}

<h2>Customization</h2>
<p>You can customize the modules directly in the web app using the built-in JSON editor. The changes will only affect the current scene. See <a href="https://github.com/ricktu288/ray-optics/discussions/145" target="_blank">here</a> for the tutorial.</p>
<p>You can customize the modules directly in the web app using the built-in JSON editor. The changes will only affect the current scene. See <a href="https://phydemo.app/ray-optics/modules/tutorial" target="_blank">here</a> for the tutorial.</p>
<h2>Contribution</h2>
<p>Contributing to the list above is welcome. Please add items to <a href="https://github.com/ricktu288/ray-optics/tree/master/modules" target="_blank">this folder</a> and open a pull request, or send the file containing your module to <a href="mailto:ray-optics@phydemo.app" target="_blank">ray-optics@phydemo.app</a> if you are not familiar with GitHub.</p>
</div>
Expand Down
Loading

0 comments on commit 001d312

Please sign in to comment.