tpp 文本演示程序技术文档

1. 安装指南

1.1 环境要求

在安装 tpp 之前，请确保您的系统满足以下依赖项：

• Ruby 1.8：可以从 Ruby 官方网站 下载并安装。
• ncurses：确保安装了最新版本的 ncurses 库。
• ncurses-ruby：可以通过 ncurses-ruby GitHub 仓库 安装。

可选依赖项：

• FIGlet：如果您希望在演示中使用大字体的文本，可以安装 FIGlet。

1.2 安装步骤

1. 获取 tpp 的源代码。

2. 在终端中切换到 tpp 源代码目录。

3. 以 root 权限运行以下命令进行安装：

   make install
   

2. 使用说明

2.1 启动演示

要启动 tpp 并显示演示文稿，请在终端中运行以下命令：

$ tpp presentation.tpp

其中 presentation.tpp 是您的演示文稿文件。

2.2 控制键说明

在演示过程中，您可以使用以下按键来控制演示：

• 空格键、向下箭头、向右箭头：显示下一页。
• b、向上箭头、向左箭头：显示上一页。
• q、Q：退出 tpp。
• j、J：直接跳转到指定页面。
• l、L：重新加载当前文件。
• s、S：跳转到第一页。
• e、E：跳转到最后一页。
• c、C：启动命令行。
• ?、h：显示帮助屏幕。

在终端的左下角，您会看到当前幻灯片的编号和总幻灯片数。如果当前幻灯片的内容未完全显示，按下空格键将继续显示下一页内容。

3. API 使用文档

3.1 演示文稿格式

tpp 演示文稿由普通文本行和特殊命令组成。特殊命令以 -- 开头，后跟命令名称。

演示文稿分为一个或多个页面，页面之间用 --newpage 分隔。在第一个 --newpage 之前的所有非命令文本将用作演示文稿的摘要部分，您可以在此设置标题、作者和日期。

3.2 常用命令

摘要页命令

• --author：设置演示文稿的作者。
• --title：设置演示文稿的标题。
• --date：设置演示文稿的日期。如果日期为 today，则插入当前日期。
• --bgcolor <color>：设置背景颜色。
• --fgcolor <color>：设置前景颜色。

页面内命令

• --heading <heading>：绘制标题，标题将居中并以粗体显示。
• --horline：在当前行绘制一条水平线。
• --header：在屏幕的第一行添加文本。
• --footer：在屏幕的最后一行添加文本。
• --color <color>：设置文本颜色，直到新的颜色被设置。
• --center <text>：居中显示文本。
• --right <text>：右对齐显示文本。
• ---：暂停显示，直到按下空格键。
• --beginoutput：标记框架输出的开始。
• --endoutput：标记框架输出的结束。
• --beginshelloutput：标记框架 shell 输出的开始。
• --endshelloutput：标记 shell 输出的结束。
• --sleep <seconds>：暂停指定秒数。
• --boldon：开启粗体打印。
• --boldoff：关闭粗体打印。
• --revon：开启反色打印。
• --revoff：关闭反色打印。
• --ulon：开启下划线打印。
• --uloff：关闭下划线打印。
• --huge <text>：使用 FIGlet 生成大字体文本。
• --sethugefont <font>：设置 FIGlet 使用的字体。
• --exec <cmd>：执行指定的命令。
• --withborder：在当前页面周围添加边框。

4. 项目安装方式

4.1 从源代码安装

1. 下载 tpp 的源代码。

2. 解压源代码包并进入解压后的目录。

3. 运行以下命令进行安装：

   make install
   

4.2 使用 Vim 语法文件

要将 tpp 的 Vim 语法文件添加到您的 Vim 配置中，请执行以下步骤：

1. 将 tpp.vim 文件复制到 ~/.vim/syntax/ 目录。

2. 如果 ~/.vim/filetype.vim 文件不存在，请创建它，并添加以下内容：

   if exists("did_load_filetypes")
       finish
   endif
   augroup filetype detect
       au! BufRead,BufNewFile *.tpp  setfiletype tpp
   augroup END
   

3. 如果 Vim 默认未启用语法高亮，请在 Vim 命令模式下输入 :syntax on 以启用语法高亮。

4.3 使用 TextWrangler/BBEdit 语法文件

要将 tpp 的语法文件添加到 TextWrangler 或 BBEdit 中，请将 TPP.plist 文件复制到 ~/Library/Application Support/TextWrangler/Language Modules/ 目录。

结语

tpp 是一个功能强大的文本演示工具，适合在终端环境中进行演示。通过本文档，您可以轻松安装、使用并深入了解 tpp 的各项功能。希望本文档能帮助您更好地使用 tpp 进行演示文稿的创建和展示。