コマンドラインインターフェイス

コマンドライン版は、Windowsのコマンドプロンプトから使用するプログラムです。入力したdocxファイルをHTMLファイルに変換する機能を提供します。

変換オプション

コマンドライン実行時は、SBHCmdに続けて、入力ファイル名(必須)、出力ファイル名(必須)および変換オプションを指定します。

変換オプションのパラメータは次の表のとおりです。入力ファイルと出力ファイルの指定は必須ですが、それ以外のパラメータは必要な時だけ指定します。パラメータを指定しないときはデフォルト動作となります。

パラメータ 機能
<input-file> (必須)入力ファイル名を指定します。
<output-file> (必須)出力ファイル名を指定します。
-clrsettings 本パラメータを指定するとデフォルト設定ファイルなどで指定済のオプション設定をクリアします。
-settings <settings-file> <settings-file>にて指定した変換オプション設定ファイルを読み込みます。
-xhtml デフォルトではHTML文法のタグを出力します。-xhtmlを指定するとXML文法のタグを出力します。
-viewport <content> <head>に次の形式のメタタグを出力します。
<meta name=”viewport” content=”contentに指定した内容”>
-endl ブロックタグの終わりに改行を出力します。
-emptyP デフォルトではWordの空の行(改行のみの行)をHTML出力時に無視します。本オプションを指定すると空行の数だけ空の<p></p>タグを出力します。
-nonrefiid Wordでは編集を重ねると文書ファイル内に参照されていないIDがdocxファイル内に沢山できてしまいます。本コンバータはデフォルトでは文書ファイル内をスキャンして、内部的に参照されていないID をHTML出力時に削除します。本オプションを指定すると参照されていないIDを削除しません。
-imgwidth イメージの幅を出力します。
-hstrong 見出しスタイルで指定された強調を無視します。
-embedimg このオプションを指定しないとき(デフォルト)、画像はimageフォルダーに出力されます。
本オプションを指定すると、画像をデータURLで本体HTMLに埋め込みます。
-(x|o)math Wordの数式エディタで編集した数式の出力形式を指定します。
次の4とおりの出力形式を指定できます。
  • 未指定 数式を<img>タグにsvg形式ファイルで出力
  • -math 数式を<img>タグにMathML形式ファイルで出力
  • -xmath 数式をMathML形式マークアップで出力
  • -omath 数式をWord独自のOffice Math形式で出力
-throughimg Wordに挿入した元の画像形式のまま出力します。
-pstyle 段落のスタイル名をclass属性の値に設定して出力します。
-citation Citationフィールドのtagの値を<a>タグのhref属性の値に設定して出力します。
-textcolor 文字に指定されている色を<span style="color:カラー値”>として出力します。
-italic n|t|s 文字に斜体が指定されているときの出力方法を指定します。
  • -italic n 出力しない(デフォルト)
  • -italic t <i>タグとして出力
  • -italic s <span style="font-style:italic>として出力
-underline n|t|s 文字に下線が指定されているときの出力方法を指定します。
  • -underline n 出力しない(デフォルト)
  • -underline t <u>タグとして出力
  • -underline s style="text-decoration-line:underline;">として出力
-linethrough n|t|s 文字に取り消し線が指定されているときの出力方法を指定します。
  • -linethrough n 出力しない(デフォルト)
  • -linethrough t <del>タグとして出力
  • -linethrough s <span style="text-decoration-line: line-through;">として出力
-encoding <encoding> HTMLファイルの文字コード(符号化方式)として、UnicodeのUTF-8 以外を指定したいとき本パラメータで符号化方式を指定します。
  • -encoding Shift_JIS シフトJISで出力(注1参照)
  • -encoding UTF-16  UnicodeのUTF-16符号化
