From 7f830605ff41c1bae5fe4de5fecc7a45d1df847b Mon Sep 17 00:00:00 2001 From: filesite Date: Wed, 8 Jan 2025 07:07:59 +0800 Subject: [PATCH] change filesite to english default --- themes/manual/views/site/index.php | 4 +- themes/manual/views/view/index.php | 4 +- www/content/README.md | 228 +++++++++++++++-------------- www/content/en/README.md | 12 +- www/content/zh-cn/README.md | 201 +++++++++++++++++++++++++ 5 files changed, 332 insertions(+), 117 deletions(-) create mode 100644 www/content/zh-cn/README.md diff --git a/themes/manual/views/site/index.php b/themes/manual/views/site/index.php index 35e066d..a643765 100644 --- a/themes/manual/views/site/index.php +++ b/themes/manual/views/site/index.php @@ -13,12 +13,12 @@ eof; {$viewData['author']} + author: {$viewData['author']}
eof; } ?> - 修改： + updated: diff --git a/themes/manual/views/view/index.php b/themes/manual/views/view/index.php index beb0fa7..61b2b89 100644 --- a/themes/manual/views/view/index.php +++ b/themes/manual/views/view/index.php @@ -14,12 +14,12 @@ eof; {$viewData['author']} + author: {$viewData['author']}
eof; } ?> - 修改： + updated: diff --git a/www/content/README.md b/www/content/README.md index 651227e..539da45 100644 --- a/www/content/README.md +++ b/www/content/README.md @@ -1,201 +1,207 @@ -# FileSite.io，一个基于文件和目录管理网址、文章、图片、视频的标准 +# FileSite.io - A standard for managing URLs, articles, images, and videos based on files and directories -**摘要：** +**Summary:** -我们基于已有的文件格式定义了一个管理几种用户常用数据类型的**标准**，旨在帮助用户在保留现有内容管理习惯的前提下，更容易地把自己的创作建设成网站、App，同时还能更简单地把创作发布到各种平台。 +Based on existing file formats, we have defined a **standard** for managing several commonly used data types by users, aiming to help users more easily build their own creations into websites while retaining their existing content management habits. App, while also making it easier to publish your creations to various platforms. -此标准目前支持网址、文章、图片和视频四种类型的数据，如有需要还将扩展其它的数据类型。 +This standard currently supports four types of data: URLs, articles, images, and videos, and will expand to other data types if necessary. -## 简介 +## Introduction -我们相信每个人都是一名创作者，他/她可以是作家，可以是摄影师，还可以是摄像师，也许他/她还会把自己喜欢的网站收藏并加以分类。 +We believe that everyone is a creator. He/she can be a writer, photographer, or videographer. Maybe he/she will also collect and classify his/her favorite websites. -因为现有的平台和环境，多数人的创作只能静静地躺在电脑的硬盘里，但终将有一天，在许许多多的从业者们的推动下，把个人的创作内容建设成网站、App的门槛会越来越低，那时人人都可以轻松、快捷地创建自己的网站和App，能用一键上传的功能就能把作品发布到各大平台。 +Because of the existing platform and environment, most people's creations can only lie quietly on the computer's hard drive, but one day, with the promotion of many practitioners, personal creative content will be built into a website , The threshold for apps will become lower and lower. At that time, everyone can easily and quickly create their own websites and apps, and can publish their works to major platforms using the one-click upload function. -我们还坚信，**每个人的作品所有权始终都归作者所有**，无论他/她已经把作品发布到哪个平台，只要他/她愿意，随时都能删除某个平台上他/她所有的数据，从电脑把作品快速上传到另一个平台是如此简单，这将改变平台和创作者之间的关系，不再是创作者依赖平台，而是**平台依赖创作者**。 +We also firmly believe that **the ownership of everyone's work always belongs to the author**, no matter which platform he/she has published the work on, he/she can delete all his/her works on a certain platform at any time as long as he/she wishes. Data, it is so simple to quickly upload works from a computer to another platform, which will change the relationship between the platform and the creator. It is no longer the creator who depends on the platform, but the platform depends on the creator. -正因为如此，我们提出了一个新标准，它没有采用任何新技术，完全基于已有的操作系统、文件系统和文件类型，以及大部分人现有的使用习惯，它也是一次抛砖引玉，让这一天早点到来吧！ +Because of this, we have proposed a new standard that does not use any new technology. It is completely based on existing operating systems, file systems and file types, as well as the existing usage habits of most people. It is also an introduction to the future. Come early! -## 版本 +## Version -名称：filesite_2023 +Name: filesite_2023 -版本号：20230130 +Version number: 20230130 -修改时间：2023-01-30 +Modification time: 2023-01-30 -## 目录和文件 +## Directories and files -本标准所说的目录和文件，是指Windows、Linux、MacOS等常用操作系统中的文件和目录。 +The directories and files mentioned in this standard refer to files and directories in common operating systems such as Windows, Linux, and MacOS. -如果市面上不同操作系统中对文件和目录的命名规范存在差异，本标准则采用他们都支持的部分。 +If there are differences in the naming conventions of files and directories in different operating systems on the market, this standard adopts the parts supported by them. -## 数据类型 +## Data type -当前版本支持以下几种类型的数据： +The current version supports the following types of data: -| 类型 | 格式 | +| Type | Format | | ---- | ---- | -| 网址 | .url 快捷方式 | -| 文章 | .md markdown文件 | -| 图片 | .jpg, .png, .gif, .ico | -| 视频 | .mp4, .m3u8, .ts | +| URL | .url shortcut | +| Article | .md markdown file | +| Pictures | .jpg, .png, .gif, .ico | +| Video | .mp4, .m3u8, .ts | -## 数据说明 +## Data description -如果需要对上述类型的数据进行扩展说明，请使用.txt格式的纯文本文件保存，我们把这类.txt文件称为“**描述文件**”。 +If you need to extend the description of the above types of data, please use a plain text file in .txt format to save it. We call this type of .txt file a "**description file**". -描述文件命名规则如下： +The description file naming rules are as follows: ``` -目录的描述文件：{英文小写属性名}.txt -文件的描述文件：{被描述文件名_}{英文小写属性名}.txt +Directory description file: {English lowercase attribute name}.txt +File description file: {described file name_}{English lowercase attribute name}.txt ``` -几个常用的属性描述文件如下： +Several commonly used attribute description files are as follows: -| 文件名 | 说明 | 属性名 | +| File name | Description | Property name | | ---- | ---- | ---- | -| title.txt | 标题 | title | -| description.txt | 描述信息 | description | -| keywords.txt | 关键词信息 | keywords | -| snapshot.txt | 快照图片 | snapshot | +| title.txt | title | title | +| description.txt | Description information | description | +| keywords.txt | keyword information | keywords | +| snapshot.txt | snapshot picture | snapshot | -## 目录和文件结构 +## Directory and file structure -目录里可包含子目录和文件，目录层级**最多支持 5 级**。 +The directory can contain subdirectories and files, and the directory hierarchy supports up to 5 levels**. -用目录对数据进行**分组**，同一分组的文件放在同一个目录里。 +Use directories to **group** data, and put files in the same group in the same directory. -示例（字母**d**代表目录，字母**f**代表文件）： +Example (the letters **d** represent directories and the letters **f** represent files): ``` --d- 小说 - |_d_ 金庸小说 - |_f_ 最爱金庸网站图标.ico - |_f_ 最爱金庸.url - |_d_ 古龙小说 - |_f_ 最爱古龙网站图标.ico - |_f_ 最爱古龙.url --d- 图片 - |_d_ 图片搜索 - |_f_ 谷歌图片搜索图标.ico - |_f_ 谷歌图片搜索.url - |_f_ description.txt - |_d_ 必应图片搜索 - |_f_ bing图标.ico - |_f_ bing.url - |_f_ title.txt +-d- novel + |_d_ Jin Yong’s novels + |_f_ Favorite Jin Yong website icon.ico + |_f_ Favorite Jin Yong.url + |_d_ Gu Long Novels + |_f_ Favorite cologne website icon.ico + |_f_ favorite cologne.url +-d- pictures + |_d_ Image Search + |_f_ Google image search icon.ico + |_f_ Google Image Search.url + |_f_ description.txt + |_d_ Bing Image Search + |_f_ bingicon.ico + |_f_ bing.url + |_f_ title.txt ``` -## API数据结构 +## API data structure -### 目录-Directory +### Directory ``` [ - 'id' => '根据完整路径生成的唯一编号', - 'pid' => '父目录id', //如果有父目录的话 - 'directory' => '倚天屠龙记', - 'realpath' => '/www/webroot/content/倚天屠龙记/', - 'path' => '/list/?id={id}', - 'snapshot' => '/content/倚天屠龙记封面图.jpg', - 'files' => [...], //文件列表 - 'directories' => [...] //目录列表 + 'id' => 'A unique number generated based on the complete path', + 'pid' => 'parent directory id', //if there is a parent directory + 'directory' => 'Eternal Dragon Sword', + 'realpath' => '/www/webroot/content/天杀龙记/', + 'path' => '/list/?id={id}', + 'snapshot' => '/content/The cover image of Yitian Slaying the Dragon.jpg', + 'files' => [...], //file list + 'directories' => [...] //Directory list ] ``` -### 文件-File +### File -除网址之外的文章、图片、视频文件。 +Articles, pictures, and video files other than URLs. ``` [ - 'id' => '根据完整路径生成的唯一编号', - 'pid' => '父目录id', //如果有父目录的话 - 'filename' => '第一章', - 'realpath' => '/www/webroot/content/倚天屠龙记/第一章.md', - 'path' => '/view/?id={id}', - 'extname' => 'md', - 'extension' => 'MD', - 'fstat' => [...], //同php方法fstat: https://www.php.net/manual/en/function.fstat.php - 'content' => '文章内容...', - 'description' => '文章简介...', - 'keywords' => '文章关键词...', - 'snapshot' => '/content/倚天屠龙记/第一章封面图.jpg', + 'id' => 'A unique number generated based on the complete path', + 'pid' => 'parent directory id', //if there is a parent directory + 'filename' => 'Chapter 1', + 'realpath' => '/www/webroot/content/天杀龙记/Chapter 1.md', + 'path' => '/view/?id={id}', + 'extname' => 'md', + 'extension' => 'MD', + 'fstat' => [...], //Same as PHP method fstat: https://www.php.net/manual/en/function.fstat.php + 'content' => 'Article content...', + 'description' => 'Article introduction...', + 'keywords' => 'Article keywords...', + 'snapshot' => '/content/Eternal Dragon Sword/Chapter 1 Cover Picture.jpg', ] ``` -其中： -extension区分大小写，extname只有小写。 +Special fields: +* extname is lower case, case insensitive +* extension is case sensitive -.txt，.md和.url 3 种文件说明： -* .txt文件是其它所有文件的描述文件，不会出现在文件列表里； -* .md会读取文件内容并存储在属性content里； -* .url读取文件内容并存储在属性shortcut里； +.txt, .md and .url 3 file descriptions: +* .txt files are description files for all other files and will not appear in the file list; +* .md will read the file content and store it in the attribute content; +* .url reads the file content and stores it in the attribute shortcut; -### 网址-Shortcut +### URL-Shortcut -.url文件是一种通用的网页快捷方式，它的数据结构比上述文件数据结构多了一个属性：**shortcut**。 +The .url file is a universal web page shortcut. Its data structure has one more attribute than the above file data structure: **shortcut**. ``` [ - 'id' => '根据完整路径生成的唯一编号', - 'pid' => '父目录id', //如果有父目录的话 - 'filename' => 'filesite.io', - 'realpath' => '/www/webroot/content/网址导航/filesite.io.url', - 'path' => '/link/?id={id}', - 'extname' => 'url', - 'extension' => 'url', - 'fstat' => [...], //同php方法fstat: https://www.php.net/manual/en/function.fstat.php - 'shortcut' => [ - 'name' => 'filesite.io', - 'url' => 'https://filesite.io', - ], + 'id' => 'A unique number generated based on the complete path', + 'pid' => 'parent directory id', //if there is a parent directory + 'filename' => 'filesite.io', + 'realpath' => '/www/webroot/content/URL Navigation/filesite.io.url', + 'path' => '/link/?id={id}', + 'extname' => 'url', + 'extension' => 'url', + 'fstat' => [...], //Same as PHP method fstat: https://www.php.net/manual/en/function.fstat.php + 'shortcut' => [ + 'name' => 'filesite.io', + 'url' => 'https://filesite.io', + ], ] ``` -.url文件内容示例： +Example of .url file content: ``` [InternetShortcut] URL=https://microsoft.com/ ``` -## PHP版实现 +## PHP implementation -我们基于本标准用php做了一个名为Machete的开源程序，你可以在github上找到它： +We made an open source program called Machete using PHP based on this standard. You can find it on github: ``` https://github.com/filesite-io/machete/ ``` -详细介绍参见： +For detailed introduction, see: -[Machete - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统](./Machete_Doc.md) +[Machete - database-free, file- and directory-based Markdown document, website navigation, book, picture, video website PHP open source system](./Machete_Doc.md) -## 联系我们 +## Contact us -如果你觉得Filesite.io对你有帮助，并愿意在某个项目中使用它，很高兴你跟我们分享你的故事： +If you find Filesite.io helpful and would like to use it in a project, we'd love you to share your story with us: -* 加入QQ群： +* Send email to us: +``` +machete@filesite.io +``` + +* Join QQ group: - Machete图片、视频源码交流群：44123711 + QQ group of Filesite/Machete: 44123711 -* 扫码加微信好友： +* Scan the QR code to add WeChat friends: - 扫描微信二维码加好友 + Scan the WeChat QR code to add friends -## English Version +## 简体中文版 -[FileSite.io - A standard for managing URLs, articles, images, and videos based on files and directories](./en/README.md) +[FileSite.io，一个基于文件和目录管理网址、文章、图片、视频的标准](./zh-cn/README.md) diff --git a/www/content/en/README.md b/www/content/en/README.md index e800e8f..ee4ab9a 100644 --- a/www/content/en/README.md +++ b/www/content/en/README.md @@ -123,7 +123,8 @@ Articles, pictures, and video files other than URLs. 'filename' => 'Chapter 1', 'realpath' => '/www/webroot/content/天杀龙记/Chapter 1.md', 'path' => '/view/?id={id}', - 'extension' => 'md', + 'extname' => 'md', + 'extension' => 'MD', 'fstat' => [...], //Same as PHP method fstat: https://www.php.net/manual/en/function.fstat.php 'content' => 'Article content...', 'description' => 'Article introduction...', @@ -132,6 +133,12 @@ Articles, pictures, and video files other than URLs. ] ``` + +Special fields: +* extname is lower case, case insensitive +* extension is case sensitive + + .txt, .md and .url 3 file descriptions: * .txt files are description files for all other files and will not appear in the file list; * .md will read the file content and store it in the attribute content; @@ -149,6 +156,7 @@ The .url file is a universal web page shortcut. Its data structure has one more 'filename' => 'filesite.io', 'realpath' => '/www/webroot/content/URL Navigation/filesite.io.url', 'path' => '/link/?id={id}', + 'extname' => 'url', 'extension' => 'url', 'fstat' => [...], //Same as PHP method fstat: https://www.php.net/manual/en/function.fstat.php 'shortcut' => [ @@ -197,4 +205,4 @@ machete@filesite.io ## 简体中文版 -[FileSite.io，一个基于文件和目录管理网址、文章、图片、视频的标准](../README.md) +[FileSite.io，一个基于文件和目录管理网址、文章、图片、视频的标准](../zh-cn/README.md) diff --git a/www/content/zh-cn/README.md b/www/content/zh-cn/README.md new file mode 100644 index 0000000..25e1161 --- /dev/null +++ b/www/content/zh-cn/README.md @@ -0,0 +1,201 @@ + +# FileSite.io，一个基于文件和目录管理网址、文章、图片、视频的标准 + +**摘要：** + +我们基于已有的文件格式定义了一个管理几种用户常用数据类型的**标准**，旨在帮助用户在保留现有内容管理习惯的前提下，更容易地把自己的创作建设成网站、App，同时还能更简单地把创作发布到各种平台。 + +此标准目前支持网址、文章、图片和视频四种类型的数据，如有需要还将扩展其它的数据类型。 + + +## 简介 + +我们相信每个人都是一名创作者，他/她可以是作家，可以是摄影师，还可以是摄像师，也许他/她还会把自己喜欢的网站收藏并加以分类。 + +因为现有的平台和环境，多数人的创作只能静静地躺在电脑的硬盘里，但终将有一天，在许许多多的从业者们的推动下，把个人的创作内容建设成网站、App的门槛会越来越低，那时人人都可以轻松、快捷地创建自己的网站和App，能用一键上传的功能就能把作品发布到各大平台。 + +我们还坚信，**每个人的作品所有权始终都归作者所有**，无论他/她已经把作品发布到哪个平台，只要他/她愿意，随时都能删除某个平台上他/她所有的数据，从电脑把作品快速上传到另一个平台是如此简单，这将改变平台和创作者之间的关系，不再是创作者依赖平台，而是**平台依赖创作者**。 + +正因为如此，我们提出了一个新标准，它没有采用任何新技术，完全基于已有的操作系统、文件系统和文件类型，以及大部分人现有的使用习惯，它也是一次抛砖引玉，让这一天早点到来吧！ + + +## 版本 + +名称：filesite_2023 + +版本号：20230130 + +修改时间：2023-01-30 + + +## 目录和文件 + +本标准所说的目录和文件，是指Windows、Linux、MacOS等常用操作系统中的文件和目录。 + +如果市面上不同操作系统中对文件和目录的命名规范存在差异，本标准则采用他们都支持的部分。 + + +## 数据类型 + +当前版本支持以下几种类型的数据： + +| 类型 | 格式 | +| ---- | ---- | +| 网址 | .url 快捷方式 | +| 文章 | .md markdown文件 | +| 图片 | .jpg, .png, .gif, .ico | +| 视频 | .mp4, .m3u8, .ts | + + +## 数据说明 + +如果需要对上述类型的数据进行扩展说明，请使用.txt格式的纯文本文件保存，我们把这类.txt文件称为“**描述文件**”。 + +描述文件命名规则如下： +``` +目录的描述文件：{英文小写属性名}.txt +文件的描述文件：{被描述文件名_}{英文小写属性名}.txt +``` + +几个常用的属性描述文件如下： + +| 文件名 | 说明 | 属性名 | +| ---- | ---- | ---- | +| title.txt | 标题 | title | +| description.txt | 描述信息 | description | +| keywords.txt | 关键词信息 | keywords | +| snapshot.txt | 快照图片 | snapshot | + + +## 目录和文件结构 + +目录里可包含子目录和文件，目录层级**最多支持 5 级**。 + +用目录对数据进行**分组**，同一分组的文件放在同一个目录里。 + +示例（字母**d**代表目录，字母**f**代表文件）： +``` +-d- 小说 + |_d_ 金庸小说 + |_f_ 最爱金庸网站图标.ico + |_f_ 最爱金庸.url + |_d_ 古龙小说 + |_f_ 最爱古龙网站图标.ico + |_f_ 最爱古龙.url +-d- 图片 + |_d_ 图片搜索 + |_f_ 谷歌图片搜索图标.ico + |_f_ 谷歌图片搜索.url + |_f_ description.txt + |_d_ 必应图片搜索 + |_f_ bing图标.ico + |_f_ bing.url + |_f_ title.txt +``` + + + +## API数据结构 + +### 目录-Directory + +``` +[ + 'id' => '根据完整路径生成的唯一编号', + 'pid' => '父目录id', //如果有父目录的话 + 'directory' => '倚天屠龙记', + 'realpath' => '/www/webroot/content/倚天屠龙记/', + 'path' => '/list/?id={id}', + 'snapshot' => '/content/倚天屠龙记封面图.jpg', + 'files' => [...], //文件列表 + 'directories' => [...] //目录列表 +] +``` + +### 文件-File + +除网址之外的文章、图片、视频文件。 + +``` +[ + 'id' => '根据完整路径生成的唯一编号', + 'pid' => '父目录id', //如果有父目录的话 + 'filename' => '第一章', + 'realpath' => '/www/webroot/content/倚天屠龙记/第一章.md', + 'path' => '/view/?id={id}', + 'extname' => 'md', + 'extension' => 'MD', + 'fstat' => [...], //同php方法fstat: https://www.php.net/manual/en/function.fstat.php + 'content' => '文章内容...', + 'description' => '文章简介...', + 'keywords' => '文章关键词...', + 'snapshot' => '/content/倚天屠龙记/第一章封面图.jpg', +] +``` + +其中： +extension区分大小写，extname只有小写。 + + +.txt，.md和.url 3 种文件说明： +* .txt文件是其它所有文件的描述文件，不会出现在文件列表里； +* .md会读取文件内容并存储在属性content里； +* .url读取文件内容并存储在属性shortcut里； + + +### 网址-Shortcut + +.url文件是一种通用的网页快捷方式，它的数据结构比上述文件数据结构多了一个属性：**shortcut**。 + +``` +[ + 'id' => '根据完整路径生成的唯一编号', + 'pid' => '父目录id', //如果有父目录的话 + 'filename' => 'filesite.io', + 'realpath' => '/www/webroot/content/网址导航/filesite.io.url', + 'path' => '/link/?id={id}', + 'extname' => 'url', + 'extension' => 'url', + 'fstat' => [...], //同php方法fstat: https://www.php.net/manual/en/function.fstat.php + 'shortcut' => [ + 'name' => 'filesite.io', + 'url' => 'https://filesite.io', + ], +] +``` + +.url文件内容示例： +``` +[InternetShortcut] +URL=https://microsoft.com/ +``` + + +## PHP版实现 + +我们基于本标准用php做了一个名为Machete的开源程序，你可以在github上找到它： +``` +https://github.com/filesite-io/machete/ +``` + +详细介绍参见： + +[Machete - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统](../Machete_Doc.md) + + +## 联系我们 + +如果你觉得Filesite.io对你有帮助，并愿意在某个项目中使用它，很高兴你跟我们分享你的故事： + +* 加入QQ群： + + Machete图片、视频源码交流群：44123711 + +* 扫码加微信好友： + + 扫描微信二维码加好友 + + +## English Version + +[FileSite.io - A standard for managing URLs, articles, images, and videos based on files and directories](../en/README.md)