人力検索はてな
モバイル版を表示しています。PC版はこちら
i-mobile

Wikiの記法でページを表示させる実装について悩んでいます。

ページ内で画像を表示させる記法についてなのですが、もともと別ページへリンクさせる記法が他のWikiシステムと同様、

[[リンク先]]

というやり方なので、単純に

[[image:file.jpg 画像のコメント]]

という記述で画像表示するやり方を当初は考えてました。
ただ、このやり方だとページの編集時に、文章の行と、画像表示の行がどちらなのか、直感的に判別しにくいと考え、以下の記法を思いつきました。

行の先頭で、
@image:file.jpg 画像のコメント

個人的にはこの方法が見やすくてよいと考えているものの、他の方から見た場合、果たしてどちらの方法がよいとお考えでしょうか?その理由もお聞かせ願えると助かります。

上記以外のやり方もあれば是非。
よろしくお願いします。


※なお、文章と画像の行は完全に分離させるので、文章中に[[image:?]]を含めて、同じ行に画像と文章を混在させることは想定していません

●質問者: wankodon
●カテゴリ:インターネット ウェブ制作
○ 状態 :終了
└ 回答数 : 3/3件

▽最新の回答へ

1 ● oil999
●34ポイント
[[image:file.jpg 画像のコメント]]

の方が良いです。

WikiやHTMLのようなタグ記法では、どこからどこまでがタグの範囲なのかを明確にする必要があります。そして、範囲を区切るのに制御文字(改行を含む)を使わないという暗黙のルールがあります。
この前提で考えると、
@image:file.jpg 画像のコメント
のように改行に頼るのはよろしくありません。

質問者の方は「文章と画像の行は完全に分離させる」と書いておられますが、これはタグ記法の定義に含まれない運用ルールなので、その意味でも改行で範囲を区切るのはよろしくありません。
運用がどうあれ、タグ記法の定義ですべての条件を満たす方がベターです。


wankodonさんのコメント
なるほど。そういう考え方もありますね。 回答有り難うございます。

2 ● TransFreeBSD
●33ポイント

私は「@image:file.jpg 画像のコメント」の方がいいですね。
こちらの方が「文章と画像の行は完全に分離させる」と言うことが明確になって良いです。
この条件では行全体が画像に関する内容なので、終了位置の指定があっても冗長なだけですし。
ただ、開始が「@image:」で良いのか(長さとか多用する機能は短い方が良いが、記号が増えたり略が多すぎると分かりにくくなる。使用頻度や機能数とのバランス)
ファイル名とコメントの分割はスペースで良いか(ファイル名にスペースが使えなくなる)
等、他の機能とのバランスも考えて検討すべき点はあるかもしれません。


wankodonさんのコメント
仰るとおり、見やすくなることのメリット、学習コストが上がるデメリット等々ありますが、まだ模索中ですのでじっくり考えて行こうかと思います。 回答どうも有り難うございます。

3 ● taroe
●33ポイント

image:file.jpg 画像のコメント?
@image:file.jpg 画像のコメント

前者はエンジニア受けするだろうし
後者は一般受けすると思います。

個人的には、後者で問題ないと思います。

WIKIのシステムをあまり知らないのですが、
前者は、なんか、はてな記法っぽい感じですね。

あと、wikiでも画像表示はプラグインで表示させるパターンだと
後者の記法に近いと思います。


後者で懸念が残るのは、
どこで終了するかを判別しにくいということです。

画像コメントが必須で省略できないのなら問題ないでしょうが
省略できるのなら、今後、拡張するときに問題がでると思います。


>文章と画像の行は完全に分離させるので、文章中にimage:??を含めて、
>同じ行に画像と文章を混在させることは想定していません

現状はこれなので問題がないのですが、
将来混在することになっても、対応できるようにしておけば
どっちが良いとかいうことを考えることもなく
後者を現状で決定することが可能だと思います。



■結論
@image:file.jpg 画像のコメント
の記述のほうが一般受けする出そうし、使い勝手もよいと個人的には思う。


wankodonさんのコメント
他のWikiのプラグインは後者のパターンなんですか。いいこと聞きました。 参考にしてみます。回答どうも有り難うございました。
関連質問

●質問をもっと探す●



0.人力検索はてなトップ
8.このページを友達に紹介
9.このページの先頭へ
対応機種一覧
お問い合わせ
ヘルプ/お知らせ
ログイン
無料ユーザー登録
はてなトップ