目录

vim文本标注符号系统(vTIS)

作者:vim 版本:av3.5.0r 注册文库:vim笔记 更新时间:2021.5.30

特别说明:vTIS符号标注系统会保持持续的升级更新,最新正式版本会在vim笔记的专题页面“http://www.vim.org.cn/doku.php?id=doc:methodology:vtis”保持发布,建议关注。有任何问题,可以邮件给vim(vim@vim.org.cn)交流咨询。

一般文章写作基于的是自然语言和相关学科领域的概念和叙述的混合,通常比较随意,很容易导致歧义和误导;但另一方面,如果像数学和逻辑学那样,用极其严谨的逻辑符号来表达,即不容易使用,也不容易理解,并不适合一般人使用。

为了在日常写作和记录过程中,表达得尽量精准和严谨一些,但又不至于出现“作者觉得麻烦,读者看不明白”的情况。vim同志借鉴Markdown基本语法wiki语法的经验,在传统写作的符号标记的基础上,参考IT互联网领域和数学领域的一些常用概念和符号系统,试着整了一个轻量级的vim文本标注符号系统(以下简称“v标注符号”或者“vTIS”)。

v标注符号的主要应用场景:

  1. 日常想法和阅读材料的记录整理:对于一些原创性的想法以及看到的材料,进行随手的记录,或者日常性的归纳整理
  2. 一般性书面讨论:在进行书面形式的沟通(或辅助沟通时),对于认识比较混乱的概念和逻辑进行标注,避免不必要的错维争论
  3. 正式写作:在进行相对比较正式的写作时,能较为精确的表达相关内容
  4. 微博、朋友圈、抖音的短文本分享:在自媒体中发布150-300字之间的短文字分享时,或者短视频的文字描述时,适当精准的表达相关意思

[vTIS]使用说明

使用[vim文本标符号系统|vTIS]时只需在文章中任何位置(建立在文末或者文首),添加一句话:“本文内容标注采用vTIS符号标注系统”即可,无需其它更多操作——当然,如果你只是想用用它,但懒得加这句话,也没有关系,反正,影响力、backlink什么的,一切都素浮云~~~

v标注符号的设计目标和原则

1. 在写作和记录时,让文章里的概念定义、逻辑层次、叙事程序较为精准且可读; 2. 没有相关经验和习惯的人,在半小时内参考一下说明,就能凑合着上手,并能越用越好用; 3. 在追求作者表述的内在定义和逻辑的一致性的同时,同时考虑可能的外在知识体系的兼容性和可连接性。

1. 尽量使用现有的计算机键盘常用的符号进行标识,少用需要特殊方式输入的字符; 2. 尽量与现有的文章写作、IT命令的习惯符号用法兼容,以及尽量在此基础上衍生发展,如无必要,不做重构; 3. 尽量使用国际通用的半角符号,扩大适用范围;注释默认使用全角符号,减少和markdown等语法的冲突

备注:不太容易做到,不过先弄一个极简的版本出来先自己用着问题应该不大,先弄着吧,啥时候自己觉得用得比较成熟了,再推广。


v标注符号的基本用法

[vim文本标符号系统|vTIS]的应用案例

例文A:

“当一个人表达一个意思时,Ta表达的绝不仅仅是Ta所说的那些话字面上的意思,事实上还包括了这些话背后的一些潜在的信息和知识,以及构成这些话语表达的认知方式和话语体系,还有这些话内置的一些价值观和意识形态,甚至这些话将可能导致的现实后果。 ”(a:vim)(O:这里讨论的是为什么理解一个人的意思那么的难,以及如果才能理解一个人的真实意思)<n:理解、沟通与话语合法性@网站:vim笔记>

例文B:

