Skip to content

helpのoptionを決め統一する #24

Description

@koron

#22 を受けての話。

いくつかの要因でユーザにとっての見え方が、統一されてないっぽい。
それを統一するための基準(optionが主)を決め、それを各ファイルに徹底しましょう。

決めた内容はWikiに書き、各ファイルに適用し終わった時点でこのissueは終わったものとみなします。

Activity

  1. koron commented on Apr 7, 2012

    @koron
    MemberAuthor

    #23 で出たように tw=78 で統一しましょう。その他のオプションは要検討。

  2. koron commented on Apr 7, 2012

    @koron
    MemberAuthor

    一つ前のコメント、#23 と #22 で間違えていた。

  3. koron commented on Apr 7, 2012

    @koron
    MemberAuthor

    現時点の最新のhelp (en)の書式設定を精査した。結果、下記の通り分類した。

    A00| vim:tw=78:ts=8:ft=help:norl:
    
    A01| vim:tw=78:ts=8:noet:ft=help:norl:
    A02| vim:tw=78:ts=8:sts=4:ft=help:norl:
    A03| vim:tw=78:ts=8:ft=help
    
    A10| vim:tw=78:sw=4:ts=8:ft=help:norl:
    A11| vim:tw=78:sw=4:ts=8:ts=8:ft=help:norl:
    
    B01| vim:tw=78:ts=8:ft=help:fdm=marker
    B02| vim:tw=78:ts=8:ft=help:norl:fdm=marker
    
    C01| vim:tw=78:fo=tcq2:ts=8:ft=help:norl:
    C02| vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:ft=help:norl:
    
    D01| vim:tw=78:sw=4:sts=4:ts=8:ft=help:norl:
         vim: set fo+=n :
    D02| vim: textwidth=78 nowrap tabstop=8 shiftwidth=4 softtabstop=4 noexpandtab
         vim: filetype=help
    

    A00が大半を占める。おそらくこの設定で統一しようとしている推測される。よってそれ
    以外のものは統一できない、していない事情があると推定すべき。あるいは単に忘れい
    ているか。

    A01, A02, A03はA00の亜種で各1つ設定が増えているか、減っている。あまり深い意味は
    無いとおもわれるのでA00に統一してしまって良いハズ。

    A10, A11はsw=4が増えているのでA01-3と同じと考えて良い。ただちょっと数が多いので
    分けておいた。A11はA10に比べてts=8の指定がダブってる。単なるミスだろう。

    B01, B02はfdmの指定がある。プラグイン系のドキュメントに共通して見られる特徴。仮
    に利用しているなら他のhelpとは混ぜるべきではなさそう。B02はnorlの有無。norlを付
    けるのは比較的新しいトレンドのようだ。

    C01,C02はfo=tcq2の指定が特徴的。C02はiskの設定が目を引く。C02は1つのファイル
    (help.txt)でしか見られない記述。

    D01, D02はそれぞれその他と大きく異なり2行にわたる。D01はA02, A10の合成に加えて
    foへの変更という構成。D02は…かなり冗長ではあるが実際設定されている内容はA系全
    部入りに加えてnowrapというあたり。

    なお各分類に属するファイル一覧は以下のとおり。

    A00
      arabic.txt autocmd.txt change.txt cmdline.txt debug.txt develop.txt diff.txt
      digraph.txt editing.txt eval.txt farsi.txt filetype.txt fold.txt ft_sql.txt
      hangulin.txt hebrew.txt helphelp.txt howto.txt if_cscop.txt if_ole.txt
      if_perl.txt if_pyth.txt if_ruby.txt if_sniff.txt if_tcl.txt indent.txt
      index.txt insert.txt intro.txt map.txt mbyte.txt message.txt motion.txt
      netbeans.txt options.txt os_amiga.txt os_beos.txt os_dos.txt os_mac.txt
      os_mint.txt os_msdos.txt os_os2.txt os_risc.txt os_unix.txt os_vms.txt
      pattern.txt pi_gzip.txt pi_paren.txt pi_spec.txt print.txt quickfix.txt
      quickref.txt quotes.txt recover.txt repeat.txt rileft.txt russian.txt
      scroll.txt sign.txt sponsor.txt starting.txt tabpage.txt tagsrch.txt term.txt
      tips.txt uganda.txt undo.txt usr_01.txt usr_02.txt usr_03.txt usr_04.txt
      usr_05.txt usr_06.txt usr_07.txt usr_08.txt usr_09.txt usr_10.txt usr_11.txt
      usr_12.txt usr_20.txt usr_21.txt usr_22.txt usr_23.txt usr_24.txt usr_25.txt
      usr_26.txt usr_27.txt usr_28.txt usr_29.txt usr_30.txt usr_31.txt usr_32.txt
      usr_40.txt usr_41.txt usr_42.txt usr_43.txt usr_44.txt usr_45.txt usr_90.txt
      usr_toc.txt various.txt version4.txt version5.txt version6.txt version7.txt
      vi_diff.txt visual.txt windows.txt workshop.txt
    
    A01
      if_lua.txt
    
    A02
      if_mzsch.txt
    
    A03
      pi_tar.txt
    
    A10
      debugger.txt gui.txt gui_w16.txt gui_w32.txt gui_x11.txt mlang.txt remote.txt
      spell.txt syntax.txt
    
    A11
      os_qnx.txt
    
    B01
      pi_getscript.txt pi_vimball.txt pi_zip.txt
    
    B02
      pi_netrw.txt
    
    C01
      os_390.txt os_win32.txt
    
    C02
      help.txt
    
    D01
      todo.txt
    
    D02
      ft_ada.txt
    
  4. koron commented on Apr 7, 2012

    @koron
    MemberAuthor

    今後の方針

    A00+改 に統一し、どうしてもダメなやつだけ2行目で対応、というのが良いんじゃなかろうか。help.txtのisk設定はなんでこうなってるのかちょっと気になる。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions