关于帖子格式的一些注意事项&讨论

鄙人在使用 Discourse 论坛发帖的过程中,发现关于帖文格式有一些值得留意、但常常被大家忽略的问题,这里鄙人简单总结一下,希望能给大家发帖提供帮助。

1 帖文中的网址/URL

1.1 概述

Discourse 论坛可以自动将帖文中的 URL 识别为超链接,不需要加入特殊的标记字符。但是,系统识别时容易出现一些错乱,如果 URL 和其后的文本之间不加空格分割,那么 URL 后的文本也会被识别为 URL 的内容,从而产生错误的超链接。

1.2 错误案例

这是一种不太合理的源代码写法:

https://www.appinn.com/是小众软件官网的链接。

渲染出的文本是

https://www.appinn.com/是小众软件官网的链接。

1.3 改进方案

根据 markdown 语法标准,文档中的 URL 应该用尖括号 < > 包裹。这样,系统就不会将 URL 外的文本与 URL 混在一起啦。

<https://www.appinn.com/>是小众软件官网的链接。

渲染出的文本是

https://www.appinn.com/是小众软件官网的链接。

1.4 附:Onebox

Discourse 论坛还有一个功能叫 Onebox,即将 URL 显示为一个卡片,卡片中会显示目标网页的标题、缩略图、内容摘要等信息。在帖子中生成 Onebox 的方式也很简单,将 URL 作为单独的一行插入帖子即可,注意上下各空一行。比如:

dufs 在 Github 上的项目地址是:

https://github.com/sigoden/dufs

dufs 在 Github 上的项目地址是:

但需要注意的是:

  1. 一些网站不允许爬取其数据,这样的网站无法展示 Onebox。
  2. 有时候,由于网络问题,论坛系统无法获取 URL 目标网页的信息,这时也无法显示 Onebox,该 URL 会显示为一个普通的超链接。
  3. 将 bilibili、YouTube 等视频网站的 URL 按 Onebox 的格式插入帖文,则会显示为内嵌的播放器。
  4. 首次在帖子中插入 Onebox,会获得论坛的 “首个 Onebox” 徽章一枚哦!

2 带扩展名的文件名

2.1 概述

有时候,帖文中带有扩展名的文件名也会被系统识别为 URL ,从而错误地为其加上超链接。对于这种情况,个人建议用反引号包裹文件名,比如

"记事本" 的可执行文件是 `C:\Windows\` 目录下的 `notepad.exe`。

渲染出的文本是:

“记事本” 的可执行文件是 C:\Windows\ 目录下的 notepad.exe

2.2 “反引号” 在哪儿?

对于一般的 PC 键盘,反引号在键盘左上角,Esc 键之下、Tab 键之上、1 键左侧。

3 特殊符号(主要是星号 *)

3.1 概述

Discourse 论坛使用的是 markdown 标记语言,其中有些特殊符号是系统预留的,主要是如下符号:

  1. 星号 *
  2. 反引号 `
  3. 大于、小于号 ><
  4. 美元符号 $

它们在帖子中有特殊的含义,直接插入到帖文中可能不会显示出来。比如

  1. 夹在两个星号之间的内容,会被渲染为斜体。比如 *awsl*awsl
  2. 夹在两个反引号之间的内容,会作为代码块,以等宽字体显示,文本背景为浅灰色。
  3. 用尖括号(其实就是大于、小于号)包裹的内容,会被渲染为超链接。
  4. 夹在两个美元符号之间的内容,会被渲染为 LaTeX 数学公式。比如 $\int_0^\infty f(x)$\int_0^\infty f(x)

3.2 解决方案

如要在帖子中显示这些特殊符号,有如下两种方法:

  1. (个人比较推荐)用反斜杠 \ 进行转义。比如 \*awsl\* → *awsl*
  2. 用反引号包裹,作为代码块显示(但对反引号不起作用)。

但我发现,其实一般来说在帖子中单独输入 $、<、> 不会出现被错误渲染的情况,但保险起见,还是建议您加上反斜杠转义一下。

4 “我最喜爱” 频道中的帖子

“我最喜爱” 频道在这里:

很多朋友在发帖时没有注意到这个频道中帖子的特殊性,因此经常能看到不规范的回帖。这里简单介绍一下。

