Top > 改行に関する検証と議論まとめ

改行に関する検証と議論まとめ
HTML ConvertTime 0.288 sec.

改行に関する検証と議論まとめ Edit

  • このページではsWikiにおける改行の仕様を検証・議論した内容をまとめています。
  • 当wikiでの改行の扱いについては議論の結果をまとめたコメント欄における改行についてを参照してください。
  • 検証・議論はComments/編集会議室Vol15で行われました。
    • 提案木:2022-08-27 (土) 19:35:48
    • 改行に関する説明ページの木:2022-09-01 (木) 01:54:51
      • 議論木の【枝8】に統合
    • 議論木:2022-09-02 (金) 18:42:01

改行の仕様 Edit

改行に関する用語の整理 Edit

改行に関連する用語が個人で異なったり混同される恐れがあるため定義・用語を整理する

名称説明
改行行送り(Enterキー等)による改行、今回の議論のターゲット
改行コード改行を示す文字コードのこと(LFやCRLF)、利用者側で意識することはほぼ無い
改行プラグイン
(BRプラグイン)
sWiki編集やコメント欄で明示的な改行を行う場合に入力する文字(半角で&br;)
この改行プラグインによる改行は後述の問題点を引き起こさず、ガイドライン上でも使用に問題はない
#BRも改行を行うプラグインだが、こちらは行頭でのみ意味を持つため今回の議論には関わらない
参考:sWikiマニュアル:改行
改行タグ改行や改行プラグインによって出力されるhtmlタグ(<BR />)のこと
直後に行頭書式がある改行はこのタグへの置き換えが行われないためレイアウト崩れの問題に繋がる
行頭書式
プラグイン
wiki編集において行頭に指定する装飾や機能設定のための記号や文字
改行の直後に存在するとレイアウト崩れに繋がる(改行の問題点を参照)
例:(~、-、+、:、>、|、//、半角スペース、#から始まるプラグイン等)
参考:sWikiマニュアル

改行の問題点 Edit

  1. コメントページの容量の話
    • 改行が容量を圧迫するのではないか
      • コメントページは150KBを超えると書き込みが出来なくなるが、改行コード自体は1-2バイトに過ぎないため全く問題はない
      • おそらく行数の問題と混同した話なのではないかと思われる
  2. コメントページの行数の話
    • コメントページは行数(2000行が基準)によって次のコメントページ設置を促す警告が表示される
      • 第1段階(6割強):コメント件数の上限が近づいています。ページを新設して下さい。
      • 第2段階(7割弱):コメント数が限界です、至急ページを新設して下さい。
    • 改行も1行と数えられるため、改行が増える事で警告の表示が早まり、結果としてページの更新が早くなる
  3. 改行によりレイアウトが崩れる
    • 改行が行われた直後に行頭書式やプラグインが存在した場合、コメント欄のレイアウトが崩れてしまう
    • 改行によりレイアウトが崩れる例(Comments/sandboxVol3に練習コメント有り)
      • 二重改行
      • 先頭の改行
      • 改行直後の行頭書式やwikiプラグイン(~、-、+、:、>、|、//、#~など)

改行制御に関係するwikiの仕様 Edit

  • #setlinebreak([on|off|default])プラグイン
    • ページの埋め込んだ場所以降に対して改行の表示を制御できる
      • 既存のページ先頭に埋め込んだ場合は、記入箇所以降の既存の内容全てが影響を受ける
      • コメントページに埋め込んでも、コメント欄設置元ページから見ると適用されていないように見える
      • 左MenuBarの表示も影響を受ける。右側ページでoffにした場合、MenuBarページではonにする必要がある
    • onの場合(既存の動作)、改行は改行タグに置き換えられる。見た目上も改行されているように見える
    • offの場合、改行は置き換えられない。見た目上は連続した文字列、または半角スペースがあるように見える
      • 明示的に改行させたい場合は改行の直前に半角チルダを置くと改行される
      • 改行プラグインを使用した場合はその箇所で改行される
      • 二重改行や多重改行、行頭の改行はonと変わらずレイアウト崩れが発生する
      • MenuBar部の表示も影響を受けてしまう、MenuBar側にonの設定を埋め込む事で対応可能
      • アップロードした画像の表示位置が変わる。コメントの次行→コメントの右側
    • ページ表示時点の設定により改行の表示を切り替えている。書き込んだ時点の設定が内容に反映されるわけではない事に注意
    • wiki単位で管理人がデフォルト値を設定する事が可能な模様、現状ではこの設定がdefault=ON=改行可に設定されている
      • 公式マニュアルより>>PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります
      • この設定の変更がwikiの全ページに影響するかは未検証だが、おそらくそうなると思われる
      • 管理人よりwikiの設定として変更は不可能との返信有り(2022-09-01 (木) 13:34:10)
      • 参考:Comments/編集会議室Vol13の2021-10-14 (木) 21:18:37の書き込み、「$line_break」と同じ設定と思われる
      • 参考:sWiki公式説明ページ
  • コメントページで利用できるかどうかの検証結果
    • 改行数の問題:内部的に元のデータを保持しているとする説が正しい場合、改行数に影響が無いため問題の解決には利用できない
      • 一応、改行修正に伴うやり取り(改行修正しました→ありがとう 等)での行数消費はなくなる
    • レイアウト崩れの問題:offの場合でもレイアウト崩れが発生するため問題の解決には利用できない
    • コメントページに設定した場合でも、コメント欄を設置している大元のページから見ると設定は反映されていない
      • おそらくincludeのような処理の中で、大元のページ側の設定が優先されていると思われる
      • 見た目を合わせるには大元のページ側でも同じ設定が必要だが、当然そちらの内容も改行制御の影響を受けてしまう
    • 表示上改行が見えなくなるため、意図しない改行を修正する編集者の負担やトラブル発生は軽減される
 掲示板で利用できるかの検証

結論

  • 既存の改行を抑制する理由となっていた問題の解決には利用できない
  • 全てのコメントページへの適用は現実的ではない
    • 見た目上の改行を抑制するとしても大元のページのレイアウトが影響を受けてしまう
    • 改行修正の問題と関連し、一部掲示板に対して改行を表示上抑制する用途であれば議論の余地がある

改行の取扱いに関する議論(2022/08~) Edit

 検証・議論のまとめ


ホーム リロード   新規 下位ページ作成 コピー 編集 添付 一覧 最終更新 差分 バックアップ 検索   凍結 名前変更     最終更新のRSS