「TSFdoc」は「TSF2KEV」を用いたドキュメントジェネレーターです。

version(branch):20170718T073839 modify:20180103W002937(執筆途中です)
ver3開発中(https://github.com/ooblog/TSF3KEV)につきver2の仕様は古くなります。

⓪-0.ライセンスの解説など

※「MIT License」準拠。

MIT License - Choose a License
http://choosealicense.com/licenses/mit/
licenses/MIT_license - Open Source Group Japan Wiki - Open Source Group Japan - OSDN
https://ja.osdn.net/projects/opensource/wiki/licenses%2FMIT_license
MITライセンスを1行1行読んでいく | プログラミング | POSTD
http://postd.cc/mit-license-line-by-line/

⓪-1.動作環境

「Tahrpup6.0.5,Python2.7.6,dmd2.074.0,vim.gtk7.4.52(vim-gtk)」および
「Wine1.7.18,Python3.4.4,dmd2.074.0,gvim8.0.134(KaoriYa)」で開発中。

※TSFdocはTSFの一部として組み込まれています。

「TSF2KEV」はプログラミング言語「TSF_Tab-Separated-Forth」のD言語とPythonによる実装です。
https://ooblog.github.io/TSF2KEV/index.html

⓪-2.インストール/アンインストール&セットアップ

gitでリポジトリ「https://github.com/ooblog/TSF2KEV.git」を「Clone」するか、
「https://github.com/ooblog/TSF2KEV/archive/master.zip」を「Download ZIP」して展開すると、
「TSF2KEV」フォルダが作成されます。

プログラミング言語「TSF_Tab-Separated-Forth」開発中。
https://github.com/ooblog/TSF2KEV

VimでTSFを編集する場合は「vimsyntax/tsf.vim」を「~/.vim/syntax/tsf.vim」にコピー。
VimでKEVを用いた漢直入力などをする場合は「メニュー→編集(E)→起動時の設定(S)」で「~/.vimrc」を開いて「filetype=tsf」や「:!TSF %」を追記。


   syntax on
   au BufRead,BufNewFile *.tsf set filetype=tsf
   autocmd BufNewFile,BufRead *.tsf nnoremap {?<}F5{?>} :!TSF %{?<}CR{?>}
   command KEV2tsf  :source ~/TSF2KEV/KEV2/kanedit.vim
   

Vimエディタでの設定が成功するとシンタックスが着色されるはずです。
TSF syntax image

⓪-3.その他現在わかっている不具合や今後の課題などソフト使用の補足ガイドライン

ソースコードから関数一覧とコメントを抽出してAPI一覧を生成する機能がまだ未実装です。

②-0.「TSFdoc」のFAQ。

Q.「TSFimport_regex:」で正規表現を使う箇所があるのですがD言語とPythonで正規表現の違いがあると挙動が変わりませんか?
A.実装言語毎に正規表現の方言があるはずです。TSF側で正規表現の方言の吸収(TSF自前で正規表現)は行わないので注意。

③-0.作者について、例えば連絡先

更新情報はGitHubやブログを確認してください。

ooblog/TSF2KEV(GitHub)
https://github.com/ooblog/TSF2KEV
[TSF] - 大風呂ダ敷
http://d.hatena.ne.jp/ooblog/searchdiary?word=*[TSF]
[kanedit] - 大風呂ダ敷
http://d.hatena.ne.jp/ooblog/searchdiary?word=*[kanedit]
↑Top