目次 このページのソースコードを表示

特徴

公開日:
更新日:

ここでは, OutlineTextの特徴を示します.

OutlineTextの特徴は以下のとおりです.

  • プレーンテキストでの見た目がそのままウェブページに反映
  • 文章のアウトラインを見えやすく
  • 見た目が分かりやすい文章は，読みやすく書きやすい
目次

プレーンテキストでの見た目がそのままウェブページに反映

まず, 初めにOutlineTextのソースコード, その次に実行例を示します. 

        
        # section
        ____________________________________________________
            # list
                * item0
                * item1
            
            # orderd-list
                1. item
                2. item
            
            # table
                |[caption]
                | A || B |
                |---||---|
                | C || D |
        
            # inline
                `hello` **important** //emphasis// __mark__ ~~strike~~
        
            # code
                ```cpp
                    printf("Hello world");
                ```
実行例

section

list
  • item0
  • item1
orderd-list
  1. item
  2. item
table
caption
A B
C D
inline

hello important emphasis mark strike

code
                    printf("Hello world");

インデントがインデントとしてそのまま出力され, プレーンテキストと出力結果の図形が同じです.

記法では, 出力結果と見た目が同じになるようなそのほかの軽量マークアップ言語(マークダウン等)を参考にしています.

文章のアウトラインを見えやすく

インデントによる整形で, 文章を作成中では, アウトラインを考えながら文章を作成できるようになります. 

        
        # 大見出し
        ____________________________________________________
            見出しは`#`のほかに`_`で見出しとすることができます.
        
            # 小見出し
                # 小小見出し
                    ここまで行くことはまれ.
        
        # 大見出し
        ____________________________________________________
            リスト表記のサンプル
            
            * アイテム0
            * アイテム1
            * アイテム2
            
                
        # 大見出し
        ____________________________________________________
            ツリー表示してみよう.
        
            + ディレクトリ0
                + サブディレクトリ0
                + サブディレクトリ1
                + サブディレクトリ2
            + ディレクトリ1
                + サブディレクトリ0
            + ディレクトリ2
            
        
        # 大見出し
        ____________________________________________________
            テーブル書いてみた.
        
            |[テーブル例]
            |  アウトライン    || 重要だと   |
            |------------------||------------|
            | 思うん           ||  です.     |
        
        
        # 大見出し
        ____________________________________________________
            ついに最後のセクションになりました.
        
            では! `exit();`

実行例

OutlineTextはインデントが重要です. インデントが一つ増えると, セクションのレベルが一つ上がります. 逆もしかりです.

インデントによって, 文章の構造がわかりやすくなります. インデントが一つ上がるのは, 文章で階層が一つ上がるのと等価です. 今, 書き手がルートからどれだけ掘っているのかわかりやすくなります( コーディングのときにインデントをしていくのと同じだと思います).

アウトラインレベルについて

OutlineTextでは, インデントの個数でアウトラインのレベルが決まります. 一番上の層のレベルを0として, 深くなるごとにレベル数は上がります.

同レベルに存在するものをまとめて"セクション"と呼びます. セクションの中にはセクションを置くことが可能です. その場合, 中に含まれているセクションのタイトルを, 含んでいるセクションに置き, 含まれている方のセクションは一つレベルが上がります.

アウトラインレベル概念図
アウトラインレベル概念図

見た目が分かりやすい文章は，読みやすく書きやすい

タイトル通りで，見た目が分かりやすい文章は，読みやすく書きやすいと思います[注 1]．書く段階から，見た目が分かりやすい文章を書くことを重視して，出来上がった文章をOutlineTextがさらに見やすくしてくれるという考えです．

注釈

  1. ^ 筆者独自解釈
「https://contentsviewer.work/Master/OutlineText/Features」から取得
文法一覧