Home - sjtu1896/chinese-edition GitHub Wiki
编辑指南
综述
应张燕迪老师和很多讲解队小伙伴的建议,我们的共享讲稿编辑系统终于上线啦!
经过新讲解员曹建真大神的建议,我们采取了Github网站来进行共享工作。
Github网站的优势:
- 可以保留版本信息。
- 可以支持多地单账号同时编辑。
- 可以支持实时在线查看。
- 可以设置开放任何人浏览和关闭。
- 操作简单易学。
Github网站的劣势:
- UI全英文但是支持wiki的中文编辑。所以需要小伙伴们提高英文水平。
我可以在哪里找到并编辑我们的讲稿?
- 网址与账号信息:
- www.github.com/sjtu1896
- 账号:sjtu1896
- 密码将会在微信群里公布或者如果之后忘记了可以咨询讲解组成员获得。
分区与功能简介
1登录(打开github后点左上角输入账号密码)
2点击左上角的个人头像
3点击选择一个需要进入的页面
(中文版本(闵行),英文版本(闵行),交大人,交大物,交大事,中文版(徐汇),英文版(徐汇),个人版本)
4点击进入wiki
5选择new page编辑新的页面,edit 编辑已经存在的页面。
6编辑区域界面
从上到下依次是
- 标题;编辑、预览;工具栏;编辑区域;版本信息;保存。
版本
在github上的编辑最好的优点是可以保留不同的版本信息,这正是我们校史档案馆的一个很重要的职能。 这也要求了我们要及时在更新版本后保留版本信息。我们可以通过简单的操作做到这一点。
1添加版本信息
-
在标题区域添加编辑信息,需要在标题处用括号标注更新时间(xxxx xx xx更新)。
-
在edit message区域里添加编辑信息,要求 先写修改点 再写日期 再写姓名(例子 对东大门的放大比例进行了修订 20190112 荆泽宇)
2查看历史版本的不同
- 点击page history
- 勾选两个不同版本,点击比较,如果需要还原,点击版本还原。
- 特殊标记及编辑规则
- 在编辑的过程中我们需要使用一些特殊标记并遵从一定的编辑规则。
- 特殊标记
- 如下所示:
- “ # ” header1 h1 最大标题 可以通过点击编辑操作栏上方的h1获得
- “ ## ” header2 h2 次级标题 可以通过单击编辑栏上的 h2 获得
- “ ### ” header3 h3 三级标题 可以通过单击编辑栏上的h3获得
- “> ”“ 添加一条引用(扩展知识)
- “``”< > 在中间的内容会被特殊标识(来源出处的标注)
- “* ”添加一个·(分段)
- “1. ”添加一个序号
特别注意:在github-wiki中空格和回车是不显示的指令符,所以如果需要使用空格和分段时一定要小心。
编辑规则
- 扩充内容及引用:
- 使用引用符号
- 在需要添加扩展内容的地方,一定要使用引用符标出,再添加引用时,注意要在上下用空行隔开(引用内容一定要表明出处使用``(键盘左上角)):
“ Aaaaaa
bbbbbbb
ccccccccc
Aaaaaaaa ”
如何分段? 用空行隔开:
“ Aaaaa
Aaaaa ”
更多详细小知识请等待更新。
如何完成一个正式版的讲解稿修改?
如果发现了正式版本中存在错误,需要及时汇报,第一在微信群中提出,并将来源出处标出。第二在/-这个文件中把修改建议发送上去。
如果感觉正式版中的语言表达可以更好,则可以在/-这个文件夹中添加建议,并私信相关负责人。
如何完成一篇校史小故事?
校史小故事分成了三个板块,可以在初始界面中找到:1交大人 SJTU-REN 2交大物SJTU-Things 3 交大事SJTU-Stories。
- 如果需要添加小故事,一定要在故事的结尾处添加来源出处,并在标题处标出(待审核)。
- 如果是在已存在的条目中添加知识,则需要在知识后面添加标注。并在标题处添加(待审核)。
如何添加一些讲解稿的补充知识?
如果是展品相关的补充知识,则需要在/-这个文件夹中添加(知识补充)(展品相关),同样要表明来源出处。
如何分享一份个人版本的讲稿?
在/personal-editon 中添加个人版本,同时在标题处用括号标注版本的更新时间。
讲解组责任人介绍:
- 讲解组组长: 魏志恺 魏老师~
- 讲稿更新维护:郑棋文(讲稿总负责人)、荆泽宇(中文维护)、曹建真(英文维护)、黄倩文(徐汇讲稿)
- 数据统计及档案收集:苏颖乔、邹鹏宇
- 日常工作管理:责任人:戴维(闵行)、黄倩文(徐汇)
- 校史知识拓展:刘睿瑾
(荆泽宇于2019年1月13日)