[关闭]
@ghosert 2014-10-31T08:19:53.000000Z 字数 2626 阅读 9226

Cmd Markdown 发布第九次更新 --- 写在侧边

Cmd-Markdown


我是 作业部落Cmd Markdown 的主要开发者,您可以通过微博关注我 @ghosert

从一种学习习惯说起

和多数喜欢学习的同学一样,从前读纸质书的时候一直有一个习惯:用黄色的粗体荧光笔在书上划重点,然后在侧边的空白处写批注,这样既可以加深对问题的理解,也便于日后回顾重点。再后来相对于昂贵的纸质书,电子版的图书无论在质量和数量上都远胜前者,所以这个习惯就变成了看各种书籍的 PDF 版本,然后使用 Adobe Acrobat 内建的荧光笔、批注功能划重点,写段内批注。知识的媒介在变,但是这些优秀的习惯会保留下来帮助那些乐于学习的人更有效的掌握知识。

那么现在问题来了

两耳不闻窗外事,一心只读圣贤书

是一种非常朴素的学习方式。由于没有顺畅的交流机制,使得一本书,一篇文稿的作者无法及时获得读者的反馈,读者对于阅读内容的疑问只能依靠自己的理解,缺少解惑受业的引路人。但实际上,通过对阅读内容进行高质量的讨论,产生强劲的脑力激荡,会让双方都受益。

我们想延续这种习惯,并且解决问题

这就是足以让我们兴奋并且不计成本投入时间的动力所在:想要解决一个好玩的问题,然后把它交付出来。在评估了许多种产品方案之后,我们决定向 Medium 致敬。起初,我们为解决这个问题预留了十天的工作量,在这个过程中,算法和系统上的设计实现又颇费周折,最后,打磨产品的过程几近残忍:一点一点把一块粗糙的石头,打磨成想象中的样子。以为很好玩,但是我们玩了 114 天,直到认为它足够好的时候,才在今天把这块石头扔出来。

以下是本次更新的主要内容:

1. 段落批注

从这个版本开始,通过鼠标指向编辑器右侧预览区内的任意段落,在该段落的右侧会显示添加批注的淡蓝色加号,点击这个加号,在输入框内完成批注,如下图所示:


remark


此外,所有公开的文稿都可以被其它读者进行批注。

特别提醒:对于此次版本更新以前的公开文稿,如果文稿作者想开启批注功能,必须在工具栏点击【发布更新】按钮,在此次版本更新以后发布的公开文稿,默认都可以被批注。

2. 段内高亮批注

除了对整段文章进行批注,我们同时支持了高亮批注的形式,读者在预览区或者公开文稿上,可以简单的通过鼠标选取段落内的部分文字内容进行批注,如下图所示:


highlight


目前的文稿段落中除了图片和 MathJax 公式只支持段落批注以外,其它大多数形式的段落包括代码段、引用、有序列表,无序列表、各级标题、都已经支持了段内高亮批注

比起传统的评论形式,这种形式的批注,使得读者可以对批注对象进行更加精确的指认,快速建立批注的上下文。

3. 社交文字

我们尊重每一个在作业部落上书写文稿并公开发表的作者,我们也欢迎更多的读者阅读批注,和作者进行高质量的讨论、对话。因此我们设计了一个对于个人友好,对于大众相当谨慎的批注系统。我们把对待每一条批注的权力交还给文稿作者本身,因为作者本人才最关乎自己的文稿。

每一条新批注默认都不会公开,只有文稿作者和批注者本人可见,直到作者向所有人公开有价值的内容,同时作者可以删除没有价值的批注内容,以保持高质量的评论内容,如下图所示:


remarkOperation


用户还可以获取带有公开批注的文稿地址,当其他人打开它时,页面会直接跳转到带有这个批注的文稿段落。

我们的批注机制也允许不同的人对同一个段落进行反复批注,每一个人都有机会观察到不同的人对同一份内容的见解,为了确保过多的批注不会分散读者对正文内容的注意力,在默认情况下,这些批注都不会展开,直到读者主动点击感兴趣的段落批注。

4. 批注回复

当作者和其它读者在公开文稿上看到批注以后,可以立即对相应的批注做出回复,展开更深层次的高质量讨论。同时批注者和文稿作者都拥有对这条回复操作的权力以维护高质量的批注列表。如下图所示:


remarkReplyList


5. 邮件通知服务

目前我们使用电子邮件的形式来通知以下事件的发生:

  1. 有新批注时通知文稿作者
  2. 文稿作者公开批注时通知批注者
  3. 批注有新回复时通知文稿作者和批注者

您还可以直接在邮件内容中,直接公开或者回复批注。

我们希望这些及时有效的反馈可以让作者和读者产生正向的脑力激荡,互相分享对方的知识,经验和思想。为了防止有限的资源被滥用,目前我们只对曾经验证过邮箱的用户开放这一服务,如果您在注册本站以后尚未验证过您的邮箱,可以点击本站顶部的提醒通知栏,或者直接前往新的 账户设置 页面重新验证或者修改您的注册邮箱。

6. 发布、反馈、修改、再发布

如同我们相信好的产品是被打磨的结果一样,我们也相信好的文字和思想是被雕琢的结果。许多优秀而严谨的作者会遵从下面的流程完稿:

发布文稿 -> 批注反馈 -> 修改文稿 -> 再次发布

为了确保有价值的批注信息不会在这个过程中,因为文稿的变动而无故丢失,我们花费了很大的努力,设计了一种有趣的算法用来计算、对比文稿修改前后的状态,进而甄选出应该保留的批注、高亮信息,剔除过时、不匹配原文的部分。因此您可以放心地修改并且重复发布文稿,以获得持续不间断地高质量反馈和讨论。

7. 基础组件升级

在编辑功能本身,我们对最基础的编辑器组件本身做了升级,修复了部分编辑操作, Vim 模式的问题,同时也对流程图组件做了升级和增强,使得流程图在文字渲染上更细腻和平滑,如图所示:

Created with Raphaël 2.1.2StartverificationYour OperationYes or No?Endyesno

8. 历史问题漏洞修复

在 github 的 问题列表中,我们有选择的进行了以下修复:

修复中文输入法界面遮挡文字的问题 github #161
修复引用区块无法显示缩进和换行,且左右文本未对齐 github #181
修复 Firefox 版本 30 中引入的 LaTex 渲染问题
修复 代码段 渲染不稳定的问题
调整了 标题 h1 - h6 的字体大小,使得整体阅读效果更美观
修复 Shellshock 攻击漏洞 https://access.redhat.com/security/cve/CVE-2014-6271

如果您在使用中发现其它问题,请同样前往 Github cmd-editor 页面提出问题,我们会定期修复。

9. 写在最后

以上就是本次更新的全部内容,在迈出这一小步之后,Cmd Markdown 不再是一个简单、纯粹的编辑器, 它会是一个在小范围内进行交流、协作的,高质量的文字社区。我们会谨慎的在社交文字的道路上走下去,和你一样期待前面的风景。

我是作业部落的主要开发者张佳伟,我们十二月再见。

关注 @ghosert
2014.10.29

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注