天地有情

[LaTeX] shdoc --- コマンドライン操作を文書化する

§1 はじめに

コマンドライン操作の内容や,操作で得られた結果(表示)を画像化し,LaTeX文書に
貼付けた経験が幾度となくあります.いわゆる,スクリーンショットの貼付けです.
これらの手間を省こうとするのが shdoc.sty であり, コマンドラインアクション
を文書化します.即ち,マニュアルや操作手順書の作成に役立ちます.

1.1 インストール

TeXLive/W32TeX などには標準でインストールされています.

1.2 マニュアル

コマンドラインから texdoc shdoc を実行するか,
上記に同梱の shdoc.pdf をお読み下さい.


§2 使い方

2.1プリアンブルに
  \usepackage [<options>] {shdoc}
  を記述します.

2.2 環境とコマンド

shdoc00.png



2.3 基本的な書式例

■■■■■■■■■■■■■■■■■■■■■■■■■
\documentclass{article}
\usepackage[dvipdfmx]{graphicx}
\usepackage{shdoc} % optionsは特に設定しなくてもよい
%
\begin{document}
\begin{sh}
    グローバル環境(共用)関係コマンドを記述
 \begin{shbox}
    セッション環境(個別)関係コマンドを記述
    ※ 上記のグローバル環境(共用)関係コマンドを記述可
  \shuser{Hayabusa}    % defaule=root
    ユーザ名を記述
  \shmachine{Windows10}  % defaule=linux
    マシン名を記述
  \shchangesymbol{indicatorsymbol}{>>} % default=$
    プロンプト記号
  \shrun{...}など
    入出力および実行コマンドなど記述
 \end{shbox}
\end{sh}
\end{document}
■■■■■■■■■■■■■■■■■■■■■■■■■

コンパイル: latex + dvipdfmx

※ 自分のPC(Windows10) では以下の事項が判明しています.

      (・ptex2pdf -l xxx でも可.ただし,Warning 出るが正しく表示される
                            和文クラスファイルの場合です)

      (・pdflatex xxx でも可.ただし,Acrobat Reader ではWarning出るが正しく表示される
           SumatraPDFでは正しく表示される. 欧文クラスファイルの場合です)


§3 サンプル

3.1 ptex2pdf のヘルプを文書化する例

shdoc01.png


【簡単な説明】

コマンドラインで ptex2pdf -h を操作し,ヘルプに必要な情報を文書化したものです.

(1) 6行目: darkblue の他に mint(default), arrows, airy, blackwhite が事前定義されています.
    変更するには,\shpreset{...} とします.
    この \shpreset は shbox環境内にあっても構いません.

(2) 22行目: shbox環境はフロート環境です.キャプション・ラベルを付けることができます.

(3) [-option] の背景色はデフォルトの white!60!gray となっています.
  変更するには, \shchangecolor{optioncolor}{色指定} とします.


3.2 コマンドライン操作でリダイレクトして文書化する例

shdoc02.png


【簡単な説明】

(1) 先ず,コマンドライン操作で ptex2pdf -h > ptex2pdf.save とし,リダイレクトされた
  "ptex2pdf.save"ファイルを必要に応じて編集します.

(2) 6行目: 背景色は mint(default) これは,gray の背景のテーマを実装しています.

(3) 8行目: ユーザ名(Hayabusa),マシン名(Windows10) を設定(defauleは root, linux)

(4) 10行目: (1)で準備した "ptex2pdf.save"ファイルを \shread で読み込みます.


3.3 該当コマンドを指定して実行する例

shdoc03.png


【簡単な説明】

(1) 6行目: 背景色は arrows これは,black の背景のテーマを実装しています.

(2) 10行目: indicatorsymbol は ">>" を指定(default)しています.

(3) 11行目: \shrun で直接に "ptex2pdf -h" を実行します.


3.4 操作手順を文書化する例
   (コマンドラインで "tex" を処理する)

shdoc04.png


【簡単な説明】

(1) 4行目: \cmd を定義しておきます.

(2) 7行目: 背景色は darkblue これは,darkblue の背景のテーマを実装しています.

(3) 11~15行目: "tex" コマンド入力し,それ以降の操作を実行します.

(4) 17~18行目: shbox環境には caption, label が付けることができます.


3.5 操作手順を文書化する例
   (コマンドラインで "latex nfssfont" (font test)を処理する)

shdoc05.png


【簡単な説明】

(1) 4行目: \cmd を定義しておきます.

(2) 7行目: 背景色は airy これは,lightblue の背景のテーマを実装しています.

(3) 11~33行目: "latex nfssfont"コマンド入力し,それ以降の操作を実行します.

(4) 26行目: wasy10 のフォント表を出力する例です.

(4) 35~36行目: shbox環境には caption, label が付けることができます.

(EOF)
スポンサーサイト
  1. 2016/09/16(金) 04:00:12|
  2. LaTeX Tools