Skip to content

kensuketamura/AssureNote

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,112 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AssureNote

AssureNote AssureNoteはブラウザ上でGSNを記述するためのツールです。 シンプルなレイアウトと、WGSN(Wiki-style GSN)と呼ばれるテキストベースの編集方法をサポートしているのが特徴です。

対応フォーマット

現在以下のフォーマットに対応しています。

  • Wiki-style GSN (*.wgsn)
  • D-Case Editor (*.dcase_model)

操作方法

基本操作

画面の何も無い部分へファイルをドロップすると、そのファイルを開きます。 スクロールはマウスで画面をドラッグして行います。ノードを右クリックすると、コンテキストメニューが表示されます。

ノードの折りたたみ

ノードをダブルクリックすると、そのノード以下のツリーを折りたたむことができます。 もう一度ダブルクリックするか、スクロールによって画面の中央上側に持って行くと展開されます。 コンテキストメニューからも切り替えることが可能です。

編集

コンテキストメニューでFullscreenEditorを選ぶと、テキストエディタが表示され、編集モードに入ります。 このモードでは、コンテキストメニューを出したノード以下のツリーをWGSN形式で編集することが出来ます。 ESCキーを押すと編集モードを抜けます。

メニュー

主要な機能は上部のメニューから呼び出せます。

  • File
    • New... 新しいファイルを作成する
    • Open... ファイルを開く
    • Upload ファイルをサーバにアップロードする(アップロード成功後、固有のURLに移動します)
    • Save ファイルを保存する
    • Save As
      • *.wgsn... WGSN形式でファイルを保存する
      • *.dcase_model... D-Case Editor形式でファイルを保存する
    • Command list コマンドの簡単な説明を表示する
    • Help このファイルを表示する
    • About AssureNoteのバージョンを表示する

メニューバー

MenuBar

メニューバーはノード上で右クリックを押すことで表示され、 ノードの追加や削除・編集のための機能を呼び出すことができます。 上の画像を用いて、メニューバーの機能の説明を左から順に行っていきます。

編集(単一ノード)

鉛筆の記号で表される項目です。 メニューバーが表示されたノードの編集を行うためのエディタが開きます。 エディタは、Escキーを押すか、エディタの外をクリックすることで閉じます。

編集(複数ノード)

文章の記号で表される項目です。 メニューバーが表示されたノードの部分木を一括して編集するためのエディタが開きます。 エディタの記法は、以降で説明されるWGSNを用います。

ノードの追加

ノードの追加を行います。 それぞれの項目は、GSNの図形の形をしています。 追加できるノードはノードの種類毎に異なる点に注意して下さい。 例えば、Goalに対してGoalを追加することはできません。 したがって、上記の画像でもGoalの追加メニューは表示されていません。

Goalの追加

Goalを追加します。

Contextの追加

Contextを追加します。

Strategyの追加

Strategyを追加します。

Evidenceの追加

Evidenceを追加します。

ノードの削除

×印の項目です。 ノード自身と、その部分木を削除します。

コマンドライン

AssureNoteではコマンドラインから操作を行うことができます。 :キーでコンソールを開き、コマンドを入力してEnterキーを押すと実行されます。

現在、使用可能なコマンドは以下の通りです。

  • help コマンドの簡単な説明を表示する
  • new [name] 新しいファイルを作成する
  • open ファイルを開く
  • save [name] ファイルを保存する
  • unfold-all すべてのノードを展開する
  • set-scale scale 拡大率をscale(0.2~2.0)にする
  • set-color label color ノードに色を付ける label: 対象となるノードのラベル, color: 色 #FFFFFFで指定する

また、:に続いてコマンド名ではなくノードのラベルを指定すると、そのノードへジャンプします。

サンプル

:G3

ノードG3へジャンプする

:save foo.wgsn

現在編集している内容をfoo.wgsnとして保存する。 ただし、ブラウザによっては改めてダイアログが出る場合があります。

検索

/キーを押すと検索コンソールが開きます。検索したい文字列を入力し、Enterキーを押すと検索が実行されます。

検索はノードの本文に対して行われ、ヒットしたノードはハイライト表示されます。このとき、Enterキーで次の検索結果、Shift+Enterキーで前の検索結果にジャンプします。

ESCキーを押すと検索結果の閲覧を終了します。

ショートカットキー

AssureNoteはキーボードでも操作できます。

  • ← ↓ ↑ →, h j k l ノードの移動
  • f ノードの折りたたみ・展開
  • a i ノードの編集

WGSN (Wiki-Style GSN)

WGSNはGSNのテキスト表現として開発された表記法で、AssureNoteではこのWGSNを用いてGSNの編集を行います。

WGSNのサンプル

* G:TopGoal
ゴール: [システム]はディペンダブルである
* C:Context
前提: [G:TopGoal]が成り立つ状況
システム:: Web教育システム
* S
戦略: 主張を分解する指標
** G:SubGoal
サブゴール: 分解された主張
** E
証拠: [システム]における、サブゴールの成立を支持する事実
** C
反証: 証拠に対する反例
** G
未達成なサブゴール

ラベル

WGSNの記法において、アスタリスク*から開始される文章がノードの先頭を示します。その際、Goal``Context``Strategy``Evidenceの各ノードはそれぞれ、G``C``S``Eのラベルを用いて表現します。

基本構造

WGSNでは、以下のルールに基づいて、アスタリスクの数によってノードの親子関係を表しています。

  • N個のアスタリスクを持つGoalは、N-1個のアスタリスクを持つStrategyの子
  • N個のアスタリスクを持つStrategy``EvidenceはN-1個のアスタリスクを持つGoalの子
  • N個のアスタリスクを持つContextはN個のアスタリスクを持つ直前のノードの子
  • 最上位のGoalはアスタリスク一つ

上記の例では、G:TopGoalが最上位のゴールとなり、C:Contextはその子となります。また、G:SubGoalStrategyの子です。 ノードを一意に表す際は、ラベルの直後に:から始まるシンボルを挿入します。

タグ

ラベルが記述された行以降は、ノードの本文となります。自由に記述することが可能ですが、(シンボル):: (パラメータ)という形式で記述された行はタグとして解釈されます。

参照

一意に表されたノードやタグは、角括弧[]を用いることでこれを参照することが可能です。上記の例において、[G:TopGoal]及び[システム]と記述された箇所です。

ノードとタグのスコープ

ノードについてはWGSNのあらゆる箇所から参照することができます。ただし、タグのスコープは定義されたノードの子や孫に限られます。例外として、Contextに記述されたタグのスコープは、Contextの親と同一です。このため、上記の例においてEvidenceから[システム]が参照可能です。

About

AssureNote is an Assurance Case Editor

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors