17コメント6KB

SandCastle Part1

■ このスレッドは過去ログ倉庫に格納されています

0001デフォルトの名無しさん

2013/02/28(木) 01:12:54.51

.NetのドキュメンテーションツールのSandCastle総合スレ

･ http://sandcastle.codeplex.com/
･ http://shfb.codeplex.com/

SandCastleはCUIのツール｡SandCastle Help File BuilderはGUIのツール(SandCastleを利用する)
SHFBのインストーラーを使うと必要なファイルは一発でインストールできる
VisualStudioプラグインも同梱

0002デフォルトの名無しさん

2013/02/28(木) 01:15:59.69

.Net環境でドキュメンテンショーンを考えるとSandCastleがベストと思うが
ぐぐってもどうも情報が少なすぎるので立てた｡
これから立派なヘルプを作るまで頑張ろうと思う｡

現状の問題点は二つ
･　SandCastle自体の日本語化のやり方
･　作成したヘルプの｢目次｣が文字化けする

この2点についてまず知りたい｡

0003デフォルトの名無しさん

2013/02/28(木) 11:39:32.02

このスレッドは天才チンパンジー「アイちゃん」が
言語訓練のために立てたものです。

アイと研究員とのやり取りに利用するスレッドなので、
関係者以外は書きこまないで下さい。

　　　　　　　　　　　　　　　　　　京都大学霊長類研究所

0004デフォルトの名無しさん

2013/02/28(木) 12:28:09.78

日本語翻訳ファイルの問題点
http://sourceforge.jp/projects/oss-ja-jpn/releases/47891

SandCastle自体の日本語化は手間の割にメリットが薄いの問題外｡
ヘルプを日本語(ja-JP)で出力するための翻訳ファイルが上記のURLでダウンロードできるが､
古すぎて現在のバージョンに対応していない｡
また最新のVS2010スタイルにも対応していない｡

というわけでざっくり全部翻訳し直す必要があると思うのだがどうだろうか
さっき自分で/Presentation/VS2010/Contents/ja-JPを作って試してみたが
英語ファイルをコピーしてUTF-8で保存し直して<?xml version="1.0" encoding="UTF-8"?>を追加したら問題なく日本語が表示された｡
localは=ja-JPに変更｡

あとはバリバリ翻訳していくだけ

0005デフォルトの名無しさん

2013/03/07(木) 20:36:33.51

日本語ヘルプパックをリリースした｡
インストールすると日本語(ja-JP)で出力できるようになる｡
そのままだと英語と日本語が混在したヘルプが出力されるのが激しく許せなかったので｡
文言の修正とかあればこのスレへ｡

code.google.com/p/sandcastle-help-file-builder-japanese-help-file-pack/

SourceSorgeにhozawaさんが翻訳したヘルプファイルがあるけど､今のSHFBではそのままでは使えなくなっているので仕切り直し｡

0006デフォルトの名無しさん

2013/03/07(木) 21:37:54.94

気がついたTIPSを書き残しておこう｡

インストールについて｡ SandCastle Help File Builder (SHFB) のインストーラーはSandCastleを含んでいるので､
SHFBをまずインストールすればいい｡対話形式になっていて途中で自動的にSandCastleもインストールできる｡
マイクロソフトのヘルプファイル2形式は使われていないので気にしなくてOK.
ヘルプファイル1とHTML出力を使う事になるだろう｡
Express EditionでなければVisualStudioプラグインもインストールしておくとすごく便利｡

0007デフォルトの名無しさん

2013/03/07(木) 21:43:13.97

SandCastleはビルドにすごく時間がかかるので設定の｢Components｣の所のCached～を全部有効にすると
ビルドの時間が半分になる｡それでも30秒ぐらいはかかるけど｡

APIリファレンスに例えば任意のウェルカムページを挿入したい時とか結構悩む｡
基本はMAMLで｢Conceptual topics｣とかいう概念で書いていけばいいのだが､
SandCastleのテンプレートを見ても正直書ける気がしない｡今時タグを手打ちって･･･
実はHTMLで書いておくと自動でMAMLに変換してトピックにしてくれる｡
フォルダーが階層構造｡簡単なページならこれでOK

0008デフォルトの名無しさん

2013/03/07(木) 21:48:00.69

ヘルプには画像を<img src="../Images/aaa.jpg" />で差し込める
SandCastleは途中の作業をWorkingフォルダーを作って行う
上記のパスはそこからの相対パス指定なので通常1つ上がる
画像は最終ファイルにコピーされるので配布物に/Images/フォルダーを含める必要はない
画像は｢Build Action｣を｢Image｣ではなく｢Contents｣にする｡
<img>タグは.NetのタグやMAMLのタグではなくHTMLのタグなので通常のMAMLの画像の扱いとは異なる指定になる

0009デフォルトの名無しさん

2013/03/14(木) 12:15:41.02

LaTeX形式で数式を埋め込むためのプラグイン
https://github.com/cuda/latex-sandcastle

0010デフォルトの名無しさん

2013/03/14(木) 16:56:26.16

砂上の楼閣

0011デフォルトの名無しさん

2013/03/27(水) 17:56:05.11

あっそ

0012デフォルトの名無しさん

2013/04/09(火) 13:43:54.85

ゾンビ

0013デフォルトの名無しさん

2013/04/21(日) 15:39:20.94

にゃん

0014デフォルトの名無しさん

2013/05/04(土) 14:44:13.30

過疎？

0015デフォルトの名無しさん

2013/05/17(金) 17:42:22.06

宮崎

0016デフォルトの名無しさん

2013/05/30(木) 15:10:02.26

クリスマス

0017デフォルトの名無しさん

2013/06/11(火) 19:22:41.22

板違いだろ

■ このスレッドは過去ログ倉庫に格納されています