metadata: title : Outlined YAYADoc マニュアル title_en : Conversion from Outline to YAML author: surname : 随風 firstname : 老師 name_en : zuihuroshi email : affiliation: org : org_en : Project PaoPei pubdate : Last modified: summary : プレイン・テキストのアウトライン文書をYAMLに変換します。 keywords : Outline,アウトライン,YAML,文書作成,構造化文書,Plain Text,プレイン・テキスト,ポストXML,Post XML ■Outlined YAYADoc#id1 ●見やすく、書きやすい構造化文書#id2 C は、エディタで編集しやすいように、マークアップを極力排除した構造化文書です。 ヘッダー行をタブ・インデントするだけで、入れ子の章節構造が簡単に作れます。 ●各種エディタのアウトライン・モードに適合#editor1 秀丸、サクラエディタ、WZエディタなど、各種エディタのアウトライン・モードに適合します。お好みのエディタでサクサク編集できます。 ヘッダーの書式は、ユーザーの好みに応じて、任意に設定できます。デフォルトでは、■や●などの記号で始まる行がヘッダーと解釈されます。 ●表組みやリストも簡単#easytable 面倒なタグ付けなしで、表組みができます。リストのネストも、インデントだけで簡単に指定できます。 ●YAML技術を使用 アウトライン・テキストは、ポストXMLとして注目されているLに変換されます。YAMLフォーマットは見読性と汎用性が高く、また、処理が非常に軽いため、これをピボットとして、XMLやHTMLなど様々な文書形式に変換して再利用することが容易です。 ■実例 ●章節構造と段落 長編小説のような「第１章　第１節………」という章節構造を、ヘッダーとインデントで指定することができます。構造は、入れ子になります。((-DocBookの C, C .. .. C に対応します。-)) ヘッダーは、行頭に０個以上のタブ・インデントと■や●などの記号で始まります。記号は、次の正規表現に含まれるものが使えます。((-プログラムのパラメータを変更することで、ユーザーが任意に設定することもできます。-)) ([■□▲△▼▽◆◇○◎●☆★・§] |[【〔［｛〈《「『【＃＊♯♪†‡¶！] |[\[\*] |[0-9A-Za-z]+\.) 章や節のナンバリングと目次の作成は、HTMLに変換するときに、システムが自動的に行います。 段落のタブ・インデントは、ヘッダーよりも一段深くします。段落は、１行以上の空行((-０個以上のタブと１個の改行マークだけからなる行。-))で区切ります。 こうした章節構造や段落の指定の仕方は、エディタをオートインデント・モードにして文章を書くと、自然に行われるものです。Cは、タグ付けに注意を奪われずに、文書作成に集中できて、しかも自然に文書が構造化されるシステムをめざしています。 インデントには、デフォルトではタブのみが使えます。((-プログラムのパラメータを変更することで、ユーザーは、たとえば半角スペースや全角スペースなど、タブ以外のインデントを指定することもできます。半角スペースをインデントに使う場合、整形済みブロックは、行頭に'C<=begin text>'のある行から、行頭に'C<=end text>'のある行までの間になります。-))半角スペースでインデントした行は、段落ではなく、整形済みブロックになります。[R
参照]

		ソース：
        ■第１章　はじめに
        [tab]第１段落
        [tab]
        [tab]第２段落
        [tab]●第１節　ごあいさつ
        [tab][tab]第１段落
        [tab][tab]
        [tab][tab]第２段落

	●リスト
		番号なしの箇条書きは、文のはじめに'C<->'（半角のマイナス記号）を入れます。はじめに'C<+>'（半角のプラス記号）を入れると、番号付きになります。番号なし・番号付きは、混在してもかまいません。
		
		リストのレベル（深さ）は、タブ・インデントで指定します。

		たとえば、こんな複雑なリストも作れます。
		- listitem1
			- listitem1.1
				- listitem1.1.1
					
					段落をリストの中に作れます
					
					paragraph2
					
					paragraph3
					
				- listitem1.1.2 リストのインデントは厳密に！
				+ 番号付リストを混在させられます。
				+ numbered 2

		ソース：
            - listitem1
            [tab]- listitem1.1
            [tab][tab]- listitem1.1.1
            [tab][tab][tab]
            [tab][tab][tab]段落をリストの中に作れます
            [tab][tab][tab]
            [tab][tab][tab]paragraph2
            [tab][tab][tab]
            [tab][tab][tab]paragraph3
            [tab][tab][tab]
            [tab][tab]- listitem3.3.3 リストのインデントは厳密に！
            [tab][tab]+ 番号付リストを混在させられます。
            [tab][tab]+ numbered 2
            [tab]- listitem3.4
            - listitem4

	●用語定義
		CのCに対応する用語定義は、インデントに続くC<:>（半角コロン）ではじまります。定義用語と定義の間にも、C<:>を入れます。
		
		インデントの深さは指定できますが、入れ子にはなりません。定義にリストは使えません。
		
		!注意：用語が空であってはなりません!用語部分が空である場合には、整形式のDocBooK XMLに変換されません。定義は空であってもかまいません。

		:用語１:定義１
			:用語２:インデントはできますが、ネストはしません。
				:用語３:
					ぱら
					
					パラ

		ソース：

          :用語１:定義１
          [tab]:用語２:インデントはできますが、ネストはしません。
          [tab][tab] :用語３:
          [tab][tab][tab]ぱら
          [tab][tab][tab]
          [tab][tab][tab]パラ

		　●定義中に段落を切ることができます。定義中にリストは使えません。

	●警告文
		インデントに続くC（びっくりマーク）ではじまる行は、警告表示に整形されます。
		
		!警告の表題!警告内容

		ソース：

        !警告の表題!警告内容

	●整形済みブロック#PRE
		ひとつ以上の半角スペースではじまる行は、整形済みブロック((DocBookのCやHTMLのC
に対応します。))になります。

 ここから
   …………
     ………… …………
       ………… ………… …………
        ………… ………… ………… …………
         ここまで           整形済みです

		ソース：
 ここから
   …………
     ………… …………
       ………… ………… …………
        ………… ………… ………… …………
         ここまで           整形済みです

	●ファイルの差し込み
		行頭のC<>>>>に続いて、ファイル名を指定すると、ファイルを読み込んで、整形済みブロックとして表示します。タブ・インデントがあってもなくても、かまいません。

		次のブロックは、ファイルから差し込んでいます。

		>>> ../var/ayaya/chapsec.ya

		ソース：

		> >>> ../var/ayaya/chapsec.ya

	●引用（ブロッククオート）
		行頭にタブ・インデントに続く半角または全角のC<>>記号のある行は、ブロッククオートされます。
		
		ブロッククオートは、インデントにより、入れ子にできます。
		> 引用１
			> 引用２
				> 引用３

		ソース：
        > 引用１
        [tab]> 引用２
        [tab][tab]> 引用３

	●表組み
		表組みとなる行は、タブ・インデントに続く'C<|>'ではじまります。表題行をいれるときは'C<|=>'ではじめます。表題は、シリアルナンバーをつけて表示されます。
		
		コラムの区切りも、'C<|>'です。行末の'C<|>'は不要です。先頭（左端）コラムが'C<|:>'ではじまると、ヘッダー行になります。

		|=表組みの例
		|: 第１列 | 第２列 | 第３列
		| 1.1 | 1.2 | 1.3
		| 2.1 | 2.2 | 2.3

		ソース：

        |=表組みの例
        |: 第１列 | 第２列 | 第３列
        | 1.1 | 1.2 | 1.3
        | 2.1 | 2.2 | 2.3

	●図
		挿入した図にシリアル・ナンバーをつけて表示することができます。

■インラインのマークアップ
	強調文字、文中に画像を表示する、ハイパーリンクなどのインライン・マークアップは、POD風の簡単な記法を使います。一部RDやPukiWikiの記法にも対応しています。
	
	●ハイパーリンク
		ハイパーリンクは、POD式・L式・L式に対応しています。PukiWiki式では、ASINコードによるAmazon自動リンクに対応しています。
		
		  [[ASIN:0201896842:image]]  [[The Art of Computer Programming:ISBN:0201896842]]
		
		  L
		
		ソース：
        PukiWiki式
        [[ASIN:0201896842:image]]  
        [[The Art of Computer Programming:ISBN:0201896842]]
        
        POD式
        L

		書式：

        POD式
          L

          L
        
        RD式
          (())            'URL:'の後にhttp://....を書きます
          (())
        
        PukiWiki式
          [[address]]
          [[anchor:address]]
          [[ASIN:code]]                'ASIN:'または'ISBN:'の後に
          [[anchor:ASIN:code]]         10桁のコードを書きます
          [[ASIN:code:image]]          画像付き
          [[ASIN:code:image:small]]    サムネイル付き

		URLを自動的にリンクにする機能はありません。


	- このマニュアルのソースはL<こちら|/yayadoc/archives/manual.txt>です。