参考手册

启动

  • 打包类型

    ME-Mydoc 有两种发布模式:平台相关以及平台无关。平台相关的下载包包含了目标平台的JRE,它的文件大小比较庞大。平台无关的下载包需要用户机器上有JRE或者JDK8。

  • 对于平台相关的下载包,解压并执行平台对应的启动项。

    Windows平台,执行命令 mydoc.exe 或者 mydoc.bat

    Linux或者Mac平台, 执行命令 mydoc.sh. 确保mydoc.sh有可执行权限,您需要执行命令 chmod +x mydoc.sh.

  • 对于平台无关的下载包,确保java可执行程序在PATH环境变量中。

    在Windows上, 执行命令 set PATH=<your java path>;%PATH%

    在Linux或者Mac上,执行命令 export PATH=<your java path>:$PATH。或许您需要预先给予jre目录执行权限, chmod +x -R <jre folder>

配置

  • 初次启动设置路径

_images/mydoc-install.jpg

用户可以点击按钮 Install 以默认路径开始初始化。或者用户也可以改变任意路径进行初始化。不存在的路径将会被创建。

笔记路径

保存笔记文件

文档路径

保存文档文件

电子书路径

保存电子书文件

代码路径

保存代码文件

索引缓存路径

保存索引缓存

临时文件路径

保存临时文件

回收站路径

删除文件回收所在路径

悬浮搜索窗

  • 全局快捷键显示/隐藏 悬浮搜索窗口

Ctrl + Alt + O : 显示/隐藏 悬浮搜索窗口

  • 悬浮窗口输入框中的快捷键

ESC

清除输入,当输入为空时隐藏窗口。

向下箭头

焦点移到结果列表,或者强制显示结果列表

回车

打开结果列表里的第一个项目

双击 一个项目

打开结果列表里的第一个项目

Ctrl + 双击 一个项目

显示项目属性窗口

Ctrl + 回车 一个项目

显示项目属性窗口

Alt + Enter 一个项目

显示项目的HTML超链接属性视图

  • Enlarge floating search window

    可以拖拽悬浮搜索窗口的右边来增大输入空间。

搜索规则

  • , 表示 AND 条件。例如:java,编程 找出所有标题包含 java编程 的项目。

  • 可以显示指定项目类型。目前有下列类型

b:

电子书

n:

笔记

d:

文档

c:

代码

t:

标签

默认情况下,只有启用的项目类型才会被显示。(菜单 视图 ‣ 文档, 视图 ‣ 笔记, 视图 ‣ 电子书)

例如,小说,现代,b: 列出所有标题含有 小说现代 的电子书. 等价于 b:小说,b:现代 或者 b:小说,现代

  • 指定全文检索的查询语句。例如, “java” 会找出所有内容包含 java 的项目。d:”java” 限制了项目内容为文档。其实,包含在 “” 的查询字符即Lucene查询字符串。比较典型的有条件与 “+词语1 +词语2” ,条件或 “词语1 词语2”

  • 指定多种类型是无效的,标签类型除外。例如, t:算法,b:数学 会找出所有电子书复合以下两个条件,标题含有 数学 ,标签含有字符串 算法

管理标签

  • 所有的电子书,笔记和文档都可以关联标签。

  • 程序第一次启动时候会生成预定义标签:电子书标签程序和程序语言标签。

  • 用户可以通过右击任意标签来创建一个新的标签。

