footnote

README

* Footnote

为一段字符串添加注脚

** before
#+BEGIN_SRC 
this is line 1.
and another line....
yet another line...
ok , the last line
#+END_SRC


** after
#+BEGIN_SRC 
this is line 1.
and another line....                  (1)
yet another line...
ok , the last line                    (2)

-----------------------------------------

1) note text
   here for (1)
2) note text here for (2)
#+END_SRC

** Usage
   
   - func New(content string) *FootNote 

     initial

   - func (f *FootNote) NoteLine(line int, note string) *FootNote 

     note line, line num begin from 0

   - func (f *FootNote) NotePoint(pos int, note string) *FootNote 

     note position, will compute line number

   - func (f *FootNote) Dump() string 
     
     generate result string

Documentation

Index

• type FootNote
  • func New(content string) *FootNote
  • func (f *FootNote) Dump() string
  • func (f *FootNote) NoteLine(line int, note string) *FootNote
  • func (f *FootNote) NotePoint(pos int, note string) *FootNote
  • func (f *FootNote) NoteRegex(regex *regexp.Regexp, note string) *FootNote

Types

type FootNote

type FootNote struct {
	// contains filtered or unexported fields
}

func New

func New(content string) *FootNote

func (*FootNote) Dump

func (f *FootNote) Dump() string

func (*FootNote) NoteLine

func (f *FootNote) NoteLine(line int, note string) *FootNote

func (*FootNote) NotePoint

func (f *FootNote) NotePoint(pos int, note string) *FootNote

func (*FootNote) NoteRegex

func (f *FootNote) NoteRegex(regex *regexp.Regexp, note string) *FootNote