[關閉]
@ghosert 2014-10-31T08:19:53.000000Z 字數 2626 閱讀 13052

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

添加新批注
在作者公開此批注前,只有你和作者可見。
回復批注
湖北快三遗漏