2 Star 2 Fork 0

xiexiaodong / iNote

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0
title: 😄iNote 帮助文档
date: 2021-07-26 10:24:21
categories: 帮助
tags: iNote
excerpt: ''

iNote 简介

iNote 专为「电子实验记录」而生:

  1. 内嵌整合了流行美观的 typora 文本编辑器,可轻松撰写图文并茂的笔记
  2. 内嵌整合了 git 工具,轻松实现记录的跟踪和内容版本控制
  3. 简单的用户界面,方便您管理搜索内容,快速访问日志记录及其附属资源
  4. 丰富的右键菜单,帮助您向实验记录中插入图片、音频、视频以及其它各种文件
  5. 实用的导出功能,可导出为 html,带参考文献的 docx 或者 zip 压缩包
  6. 便捷的资料备份和恢复功能,采用增量备份方案,节省备份所需空间和时间

iNote 界面概览

image-20210726102031168

注:此为用户界面基本设计,新增功能主要是添加 actionButton,未必及时更新

iNote 安装与配置

1️⃣下载文件解压

百度网盘链接:https://pan.baidu.com/s/1LTuK1ffHfXWII9oN3qJHug

提取码:v273

iNote 目前支持 windows 系统和 manjaro-linux 系统,请使用 7z 工具 解压,解压后目录如下:

2️⃣修改注册表

双击运行iNote.exe,第一次打开会自动生成iNote.reg注册表文件,双击注册表文件,一路同意或者OK,这样您就可以把 iNote 添加到系统右键菜单中,可以右键单击任意文件夹使用 iNote 打开了。

iNote 使用方法

1️⃣运行 iNote

针对每一个课题,新建一个文件夹📂,然后右键单击,选择使用iNote 打开即可。打开一个项目后,强烈推荐 Settings > Shortcut 在桌面创建快捷方式,下次直接双击即可使用 iNote 打开指定文件夹。

2️⃣新建文稿(Ctrl+N)

点击菜单栏中 File 可以寻找到按钮,需要注意的是:

  • 新建文件,文件名默认为时间戳,您也可以根据情况修改
  • 新建文件自带 front matter,请注意修改标题(title)
  • 如果你希望文件在列表中置顶显示,则标题以 🚀、🔥、⏳三种emoji 表情开头,如title: 🔥这篇文章可以置顶
  • front matter 目前支持 abstractcategoriestags 等字段,分类一篇文章建议仅为一个,标签不超过五个,如果有多个分类和标签,使用空格分开。

3️⃣标题标签举例

emoji 名称 备注
星星 周小结、小组会
📊 图表 数据分析
🔨 锤子 做实验
🎨 调色板 作图
💎 钻石 非常重要
👀 眼睛 阅读文献或调研
🎯 飞镖 计划安排目标
🚌 巴士 出差
💻 电脑 写代码
🔍 放大 搜索文献或网络资源
🛒 购物 买试剂耗材仪器设备

标题标签有助于通过图形快速对文稿的类别和性质做分类

4️⃣使用git版本控制(Ctrl+G)

对于任一项目文件夹内,首次使用 git 版本控制功能,需要File>Commit 提交版本注释,完成版本控制的初始化。

后续使用,程序启动时会自动提交修改记录,实现版本控制。当然如果你取得了关键的重要的进展,建议手动 commit,并且输入自定义注释信息,如某某实验成功!。手动提交的将被记录到history.md文件中,并自动加入时间戳,在软件下方消息框随机动态显示。

5️⃣搜索关键词

  • 搜索框输入为空或关键词长度小于2时,搜索会自动刷新当前文件列表
  • 多关键词搜索,使用空格键隔开
  • 正则搜索仅支持一条表达式,需要以*作为前缀,且.能够匹配\n(换行符)
  • 输入help搜索,会自动打开 iNote 的帮助文档网页
  • 支持日期范围搜索语法,输入date:20210714:3,可以搜索 2021年7月14日之后三天内的文稿,对应的date:20210714:-3则表示三天之前的文稿。
  • 搜索框输入内容以:开头,进入message状态,输入内容将被记录到message.md文件中,并自动加入时间戳,在软件下方消息框随机动态显示。

