イントロ

my_helpってのはcuiで使いやすいメモソフトを目指して，emacs org-mode + .my_helpで実装されました．

my_helpの使い方と振る舞いを紹介します．

使い方

README

振る舞い

~/.my_helpにmy_helpのmemoが保存されます．
そのファイルから必要な情報を取り出し，
そのファイルの操作を行う．

という単純なアプリです．なので，基本的な編集操作はemacs org-modeがあればできます．viとかvscodeでもorg-modeは用意されていますので，editorを変更してそのまま使えます．

emacs org-mode

ここでは，org-modeの使い方を紹介します．qiita_orgでも同じです．

概要

org-modeはemacsに組み込まれているmajor-modeの一つで，TODOなどが書きやすい機能が用意されています．それだけでなく，pdf出力やmd・html変換, 数式・図・表の表示があるので，卒論，修論などのreportや本格的な論文を書くのにも多用します．

開始

emacs hogehoge.org

あるいは

M-x org-mode

orgの体裁(markup)機能

見出し，リスト

* 見出し
** 子見出し
*** 孫見出し
** head付き項目
 - 項目1
   - 子項目1
   - 子項目2
 - 項目2
** 数字付き項目
 1. 最初の項目
 2. 二番目の項目
** 名前付き項目リスト
   - 名前1 :: 内容1
   - 名前2 :: 内容2
** チェックリスト [/]
   - [ ] チェック項目1
   - [ ] チェック項目2

文字修飾

前後に半角スペースが必要
太字
斜体
_下線_
=固定幅=
~~消し線~~

folding あるいはtoggle表示

これがorgの一番重宝している理由です．

titleやblockで :kbd:'tab' すると折り返しが効きます
shift-'tab'も違った挙動をします
folding, toggleと呼ばれます

リンク

[[file:./tmp/tmp.txt][Link to file]]
[[link][name]]

to edit, c-c c-l
to open, c-c c-o
org-return-follows-linkが設定されていたらRETでも開く

internal_Link

  * Headline 2
  :PROPERTIES:
  :CUSTOM_ID: my-headline-2
  :END:
[[#my-headline-2]]

外部ファイルの中のcustom idにlinkする場合, <../README.md>
編集用表示，M-x org-toggle-link-display

startup

'#+startup'でorg-fileを開けたときの振る舞いを調整できる．

indent, noindent
nolineimages,
content, overview, showall, showeverything

verb_and_code

block quote
- ': 'を頭におく
- #+begin_example…#+end_example
- #+begin_quote – #+end_quote
inline quote or command
- name or name
- 前後に半角空白がないと認識しない．
source
- #+begin_src ruby … #+end_src
- #+begin_src python -i … #+end_src #-iがないとindentが不適切
- #+begin_src tex … #+end_src
include
- #+name: ./codes/hello_name.rb
- #+include: "./codes/hello_name.rb" src ruby -i -n

数式

mathjaxを使って，htmlあるいはqiitaでは表示．記法は，platexと同じ

$$
\int_{x=1}^{x=3}\ln \left(\frac{1}{4x}\right) {\rm d}x
$$

$$\int_{x=1}^{x=3}\ln \left(\frac{1}{4x}\right) {\rm d}x$$

文章中では，'$'一個で囲うとできます．safariだと複数の数式が一行にあるとうまく表示されないかもです．

source ~/git_hub/ruby_docs/chart_style_ruby/c02_my_help.org

チャート式ruby-appendix-II(my_help)