WDTP(山湖路)示例及语法详解

关键词: WDTP, 山湖路, 示例, Markdown, 扩展标记, 解析与渲染

本页面详解并展示WDTP(山湖路)所支持和定义的文本标记语法,以及软件自带主题所渲染的默认效果。

本文目录

  · 正文
    · 段落
  · 标题
  · 二级标题
    · 三级标题
  · 斜体、加粗与粗斜
  · 删除线与下划线
  · 页面分割线
  · 文本背景高亮
  · 代码标记
    · 行内代码
    · 代码块
  · 居中和右对齐
  · 增大行间距
  · 强制缩进与反缩进
  · 无序列表与有序列表
    · 无序列表
    · 有序列表
  · 图注和表注
  · 插入多媒体文件
    · 图片与图注
    · 插入音频
    · 声音记录/录音
    · 插入视频
  · 各类链接
    · 文字型超链接
    · 网址型超链接
    · 项目内部文档或目录的链接
    · 图片式链接
    · 锚链接
  · 智能粘贴
  · 尾注与批注
    · 尾注
    · 批注
  · 目录
  · 表格与表注
    · 单元格对齐
    · 表格的样式
    · 单元格的自动计算
  · 引用
  · 数学公式
    · 简单的数学公式
    · 复杂的数学公式
  · 缩略语
  · 图文混排
  · 字体、文字大小与颜色
  · 跨文档扩展标记
    · 整站索引
    · 最新文章
    · 最新修改
    · 精华文章
    · 随机推荐
    · 发布记录
    · 更新记录
  · 自定义index页
  · 注释
  · 返回顶部
  · 标识符
  · 标点符号的自动匹配
  · 智能提示与自动补全
  · 其它
  · 扩展阅读

正文


您现在看到的这段话为普通的段落,什么标记都不需要。普通正文的段落首字符按中文文档的排版习惯,自动缩进。

段落

两个段落之间可用一个空行隔开。这种格式,下一个段落的首字符缩进。两个段落的行间距也稍大一些,方便阅读。
如两个段落之间无空行,则WDTP(山湖路)将这种格式视为“软回车”,首字符不缩进,段落之间的行间距与普通的行间距一致。比如本段。

标题


显示效果:本文标题为一级标题(自动居中)。以下为二~六级标题的默认效果:

二级标题


三级标题

四级标题

五级标题
六级标题

:WDTP允许用户使用中文#号作为标题的文本标记,使用规则与英文#号一致。

斜体、加粗与粗斜


删除线与下划线


WDTP(山湖路)不兼容传统的Markdown删除线标记(该标记定义为文本背景高亮,详情见下)。要实现常规的删除线,可使用更易记的html语法:

同理,下划线也可使用html语法来实现:

页面分割线


单独一行至少三个小写的减号“-”。显示效果:


文本背景高亮


两个波浪号“~”包裹要实现该效果的文字。快捷键:Ctrl + U

代码标记


行内代码

一个小撇号“`”包裹要实现该效果的文字。快捷键:Ctrl + L

代码块

三个小撇号“`”包裹要实现该效果的代码块。快捷键:Ctrl + K。WDTP(山湖路)支持传统的Markdown给出语言名称的标记方式(软件默认自动检测代码语言并选择最佳的高亮方案。因此,代码块标记中指定语言名称与否均可)。显示效果:


 /** constructor of this class.
     these code only for demonstrate */
 EditAndPreview::EditAndPreview (MainComp* mainComp_)
      : mainComp (mainComp_)
 {
     addAndMakeVisible (webView = new WebBrowserComp (this));
     webView->setWantsKeyboardFocus (false);

     // stretched layout, arg: index, min-width, max-width,default x%
     layoutManager.setItemLayout (0, -0.5, -1.0, -0.72);  // editor
     layoutManager.setItemLayout (1, 2, 2, 2);            // layoutBar
     layoutManager.setItemLayout (2, 2, -0.5, -0.28);     // setupPanel

     addAndMakeVisible (editor = new EditorForMd (this));
     addAndMakeVisible (setupPanel = new SetupPanel (this));
     editor->setFont (20.f);
     // ...
 }

注意

居中和右对齐


需要居中的文字

需要靠右的文字

增大行间距


强制缩进与反缩进


无序列表与有序列表


无序列表

无序列表显示效果支持嵌套):

