novelWriter 技术文档

novelWriter 技术文档

novelWriter novelWriter is an open source plain text editor designed for writing novels. It supports a minimal markdown-like syntax for formatting text. It is written with Python 3 (3.8+) and Qt 5 (5.10+) for cross-platform support. 项目地址: https://gitcode.com/gh_mirrors/no/novelWriter

1. 安装指南

1.1 系统要求

• 操作系统: Linux, Windows, macOS
• Python版本: 3.9+
• 依赖库: Qt5, PyQt5 (5.15 only)

1.2 安装步骤

1.2.1 使用 pip 安装

pip install novelWriter

1.2.2 从源码安装

1. 克隆项目仓库:

   git clone https://github.com/vkbo/novelWriter.git
   cd novelWriter
   

2. 安装依赖:

   pip install -r requirements.txt
   

3. 运行安装脚本:

   python setup.py install
   

2. 项目使用说明

2.1 启动 novelWriter

安装完成后，可以通过命令行启动 novelWriter:

novelWriter

2.2 界面介绍

• 主界面: 包含文本编辑区、项目管理区、元数据编辑区等。
• 项目管理: 可以创建新项目、打开已有项目、保存项目等。
• 文本编辑: 支持 Markdown 语法，可以进行文本格式化、添加注释、编写大纲等。

2.3 项目管理

• 创建新项目: 点击“新建项目”按钮，输入项目名称和路径，即可创建新项目。
• 打开项目: 选择已有项目文件夹，点击“打开”按钮即可加载项目。
• 保存项目: 编辑完成后，点击“保存”按钮保存项目。

3. 项目API使用文档

3.1 API 概述

novelWriter 提供了一些 API 接口，用于项目管理和文本处理。以下是一些常用的 API 接口：

3.1.1 创建新项目

from novelWriter import Project

project = Project.create(project_name, project_path)

3.1.2 打开已有项目

from novelWriter import Project

project = Project.open(project_path)

3.1.3 保存项目

project.save()

3.1.4 添加文本

project.add_text(text_content)

3.1.5 获取项目信息

project_info = project.get_info()

3.2 API 示例

以下是一个简单的示例，展示如何使用 novelWriter 的 API 创建并保存一个新项目：

from novelWriter import Project

# 创建新项目
project = Project.create("MyNovel", "/path/to/save")

# 添加文本
project.add_text("这是一个新的章节。")

# 保存项目
project.save()

4. 项目安装方式

4.1 使用 pip 安装

pip install novelWriter

4.2 从源码安装

1. 克隆项目仓库:

   git clone https://github.com/vkbo/novelWriter.git
   cd novelWriter
   

2. 安装依赖:

   pip install -r requirements.txt
   

3. 运行安装脚本:

   python setup.py install
   

通过以上步骤，您可以成功安装并使用 novelWriter 进行小说创作和管理。

novelWriter novelWriter is an open source plain text editor designed for writing novels. It supports a minimal markdown-like syntax for formatting text. It is written with Python 3 (3.8+) and Qt 5 (5.10+) for cross-platform support. 项目地址: https://gitcode.com/gh_mirrors/no/novelWriter