Hyplusite内容创作统一格式定义——分类描述(Taxonomy Description)与博文(Post),以及特殊PW群内容翻译等基本模板。持续更新规范!其他预定义样式与模板详见HyplusCSS!
Hyplus Snippets: github.com/hyperplasma/hyplus-snippets
1 重要子规范速查
本站自主制定了以下重要子规范,此处供日常翻阅修改之用:
- Hyplus翻译格式
- ……
博文型内容创作结构分级:站点、分类、博文系列、篇、章、节、子节、h6内容(暂定名)、部分、块、段、行、句、词元
页面型内容创作结构分级:站点、页面(父页面/子页面),若父页面为“特色资源”(hypress),则成为合法的博文系列页面
2 分类描述撰写规范
一级分类描述规范:
- 返回按钮:分类页面描述第1行为“返回上一级”链接:
<< Hyplus主页 - 可另设其他内容相关列表:子类一览、阅读须知……
子类描述规范:
- 返回按钮:子类页面描述第1行应为“返回上一级”链接:
<< {父类} - 可另设其他内容相关列表:便捷工具、阅读须知……
此外,对于有下属博文系列的分类,务必在描述中用无序列表组织各下属博文系列的HySnip短代码(形如hysnip id="20650"),详见后述。
3 博文撰写规范
博文基本规范:
- 标题:允许重复使用1级标题!还可以使用引言块(Blockquote)作为子标题,分隔内容更清晰!
- 关于标点:除纯英文文本可用英文括号(
( ))包裹外,一律使用中文括号(( ));中英混杂时优先使用中文标点。
- 关于标点:除纯英文文本可用英文括号(
- 空格:一般情况下,中英文单词之间无空格!
- 速删空格方法:
Ctrl + F搜索空格字符()
- 速删空格方法:
- 图片:少图多scripts,大体积图片请使用HyImg内嵌阅览器或HyGal综合画廊(Hyplus管理员限定),活用外链(注意绕过防盗链)!
- 锚点、脚注:活用锚点链接跳转,方式不限,最常用的是脚注(遵循Markdown语法)。
- 内容:自由发挥。挖坑请写明
WIP,不建议标注TODO(可能与某些代码示例冲突)。
4 博文系列归档格式
博文系列(Post Series)是专门用于链接同类博文的页面,相较于传统的WP分类目录更具可维护性、可扩展性、易用性和可测试性。一个博文系列页面的制作规范如下:
- 系列大标题:可随时更改,随便填,但字数尽量不超过7个汉字。
- 子类标题:使用
<h5>标签,数量不限。 - 内容列表:从各博文页面获取非弹窗式HySnip短代码(点击剪切板emoji按钮复制,内容形如
hysnip id="{博文ID}" mode="none"),用<h5>标题+无序列表进行二次分类。亦可自制精美样式。 - 务必设置父页面为“特色资源”页面。
对于各博文(Post),撰写时设置自定义字段:hy_series_id(系列博文页面ID,可为列表,用逗号分隔)、hy_series_button_label(博文侧边系列按钮群文字,需与ID列表一一对应,可选)。
在各二级分类的分类描述中,用无序列表组织各下属博文系列的HySnip短代码(形如hysnip id="20650")。
新建一篇博文的步骤:
- 找到某相应的博文系列页面(新建博文时一般仅指定1个博文系列)。
- 进入后台编辑界面(快捷键:
Alt+D),复制“内容信息”区块里的“文章ID”,随后选择侧边栏“文章”选项卡中“写文章”选项并在新标签页中打开(快捷键:Command+左键单击)。- 在博文自定义字段中设置
hy_series_id,随后进入正式撰写流程(略)。- 保存博文后,查看博文,点击剪切板emoji按钮复制非弹窗式HySnip短代码,返回博文系列页面后台编辑界面,粘贴至无序列表中适合的位置(可以自由排序)。
及时处理同步问题。
A Markdown编辑器
Hyplusite主要使用自研工具WP Githuber MD Hyplusified进行内容创作,所有博文采用Markdown格式存储!编辑时推荐禁用即时预览并使用2栏布局(暂不建议使用移动端创作),各栏中界面元素推荐摆放方式如下:
- 左栏:自定义字段、标签、分类目录、评论
- 右栏:发布、“Ultimate Member:内容限制”、特色图片
请活用以下快捷键(Command=Ctrl,Option=Alt):
| 快捷键 | 功能说明 |
|---|---|
Ctrl+A |
全选 |
Ctrl+F |
打开搜索框 |
Ctrl+G |
跳转到下一个搜索结果 |
Ctrl+Shift+G |
跳转到上一个搜索结果 |
Ctrl+Z |
撤销 |
Ctrl+Shift+Z |
恢复 |
Alt+S |
显示/隐藏文档导航(目录) |