注1 シフトJISに定義されている文字の種類はUnicodeより少ないため、シフトJISで扱えないUnicodeの文字は&#x文字番号;(文字番号は16進数)で出力されます。なお、JIS X0208にマイクロソフトが追加した旧機種依存文字(①、②など)はシフトJISの文字として扱います。
-defstyle 本オプションを指定すると<head>の<style>要素(デフォルトCSSスタイルを指定する要素)を出力しません。
-spaceindent 本オプションを指定すると段落先頭に1文字以上の字下げが指定されているとき、字下げを1文字の全角空白に変換します。
-outputbr 段落を<p>タグで囲む代わりに、段落の終わりに<br>タグを出力します。-xhtmlパラメータ指定時は無効です。
-fileimages 画像ファイルを格納するフォルダー名を、“変換先ファイル名.images”とします。
-css cssfile [media] CSSファイルをリンクします。CSSファイルはWindows上のフォルダーに置き、そのパスを指定します。指定したCSSファイルが存在しないとエラーになります。オプションでmediaを指定できます。 <head>に次の形式のlinkタグを出力します。 <link href=”xxx.css” rel=”stylesheet” type=”text/css” media=”print”>指定したCSSファイルはHTML出力先フォルダーにコピーされます。 -cssとCSSファイルの組を複数指定できます。
-js javascript-path <head>にscript タグを置き、そのsrc属性にJavaScriptファイルのパス(URL)を指定します。指定したJavaScriptのパスが存在しなくてもエラーになりません。
-savesettings <settings-file> コマンドライン実行時変換オプション・パラメータの指定値を<settings-file>にて指定したファイル名で保存します。
-savedefault コマンドライン実行時の変換オプション・パラメータの指定値をデフォルト設定ファイル(def-settings.xml)に出力します。
-split 1|2|3 本パラメータを指定した場合、Word文書のアウトラインレベルに応じてHTMLファイルを分割して出力します。アウトラインレベルは1~3を指定できます。
-tocout

本パラメータを指定した場合、-splitパラメータを指定時にWordの目次機能で挿入した目次箇所を、別のHTMLファイル(inc-toc.html)として出力します。

inc-toc.htmlはJavaScriptを利用して、分割したHTMLファイルにインクルード(読み込み)できます。inc-toc.htmlには目次箇所のタグ以外の<head>や<body>などのタグは出力されません。

JavaScriptを利用した目次箇所のインクルード方法については、下記Webページにサンプルを用意していますので、ご参考にしてください。

https://www.antenna.co.jp/xhw/sample.html

本パラメータを指定しない場合は目次箇所は分割したすべてのHTMLファイルの上部に出力されます。

-pagenavi language

本パラメータを指定した場合、-splitパラメータを指定時に分割したHTMLファイルの上部(目次箇所がある場合は目次箇所の直後)と下部に、前のページと次のページに移動するリンクを出力します。

-pagenaviに続く「language」箇所に「ja」を指定した場合は、日本語で「前へ」「次へ」リンクが出力されます。

「language」箇所に「ja」以外を指定した場合、または省略した場合は、英語で「Prev」「Next」リンクが出力されます。

前のページまたは次のページが存在しない場合は、各リンクは省略します。

-lang language

本オプションを指定すると、出力するHTMLファイルの<html>タグに出力する言語(lang属性)を指定できます。-langに続く「language」箇所に言語コードを指定します。(例. 日本語の場合:ja、英語の場合:en)

「language」箇所に「none」を指定した場合は、<html>タグにlang属性を出力しません。

本オプションを指定しない場合や、半角英数字、半角のハイフン以外の値を指定した場合は、Word文書から推定して「ja」(日本語)または「en」(英語)を出力します。

「-xhtml」パラメータを指定した場合は、<html>タグのxml:lang属性とlang属性にそれぞれ指定した言語コードを出力します。

例. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">

-spaceindent 本オプションを指定すると段落先頭に1文字以上の字下げが指定されているとき、字下げを1文字の全角空白に変換します。
-fileimages 画像ファイルを格納するフォルダー名を、“変換先ファイル名.images”とします。
-tablestyle Word文書中の表や表のセルに指定されている、背景色や枠線の太さ・色・スタイル(一部のスタイルのみ対応)、表の幅を各HTMLタグのstyle属性で出力します。
-v コマンドラインインターフェイスのバージョンや著作権を表示します。 このパラメータが指定されている場合は実際の変換処理は行いません。

コマンドライン操作例

次はコマンドラインで、変換元ファイル名:NewsRelease.docx、変換先ファイル名:NewsRelease.htmlとし、CSSファイル:sample.news.css を指定した例です。

SBHCmd NewsRelease.docx NewsRelease.html -css sample-news.css

変換が正常に実行されると次のメッセージが表示されて、HTMLファイルが作成されます。

Converting finished normally.

シェルスクリプトによるコマンドラインプログラムの実行

Docx to HTML Converter of OSDC V10.0 Linux 版では、run.sh というシェルスクリプトが [Install directory] にインストールされています。これはコマンドラインプログラム SBHCmd を実行するためのサンプルスクリプトです。このスクリプトは必要な環境変数の設定を行ってから SBHCmd を実行します。このスクリプトを使って Docx to HTML Converter of OSDC V10.0 Linux 版のコマンドラインプログラムを実行するには、以下のようにしてください。

$ cd [Install directory] $ ./run.sh NewsRelease.docx NewsRelease.html -css sample-news.css

変換が正常に実行されると次のメッセージが表示されて、HTMLファイルが作成されます。

Converting finished normally.

run.sh には、SBHCmd に指定できるパラメータと同じパラメータを同じ形式で指定します。