跳转至

官方文档 —— Russian Natural Science Wiki

Wiki 贡献方式?

我们将 Wiki 的内容完全开源至 GitHub,您可以通过 GitHub 增添或修改仓库文件来为此 Wiki 做出贡献。

此 Wiki 的内容范围预计包括中国学生在俄罗斯留学时理工科学习的各方面知识,其文档全部保存在 GitHub 仓库上。这个仓库实质上相当于一个文件夹,我们将所有专业的所有科目作为其子文件夹,在索引中用专业来划分各个科目。

我如何增添或修改内容?

新增科目

在 GitHub 仓库根目录下新建一个子文件夹,以学科名称命名即可

对科目新增页面

在对应科目的文件夹下新建文件即可

编辑内容

在目标页面中按照我们的 标准MarkdownLaTeX 编写文件即可

提交内容

当您完成内容的增添或后,点击 Commit 提交,之后交由我们审核即可

如果您不了解代码或 GitHub

  1. 注册 GitHub 账号
  2. 打开 Wiki 仓库地址
  3. 点击 Add file,在下拉选项中点击 Create new file
  4. 此时您将会看到两个文本框:
    1. 目录文本框:“Natural-Science-Wiki/Name your file in ITMO-Computer-Science-Group:main”,此时将 Name your file 改成想要提交的目录位置(如果这个科目还没有被建立),或者在 Wiki 仓库打开指定的目录,此处即可不用填写。
    2. 文件内容文本框:在这里用 MarkdownLaTeX 编写文件
  5. 编写完成后可点击 Preview 预览
  6. 点击下方的 Propose new file (绿色)保存文件
  7. 点击 Create pull request (绿色)向 Wiki 创建提交请求
  8. 在新的页面留下附言、评论或说明,然后点击 Create pull request (绿色)
  9. 好!接下来等待我们的审核即可!

您需要遵守哪些标准?

1. 文件标准

当您在创建以及编辑文档时,需要遵守我们的文件标准,我们的文件标准很简单:

  • 每个文件必须要有一个文件标题作为文件名称,并以 .md 作为文件扩展名
  • 文件标题应在文件中用 一级标题 置顶显示
  • 内容标题从大标题到小标题,层级从 二级标题 开始依次递减
  • 内容使用 无序列表 表示其逻辑,类似于思维导图

我们给出一个一般模板:

样式

文件标题

第一级内容标题

第二级内容标题

第三级内容标题

  • 主干内容
  • 分支内容
    • 次级分支内容

源码

# 文件标题

# 第一级内容标题

## 第二级内容标题

### 第三级内容标题

- 主干内容
    - 分支内容
        - 次级分支内容

标准的具体实现可以参考我们已经做出的文件

2. git message 标准

当您想要向仓库中提交您做出的更改时,git 会要求您填写 git message。git message 相当于是一条信息,用于说明本次提交做出的更改的具体详情,git message 一般由以下两部分组成:
- Summary - 必填字段,一般用于简要概括本次提交的文件操作 - Description - 选填字段,一般用于详细说明本次修改的具体内容

对于 git message 我们执行以下标准: - 对于处于 ICSG 任务系统 中的任务提交 - Summary 统一填写任务系统中对应的任务标题 - Description 统一填写任务系统中对应的任务详情 - 对于其他的提交 - 对于文件的更新:一般只需在 Summary 填写 update 即可 - 如对一些操作进行区分,也可以选择填写: - upload <fileName> (上传文件) - new <fileName> (新建文件) - delete <fileName> (删除文件) - 等等

您需要了解哪些技术?

本 Wiki 网页渲染流程(只需了解即可)

首先我们需要了解一些概念: - 纯文本:指没有任何文本修饰的(即没有任何粗体,下划线,斜体,图形,符号或特殊字符及特殊打印格式的文本),只保存文本,不保存其格式设置,将所有的分节符、分页符、新行字符转换为段落标记的文本 渲染流程: 1. 纯文本 $\rightarrow$ 富文本 2. 富文本 $\rightarrow$ Wiki 文本

1. Markdown

Markdown 是一个轻量化的文本排版语言,不同于 Word 等文档排版,Markdown 没有太多的富文本格式,但其内容形式多样,语法简单,并且十分容易上手。
以下是一个 GitHub Flavored Markdown 的简单教程,只收录了和本 Wiki 编辑有关的部分内容。如果想要了解更多,请自行查找 GitHub Flavored Markdown 的相关资料。

  • 标题
    • 样例: ># 一级标题
      >## 二级标题
      >### 三级标题
      >#### 四级标题
      >##### 五级标题
      >###### 六级标题
    • 源码: # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题
  • 正文:无任何语法结构,直接输入即可
  • 换行

    • 段内换行:在一行的结尾加两个空格
      • 样例: >一行文本
        >又一行文本
      • 源码: 一行文本 <!--注意末尾有两个空格> 又一行文本
    • 分段换行:在两行之间插入一个空行

      • 样例: >一行文本
        > >又一行文本
      • 源码: ``` 一行文本

        又一行文本 - 文字高亮: - 样例:`文字` - 源码: 文字 `` - 斜体: - 样例:*斜体* - 源码:斜体- 粗体 - 样例: **粗体** - 源码:粗体- 分割线 - 样例: ___ - 源码: -___(为了避免与 markdown 其他语法重复,一般使用这种) ----`

      • ***

      • 表格
        • 一般表格
      • 样例: |表头|左对齐|居中|右对齐| |----|:----|:----:|----:| |内容|内容|内容|内容|
      • 源码: |表头|左对齐|居中|右对齐| |----|:----|:----:|----:| |内容|内容|内容|内容|
        • 表格内换行
      • 样例: |表头|表头| |----|----| |内容|内容1
        内容2| |内容|内容3
        内容4|
      • 源码: |表头|表头| |----|----| |内容|内容1 <br> 内容2| |内容|内容3 <br> 内容4|
    • Excel 转换 Markdown 表格:

      • 点击 https://tableconvert.com/,在上方 import 选择并复制您的 Excel,在下方选择 Markdown 并复制转换得到的 Markdown 语法
  • 无序列表

    • 样例:本文档即为无序列表样例
    • 源码: ```
      • 无序列表的顶级
        • 无序列表的下一级
          • ... ```
  • 链接

    • 样例:文字
    • 源码:[文字](URL地址)
  • 图片

    • 样例:
      文本
    • 源码:![文本](图片地址)
  • 代码

    • 行内代码
      • 样例:public stativ void main(String[] args) {}
      • 源码:`public stativ void main(String[] args) {}`
    • 多行代码
      • 样例: java public class operate { public static void main(String[] args) { System.out.println("Hello, World!"); } }
      • 源码:
        ```java
        public class operate {
            public static void main(String[] args) {
                System.out.println("Hello, World!");
            }
        }
        ```
        

2. $\LaTeX$

$\LaTeX$ 是基于 Tex 的一个十分强大的文字排版语言,其内容极为丰富,但是语法较为复杂,学习门槛较高,因此我们只取用其公式部分的语法,以弥补原生 Markdown 不支持公式显示的缺陷。

这里给出了部分常用的 $\LaTeX$ 公式语法,我们使用这种方式在网页上表示公式及符号。

  • 公式的插入
    • 行内公式:在正文文本中插入的公式
      • 样例:这是一个 $行内公式$
      • 源码:这是一个 $行内公式$
    • 独行公式:独占一行的公式
      • 样例: $$这是一个独行公式$$
      • 源码:
      • $$这是一个独行公式$$
    • 多行公式:
      • 样例: $$ \begin{aligned} c&=b\ a&=b\ b&=c\ \end{aligned} $$
      • 源码: LaTeX $$ \begin{aligned} c&=b\\ a&=b\\ b&=c\\ \end{aligned} $$
      • 说明:将要写的公式放在 \begin{aligned}\begin{aligned} 语句之间,使用 \\ 换行,用 & 来对齐公式
    • 方程组
      • 样例: $$ x = \left{ \begin{aligned} d\ c\ e\ \end{aligned} \right. $$
      • 源码: LaTeX x = \left\{ \begin{aligned} d\\ c\\ e\\ \end{aligned} \right. $$
  • 公式中的空格分隔

    • 需要注意的是,在 $\LaTeX$ 源码中的空格不会在公式渲染后显示,一般来说,$\LaTeX$ 源码中的空格仅用于分割代码字段,例如这就是一个例子:
      • 源码:$这是 一个 公 式$
      • 效果:$这是 一个 公 式$
    • 如果要使用空格分隔公式内容,有以下写法:
      • 短空行:\quad
        • 源码:$这是\quad一个\quad公\quad式$
        • 效果:$这是\quad一个\quad公\quad式$
      • 长空行:\qquad
        • 源码:$这是\qquad一个\qquad公\qquad式$
        • 效果:$这是\qquad一个\qquad公\qquad式$
    • 规范:一般对于公式与其公式编号(如果有的话),之间用 \qquad 分隔,对于一般的公式见间隔,使用 \quad 即可,具体根据实际情况判断
  • 一般公式:

    名称 效果 源码
    分式 $\frac{x}{y}$ \frac{x}{y}
    绝对值 $\lvert a\rvert$ \lvert a\rvert
    根号 $\sqrt{x}$
    $\sqrt[b]{a}$
    \sqrt{x}
    sqrt[b]{a}
    次方 $a^{b}$ a^{b}
    对数 $\log_ab$
    $\lg{a}$
    $\ln{a}$
    \log_ab
    \lg{a}
    \ln{a}
    积分 $\int_{a}^{b}$ \int_{a}^{b}
    求和 $\sum_{n=1}^{20}$ \sum_{n=1}^{20}
    极限 $\underset{x\rightarrow\infty}{\lim}$ \underset{x\rightarrow\infty}{\lim}
  • 常用符号

    名称 效果 源码
    无穷 $\infty$ \infty
    正负号 $\pm$
    $\mp$
    \pm
    \mp
    乘号 $\times$ \times
    除号 $\div$ \div
    点乘号 $\cdot$ \cdot
    角度 $\degree$ \degree
    单波浪线 $\sim$ \sim
    约等于号 $\approx$ \approx
    成比例 $\propto$ \propto
    大于等于
    小与等于
    $\ge$
    $\le$
    \ge
    \le
    不等于号 $\neq$ \neq
    同余号 $\equiv$ \equiv
    向右单
    双箭头
    $\rightarrow$
    $\Rightarrow$
    \rightarrow
    \Rightarrow
    左右单
    双箭头
    $\leftrightarrow$
    $\Leftrightarrow$
    \leftrightarrow
    \Leftrightarrow
    包含于
    包含
    $\in$
    $\ni$
    \in
    \ni
    任取 $\forall$ \forall
    存在
    不存在
    $\exists$
    $\nexists$
    \exists
    \nexists
    并集
    交集
    $\cup$
    $\cap$
    \cup
    补集 $\complement$ \complement
  • 希腊字母

    效果 源码
    $\alpha$ \alpha
    $\Alpha$ \Alpha
  • 希腊字母名称

    大写 源码 小写 源码
    $\Alpha$ \Alpha $\alpha$ \alpha
    $\Beta$ \Beta $\beta$ \beta
    $\Gamma$ \Gamma $\gamma$ \gamma
    $\Delta$ \Delta $\delta$ \delta
    $\Lambda$ \Lambda $\lambda$ \lambda
    $\Mu$ \Mu $\mu$ \mu
    $\Eta$ \Eta $\eta$ \eta
    $\Theta$ \Theta $\theta$ \theta
    $\Rho$ \Rho $\rho$ \rho
    $\Sigma$ \Sigma $\sigma$ \sigma
    $\Phi$
    $\varPhi$
    \Phi
    \varPhi
    $\phi$
    $\varphi$
    \phi
    \varphi
    $\Omega$ \Omega $\omega$ \omega
    $\Pi$ \Pi $\pi$ \pi
  • 上下标

    效果 源码
    ${xxx}^{bbb}$ {xxx}^{bbb}
    ${xxx}_{bbb}$ {xxx}_{bbb}
    $_{bbb}^{ccc}xxx$ _{bbb}^{ccc}xxx
    $_{bbb}xxx$ _{bbb}xxx
    $^{ccc}xxx$ ^{ccc}xxx
  • 在头顶的东西

    名称 效果 源码
    $\hat{x}$ \hat{x}
    $\bar{x}$ \bar{x}
    $\widetilde{x}$ \widetilde{x}
    上划线 $\overline{x}$ \overline{x}
    下划线 $\underline{x}$ \underline{x}
    向量 $\vec{a}$ \vec{a}
    向右向量 $\overrightarrow{AB}$ \overrightarrow{AB}
    向左向量 $\overleftarrow{DE}$ \overleftarrow{DE}
  • 括号

    名称 效果 源码
    $\underbrace{jack}_{4}$ \underbrace{jack}_{4}
    一般括号 $(\frac{\frac{a}{b}}{c})$ ()
    自适应括号 $\left(\frac{\frac{a}{b}}{c}\right)$ \left(\right)
  • 三角函数

    名称 效果 源码
    正弦函数 $\sin{x}$ \sin{x}
    余弦函数 $\cos{x}$ \cos{x}
    正切函数 $\tan{x}$ \tan{x}
    余切函数 $\cot{x}$ \cot{x}

内容生产规则:

1. 语言生产

  • 一个文档的基本格式,通常包含以下部分,他们都是可选的:
    • Word
    • Grammar
  • 文档模板
# Title

## Word

| русский                 | 中文              |
|-------------------------|-------------------|

  • 关于 Word 部分
    • 总要求:
      • 记录词的原型
      • 非专有名词首字母不大写
      • 可信度排名:字典>千亿词霸>译酷>谷歌翻译
    • 对于内容来源
      • 动词
      • 要求动词不定式,有两个体的,未完成体在完成体前面
      • 要求记录在原文中的接格关系
      • 名词组
      • 具有以下特征的被称为“名词组”
        • 各部分高内聚的,整体与句子其他成分低耦合的
        • 整个词组在中文中有专有名词的
      • 名词组首先要单独记录,其次在可选的情况下,可以将里面的单词分别单独记录
      • 名词
      • 如果名词不在名词组中,直接记录
      • 如果名词在名词组中,可选的记录
      • 形容词
      • 如果形容词在名词组中,可选的记录
      • 如果形容词有接格关系(这通常是由其动词决定的),要求写出形容词的接格关系
      • 副词
      • ~~副词有对应形容词的,只记录对应形容词~~ 我相信没有人能遵守这一条,所以我们不要了
      • 副词没有对应形容词的,记录当前副词,例如“【副】жарко”
      • 其他词
      • 前置词请记录到前置词语法
      • 要求标注词性,例如“【代】он”
    • 对于在文中的格式
      • 【】
        • 此符号在中文列使用,标识俄语单词的词性、特殊性质(例如是*的形动词等)
      • ()
        • 此符号在中文列使用,表示中文释义的某一释义的补充说明
        • 此符号在中文列使用,标识相差较大的中文释义
        • 此符号在中文列使用,标识相差较小的中文释义
      • 对名词特殊变格的标注

        • 特殊变格不超过单数二格、复数一格、复数二格的,按照如下顺序在俄语列标注

          сло́во -(单数二格词尾) -(复数一格词尾) -(复数二格词尾)
          сло́во -а -а́ -¢
          
          • ¢ 表示秃尾或零词尾
          • 约定俗成,词尾有重音的单词发生重音偏移,词尾没有重音的单词重音保持不变,单词重音偏移而不在词尾的单词的格在对应位置写完整。
          • 不足三个的,将按顺序补足至目标名词的格,例如分别表示 сло́во 的单数二格、单数二格和复数一格、复数一格、复数二格:
            сло́во -а
            сло́во -а -а́
            сло́во -а -а́
            сло́во -а -а́ -¢
            
        • 特殊变格不在上述范围内的,在中文列使用 【】 符号标注。 - 对动词、形容词的变化和接格的标注

        • 将动词变位在对应体的后面依次写出
        • 单数第二人称变化可反映动词、形容词所有变化的词,只需依次写出 я ты 的变化,они 的变化可选的写出,单词变化特殊的,要将所有人称的变化写出
        • 词的过去时变化总在单词后面或现在时变化后面,词的接格总在所有组成部分的后面,即:( [] 表示可选部分)

          单词 [现在时变化] [过去时变化] [接格]
          
        • 约定俗成,词尾有重音的单词发生重音偏移,词尾没有重音的单词重音保持不变,单词重音偏移而不在词尾的单词的变化在对应位置写完整。

2. 内容梳理生产

  • 内容梳理概念

    • 定义:对于指定材料及相关资料经过理解消化后,对内容进行划分,分层,总结,整理后基于无序列表,采用各种文本样式,按照各项标准和规范,制作出的一份包含了材料即相关资料所有知识点及相关内容的,易读易理解的文件(类似于思维导图)
    • 目的:充分学习指定材料及相关资料的知识,然后公开分享学习成果
  • 一份内容梳理文件的基本要素,通常包含以下部分:

    • 枝干:拿到一份源文件首先需要根据文件所讲述的内容划分枝干
      • 文件标题(必选)
        • 使用一级标题在写在文件第一行
        • 样例:# 文件标题
      • 部分标题(可选)
        • 使用一级标题表示
        • 样例:# 第<部分序数>部分:<部分名称>
      • 章节标题(可选)
        • 使用二级标题表示
        • 样例:## 第<章节序数>章:<章节名称>
      • 小节(可选)
        • 使用三级标题表示
        • 样例:### §<章节序数>.<小节序数> <小节名称>
    • 内容:除去枝干部分的所有文字,图片,公式,代码等都属于内容,所有的内容都写在无序列表下,其中可以选择性穿插使用有序列表,表格,图片,超链接等丰富文本样式和内容,一般地我们给出如下示例样式:

  • 知识点
  • 概念
    • 子概念
  • 定义:
  • 分类:
    1. 类别1:说明内容
    2. 类别2:说明内容
  • 特点:
    1. 特点1:说明内容
    2. 特点2:说明内容
  • 文字内容
    • 子内容
      • ......
  • 图片内容
    • 说明
  • 表格内容

    表格 表头1 表头2
    表头1 内容 内容
    表头2 内容 内容
    • 说明
    • 文本 超链接 文本
    • 公式内容 $$一行公式(或多行公式)\qquad (公式序号)$$
      其中:
    • $公式要素1$ - 说明
    • $公式要素2$ - 说明
    • 代码内容 代码语言 样例代码 其中:
    • 说明
    • 关键字1 - 说明
    • 关键字2 - 说明
      • 补充说明内容或引用内容
    • ......

以上样板仅供参考,在实际生产中需要负责人自行根据材料判断,在遵守各项规范下尽可能设计出更清晰,更易读,更易理解的内容样式 - 生产步骤 1. 领取任务,拿到材料后,首先整体地阅读材料,大概划分出材料的枝干部分,包含的章节,小节等 2. 对材料内容展开翻译工作,这里我们给出几种翻译方式: - 词典逐词查询翻译 - DeepL翻译 或 Google 翻译 - 自行翻译(仅在掌握材料内容的情况下)

    通常我们首先使用 DeepL翻译 或 Google 翻译 对材料进行整体翻译,辅助理解材料内容,同时也兼顾其他翻译方式,对翻译结果进行完善,必要时可以查阅相关的中文资料,对翻译难懂的地方进行完善,并且要求负责人通过翻译工作,理解并掌握材料内容
3. 理解并掌握材料内容后,根据材料的内容,使用自己的语言将材料内容整合进文件中,要求遵循各项标准规范,参考优秀的内容梳理样例尽可能地以更加易读易理解的方式表现材料内容
4. 完成生产后,仔细检查做出的内容梳理,对于其中翻译不准确的,不易理解的地方进行改进,纠正各种错误,按照 [排版规范](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.md) 优化文案排版,对内容梳理的各个方面做出改善
5. 完成生产
  • 质量评判标准
    • 合格:
      1. 负责人在完成生产后有所收获,学习到了知识
      2. 负责人在进行生产后能理解材料所讲述的内容以及自己做出的文件内容
      3. 其他人阅读这份内容梳理也能理解其中的内容
      4. 内容没有重大错误
    • 良好:
      1. 达到合格的标准
      2. 穿插使用了各种文本样式丰富内容层次,使内容的说明更加直观易懂
      3. 对于难懂的内容,有自行查询资料辅助说明
      4. 语言翻译准确,易理解,没有任何难懂拗口的翻译腔
      5. 内容基本没有错误,语法基本没有错误,专有名词旁有补充俄语,文案基本遵守 排版规范
    • 优秀:
      1. 达到良好的标准
      2. 对于材料的不同重要级的,在文件中有使用加粗,下划线,斜体等方式进行区分
      3. 通过查询其他相关资料,对材料中未提及的相关内容进行了补充,丰富知识体系
      4. 内容完全没有错误,语法完全没有错误
      5. 正确的插入空格,使用标点符号,使用大小写、缩写等,整体的文案严格遵守 排版规范