_images/mydoc-tag-menu.png
  • 快速定位标签。在标签控件里输入标签路径。标签路径唯一标示了标签,比如 /电子书/艺术 表示电子书标签下的艺术标签。* 可以作为通配符匹配任意字符。例如 *艺术* 可以找到所有路径中含有艺术的标签, /电子书/* 表示以 /电子书/ 开头的标签。搜索从当前选定的标签开始。按 ESC 清除所有输入,按 回车 开始寻找下一个结果。

_images/mydoc-tag-search.png

注解

注意删除一个标签要求没有任何项目关联到此标签。

操作项目

  • 右键点击一个项目可以出发操作菜单

_images/mydoc-menu-right.png
  • 打开一个项目可以按 回车 或者 双击 搜索下拉列表或者主窗口列表

  • 在项目上按 Alt + 回车 会显示它的HTML超链接属性窗口。

_images/mydoc-book-hyperinfo.png
  • 属性窗口可以在一个项目上按 Ctrl + 回车 或者 Ctrl + 双击 来触发。

  • 文档属性窗口

_images/mydoc-doc-property.jpg
  • 笔记属性窗口

_images/mydoc-note-property.jpg
  • 电子书属性窗口

_images/mydoc-book-property.jpg

打开文件,可以双击 文件

_images/mydoc-misc-tooltip.png
  • 最近访问的项目。当新建一个项目或者访问它之后,会被更新到最近访问菜单里。

_images/mydoc-menu-history.png

添加文档

  • 创建新文档,可以通过菜单 文件 ‣ 添加文档 或者当焦点在主界面上按快捷键 Ctrl + Alt + D

_images/mydoc-doc-new.png
  • 要添加多个文件,点击按钮 选择

  • 标签 域中点击链接 修改 来修改标签。

_images/mydoc-tag.jpg
  • 创作时间 必须符合格式 YYYY 或者 YYYY-MM 或者 YYYY-MM-DD

  • 如果您添加的文件被检测出已经归档,(md5匹配),确认窗口将会弹出。您可以双击匹配列表中的项目来查看其属性。

添加笔记

  • 创建新笔记的全局快捷键 Ctrl + Alt + N

  • 另外,在主窗口标签上右击选择 创建笔记 可以创建一个关联与此标签的笔记。

  • 笔记编辑窗口有四个元素。最右边是HTML源代码编辑区。左边从上到下依次是属性,工具栏和HTML编辑区。

_images/mydoc-note-edit-with-src.png
  • 用户可以切换全屏模式和普通模式。全屏模式提供给用户最大的编辑空间。

_images/mydoc-note-cross-ref.jpg
  • 普通模式可以包含属性和工具栏。

_images/mydoc-note-normal-mode.jpg
  • 增强的工具栏按钮

_images/mydoc-note-button.jpg

描述如下

_images/note_render_code.png

打开关闭高亮源代码,当高亮源代码或者渲染数学公式时,HTML编辑区变成只读,用户只能在HTML源代码编辑区进行修改。

_images/note_math_16.png

打开关闭渲染数学公式,当高亮源代码或者渲染数学公式时,HTML编辑区变成只读,用户只能在HTML源代码编辑区进行修改。

_images/note_full_16.png

切换到全屏模式

_images/note_prop_16.png

显示或者隐藏属性区

_images/note_src_16.png

显示或者隐藏HTML源代码编辑区。

_images/note_link_16.png

给所选文字添加超链接

_images/note_image_16.png

插入图片链接

_images/note_code_16.png

将所选文字转换为代码

_images/note_sync_view_16.png

同步HTML编辑区的内容到HTML源代码编辑区

_images/note_refresh_16.png

全部刷新

_images/note_sync_src_16.png

同步HTML源代码编辑区的内容到HTML编辑区

  • 当焦点在HTML编辑区是,有下列快捷键

ESC

丢弃修改并关闭窗口。如果这个笔记是新建的,不保存这条笔记。

Alt + S

保存并保持窗口

F2

切换全屏普通模式

F5

刷新

F6

插入项目超链接

F9

减小字体

F10

增大字体

  • 在HTML源代码编辑区有如下快捷键

Alt + S

保存并刷新HTML编辑区

F5

刷新HTML编辑区

  • 项目超链接 F6 。您可以单击超链接来打开对应项目。

_images/mydoc-note-trigger-cross-ref.jpg _images/mydoc-note-render-math.jpg _images/mydoc-note-render-code.jpg

可以混合代码和AsciiMath

_images/mydoc-note-render-math-code.jpg

保存的HTML文件可以用浏览器打开,代码高亮和数学公式也可以正确显示。

注解

一旦其中一项启用以后,HTML编辑区就变成了只读,您只能在HTML源代码编辑区中修改。

添加代码

  • 一个代码项目包含若干个代码片段。每个片段可以指定一种程序设计语言标签,并以代码高亮显示。

_images/mydoc-code.jpg
  • 创建一个片段,单击 片段 域的 新建 按钮

  • 一个新创建的片段的默认程序设计语言是Java。点击 语言 域的 编辑 按钮来改变。

_images/mydoc-code-pl.jpg
  • 查看编辑一个代码片段,选择菜单 片段 ‣ 某一片段

_images/mydoc-code-snippets.jpg
  • 显示隐藏属性区,选择菜单 配置 ‣ 显示属性

_images/mydoc-code-minimal.png
  • 改变按键集,选择菜单 配置 ‣ 默认按键集 或者 配置 ‣ Vim 按键集

  • 从本地目录导入代码项目

选择菜单 文件 ‣ 导入代码 ,选择一个目录,所有文件都会被递归导入,注意不包括以点开头的目录。

添加电子书

  • 创建新的电子书项目,可以通过菜单 文件 ‣ 添加电子书 或者在主界面使用快捷键 Ctrl + Alt + B

_images/mydoc-book-new.png
  • 如果您添加的电子书文件被检测出已经归档,(md5匹配),确认窗口将会弹出。您可以双击匹配列表中的项目来查看其属性。

_images/mydoc-book-dup.png
  • 在域 标题 ,必须以格式 标题:副标题 输入。

_images/mydoc-book-title.jpg

双击一个已输入的标题,可以编辑标题所有部分。按 DEL 删除一个输入的标题。

_images/mydoc-book-title-detail.jpg
  • 在域 标签中 ,双击空白处会弹出 选择标签 窗口。 可以点击 切换到所有标签 。双击一个标签它就会被删除。

_images/mydoc-tag-book.jpg
  • 在域 作者 中,输入的全面会被程序解析。如果一个作者的姓和名跟以后作者匹配,会弹出 选择已有作者 窗口。在弹出窗口中点击 取消 会创建一个新的作者

_images/mydoc-author-select.jpg
  • 如果您希望进一步搜索已有作者,点击 选择已有作者

_images/mydoc-author-window.jpg
  • 在域 出版日期 中,必须遵循格式 YYYY 或者 YYYY-MM 或者 YYYY-MM-DD

  • 在域 出版社 中,双击空白处触发 选择出版社 窗口

  • 双击 系列 域会弹出 选择系列 窗口。

  • 一个电子书项目可以包含多个文件,通过点击 添加文件

  • 监视剪贴板并自动识别填充某些元信息。菜单里有多个选项,可以识别诸如ISBN,或者出版社之类的元信息。

_images/mydoc-book-new-menu.png

管理电子书

  • 自定义搜索电子书

_images/mydoc-book-search-custom.png
  • 添加新的出版社,请选择菜单 编辑 ‣ 出版社

_images/mydoc-publisher-window.png
  • 新建系列,选择菜单 编辑 ‣ 系列

  • 查看某作者名下的书,选择菜单 编辑 ‣ 搜索作者

搜索匹配结果

在全文检索窗口中,匹配的字符及其上下文会高亮。搜索规则参见 搜索规则

_images/mydoc-highlighter.png

视图控制

菜单 视图 选项

_images/mydoc-menu-view.png

视图 ‣ 仅显示当前标签

显示当前标签的项目

视图 ‣ 显示所有子标签

显示当前标签及其所有子标签关联的项目

视图 ‣ 显示收藏

显示收藏的项目。注意这个时候改变标签不会影响主界面项目列表

视图 ‣ 显示无标签

显示没有标签的项目

视图 ‣ 显示所有

显示所有项目

视图 ‣ 文档

显示文档项目。也会影响到 悬浮搜索窗

视图 ‣ 笔记

显示笔记项目。也会影响到 悬浮搜索窗

视图 ‣ 电子书

显示笔记项目。也会影响到 悬浮搜索窗

视图 ‣ 代码

显示代码项目。也会影响到 悬浮搜索窗

选项

_images/mydoc-dialog-option.png
  • 启用全文检索 :启用后,新的项目创建时会被索引。选择启用它后会提示用户开始索引。

_images/mydoc-dialog-index-option.jpg
  • 拷贝打开 :启用后,打开的文档或者电子书会预先拷贝到临时文件夹里,以防原文件意外损坏。

  • 显示隐藏项 : 启用后,在搜索下拉列表或者主窗口列表中显示隐藏的项目。

  • 删除时移动到垃圾文件夹 :启用后删除的项目会移至垃圾文件夹。