minidoc

package module

Go to main page

Versions in this module

v0

v0.1.12

Mar 8, 2020

Changes in this version

+ func ScreenScrape(url string) (*xmlpath.Node, error)

+ func SearchByXPath(context *xmlpath.Node, xpath string) []*xmlpath.Node

+ func SingleEntryModalForm(title, label, value string, width, height int) (*tview.Form, *tview.InputField, *tview.Pages)

+ func Transpose(line string, s *Search) string

+ func XPathGet(context *xmlpath.Node, xpath string, index int) string

type Help

+ func (h *Help) GetInstance() interface{}

type New

+ func (n *New) GetInstance() interface{}

type PageItem

+ GetInstance func() interface{}

type PagesHandler

+ func (p *PagesHandler) GetPageItem(title string) PageItem

type Search

+ Referenced *tview.TextView

+ RegionCount int

+ RegionDocIDs map[int]string

+ RegionID int

+ Rows *tview.Flex

+ func (s *Search) ClipboardCopy()

+ func (s *Search) GetInstance() interface{}

+ func (s *Search) GoToPreview()

+ func (s *Search) HideReferenced()

+ func (s *Search) Notify(title, text string)

+ func (s *Search) PreviewInputCapture() func(event *tcell.EventKey) *tcell.EventKey

+ func (s *Search) ShowNextReferenced()

type SetAppAdapter

+ func (a SetAppAdapter) GetInstance() interface{}

type ToDoDoc

+ Detail string

+ func (d *ToDoDoc) GetViEditFields() []string

type TreePage

+ func (t *TreePage) GetInstance() interface{}

+ func (t *TreePage) RenameFile(app *SimpleApp, path string)

v0.1.11

Mar 1, 2020

Changes in this version

+ func CreateGeneratedDirIfNotFound() string

+ func GetMiniDocGenDir() string

+ func GetParentPath(childPath string) string

+ func HTTPGet(url string) ([]byte, error)

+ func ImportFile(str string, s *Search) bool

+ func ImportFromWeb(str string, s *Search) bool

+ func ImportLineByLine(line string, s *Search) bool

+ type Node struct

+ Children []*Node

+ Expand bool

+ Path string

+ Selected func()

+ Text string

+ func NewDirNode(info os.FileInfo, path string) *Node

+ func NewFileNode(info os.FileInfo, path string) *Node

type SimpleApp

+ func (app *SimpleApp) SetStatus(text string, rightsides ...string)

+ type TreePage struct

+ App *SimpleApp

+ Columns *tview.Flex

+ Detail *tview.TextView

+ Nodes map[string]*Node

+ RootNode *Node

+ SelectedNode *Node

+ Title string

+ Tree *tview.TreeView

+ func NewTree() *TreePage

+ func (t *TreePage) ConvertToTreeNode(target *Node, expanded bool) *tview.TreeNode

+ func (t *TreePage) InputCapture() func(event *tcell.EventKey) *tcell.EventKey

+ func (t *TreePage) Page() (title string, content tview.Primitive)

+ func (t *TreePage) RefreshRootNode()

+ func (t *TreePage) SetApp(app *SimpleApp)

+ func (t *TreePage) Visit() filepath.WalkFunc

+ func (t *TreePage) WalkGenDirAsNode(minidocGenDir string) *Node

v0.1.10

Feb 27, 2020

v0.1.9

Feb 27, 2020

v0.1.8

Feb 27, 2020

Changes in this version

+ func CreateMinidocHomeIfNotFound() string

v0.1.7

Feb 26, 2020

Changes in this version

+ const DIRECTION_NONE

+ const DOWN

+ const UP

+ func ConfirmDeleteModal(s *Search, json interface{}, deleteFunc func(doc MiniDoc) error)

+ func ConfirmationModal(app *SimpleApp, message string, action func())

+ func DeleteFile(filepath string) (success bool)

+ func DocumentMapping(indexedFields []string) *mapping.DocumentMapping

+ func DoesBinaryExists(binary string) bool

+ func Exec(args []string) error

+ func Execute(args []string) (string, error)

+ func ExtractFieldValues(jh *JsonMapWrapper, f *tview.Form)

+ func GetCheckBoxChecked(form *tview.Form, label string) bool

+ func GetInputValue(form *tview.Form, label string) *string

+ func IndexMapping() (*mapping.IndexMappingImpl, error)

+ func JsonMapFrom(minidoc MiniDoc) interface

+ func NewCell(reference interface{}, text string, color tcell.Color) *tview.TableCell