有序列表

  1. 一级有序列表。本段以“+ ”(小写加号)顶格开头,后接一个空格,然后是列表内容(使用加号代表“序号递增”的意思)。显示效果见本段。
    1. 二级有序列表。本段以四个空格开头,后接“+”和空格,然后是列表内容。显示效果见本段。
    2. 注:无论平级与否,有序列表的段落之间不可留空行。

有序列表显示效果同样支持嵌套

  1. 坚果
    1. 核桃
    2. 松籽
    3. 开心果
  2. 薯类
    1. 南瓜
    2. 红薯
  3. 谷类
  4. 豆类

注:WDTP(山湖路)不支持有序列表与无序列表的混合嵌套(看起来实在蛋疼)。

图注和表注


单独一行,语法格式:^^ 图表说明。也可右键菜单插入,快捷键:Ctrl + P。显示效果:

图表说明

插入多媒体文件


WDTP可设置并直接调用外部编辑程序对文档内插入的图像及音频数据进行编辑处理。处理后无需任何额外操作,直接预览即可看到(听到)处理后的实际效果。

图片与图注

语法格式:![图片标题](图片地址),简化格式:![](图片地址)。 不建议手工输入显示图片的格式标记,可使用三种办法来完成:编辑器右键菜单-插入;操作系统中的图片文件直接拖到编辑器中;快捷键Ctrl + M。可一次性插入多个所选的图片,所插入的本机图片自动导入项目中,每一幅都给出图注标记。手工输入标记,如图片已经存在于本项目中,请使用相对路径。

实际效果

独晓 - 摄影:SwingCoder(2004年6月

插入音频

语法格式:~[](MP3音频文件的地址)。 不建议手工输入该标记,可使用三种办法来完成:编辑器右键菜单-插入;操作系统中的音频文件直接拖到编辑器中;快捷键Ctrl + M。可一次性插入多个所选的音频,所插入的本机音频文件自动导入项目中,每一个都给出注记。手工输入标记,音频文件请使用相对路径,而且请确保音频文件位于项目的某个media文件夹内。

实际效果

电吉他即兴SOLO片段 - 编曲、演奏、录音、混缩:SwingCoder (2002年11月

声音记录/录音

WDTP(山湖路)不仅可以插入本机已有或远程音频文件,更可以在内容创作/写作时直接开启录音功能,进行声音记录。录音完成后,软件将自动插入所录制并压缩转换后的音频数据。

录音功能尤其适合于以下群体:不擅长或不习惯文字表达的人,记者、演员、各类主持人、音乐家、演奏家,记录并真实再现访谈或对话,聆听讲座和演讲时做全程记录或分段记录……等等。WDTP的录音功能将是这批人最得力的工具。

插入视频

语法格式:@[](视频文件的相对路径或绝对路径 = 680)

不建议手工输入该标记,可使用三种办法来完成:编辑器右键菜单-插入;操作系统中的视频文件直接拖到编辑器中;快捷键Ctrl + M。可一次性插入多个所选的视频,所插入的本机视频文件自动导入项目中,每一个都给出注记。手工输入标记,视频文件请使用相对路径,而且请确保该文件位于项目的某个media文件夹内。

实际效果

Yesterday Once More 民谣吉他独奏
曲作者:Richard Carpenter
记谱、改编、演奏、静态素材拍摄、音像录制、后期处理:SwingCoder
摄制助理、灯光:Amy 友情客串:Alex

WDTP可一次性插入多个MP4视频文件,还可直接将操作系统中的MP4视频文件拖入编辑器中。软件将自动导入并插入这些视频的格式标记(默认宽度为680,可修改为任意值)。

各类链接


文字型超链接

注1:默认情况下,点击渲染页的文字型链接后在浏览器的当前页加载。如需在新窗口(新标签页)中打开该链接,则在该链接地址的最后添加空格和一个小写的减号“ -”。示例:

注2:如网址中包含英文右小括号“)”等“特殊字符”,可使用小写引号将网址引起来(否则解析时会提前截断网址,导致链接文本显示不正确,解析后的网址也不正确等问题)。示例:

网址型超链接

可直接输入URL网址,或浏览器中复制网址后,编辑器右键菜单“粘贴”。注意,网址首尾必须各留一个空格。如果首尾不留空格,则该网址视为普通的正文内容,而非可点击的网址链接。实际效果: http://underwaySoft.com

项目内部文档或目录的链接

要插入项目内某个文档的链接,文件树面板中鼠标右键单击该文档,弹出的菜单中选择“获取路径”,而后回到正在编辑的文档,Ctrl + V或编辑器右键菜单:插入-粘贴内部链接。实际效果:山湖路-主要更新记录

图片式链接

先插入一个文字型链接,而后将此链接所显示的文本(中括号内的文本)替换为(或插入式替换为)显示图片的文本标记。语法:

实际效果

上图为图片式链接,点击后可跳转到另一个网页

锚链接

以上各种类型的链接,网址最后加一个#号,后接锚点文本即可。锚点文本为该网页(文档)中的二级或三级标题的文本。

智能粘贴


复制浏览器中的网址或远程媒体文件后(包括项目内部的各类复制),在文本编辑器中按下Ctrl + V之后,系统内部将自动识别并插入对应的文本标记。比如:复制了远程图片,Ctrl + V后将自动插入图片的文本标记;复制了远程MP3后,自动插入播放该音频的标记;复制了普通网址,则自动插入该网址的文本链接……等等。

如果打算粘贴原始内容,而不带文本标记,则使用右键菜单中的“粘贴”菜单项。

尾注与批注


尾注

在需要处直接写即可,也可右键菜单插入。语法格式:[^ 尾注内容]

批注

某些文本(文档内容)设置批注后,预览模式下(所生成的网页中),鼠标指向这些文本时将以Tooltip临时小窗口的方式显示批注。默认样式,设置了批注的文本带有醒目的红色下划线。详情:

目录


单独一行,语法格式:[TOC],自动提取并以文本链接的形式显示本文的所有二级标题和三级标题。也可右键菜单插入该标记。显示效果请参见本文档顶部的目录区。

表格与表注


不建议手工输入表格的文本格式标记,Ctrl + T或编辑器右键菜单“插入-表格”即可。可根据实际需要增删行和列。注意:每一行代表列的“ | ”两侧均需有空格。WDTP(山湖路)支持显示空白单元格,可设置表格的样式与任意列的对齐方式。

单元格对齐

表格对齐以列为单位:

比如某个表格的表头行内容为:(>)第一列 | (^)第二列 | 第三列 | (>)第四列 渲染后的结果:该表格第一列的所有单元格全部右对齐;第二列居中;第三列左对齐(无对齐标记则默认为左对齐);第四列右对齐。

表格的样式

表格样式通过表格文本标记的第二行内容来设置(第一行用来设置表头,可在第一行设置列的对齐方式)。WDTP(山湖路)默认的表格样式有三种,分别是:

用户可自定义或修改默认的表格样式(系统菜单-修改当前主题-全局样式表,table区)。样式表中与表格有关的class有:

表格的默认显示效果:

表头1表头2表头3
本列右对齐本列内容居中本列左对齐
2123
3132
4243

上表:本行是自动插入的表注

填写表格内容时需注意:“ | ”两侧均需预留一个空格。

WDTP(山湖路)的表格有三种样式,每种样式均可设置列的对齐方式。上表是普通样式,下面是另外两种:

品名特点 产地单价(
ABC-36XY做工扎实,经久耐用瑞士15,800.00
猕猴桃味道鲜美,营养丰富陕西2.25
CX-10265黑科技产品索马里面议
AK-47火力猛,抗造苏联4,500.00
海句-iw学外语必备本站300.00
愤青/奴才/盲众
有知无识的新时代红卫兵
粗俗虚荣,逻辑怪异,喜欢抬杠。
只有破坏与毁灭,毫无建设与创新
天朝0.50

上表:隔行换色,无边框和框线

两个黄鹂鸣翠柳,一行白鹭上青天。
窗含西岭千秋雪,门泊东吴万里船。

上表:无边框、框线和背景色

单元格的自动计算

针对表格,WDTP专门开发了功能强大的自动计算功能,可合计某行、某列所有单元格内的数字,或者求其平均值(文本编辑器,右键菜单-插入-自动合计与平均)。如计算结果为整数,则自动给出该整数(不含小数位)。如计算结果包含小数,自动给出四舍五入后的前两位小数。单元格的非数字内容不参与计算。示例:

H0H1H2H3H4合计
ABC1112文字1437
DEF2122232490
GHI31文字333498
合计63345672225

上表:自动计算某行或某列的所有数字

引用


本段开头顶格一个“>”,后接空格和内容。

使之保持简单,再简单,更简单一些……但不要过分简单——爱因斯坦

数学公式


简单的数学公式

简单的数学公式可直接写,或者使用html的<sup/><sub/>标签:

复杂的数学公式

复杂的数学公式可插入其图片,还可用LaTeX文本标记[5]配合MathJax外链脚本来完成[6]
$$\sum_{i=0}^N\int_{a}^{b}g(t,i)\text{d}t\tag{1.1}$$

$$f(x,y,z) = 3y^2z \left( 3+\frac{7x+5}{1+y^2} \right)\tag{1.2}$$

$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)^e}{6}\tag{1.3}$$

