格式手册
在文章开始之前，JPh Wiki 项目组全体成员十分欢迎您为本项目贡献页面。正因为有了上百位像您一样的人，才有了 JPh Wiki 的今天明天和~~昨天~~！
本页面将列出在 JPh Wiki 编写过程时推荐使用的格式规范与编辑方针。请您在撰稿或者修正 Wiki 页面以前，仔细阅读以下内容，以帮助您完成更高质量的内容。
如果您已迫不及待，想要快速上手，建议先阅读这篇文章。
贡献文档要求
当你打算贡献某部分的内容时，你应该尽量熟悉以下三部分：
- 文档存储的格式
- 文档的合理性
- remark-lint 和 \(\rm{\LaTeX}\) 公式的格式要求
文档引用与存储的格式
-
文件名请务必都小写，以
-分割。 例如：file-name.md。 -
请务必确保文档中引用的 外链 图片已经全部转存到了 本库内 对应的
assets文件夹中（防止触发某些网站的防盗链），建议处理成MD 文档路径 + 图片编号的形式（可参考已有文档中图片的处理方式）。例如：本篇文档的文件名称为 qwerty，归类是 hhh，则文档中引用的第一张图片的名字为assets/hhh/qwerty/1_1.png。 -
推荐使用 SVG 格式的图片，以获取较好的清晰度和缩放效果。
-
动图如果无法或者不会制作 SVG 格式的，则推荐使用 APNG 格式[^apng]的文件。Windows 用户可使用 ScreenToGif 录制，Linux 用户可使用 Peek 录制，注意需要在设置里调整为录制 APNG。其他情况则推荐先制作为 MP4 等视频文件再转换为 APNG，如果使用 ffmpeg 则可以使用
ffmpeg -i filename.mp4 -f apng filename.apng -plays 0转换。 -
同时具有源文件和导出图像的图片（例如 JPG 文件与 PSD 文件或者 SVG 图像与 TikZ TeX 源代码），建议将源文件以与图片相同的文件名保存于同一目录下。
-
请确保您的文档中的引用链接的稳定性。不推荐 引用 自建 服务中的资源。
-
站内链接请去掉网站域名，并且使用相对路径链接对应
.md文件。例如，在本页面（intro/format）中链接杂项简介（misc），应使用[杂项简介](../misc/index.md)。可以在链接中添加 hash 来链接到某一节，例如[Pull Request 信息格式规范](../htc.md#pull-request-信息格式规范)，hash 的值可以通过位于每个标题右侧的按钮或者位于网页右侧的目录中的链接得到。
文档的合理性
合理性，指所编写的 内容 必须具有如下的特性：
- 由浅入深，内容的难度应该具有渐进性。
-
逻辑性。
-
对于计算方法或物理概念类内容的撰写应该尽量包含以下的内容：
- 方法推导（也可以叫原理）：说明该内容对应的原理；
- 例子：给出 1 - 2 个典型的例子；
- 题目：在该标题下，只需要给出题目内容和题目解答。
示例页面：FSA
-
对于实验类内容的撰写应该尽量包含以下的内容：
- 简介：阐明该实验的背景与目标。
- 实验方式：详细给出实验的过程。
示例页面：暂时缺失。
-
除现有内容质量较低的情况外，建议尽量从 补充 的角度来做贡献，而非采取直接覆盖的方式。如果拿不准主意，可以联系管理员或者有经验的用户。