“我最喜爱” 频道的帖子都是投票帖,每一个回复都会作为一个提名项目参与投票,因此该频道发帖有些特殊要求:

  1. 每一条回复,只能提名 一个 软件或方案。如想提名多个软件或方案,请将其分为多个回帖发送。但需要注意的是本论坛似乎对一位用户的连续发帖数量有限制。
  2. 如果只想对某个提名项目,或对该帖子的内容进行评论,而不想提名软件或方案,请不要直接在帖子下面回复。用户可以在需要回复的帖子下面,点击 “添加评论” 进行讨论。
  3. 不要进行重复提名
  4. 进行提名前,请仔细阅读一楼的发帖要求。有些投票帖会要求提名者提供详细的信息,如软件平台、是否收费等,也可能会规定发帖格式。为了方便他人浏览,请您尽量遵守。

插句题外话,提名安卓应用的时候,最好把软件包名也带上。因为应用重名的情况还是很多的,加上包名,用户下载后可以确认一下自己下载的软件和推荐的是否一样。

5 维基帖

一般而言,论坛中的帖子只有发帖人和版主/管理员可以进行编辑,但维基帖是所有用户均可参与编辑的。维基帖一般发布在 “网络黄页” 频道:

维基帖没有统一的格式规范,但大家参与编辑前,请务必仔细阅读楼主的格式要求,或观察其他人编辑后帖子的格式,保持版面的整洁、统一。


废话可能有点多,希望能给大家带来一些帮助。最后,祝大家新春快乐,龙年大吉……诶,今天是大年初五,可能有点晚了,不要紧,那就祝大家晚年幸福吧 o(*≧▽≦)ツ

13 个赞

还可以在链接前后加空格。

2 个赞

(感觉发帖不在意的人不会看,在意的人自己已经知道了)

2 个赞

这个我还真的是第一次知道耶,虽然之前看大家发出来的帖子有各种样式,但是还真的没有意识到是为什么不一样的,感谢分享!

1 个赞

其实 Onebox 的玩法挺多的,比如

1 普通网页

普通网页可以生成标题、摘要、缩略图,比如

https://github.com/vinceliuice/WhiteSur-gtk-theme

2 视频网站

可以直接作为嵌入式播放器插入,比如

https://www.bilibili.com/video/av425832091/

3 站内

这部分是最丰富多彩的,比如

3.1 帖子

https://meta.appinn.net/t/topic/52640/

如果在帖子后加上数字,可直接引用指定楼层的内容:

https://meta.appinn.net/t/topic/52640/4

3.2 用户名片

https://meta.appinn.net/u/victoryroad/

3.3 频道

https://meta.appinn.net/c/discuss-and-share/

备注

  1. 插入 Onebox 后,建议先打开帖子预览界面,等一会儿,待里面的 Onebox 渲染好后再发布。不然 Onebox 可能渲染失败,只显示一个超链接。
  2. 来自其他基于 Discourse 的论坛的内容(频道、帖文、用户名片等)无法渲染出 “3 站内” 章节中的那种格式。
2 个赞

有些符号可以用 HTML 字符值引用的方式输入,这样可以避免被系统识别为 URL。比如 . 可以用 &#x2E; 或者 &#46; 来代替,须要了解这类字符对应的 ASCII 编码。具体说明看这里:

2 个赞

这样用太麻烦了,不如空格呀

不不不,在某些时候这是个很好的办法,例如这里,我通过利用全角空格成功达到了让 readme.md 也能和普通的中文段落一样首行缩进的功效(不直接打出全角空格的原因是VSCode会疯狂警告并提示你换用普通空格)

链接: 山二医入学与生活指南: 《山二医入学与生活指南》Latex版本| 原始docx版本由“山二医校园频道”接手更新工作,本人不再负责更新;其与本文属于分叉(Fork)关系,互不干扰。

补充:全角空格代码为 &emsp;

首行缩进这个需求自从不写作业以后就放弃了 :rofl:

不过的确是个好办法

还有一个,&#x3000;

其实全角空格还是很有用的。比如我写电子邮件的时候喜欢严格按照中文书信格式(称呼顶格,正文空两格),而且喜欢写纯文本邮件,这时候全角空格就相当有用了。

看到这,突然想起委座了(空一格):doge:

青蛙,我这突然打不开编辑帖子的特殊格式菜单了:


(似乎无法上传gif动图……)
就是点击齿轮按钮后就只出现一条变长的蓝色横线,然后没了,没出现格式菜单
除此之外没发现其他功能问题,表情包弹出菜单和点赞弹出菜单都正常

确实,我这里也出现了类似的问题。

另外,关于论坛系统的问题,请移步该帖讨论:

https://meta.appinn.net/t/topic/31808/283

本帖的楼主不是站长,因此在该帖回复站长那边不会收到通知。