「WikiNotation/」で始まるページを作成

記法案。それと記法の実装案。
  • -----------------------------------------------

目次 Edit

関連 Edit


記法定義は汎用記法シンタックスシュガー

検索:WikiNotation

汎用記法は全ての要素を表現できる記法。要素クラス名をパラメーターとして受け取れる。

WikiNotation周辺のタグ Edit

Array
ToMarkdown()などを持つのはビルトイン要素。

プラグイン要素はそういった記法系に無い。汎用記法と、それにマッピングしたシンタックスシュガーでのみ表記できる。

WikiNotationとは Edit


プラグイン呼び出し記法シンタックスシュガー

呼び出すプラグインごとに定義。1つのプラグイン呼び出しについて複数WikiNotationを定義していい。
  • -
----
*
**
***

記法 Edit


記法は読むためのもの。書くためのものではない。
&(...);
#...

:i/記法定義は記法→要素クラス→記法 Edit

:Done/記法定義の方法 Edit

:i/ページの内容はコードと見なせる Edit


記法はコードのようなもの。実行結果がページの閲覧時に組み込まれる。

他の言語のコードを書くのならシンタックスハイライトとか自動リンクとか。コンテンツ扱い。実行のようなことはしないで。

などのWiki特有の書き方のこと。

それと、これらの書き方で書かれたテキストのこと。

マークダウン」などと同じ用途・目的。→キーワード:Markdown Google:Markdown

WikiTextもWikiFormatも同じ意味で使われていそう。

ここではWikiNotationを含むテキストをWikiTextと言うことにしている。

Google:Wiki-Notation

Google:Wiki-Format

Google:WikiText

Google:Wiki Formatted Text

Markdownの特徴 Edit


http://space.hatena.ne.jp/pmint/entry/14218542507645637066

実体はプラグインの呼び出し方(プラグインを呼び出したいときの書き方)。

→ X/Element/Notation[?]

思い付き Edit

Excel関数を参考に Edit

ページ見出しを、リンクする/されるの両方に Edit


ページ名を表す記法見出しを表す記法を用意。

段落始めに書けばページ名見出しを定義する。それ以外に書くと指定したページ見出しへのリンクになる。

タブでインデントしたい Edit


テキストエディターを使うとインデントしやすくなる。

見えない文字は無視したい Edit


使うとすれば記法を越えない程度に。

空白を取り除いても同じ記法になるように。

検索用クラスやめ Edit


検索」に書かれているクラスを廃止。

Notationクラスで行う。

Notationの機能…
  • 検索式→オブジェクトの単行表現
  • ページのテキスト→オブジェクトの複数行表現
  • オブジェクト同士を比較したときの適合度算出
    具象クラスが同じ場合も先祖が共通の場合も使える。

    先祖が共通の場合は適合度がやや下がる。

    クラスメソッド。
  • オブジェクト→テキスト(HTML)

…といったことができる。

プラグイン検索時の比較方法もメソッドとして持つ。 Edit


色とか。色プラグイン(色を示す表現を色オブジェクトに置き換えるプラグイン)色を示すWikiNotationプラグイン
#FFF
White

…などが
#FFC

などと近く(高い適合率)になるように。

WikiCreole Edit


WikiCreoleを導入(準拠)するなら日本語キーボードでのかな漢字変換向けマークアップ+WikiCreoleに。

WikiCreoleに含まれるWikiNotationはカスタマイズ不可でいい。

ページ編集ページで「WikiCreoleが使える」と一言明記。
WikiCreole
http://www.wikicreole.org/

チートシート

creole_cheat_sheet.png

リンクPukiWikiと同じ。MediaWikiとは違う。

箇条書きはMediaWikiと同じ。PukiWikiとは違う。

{{…}}の中がページ名として存在するなら埋め込み(includeプラグインと同じ効果)にしてもいい。…[?]リンク、{{…}}は埋め込みということにする。

(拡張子で画像かページ名か判断するのは良くない。不確かなので。せめてMIMEコードを取得して判断しないと。)

改行は無視。

でも連続した改行(空行)は反映する。

改行をしたいときは
を付けなければ反映されない。これは画面の大小に関わらず誰にでも読みやすくするためか。

ヘルプは初心者向けのみ Edit


詳細な説明なら定義ページを見ればいい。

変換ルールはページ内で定義 Edit


WikiNotation→内部形式(Element系オブジェクト)のルール

RegExp→Element系クラス名

…という形式で定義。

1ページに1クラス分の複数書式を定義。ページ名と対応するクラスはハードコーディング(変更不可能)で良い。

