簡易書式テキスト文書

簡易書式テキスト文書 アイコンダウンロードページへ

概要

「簡易書式テキスト文書」とは、簡単に言うと、必要最低限のシンプルな書式を規定し、それに従ってテキストファイル(.txtファイル)形式で文書を作成、ツールで目的のフォーマットに変換するという一連の枠組み(フレームワーク)です。

過去に携わったプロジェクトですでに使用実績があります。

環境

プラットフォーム Microsoft .NET Framework 2.0
開発言語 C#

背景

悩み(その1)

開発現場で作成された設計書などの文書を見ると、説明文が少なく細部を記した表や箇条書きが多い・・・これでは概念や全体像を掴みにくい。

何でもExcelで作成する人をよく見かけるが、Excelはそもそも表計算ソフトなので長い文章を記述するのには向いていない。

わかりやすい文書を作成するためには、文章能力の向上以前に、何でもExcelで作成する習慣をやめさせる必要があるのでは?

悩み(その2)

文章を書くならWordのようなアプリケーションが向いている。しかし、Wordを使いこなせる人は少ない。体裁が不統一で、作成する人や時期によって見栄えが異なってしまう。

見出しも箇条書きもすべて「標準」スタイルで書いてしまう人をよく見かけるが、ところどころ微妙に書式が異なっていたりする。

テンプレートを用意してもスタイルを適切に使用してもらえるだろうか?

悩み(その3)

チームの全員がWordを使いこなして体裁が統一された文書を作成できるようになるには、コストがかかる。

こんな悩みを解決するべく開発したものが「簡易書式テキスト文書」です。(現在もバージョンアップ開発中)

構成

簡易書式テキスト文書は、「書式規定」「文書変換ツール」「文書解析ライブラリ」で構成されています。

書式規定

Wikiと似ていますが、Wikiよりも日本人向けに直観的な書式にしています。テキスト文書のままでも、見やすい書式になっています。

■簡易書式テキスト文書
・何でもExcelで文書を作成する習慣をやめたい
・誰が作っても同じ書式になるよう徹底したい
・簡単に体裁の整った文書を作成したい
そんな動機から作成した、文書作成のフレームワークです。

文書変換ツール

現時点では、HTML文書に変換するツールを用意しています。

HTMLは正式な納品物のフォーマットとしては採用されにくいですが、ちょっとした説明資料やメモなどに利用できます。(現在、Word文書への変換ツールを開発中です。)

文書変換ツール 画面

文書解析ライブラリ

文書解析ライブラリと文書変換ツールを独立させることで、文書解析ライブラリを利用して独自のツールを開発しやすい仕組みにしました。COMコンポーネントなのでVBScriptでも使用できます。

' 入力する簡易書式テキスト文書
strText = _
"■サンプル" & vbCR & vbLF & _
"サンプルの本文です。"

' パーサーでテキスト文書を解析する処理
Set objParser = CreateObject("Tk4.SfdParser.1.0")
Set objDoc = objParser.Parse(strText)

' HTMLジェネレータでHTML文書を生成する処理
Set objGenerator = CreateObject("Tk4.SfdHtmlGenerator.1.0")
Set objGenerator.Document = objDoc
objGenerator.Title = "サンプル文書"
objGenerator.Generate

' 生成したHTML文書を表示する
MsgBox objGenerator.OutputDocument