6️⃣搜索结果右键菜单

  • cite:引用该文稿,生成🔗[《title》](filepath)到粘贴板
  • related:显示选中文稿内引用的其它相关文稿
  • openAssets:打开文稿附录文件夹
  • addImage:向文稿中插入图片资源(可以是多张),文件会自动拷贝到附录,如果资源已经存在于附录,您可以直接把文件拖拽到文稿中,引用文本自动拷贝到粘贴板,下同。
  • addAudio:向文稿中插入音频资源
  • addMovie:向文稿中插入视频资源
  • addOthers:向文稿中插入其它文件资源
  • toArchive:将文稿归类到指定分类
  • toDesktop:将文稿及其附录资源拷贝到桌面 Export 目录并压缩(文件后缀名为.iNote.zip
  • toHTML:依赖pandoc插件,将文稿导出为可离线访问的独立 HTML 文件(可嵌入音频和视频)到用户桌面
  • toDOCX:依赖pandoc插件,将文稿导出为带有引用参考文献的docx文档到用户桌面
  • toTrash:将文稿及其附录资源移动至桌面 Trash 目录
  • copy:将文稿绝对路径拷贝至粘贴板
  • paste:与copy组合使用,能够把一个文库的文稿及其附录资源复制粘贴到另外一个文库中
  • import:导入后缀名为.iNote.zip的文件到文库中
  • post:可以修改文稿的 Front-Matter,包括标题、摘要、分类和标签等信息
  • gather:多选状态下(Alt+C可切换单选多选状态)的功能,可基于多个文稿生成新的汇总文件。

7️⃣ Archive说明

对于科研课题相关文稿资料,大体上按照 paper 分为以下几类:

  • Favorites:一般性收藏
  • References:课题相关参考资料,包括文献和其它资源
  • Methods:课题相关的有效的重要的实验方法
  • Materials:所使用到的一些实验试剂耗材设备仪器,包括采购报销记录
  • Results:一些重要的有效的实验分析结果
  • Discussion:小组会或者一般性学术交流
  • Summary:对课题的思考,比如创新性、重要性和展望

特别提示,Archive 属于后置行为,一般在文稿完成后定期进行分类,与标题 emoji 搭配使用,事半功倍。分类后有助于撰写文章时查找相关内容。

8️⃣ 快捷键

  • Enter:搜索或提交文本输入框内容
  • Ctrl+N:新建文稿
  • Ctrl+G:提交修改
  • Ctrl+T:窗口置顶
  • Alt+C:切换列表单/多选模式

Vscode 使用技巧

vscode 是 iNote 强烈推荐并完美适配的文本编辑器,使用简单,界面简洁优美,功能强大,是您撰写试验记录的不二选择。

安装 vscode 之后,一定要安装 Markdown All in One、Paste Image、Foam 等插件,以支持更便捷丰富的 markdown 编辑预览功能。

Markdown语法及原理从入门到高级(可能是全网最全) - 知乎 (zhihu.com)

Markdown 教程 | 菜鸟教程 (runoob.com)

Git 版本控制

版本控制最主要的功能就是追踪文件的变更。它将什么时候、什么人更改了文件的什么内容等信息忠实地了记录下来。iNote 采用 git 对实验记录进行版本控制,提供了简单的 commit 按钮实现一键式提交修改到本地仓库。您可以使用 github desktop 等工具可视化追溯查看文件修改记录。

Git - 关于版本控制 (git-scm.com)

如何学习版本控制工具Git? - 知乎 (zhihu.com)

版本控制系统 - GIT - 知乎 (zhihu.com)

配套工具推荐

在撰写日志的过程中,好用的截图和屏幕录制工具必不可少,这里强烈推荐 snipastescreen2gif 两个工具。用户可自行从上边提供的百度云分享链接下载,解压即可使用。

相关介绍资料如下:

最强截图软件:snipaste - 知乎 (zhihu.com)

GIF截图工具推荐——screenToGIF。_wsdchong的博客-CSDN博客

插入参考文献的说明

注意此说明仅针对导出具有参考文献的docx文档功能进行。默认状态下,程序自动寻找选定文稿附录中的 refs.bib 读取文献条目记录。您可以使用 Mendeley、Zotero、JabRef 等文献管理工具导出文献条目为 refs.bib 文件,然后添加到文稿附录中。在 markdown 文稿中插入引用时使用 [@CitationKey;@CitationKey2]的方式。

对于 Mendeley,您可以生成一个跟文献库实时同步的 library.bib(Mendeley>Tools>Option>BibTeX>Enable BibTex syncing),然后修改 iNote解压目录中 plugin/pandoc/MD2DOCX.bat 文件。将 set bibpath=%~f2 修改为 set bibpath="path/to/library.bib",注意path/to/library.bib 是 Mendeley 生成实时同步的 library.bib 的绝对路径。

一些奇奇怪怪的问题

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于「git 版本控制」和 「typora」的电子实验记录创建和管理工具 展开 收起
Python 等 3 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/sheldonxxd/inote.git
git@gitee.com:sheldonxxd/inote.git
sheldonxxd
inote
iNote
master

搜索帮助