それらをまとめたページを作ればWikiNotation定義の一覧になる。

変換前/後が何であるか、何をどうするのかの違い。

いろいろな記法 Edit


参考に Edit


WikiCreole: List Of Wiki Markup

WikiMatrix - Compare them all

Help:Cheatsheet - Wikipedia, the free encyclopedia

でも、Notationを単なる 正規表現→プラグイン名とパラメーター とすれば1ページにいくらでもまとめてもいいかも知れない。

例外がなければ。

記法/ Edit


Notation定義を参照するときのキーは?

特定ページ、または特定のページ以下にあるページ集合?

実装 Edit


埋め込み式ページ[?]を応用して実装。

WikiNotationを、「プラグイン呼び出し記法が書かれたページ」を埋め込むことで実現できる。

そうすればWikiNotationプラグイン呼び出しをページで定義・カスタマイズできる。

…というのはパラメーターなしのプラグイン呼び出しだけ。

ほとんどのNotationはWikiNotation/定義に書かないといけない。

色々な記法 Edit

  • 単行テキスト
  • 複数行テキスト
  • メールアドレス
  • URL
    http:、https:、ftp:のほかtwitter:なども。
  • 数値と計算式とフォーマット
    金額とか。
  • 日時と計算式
  • 時間(日時×2)と計算式
  • 選択・列挙
    文字列の列挙、列挙されていない値は持てない。選択可能数1または任意個。
  • ページ任意数
    とフィルタリングルール。フィルタリングで特定のページだけを選択肢に。ユーザー限定など。

    添付ファイル、添付イメージなどはページとして記述。

どこでもWikiNotation Edit

特別なNotation Edit


プラグインではないもの。特別扱いする必要のあるもの。

種別、影響範囲 Edit


WikiCreoleの実装にも適用。

影響範囲の小さい順に行修飾、文字修飾、段落…。

影響範囲が重なっている部分では、範囲の小さいWikiNotationが優先される。

以下、影響範囲の小さい順(優先度の高い順)
  1. 行修飾、ライン
    改行間の全てに影響。

    行頭に書く。行頭を含むNotation。1行にしか影響しないのは行頭に書くものなので。書き方の問題。
    **見出し
  2. 行修飾(連結)
    行頭。で次の行も同じNotationならまとまる。というよりも前の行が同じなら連結。(もし衝突があったとしても)前の行の属性が優先されるので。
    -リスト
    -リスト
  3. 文字修飾、インライン
    どこからでも開始できる。

    改行を越えて影響するため、行修飾よりも広範囲。
    //斜体//
  4. 段落修飾、パラグラフ
    空行(連続改行)間で有効。

    空行後に書く。というか、空行が無くてもこのNotationからを段落とみなす。

    少なくとも行頭に書く必要あり。このNotationだけで1行。というか改行を含むNotation
    >>
    引用(brockquote)

    末尾を<<で終わらせるようにすれば段落を越えられるが…→連結するので、越えなくていい。書くときに手間がかかるが閲覧時の見た目は一緒。影響範囲が分かりやすくなる。

    斜体などの段落があってもいい。
  5. 段落修飾(連結)
    段落修飾は全て連結可能にしていいはず。ゆえに段落修飾はどれも連結する。
  6. ページ
    1ページ全体に影響。なので、どこに書いてもいいが専用欄を設けてもいい。

    ページ冒頭か末尾に書くのが簡単?
  • -------------------------------------

行頭後・空行後に書くものは改行処理前に解釈。それ以外は改行処理をした上で解釈。ただ空行は残すので空行後の物は改行処理の後でもいい。

改行→<br/>をする設定でもしない設定でも、文字修飾は改行を越える。空行も越えられるが…→WikiCreoleに合わせて越えないようにする。影響範囲が分かりやすい。

曖昧なWikiNotationを解釈 Edit


書き手の意図を反映させるように。

記号の前後は必ず何らかの効果が現れるように。

 **リスト

で、

 …**太字**

のとき、

 …**B**B**… → …<b>B</b>B**…

 **B**… →<b>B</b>… または <li>B**…

 **…**B**… → <li>…<b>B</b>…

 **B**…**B**… →<b>B</b>…<b>B</b>… または <li>B<b>…</b>B**…

正しくは

 ****B** → <li><b>B</b>

ユーザーが入力した情報が失われてしまうのを防ぐため、余ったNotationは消さずに残す。

bとして解釈できる場合、行頭の**を2つの意味で捉える?

 **B** →<li><b>B</b>

他のケースで使いにくく(結果を予想できなく)なってしまいそう。

設計 Edit

WikiNotationが含むもの Edit