$$\begin{bmatrix}
{a_{11}}&{a_{12}}&{\cdots}&{a_{1n}}\\
{a_{21}}&{a_{22}}&{\cdots}&{a_{2n}}\\
{\vdots}&{\vdots}&{\ddots}&{\vdots}\\
{a_{m1}}&{a_{m2}}&{\cdots}&{a_{mn}}\\
\end{bmatrix}\tag{2.5}$$

$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 \tag{2.6}$$

$$\begin{cases}
a_1x+b_1y+c_1z=d_1\\
a_2x+b_2y+c_2z=d_2\\
a_3x+b_3y+c_3z=d_3\\
\end{cases}\tag{2.7}$$


关于MathJax等外部js脚本的调用:WDTP(山湖路)的文档属性面板,“代码”文本框中可复制并粘贴以下内容(此处使用MathJax的默认配置仅为演示,实际使用时请根据您的具体需求确定配置参数。更多信息请访问 MathJax官网)。


<script type="text/x-mathjax-config">
  MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}});
</script>
<script type="text/javascript" async 
  src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default">
</script>

举一反三,可采用完全一致的思路和做法,在WDTP中给任意目录或文档(网页)挂接并调用任何外部js脚本。当然,更可以直接输入“本地”js代码。如此一来,可让您的网页实现更强悍的功能与惊人的效果。如配合其他前端技术,完全可以实现服务器端脚本程序所能实现的绝大多数功能,更可以本地直接编辑、调试并生成动态、交互性的网页。

注1:不仅可在文档/目录属性面板中挂接或执行js脚本,还可以直接在正文内容中敲代码。这种做法,可让WDTP成为一款简洁方便的前端开发IDE。

注2:文档属性面板的“代码”文本框中不仅可以给出js代码,还可以给出任何脚本语言的代码。只要您的服务器支持该语言,它就能够很happy地执行。同理,还可在此处给出css代码,对该文档所对应的网页(渲染结果)进行更精细、复杂的控制。

缩略语


文档属性中的“缩略语”属性用于设置该文档中部分原始内容的“缩写标志”。详解如下:

图文混排


该功能非常强大,可实现任意列数和行数、任意图、文的混合排版。可以很轻松地制作出Portfolio、九宫格日记、照片墙、作品集、产品墙、报刊版面、双栏多栏、图文环绕、图文并列、图文交错等版面样式。先看看默认的显示效果:


图文并列。请注意单元格文本的自动缩进(使用了强制缩进的文本标记):

火箭飞行所能达到的最大速度主要取决于两个条件:一是喷气速度,二是质量比(火箭开始飞行时的质量与燃料燃尽时的质量之比)。喷气速度越大,最终速度就越大,由于当代科技条件下一级火箭的最终速度还达不到发射人造卫星所需要的速度,所以发射卫星要用多级火箭。
游戏手柄的标准配置是由任天堂确立及实现的,包括:十字键,ABXY功能键,选择及暂停键这三种控制按键。随着游戏设备硬件的升级换代,现代游戏手柄又增加了:类比摇杆(方向及视角),扳机键以及HOME菜单键等。


双栏文本

白云天竺飞来,图画里、峥嵘楼观开。爱东西双涧,纵横水绕,两峰南北,高下云堆。逋曰不然,暗香浮动,争似孤山先探梅。须晴去,访稼轩未晚,且此徘徊。
简评:鲜活生动、风趣盎然、情节谲幻,有词以来实不多见。词人对辛弃疾这位重臣元老的首次邀约既表示盛情难却,又婉言暂不能至,不卑不亢,不即不离,处理方式极为得体。


图文环绕

