👌

[小ネタ]backlogテキスト整形のルール~表の生成技~

2022/12/01に公開約5,200字

Backlogとは

チームのタスク管理ツールBacklog。
言った言わないがなくなるバックログ♪
詳しくは公式Web

この記事で書くこと

私はBacklogを仕事でよく使っています。便利ですよね。
そして、キレイに!わかりやすく!書こうと思ったら、記法を使いこなさないといけません。

記法は2つしかありません。

  • Backlog記法
  • Markdown

私がよく使うのは

  • 課題へのリンク
  • URLへのリンク
  • 見出し
  • 箇条書き
  • 引用文
  • コードマクロ

あたりです。
その中でも特にの生成がめんどくさい!!
使ってるかた、思いませんか?

今回は、表を簡単に作る方法について記載します。

Backlog記法とは

Backlog記法の表の記法については、公式サイト及び実際のBacklogの画面内の"?"から参照できます。
テキスト整形のルール (Backlog記法) - 表

ヘッダーなし

| ホスト名 | IPアドレス   |     備考      |
| sun        | 192.168.100.1   |                  |
| earth     | 192.168.100.2   |                  |
| moon    | 192.168.100.20 | 予備機です |

ヘッダーあり(h)

| ホスト名 | IPアドレス   |     備考      |h
| sun        | 192.168.100.1   |                  |
| earth     | 192.168.100.2   |                  |
| moon    | 192.168.100.20 | 予備機です |

ヘッダーあり(~)

|~ ホスト名 | IPアドレス   |     備考      |
|~ sun        | 192.168.100.1   |                  |
|~ earth     | 192.168.100.2   |                  |
|~ moon    | 192.168.100.20 | 予備機です |

めんどくさいΣ( ̄ロ ̄lll)
太字なら''''で囲むだけなのに、複数行を手打ちで成型すると大変!!

そこで、私はサクラエディタのマクロで変換しています。

Backlog記法の表を生成する手順(サクラエディタマクロ使用)

  1. 下記ファイルを作成します。
    backlog.mac
    //キーボードマクロのファイル
    ReplaceAll('"', '', 28);	// すべて置換
    ReplaceAll('\\r\\n', '\\r', 28);	// すべて置換
    ReplaceAll('\\n', '&br;', 28);	// すべて置換
    ReplaceAll('\\r', '|\\r\\n', 28);	// すべて置換
    ReplaceAll('\\t', '|', 28);	// すべて置換
    ReplaceAll('^', '|', 28);	// すべて置換
    ReDraw(0);	// 再描画
    GoFileTop(0);	// ファイルの先頭に移動
    GoLineEnd(0);	// 行末に移動(折り返し単位)
    Char(104);	// 文字入力
    
  2. ExcelやGoogleスプレッドシートなどで表データを作成、コピーしてサクラエディタに張り付ける
  3. サクラエディタで「キーマクロを読み込む(Ctrl+L)」を実行
    backlog.macを選択/開く
  4. サクラエディタで「キーマクロの実行(Shift+Ctrl+L)」を実行
  5. 変換されたテキストをコピーする
  6. Backlogへ貼り付ける
  7. プレビューを押す
  8. (゚д゚)ウマー

変換の仕組み

表計算ソフト(ExcelやGoogleスプレッドシート)の表データは

  • セルとセルの間はTAB区切り
  • 行の改行はCRLF
  • セル内の改行はLF

になっています。

サクラエディタにコピー&ペーストして見るとわかりやすいです。

  • 表と表の間はTAB区切り
    →サクラエディタで見ると^(べき乗を表す記号。「ハットマーク」「ハット」及び「キャレット」と読むらしいです)
  • 行の改行はCRLF
    →サクラエディタで見ると⏎(リターン記号)
  • セル内の改行はLF
    →サクラエディタで見ると↓(下矢印)

となります。
あとは、マクロファイルの右側のコメントの通りにBacklog記法に合わせて変換をかけていけば、できあがりです。

backlog.mac
//キーボードマクロのファイル
ReplaceAll('"', '', 28);	// すべて置換
ReplaceAll('\\r\\n', '\\r', 28);	// すべて置換
ReplaceAll('\\n', '&br;', 28);	// すべて置換
ReplaceAll('\\r', '|\\r\\n', 28);	// すべて置換
ReplaceAll('\\t', '|', 28);	// すべて置換
ReplaceAll('^', '|', 28);	// すべて置換
ReDraw(0);	// 再描画
GoFileTop(0);	// ファイルの先頭に移動
GoLineEnd(0);	// 行末に移動(折り返し単位)
Char(104);	// 文字入力
//キーボードマクロのファイル 処理 処理説明
ReplaceAll('"', '', 28); // すべて置換 表計算ソフトで出力されるときのダブルクォーテーションを削除します
ReplaceAll('\r\n', '\r', 28); // すべて置換 次のフェーズで「\n」の変換で巻き込まれないように「\r\n」をいったん「\r」にします
ReplaceAll('\n', '&br;', 28); // すべて置換 セル内改行をBacklog記法の改行「&br;」に変換します
ReplaceAll('\r', '|\r\n', 28); // すべて置換 前フェーズの「\n」変換が終わったので一時的に変換した「\r」を「\r\n」に戻します
ReplaceAll('\t', '|', 28); // すべて置換 TABをBacklog記法のセルとセルの間に入れる「
ReplaceAll('^', '|', 28); // すべて置換 先頭にBacklog記法のセルとセルの間に入れる「
ReDraw(0); // 再描画
GoFileTop(0); // ファイルの先頭に移動 1行目の末尾にh 挿入のため、ファイルの先頭に移動
GoLineEnd(0); // 行末に移動(折り返し単位) 1行目の末尾にh 挿入のため、行末に移動(折り返し単位)
Char(104); // 文字入力 1行目の末尾にh挿入

Markdown記法

エンジニア御用達(?)のMarkdown。お好みの変換ツールをご使用されれば問題ないと思います。

私は、Visual Studio Code(以下、VS Code)のマクロで変換しています。

Markdownの表を生成する(VS Codeの拡張機能を使用)

  1. 拡張機能 csv to Markdown Table Converter を追加する
  2. ExcelやGoogleスプレッドシートなどで表データを作成、コピーする
  3. F1押下して「Excel to Markdown table」を押下する
  4. Backlogへ貼り付ける
  5. プレビューを押す
  6. (゚д゚)ウマー

展望と感想

Backlog記法対応のVS Code拡張機能が作れたかっこいいなぁ、なんて。

これからBacklogを使い始める時は、Markdown記法がおススメです(今、新しくプロジェクト作るとデフォルトはMarkdownなのかな・・?)
GitHubをはじめとするエンジニア御用達のツールはほとんどがMarkdownで記述できますので、移行なども考えるとMarkdownで記載するのがよいと思います。

おわりに

繰り返しやることは自動化してみる、という考えのもと考えた方法をご紹介しました。
楽をすることを考えると、生産性はあがるのではないでしょうか。
楽をする=サボる ということではなく、「効率的に作業をする」という意味で楽をして仕事をしていこうと常々思います。

最後までお読みいただき、ありがとうございました。

Discussion

ログインするとコメントできます