+ func NewCellWithBG(reference interface{}, text string, color, bg tcell.Color) *tview.TableCell

+ func NewDocFlow(doctype string, app *SimpleApp) error

+ func NewEditForm(s *Search, doc MiniDoc) *tview.Form

+ func NewFormWithFields(doc MiniDoc) *tview.Form

+ func NewLoggingRows() *tview.Table

+ func NextSequence(bx *buckets.DB, sequenceName string) ([]byte, error)

+ func OpenFileIfNoneExist(filepath, content string) error

+ func OpenVim(app *SimpleApp, filepath string)

+ func ReadFromFile(filepath string) (string, error)

+ func Reindex(ih *IndexHandler, db *BucketHandler)

+ func WriteToFile(filepath, content string) (done bool)

+ type BaseDoc struct

+ CreatedDate string

+ Description string

+ Fragments string

+ ID uint32

+ Selected bool

+ Tags string

+ Title string

+ Toggled bool

+ Type string

+ func (M *BaseDoc) GetAvailableActions() string

+ func (m *BaseDoc) GetDescription() string

+ func (m *BaseDoc) GetDisplayFields() []string

+ func (m *BaseDoc) GetEditFields() []string

+ func (m *BaseDoc) GetID() uint32

+ func (m *BaseDoc) GetIDString() string

+ func (m *BaseDoc) GetJSON() interface{}

+ func (m *BaseDoc) GetMarkdown() string

+ func (m *BaseDoc) GetSearchFragments() string

+ func (m *BaseDoc) GetTags() string

+ func (m *BaseDoc) GetTitle() string

+ func (m *BaseDoc) GetToggle() bool

+ func (m *BaseDoc) GetToggleValueAsString() string

+ func (m *BaseDoc) GetType() string

+ func (m *BaseDoc) GetViEditFields() []string

+ func (m *BaseDoc) HandleEvent(event *tcell.EventKey)

+ func (m *BaseDoc) IsSelected() bool

+ func (m *BaseDoc) IsSelectedString() string

+ func (m *BaseDoc) IsTogglable() bool

+ func (m *BaseDoc) SetCreatedDate(createdDate string)

+ func (m *BaseDoc) SetID(ID uint32)

+ func (m *BaseDoc) SetIsSelected(selected bool)

+ func (m *BaseDoc) SetSearchFragments(fragments string)

+ func (m *BaseDoc) SetTags(tags string)

+ func (m *BaseDoc) SetToggle(toggle bool)

+ func (m *BaseDoc) SetType(doctype string)

+ type BucketHandler struct

+ DBPath string

+ func NewBucketHandler(opts ...BucketHandlerOption) *BucketHandler

+ func (bh *BucketHandler) Delete(doc MiniDoc) error

+ func (bh *BucketHandler) Read(key uint32, doctype string) (MiniDoc, error)

+ func (bh *BucketHandler) ReadAll(doctype string) ([]MiniDoc, error)

+ func (bh *BucketHandler) Write(doc MiniDoc) (uint32, error)

+ type BucketHandlerOption func(*BucketHandler)

+ func WithBucketHandlerDBPath(path string) BucketHandlerOption

+ func WithBucketHandlerDebug(debug func(string)) BucketHandlerOption

+ type CellData struct

+ type DataHandler struct

+ BucketHandler *BucketHandler

+ IndexHandler *IndexHandler

+ func (dh *DataHandler) Delete(doc MiniDoc) error

+ func (dh *DataHandler) Write(doc MiniDoc) (uint32, error)

+ type DebugView struct

+ App *SimpleApp

+ IsDebugOn bool

+ Layout *tview.Flex

+ Rows *tview.Table

+ func NewDebugView(app *SimpleApp) *DebugView

+ func (d *DebugView) Debug(message string)

+ type Edit struct

+ Form *tview.Form

+ Search *Search

+ func (e *Edit) CancelAction()

+ func (e *Edit) DeleteAction()

+ func (e *Edit) UpdateAction()

+ type Error int

+ const ErrorCSVDoesNotExist

+ const ErrorGeneric

+ func (e Error) Error() string

+ type Help struct

+ App *SimpleApp

+ Content *tview.TextView

+ func NewHelp() *Help

+ func (h *Help) Page() (title string, content tview.Primitive)

+ func (h *Help) SetApp(app *SimpleApp)

+ type IndexHandler struct

+ func NewIndexHandler(opts ...IndexHandlerOption) *IndexHandler

+ func (ih *IndexHandler) Delete(doc MiniDoc) error

+ func (ih *IndexHandler) Index(doc MiniDoc) error

