一、iWriter 写在开发之前

Hi,大家好,我是姜友华。N年前我进行过一个名为“iWriter”的macOS程序开发,但后来不了了之,这一次重新拿起,希望能善始克终。

我打算使用Swift UI进行macOS开发,在之前我使用过Swift试过。macOS与iOS基本上很相似,但有一些特殊的方法在macOS里并没有。比如说:bringSubviewToFront(),在macOS里是没有的。

一、iWriter是什么?

iWriter是一个用来写作的程序。前一次把它想得很复杂,这一次我们按简单的来。看一下,草图效果如下:


欢迎页面
主页面
  1. 弱化菜单,只添加设置项在菜单里;
  2. 主页面分两个板块:默认左侧写作板块,右侧为辅助功能板块;
  3. 两板块可通过拖移板块间的分割线来控制大小,甚至可使用其中一个板块隐藏;
  4. 两板块可上下分布,可互换位置;
  5. 写作板块:默认左侧为目录,右侧为章节。可拖移中间的分割线控制大小或隐藏,也可上下分布、位置互换;
  6. 目录只有一个层级,即使用一维数组。目录可排序、可选择,不可编辑目录名称与删除;
  7. 章节可通过点击标题栏实现展开与收拢。展开时显示编辑区,可在其内编辑章节文节,收拢时只显示标题。编辑区的第一句自动为标题;
  8. 章节编辑区有查找与替换,只应用于当前章节;
  9. 章节最下方为新建章节按钮,可创建章节;
  10. 辅助功能板块,汇集多个辅助功能,可通过标签切换使用。主要辅助功能有:大纲(Mind),备忘录,取名,搜索等;
  11. 辅助功能有自己的工具栏;
  12. 章节编辑区、辅助功能区均可全屏。

二、文件格式的设定

格式的理解

文档型App需要设置其文档格式以保存输出。一般在格式处理上有两种方式。

  1. 单文件方式:使用一个文件来保存输出的内容,如PDF。
  • 头区:按固定字节长表示当前格式、版本、文件完整性的MD5、及其它信息。一般还有索引区的起止;
  • 索引区:摘要、公共资源(如字体等)与索引等,索引指出各内容片区的起止位置;
  • 内容片区:PDF的内容片区保存的是压缩后的数据。
  1. 多文件方式:使用多个文件来保存输出的内容,然后压缩为一个文件,如:EPUB。EPUB可以看成压缩了一个小网站。

我们在这里使用第二种方式。

为什么使用第二种方式

macOS的Document工程默认只支持第一种方式的格式,如果使用第一方式来实现,在开发上可能更方便,但我还是选择了第二方式实现格式。为什么会选用第二种方式呢。由于是写作类的程序,设计上有以下考虑:

  1. 各章节分开保存,编辑时不用加载整个作品,这个在操作时有一定的便利性,如:加载、版本管理等。

  2. 想加一些辅助功能到程序中,这些辅助功能的数据有的也需要保存,如:大纲、备忘录等。这些辅助功能本身有可能产生极大的数据量。

总体来说,不愿意基于一个极大的数据进行操作。

iWriter的格式

iWriter的格式数据有两种类型:

1. .txt,按章节保存作品内容
  • 作品内容:每一章节一个多个Text文件,章节创建的时间加最新版本时间。即前面的时间表示章节,后面的时间表示版本;
1234323203_0.txt               // 章节刚创建的。
1234323203_12343245233.txt   // 建立新版本的。

内容。第一段为标题,其余为内容。

XXXX // 标题。
XXXXXXXXXX // 内容。
2. .json,按目录、辅助功能分文件保存JSON数据。
  • 目录文件,catalog.json
    JSON文件,保存作品名称、目录。第一个对象为作品名称,其余为章节名称;
{
    title: "作品名称"
    createTime: 123141214,    // 作品创建的时间。
    queue : [      // 目录排序。
       1234323203    // 章节创建的时间。
        ......
    ],
    items: { 1234323203: [    // 章节明细。如无,则只有默认版本。
        {
          id: 12343245233,    // 章节创建时间。
          title: "",    // 章节标题。
          ......      
        },
         ......
    ]}
}
  1. 辅助功能数据:如大纲、备忘录等,需要进再讲。

好,这一章就到这里,我是姜友华,下次见。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容