8000 GitHub - xuyao0127/muntool-iris: Iris: MUN documents editor
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

xuyao0127/muntool-iris

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Iris 模联写作工具使用说明 v0.2

1 mtf标记语言

1.1 什么是标记语言

使用标记语言进行排版是程序员,尤其是Linux程序员喜欢的排版方式。相对于office word这种“所见即所得”的字处理程序,标记语言更加轻巧,灵活。常见的标记语言有HTML(排版网页),LaTex(专业级排版),wiki(维基百科一类网页使用)和Markdown(本文档使用Markdown排版)。

1.2 Iris和mtf

Iris使用的mtf标记语言是为满足模联文件写作需要设计的标记语言,现在只有4个标记用于排版(‘*’,‘#’,‘=’,‘+’,‘%’)。便于学习和使用。使用时,将对应标签放在每段的段首,程序就可以自动完成排版。排版原理是将mtf标记文件转换为html格式的文件,可以通过浏览器查看,同时可以用浏览器导出为PDF文档。

1.3 标记的使用

1.3.1 ‘=’标记

‘=’标记的含义是“标题”。使用Time New Roman字体。相比于其他文本,他的字号会大一些,为16pt。示例:

= working paper v1

1.3.2 ‘*’标记

‘*’标记的含义是“段落”。使用Time New Roman字体,大小为14pt。 注意,只有以标签开头的文字才会独立成段,回车是无效的。示例:

* Paragraph 1

* Paragraph 2

1.3.3 ‘#’标记

‘*’标记的含义是“序列”。使用Time New Roman字体,大小为14pt。以‘#’起始的段落排版时会加上数字开头的标示。几个‘#’标签段之间可以加入空行,数字的生成不会受影响,但是中间加入其它标签,数字就会重新计数。示例:

# item 1

# item 2

* new paragraph

# this item starts with "1"

1.3.4 ‘%’标记

‘*’标记的含义是“注释”。加上‘%’标签的段落在排版时会被解释成html注释。这就意味着内容不会出现在排版完成的页面上。只是为了帮助用户整理自己的写作思路。在查看生成的html源代码时也会发现这些注释。示例:

% the following item may be deleted because I think it won't make any difference.

* Paragraph 1

* Paragraph 2

2 文件管理

2.1 基本概念

  • 文档(document):一个文档,就对应着平时我们所说的一份文件,通常会包含若干个版本(tag)。每个文档会在iris程序目录下的work文件夹中对应一个同名的文件夹。
  • 版本(tag):同一个文档在不同情况下可以衍生出很多不同的版本,Iris会将每个版本保存为一个.mtf文件,并将其放入对应文档的文件夹中。

2.2 文档的操作

2.3.1 新建文档

使用工具栏上的新建按钮就可以新建一个文档,如果已有同名文档,程序会提示你重起一 5BCF 名字。

2.3.2 导入文档

使用工具栏上的导入按钮就可以导入一个文档。也可以手动建立文件夹或版本文件,但需要手动创建需要重启程序才能在文档列表中显示。

2.3.3 新建版本

使用工具栏上的新建版本按钮就可以新建一个版本。程序会将你正在编辑的内容保存到新的版本文件中,原文件不会保存这些更改。

2.3.4 导出

使用工具栏上的导出按钮就可以将当前的版本导出为html文件。

3 协议

本程序及文档使用GPL v3协议发布

GPL v3: http://www.gnu.org/licenses/gpl.html

About

Iris: MUN documents editor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0