在写代码的时候,有些逻辑上的东西需要在代码写完时立即记录,以前一直是写个.txt文件来记录,或者写一个word文档来记录,但这种方式总觉得不太好,用.txt记录很多格式,图片,链接无法保存,用.doc记录又觉得麻烦,长时间后,文档记录的兴趣也没有了。
注意到Eclipse的右键菜单里面有一个WikiText选项好久了,但一直不知道他是做什么用的,花了一些时间查了一下这个,发现是用来生成一些文档的,而且用起来十分方便,格式,图片,链接都可以保留。我觉得用这个来记录写代码时的一些问题,会非常不错。
想要使用这个功能,只需建一个以.textile为后缀的文件就可以了。Eclipse会用WikiText Editor 打开它,打开后有两种视图,Textile Source和Preview,前面是用来编辑Textile格式文件的,后者就是立即预览的。现在就可以在里面输入一些内容了。写好后,在编辑区域或者文件上面右键选择WikiText-->Generate HTML就可以生成一个html文档。看起来十分文便。
如果要使用WikiText来编辑一些比较好的格式的文档,需要了解WikiText使用的语法标记,和记录方式。一般我使用Textile来编辑,以下为Textile使用的一些记录
Textile使用简介
1、段落
段落以空行分隔,产生的HTml是以<p>包围的,段落中的换行会被转换成<br>
行首的空格在Textile中有意义,如果没有空格,该段会以<p>包围,如果有空格,该行不会被Textile处理,内容会原样保留
2、符号
标点符号会被转换成对应的HTML写法,如 ' 会被转换成’两个数字中的x会被当作乘法,被转换成×
特殊的符号如商标TM用(tm) 注册®用(r) 版权©用(c)来表示
3、缩写
三个或三个以上的英文单词后面紧跟着一些字用括号括起来,生成的HTML会用acronym标签包围,括号里面的字会当作标记的title属性
而三个或以上的独立的英文字母会用span标签包围
4、链接
常规链接:"mylink text":linkurl
带有title属性的链接:"my link text(this is the title)":linkurl
如果一个链接被经常使用到,可以对这个链接进行一个定义,然后在需要时进行引用:
[aurl]:theurl
"一个引用":aurl
5、图像
常规图像:!imgurl! 或者!imgpath!
带有title属性:!imgurl(some text)!
带有链接的图片:!imgurl!:url
6、块
标题:hn. 如h1. 在.后面有一个空格
引用块:bq. 在.后面有一个空格
代码块:bc. .后有一人空格,转换成相应的HTML时,会被<pre><code> </code></pre>包围
多个块:bq.. 或bc.. .后面有一个空格 这种在生成HTML时,会将接下来的每一段都加上同样的样式,到下一个Textile标记出现为块的结束
7、修饰
em:_em_
strong:*strong*
<b>:**bold**
<I>:__italic__
cite:?cite?
del:-del-
underline:+underline+
sup:^sup^
sub:~sub~
span:%span%
code:@code@
8、样式
类属性:p(myclass).
id属性:p(#myid).
行类样式:p{color:red}
这种样式同样适用于对单词的修饰如my **(#myid)bold** word
样式可以叠加如 p(myclass#myid){color:red}
9、文本修饰:
<左对齐 eg:h1<. heading
>右对齐,
<>两端对齐
= 居中对齐
( 左缩进1 em
))右缩进2em
()左右各缩进1em
段落中的文本修饰
如果想要让this*won't*work 表示成thiswillwork 应当使用this[*will*]work
1[^st^], 2[^nd^], 3[^rd^]显示成 1st, 2nd, 3rd
2 log[~n~]显示成2 logn
A close[!/img.gif!]image.
也就是说如果要对一段文字中的某个字进行修饰请加上[]
10、表格
表格用|分隔每一个单元格,表头的单元格用|_.来修饰
|_. 1|_. 2|_.3|
| a | b | c |
表格的行样式
(rowclass). |a|classy|row|
表格的样式
table(tableclass).
|a|classy|table|
|a|classy|table|
表格对齐:|^. 顶对齐
|-. 居中对齐
|~. 底对齐
跨列:
|\2. spans
two cols |
| col 1 | col 2 |
跨行: |/3. span 3 rows|row a|
|row b|
|row c|
11、列表
有序列表#
无序列表*
多层递进列表用多个#或*
列举一些优秀的参考:
http://redcloth.org/textile/writing-paragraph-text/
http://thresholdstate.com/articles/4312/the-textile-reference-manual?ch=2#toc_1