月球车是一种能够在月球表面行驶并完成月球探测、考察、收集和分析样品等复杂任务的专用车辆。在实验室里,这个重要角色的学名是“月面巡视探测器”。
月球车是一项复杂严格的研发任务,除了要掌握自主导航和机械臂等技术外,更重要的是要在航天器的规范与标准管理上多下工夫。
1971年7月31日,“阿波罗15”的两位宇航员进行了人类首次月球驾车行驶,他们在崎岖的月面上越过陨石坑和砾石走了数公里。
月球车分为无人驾驶和有人驾驶两类。无人车由轮式底盘和仪器舱组成,用太阳能电池和蓄电池联合供电。所有的月球车最终都留在了月球上。
车底盘由铝合金管材制成,中部有使用铰链以便储物。每个铝制车轮都有自己的电力驱动器和机械制动器,轮胎则由涂有锌层的钢丝网制成。


九宫格日记

早晨起来伸懒腰
嘿吆嘿吆嘿吆吆

下床洗漱做早操
嘿吆嘿吆嘿吆吆

早餐要吃小面包
嘿吆嘿吆嘿吆吆

流水账随便记
啦啦啦吼吼吼呵呵

做了什么好事
啦啦啦吼吼吼哈哈

读书有何心得
啦啦啦吼吼吼呵呵

晚上出去转转
啷哩个啷哩个啷

上网四处看看
啷哩个啷哩个啷

洗澡泡脚睡觉
啷哩个啷哩个啷


图文混排的语法格式


~~~5 (5表示每个区块的间距,值范围:0~9。不指定默认为0)
第一行的第一列(内容可为文本,也可为插入的图片或图片链接。下同)
第一行的第二列
第一行的第三列
(空行表示换行)
第二行的第一列
第二行的第二列(注意:第二行仅有两列。这两列将与上一行的三列同宽)
... (更多行和列)
~~~

字体、文字大小与颜色


跨文档扩展标记


整站索引

最新文章

最新修改

精华文章

随机推荐

发布记录

更新记录

自定义index页


可将某个文档设置为所在目录或整个网站的index页。详情:

注释


语法格式:至少6个斜杠“/”,成对匹配(多了不限),包裹要注释的文本区域。所注释的内容预览时不显示(也不参与网页的渲染与生成)。示例:


////////////////////
要注释的文本
123abc
这些文本都将注释掉
///////////////////

要注释的内容可以是大段的文本块,也可以是行内的某些文本。

WDTP(山湖路)注释与普通html注释的差别:

返回顶部


语法格式:[TOP]。该标记的默认解析结果为一个文本按钮,右对齐,点击后将跳回页顶。显示效果见下:

标识符


语法格式:某行顶格至少6个连续星号(******),多了不限。该标记在解析时将被整行丢弃。其作用主要是:文本编辑器中对某些比较重要或眼睛不易定位的行做醒目标记。比如在二级标题、三级标题或某些重要的段落下方添加此标记。如此一来,可一定程度上弥补纯文本编辑器“版面字体”太单调、眼睛容易疲劳、不易视觉定位等固有缺陷。

标点符号的自动匹配


某些需要成对出现的标点符号,WDTP(山湖路)可自动完成匹配。规则:

智能提示与自动补全


详情请参见《WDTP(山湖路)常见问题及解决方案·如何实现智能提示与自动补全》。

其它


字符转义可使用行内代码的语法格式,比如:

## 二级标题(^) 居中5 * 6 = 30

或者使用传统的转义前缀“\”,还可使用html的转义字符。

WDTP中,大多数文本格式标记可使用快捷键完成输入,也可以在编辑模式下,点击鼠标右键,选择对应的菜单项来完成标记的自动输入。当然,更可以直接敲出来。

插入作者,快捷键:Ctrl + O:

SwingCoder

扩展阅读



尾注:

  1. 达尔文(1809~1882):英国生物学家、博物学家,进化论创始人和奠基者。
  2. 注释内容abc
  3. 注释内容123
  4. 所有尾注均自动编号
  5. LaTeX也是文本标记型语言之一,它适合专业级的精细排版和要求很高的文档呈现。比如:学术论文、文献教材、报刊杂志等等。
  6. 文档属性面板的“代码”文本框中给出MathJax的脚本代码链接语句,而后在编辑器中输入LaTeX或TeX等数学公式的标记文本即可。

Email: underwaySoft@126.com 微信公众号: UnderwaySoft