“党对于公共事务的组织过程和发展过程,用一个更常见的概念表述就是[党建],在中国,党建的本质事实上是国家建设,是一个国家社会的组织化过程和治理过程,也就是说党建的目标是为了让国家社会更有效、更规范、更正义,或者说:让这个国家社会更有[e:正当性]:(#政治学,|合法性)。这意味着大量的公共事务、公共管理、公共服务等公共品需要提供,并且配套着国家层面的组织化动员。”(a:vim@业擎社创,d:200722,o:原文讨论的是“中国公益的现代化和本土化”,这一部分是其中关于社会公益和国家治理的讨论,用于帮助理解){#党建与国家建设}><n:中国公益的现代化与本土化——公益性质变迁、国家社会关系与公共事务思维@公众号:业擎社创>

以上两篇文字就是[vim文本标符号系统|vTIS]的典型应用,它即是一段完整的表述,可以表达一段在内容和逻辑上较为完整的话。它的应用场景包括:

  1. 直接在朋友圈、微博等自媒体上以短内容的形式发布;
  2. 一篇文章的相关章节中,引用其作为注释及阐述内容;
  3. 在一段完整的长文章中,被“标记”(/截取)出来,方便查询和收藏;
  4. 将若干段具有一定逻辑关系这样的小文字,组成一篇文章的内核,然后在此基本上写成一篇完整的内容。

为了更好了记录或者创作这样的焦点内容,vim同志参考IT互联网领域的程序语法、格式语法、命令行语法等经验,弄出了一系列标记符号及语法形式,通过适当的表达式,可以更好的满足相关写作和记录需求。

基本表达式

基于现实应用场景,参考IT互联网字符界面的命令行模式设计,主要包括四部分内容:[对象标记域],(对象注释域),{索引命名域},<链接跳转域>。

备注:表达式中如果标为“功能符 相关内容”的,两者之间无需空格,这里的空格仅为了便于本文阅读,本文的后续部分均采用此原则。

内容域的基本含义

备注:为减少过程中切换中英文输入法不方便,方便非中文用户使用,所有的符号默认均为英文字符下的相关符号,同时兼容中文的相关符号;同时为了不与markdown等语法的渲染冲突,在使用[]定义对象时,在[]和()之间添加“:”符号隔离,在使用“”定义对象时,可以不加“:”符号。


内容[块,域]的标记符号

对象标记域

说明:用于对文章内容的要点进行特别标记,说明其有特定的内涵和外延,使读者的认知在作者希望讨论的焦点上或者框架内。

表达式:[参数符?标记对象|对象别名]

对象标记符号

标记对象别名

说明:对标记的对象,起一个简明的别名或者简称,方便理解和引用表述。

表达式:[标记对象|对象别名]

标记对象类型

说明:标记对象可以添加参数符号,以更精准的说明其类型,参数符需要位于标记符号对中,参数符之间用集合符区隔或者连接。


对象注释域

说明:对前面标记的对象,提供简单的说明、补充、阐述等,帮助读者更好的理解其含义。

为保障内容的易读性,将注释在书面形式上分为“句内注释”、“段后注释”、“文末注释”3种,如果没有特别申明,注释默认为“句内注释”.

备注:段后注释的性质在vTIS中被定义为“块”,默认形式为一个独立的段落。也可以用块符号进行标记,相关使用方法及说明及在本文的“文章内容的分区应用”中查询。

注释标记符号

备注:原则上同时可以用半角括号(即英文输入法时的括号)或者全角括号(中文输入法时默认的括号),考虑到切换输入法的便利性,建议使用半角符号,这个时候为了避免与markdown语法的渲染冲突,建议在[]和()之间添加“:”进行隔离。

注释功能符

表达式:(参数符 注释内容)

备注:如果注释区中没有任何功能符(或类型符)标识,默认视为采用的是“说明”功能符标识。

注释类型符

备注:注释内容应该放在注释符号对内,用于对内容的精准注释;注释内容正常情况下应紧跟着内容对象后面进行说明,也可以放在段后或者文末。


索引命名域

说明:用于在一定的范围内,对文章内的被标记对象进行统一命名,方便内容的查询参考、延伸阅读和跳转。该范围被称为[命名区]:(|命名空间),指一组命名锚点和命名对象的专用命名数据库.

表达式:{#锚点,|命名,%适用范围}

命名标记符号

对象命名功能符

备注:没有特别申明的情况下,命名空间指向本文档的命名区,也可以指定为特定的文档、文集和文库的相关内容。

对象命名参数符

备注:对象命名的参数及命名空间的使用,结合[文章、文集和文库]的用法来用,以其为相关参数,如未设定相关参数或者没有特别说明的,对象的“锚点和命名”的适用范围为本文档。如果文章存在多个层次的相同的命名,且在应用时发生冲突时,官方命名在注册文库中的命名拥有最高的优先级,文集、文档渐次;自定义命名反之,当前文档中的命名具有最高优先级,文集、文库渐次。


链接跳转域

说明:提供命名对象及标记对象延伸阅读的具体地址,可以是网址或者命名空间内的命名对象。如未设定相关参数,访问对象范围在本文章范围内

基本表达式:<功能符 跳转对象,类型符:链接注册区>

跳转符号

链接跳转功能符

备注:如果没有特别注明,默认视为跳转至本文命名区的命名对象上。

链接跳转类型符

备注:如果使用了社交媒体跳转的应用,原则上文末的命名区中,应有社交媒体定义版块,如果引用的都是众所周知的知名媒体,该部分也可以略过。


高级应用:参数符

说明:用于精简定义文本对象、注释、命名和链接的性质和用法的一组符号,包括:功能符,类型符,集合符,其它基本符号。规定域空间符号对内的参数符,原则上都应该是英文环境下的半角字符。

功能符

说明:用于定义符号后面内容的相关功能,用于更精准的对相关内容进行操作,形式为“特定功能符 相关内容”

表达式:(功能符 对象内容)

备注:功能符的具体内容,在不同的内容区分别定义,原则上在较高抽象程度上,相同的参数序具有类似的内涵和一般用途。

类型符

说明:用于定义对象和注释等内容的相关内容的类型性质,用于精准表示文本对象、注释、命名和链接等,形式为“特定字符+类型符”。

表达式:(固定类型类型:标记对象or对象注释)或者(自定义类型类型;标记对象or对象注释)

集合符号与其它符号

说明:当讨论的内容存在多个要素和多重维度时,展示其组成,以及之间的关系进行简单标注,便于了解讨论的内容的系统性和逻辑性。

备注:集合符表示这个对象由多个要素、多重维度共同建构,需要复合性、系统性的理解,展开来会相关的复杂,先把基本用法列出来,后续再完善,

其它基本符号


文章层面的高级应用

版本标识与文库标记

说明:为确保对作者所表述内容的连续性和演进过程的了解,同时参考软件工程的版本管理,对文章及其汇编内容以版本号的形式进行标注管理。参考软件工程领域的版本标识体系,版本采取3×3的多级版本标识体系

基本标注表达式:ArticleVer:x.y.z(p/r/i/c/s) · BookVer:x.y.z · LibraryVer:x.y.z

文章、文集与文库

说明:文章根据是独立单篇文章、属于相关文集、以及是否在特定数据库登记,采取多级版本号,其中文章自身的版本号是必备的。

备注:每篇文章默认都有Article版本号;Book版本号只在文章被收录进某文集/书,值得关联阅读时加入;Libray版本号指文章的正式发布渠道,里面默认提供本文的最新的版本、历史版本、以及相关内容的正式解释。

版本号

说明:根据文章(文集、文库)的更新性质,用三级的版本号,分别表示文章的改动是根本性的、改进性的还是细节修订型的。

备注:原则上,每一篇文章在草稿阶段均从PV0.0.1开始写;初步可用,但系统性和结构性不完整的,可以以PV0.1.n开始内部引用和发布;只有在文章已经比较完善的情况下,再以PV1.n.n的版本号对外发布。

版本发布标识

说明:文章在对外发布时,原则上应该增加发布标识,以方便确认本文发布时的大致用途和目标

备注:文章如果没有相关标识的话,默认指作者写作中的过程版本,限作者个人使用;外发版本原则上应该带有版本标识,如无参数,可以默认当作Inside版本。


文章内容的分区应用

文章内容的功能分类(区,块,域)

文章主要分区类型及其符号

说明:这一部分内容主要是为了提高文章的视觉可读性,同时考虑与常用互联网格式语法的兼容性。

表达式:===分区类型(注释){命名}<跳转>

主要分区类型:

备注:一般文章不需要包括以上所有的分区,一般来说,导读区、正文区、注释区是核心内容,一般文章包括这几部分即可;如果是较为严谨的内容创作,可以根据需要增加相交区域内容。

外部内容调用

如果有经常使用的自定义的命名、媒体、类型等内容,也可以统一准备专门的自定义文件,然后在相关分区中直接调用。

表达式:“~调用外部自定义内容@l:文库名/b:文集名/a:文档名”

调用说明:注册了文库的调用指定文库中的相关文档;指定了目录的调用指定目录中的相关文档;没有注册文库的,直接调用本文档所在目录下的指定名称的文档。

备注:默认自定义文档名为“parameters.vtis”。(:具体格式规范以后完善)

文章内容的层次分类(篇,章,节,段,句)

备注:本部分内容先留着,暂时没太大用途,后续应用场景多一些,用途再高级一些后,再考虑相关内容的展开

文章层面的特殊符号

备注:特殊符号一般可以不用,可以根据上下文自动识别,如果是严格表达,或者特殊应用的情况下,可以采用这些特殊符号。更多的特殊符号,根据应用场景具体添加,通常采用三个连续的符号的形式。

典型应用说明

  1. 在微博、朋友圈、短信等应用场景中,或者个人记笔记时,因为主要是块文字,且内容发表人的信息非常明确。块文字的整体范围可以不用符号界定。但如果相关内容未来考虑在此基本上写大段文章,或者考虑内容被转载的情况,进行完整标注会更合适;
  2. 如果以注释域(或者其它部分)使用了自定义类型(;),原则上文末的类型区中应有条目对其进行定义,或者通过(~引用)的方式进行定义;
  3. 如果在跳转域使用了社交媒体跳转的应用,原则上文末的命名区中,应有社交媒体定义版块,如果引用的都是众所周知的知名媒体,该部分也可以略过。
  4. 版本升级过程中,如果文章没有对外发布,且无需做版本分支,那么,Z层次上的小内容调整,可以无需保持过程版本,在下一个版本中再升级即可;
  5. 如果在使用过程中,需要通用的表示各种域的,可以用“”作为所有域类型的通用符。

vTIS使用说明

使用[vim文本标符号系统|vTIS]时只需在文章中任何位置(建立在文末或者文首),添加一句话:“本文内容标注采用vTIS符号标注系统”即可,无需其它更多操作——当然,如果你只是想用用它,但懒得加这句话,也没有关系,反正,影响力、backlink什么的,一切都素浮云~~~

联系方式

邮件:vim@vim.org.cn 网站:www.vim.org.cn 留言:联系vim同志