+ func (ih *IndexHandler) Search(queryString string) ([]MiniDoc, string)

+ type IndexHandlerOption func(*IndexHandler)

+ func WithIndexHandlerDebug(debug func(string)) IndexHandlerOption

+ func WithIndexHandlerIndexPath(indexPath string) IndexHandlerOption

+ type JsonMapWrapper struct

+ func NewJsonMapWrapper(jsonMap interface{}) *JsonMapWrapper

+ type MiniDoc interface

+ GetAvailableActions func() string

+ GetDescription func() string

+ GetDisplayFields func() []string

+ GetEditFields func() []string

+ GetID func() uint32

+ GetIDString func() string

+ GetJSON func() interface{}

+ GetMarkdown func() string

+ GetSearchFragments func() string

+ GetTags func() string

+ GetTitle func() string

+ GetToggle func() bool

+ GetToggleValueAsString func() string

+ GetType func() string

+ GetViEditFields func() []string

+ HandleEvent func(event *tcell.EventKey)

+ IsSelected func() bool

+ IsSelectedString func() string

+ IsTogglable func() bool

+ SetCreatedDate func(string)

+ SetID func(uint32)

+ SetIsSelected func(bool)

+ SetSearchFragments func(string)

+ SetTags func(string)

+ SetToggle func(toggle bool)

+ SetType func(string)

+ func EditWithVim(app *SimpleApp, doc MiniDoc) (MiniDoc, bool)

+ func MiniDocFrom(jsonMap interface{}) (MiniDoc, error)

+ func NewDoc(doctype string) (MiniDoc, error)

+ type New struct

+ App *SimpleApp

+ BucketHandler *BucketHandler

+ Form *tview.Form

+ IndexHandler *IndexHandler

+ Layout *tview.Flex

+ func NewNewPage(doc MiniDoc) *New

+ func (n *New) CancelAction()

+ func (n *New) CreateAction()

+ func (n *New) Page() (title string, content tview.Primitive)

+ func (n *New) SetApp(app *SimpleApp)

+ type NoteDoc struct

+ Note string

+ func (d *NoteDoc) GetAvailableActions() string

+ func (d *NoteDoc) GetDisplayFields() []string

+ func (d *NoteDoc) GetEditFields() []string

+ func (d *NoteDoc) GetJSON() interface{}

+ func (d *NoteDoc) GetMarkdown() string

+ func (d *NoteDoc) GetViEditFields() []string

+ type PageFunc func() (title string, content tview.Primitive)

+ type PageItem interface

+ Page func() (title string, content tview.Primitive)

+ SetApp func(*SimpleApp)

+ type PagesHandler struct

+ CurrPageIndex int

+ MenuBar *tview.TextView

+ PageIndex map[string]string

+ PageItems []PageItem

+ Pages *tview.Pages

+ PrevMenuText string

+ func (p *PagesHandler) AddPage(s *SimpleApp, pi PageItem)

+ func (p *PagesHandler) GoToNextPage()

+ func (p *PagesHandler) GoToPrevPage()

+ func (p *PagesHandler) GotoPageByTitle(title string)

+ func (p *PagesHandler) HasPage(title string) bool

+ func (p *PagesHandler) LoadPages(s *SimpleApp)

+ func (p *PagesHandler) RemoveLastPage(s *SimpleApp)

+ func (p *PagesHandler) UnloadPages()

+ type ResultList struct

+ Search *Search

+ func NewResultList(s *Search) *ResultList

+ func (rl *ResultList) GetCellRefBool(rowIndex, colIndex int) (bool, error)

+ func (rl *ResultList) GetCellRefString(rowIndex, colIndex int) (string, error)

+ func (rl *ResultList) GetCellRefUint32(rowIndex, colIndex int) (uint32, error)

+ func (rl *ResultList) InputCapture() func(event *tcell.EventKey) *tcell.EventKey

+ func (rl *ResultList) InsertColumns(size int)

+ func (rl *ResultList) LoadMiniDocFromDB(rowIndex int) (MiniDoc, error)

+ func (rl *ResultList) MoveRow(direction int)

+ func (rl *ResultList) SetColumnCells(rowIndex int, cd []CellData)

+ func (rl *ResultList) UpdateRow(row int, doc MiniDoc)

+ type Search struct

+ App *SimpleApp

+ Columns *tview.Flex

+ CurrentRowIndex int

+ Detail *tview.TextView

+ EditForm *tview.Form

+ IsEditMode bool

+ Layout *tview.Flex

+ ResultList *ResultList

+ SearchBar *tview.Form

+ func NewSearch() *Search

+ func (s *Search) BatchDeleteActionFunc()

+ func (s *Search) BatchDeleteConfirmation()

+ func (s *Search) DelegateEventHandlingMiniDoc(event *tcell.EventKey) *tcell.EventKey

+ func (s *Search) Edit()

+ func (s *Search) GoToSearchBar(clear bool)

+ func (s *Search) GoToSearchResult()

+ func (s *Search) HandleCommand(command string)

+ func (s *Search) InitSearchBar()

+ func (s *Search) InputCapture(input *tview.InputField) func(event *tcell.EventKey) *tcell.EventKey

+ func (s *Search) LoadMiniDocFromDB(row int) (MiniDoc, error)

+ func (s *Search) Page() (title string, content tview.Primitive)

+ func (s *Search) Preview(direction int)

+ func (s *Search) Search(searchby string) bool

+ func (s *Search) SelectAllRows()

+ func (s *Search) SelectRow(row int)

+ func (s *Search) SetApp(app *SimpleApp)

+ func (s *Search) ToggleAllRows()

+ func (s *Search) ToggleSelected()

+ func (s *Search) ToggleTogglable()

+ func (s *Search) UnLoadEdit()

+ func (s *Search) UpdateCurrRowIndexFromSelectedRow(direction int)

+ func (s *Search) UpdateResult(result []MiniDoc)

+ type SetAppAdapter struct

+ func (a SetAppAdapter) SetApp(app *SimpleApp)

+ type ShortcutKeyDoc struct

+ ShortCutKey string

+ func (d *ShortcutKeyDoc) GetDisplayFields() []string

+ func (d *ShortcutKeyDoc) GetEditFields() []string

+ func (d *ShortcutKeyDoc) GetJSON() interface{}

+ type SimpleApp struct

+ BucketHandler *BucketHandler

+ DataHandler *DataHandler

+ DebugView *DebugView

+ IndexHandler *IndexHandler

+ Layout *tview.Flex

+ MenuBar *tview.TextView

+ PagesHandler *PagesHandler

+ PrevFocused tview.Primitive

+ Rows *tview.Flex

+ StatusBar *tview.TextView

+ func NewSimpleApp(opts ...SimpleAppOption) *SimpleApp

+ func (app *SimpleApp) ClearDebug()

+ func (app *SimpleApp) ClearMenu()

+ func (app *SimpleApp) Exit()

+ func (app *SimpleApp) GetInputCaptureFunc() func(event *tcell.EventKey) *tcell.EventKey

+ func (app *SimpleApp) GoToDebugView()

+ func (app *SimpleApp) ToggleDebug()

+ type SimpleAppOption func(*SimpleApp)

+ func WithSimpleAppConfirmExit(confirm bool) SimpleAppOption

+ func WithSimpleAppDataFolderPath(path string) SimpleAppOption

+ func WithSimpleAppDebugOn() SimpleAppOption

+ func WithSimpleAppDelegateKeyEvent(keyEvent func(event *tcell.EventKey) *tcell.EventKey) SimpleAppOption

+ func WithSimpleAppDocsReindexed(reindex bool) SimpleAppOption

+ func WithSimpleAppPages(pages []PageItem) SimpleAppOption

+ type ToDoDoc struct

+ Done bool

+ Task string

+ func (d *ToDoDoc) GetAvailableActions() string

+ func (d *ToDoDoc) GetDisplayFields() []string

+ func (d *ToDoDoc) GetEditFields() []string

+ func (d *ToDoDoc) GetJSON() interface{}

+ func (d *ToDoDoc) GetMarkdown() string

+ func (d *ToDoDoc) GetTitle() string

+ func (d *ToDoDoc) GetToggle() bool

+ func (d *ToDoDoc) GetToggleValueAsString() string

+ func (d *ToDoDoc) HandleEvent(event *tcell.EventKey)

+ func (d *ToDoDoc) SetToggle(toggle bool)

+ type URLDoc struct

+ URL string

+ WatchLater bool

+ func (d *URLDoc) GetAvailableActions() string

+ func (d *URLDoc) GetDisplayFields() []string

+ func (d *URLDoc) GetEditFields() []string

+ func (d *URLDoc) GetJSON() interface{}

+ func (d *URLDoc) GetMarkdown() string

+ func (d *URLDoc) GetToggle() bool

+ func (d *URLDoc) GetToggleValueAsString() string

+ func (d *URLDoc) HandleEvent(event *tcell.EventKey)

+ func (d *URLDoc) SetToggle(toggle bool)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL