instruction upload#

Description#

HTMLファイルを作業ガイドとして登録します。

Examples#

基本的な使い方#

作業ガイドとして登録するHTMLファイルのパスを、--html に指定してください。 img要素のsrc属性がローカルの画像を参照している場合（http, https, dataスキーマが付与されていない）は、画像も作業ガイドの画像としてアップロードします。

instruction.html#

<html>
<head></head>
<body>
作業ガイドのサンプル
<img src="lenan.png">
</body>
</html>

$ annofabcli instruction upload --project_id prj1 --html instruction.html

補足：ConfluenceのページをAnnofabの作業ガイドとして登録する#

以下の手順に従って、HTMLファイルを作成してください。

Confluenceのエクスポート機能で、作業ガイドに登録したいページをエクスポートする。
エクスポートしたzipに格納されている site.css を https://raw.githubusercontent.com/kurusugawa-computer/annofab-cli/main/docs/command_reference/instruction/upload/site.css に置き換える。デフォルトの状態では、表の罫線や背景色が表示されていないため。
エクスポートしたHTMLのスタイルを、style属性に反映する。Annofabの作業ガイドには、スタイルシートを登録できないため。
1. エクスポートしたファイルをChromeで開く。
2. Chrome開発ツールのConfoleタブで以下のJavaScriptを実行して、表関係の要素スタイルをstyle属性に反映させる。
```
elms = document.querySelectorAll("table,thead,tbody,tfoot,caption,colgroup,col,tr,td,th");
for (let e of elms) {
    s = window.getComputedStyle(e);
    e.style.background = s.background;
    e.style.color = s.color;
    e.style.border = s.border;
    e.style.borderCollapse = s.borderCollapse
}
```
1. Chrome開発ツールのElementタブで、html要素をコピー(Copy outerHTML)して、HTMLファイルを上書きする。

Usage Details#

HTMLファイルを作業ガイドとして登録します。img要素のsrc属性がローカルの画像を参照している場合（http, https, dataスキーマが付与されていない）、画像もアップロードします。

usage: annofabcli instruction upload [-h] [--yes]
                                     [--endpoint_url ENDPOINT_URL]
                                     [--annofab_user_id ANNOFAB_USER_ID]
                                     [--annofab_password ANNOFAB_PASSWORD]
                                     [--annofab_pat ANNOFAB_PAT]
                                     [--logdir LOGDIR] [--disable_log]
                                     [--debug] -p PROJECT_ID --html HTML

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--html: 作業ガイドとして登録するHTMLファイルのパスを指定します。body要素があればbody要素の中身をアップロードします。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

チェッカーまたはオーナロールを持つユーザで実行してください。