Skip to content

Commit 8e3fe0c

Browse files
brsvhbrsvh
committed
update Peony project documnet
1 parent 3358fd4 commit 8e3fe0c

File tree

2 files changed

+209
-0
lines changed

2 files changed

+209
-0
lines changed

‎en_US/Implementation of the Peony File Manager preview feature.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Implementation of Peony File Manager preview feature
2+
3+
English | [简体中文]
4+
5+
[简体中文]: ../zh_CN/Peony 文件管理器预览特性的实现.md
6+
7+
## Origin Project
8+
9+
[Peony] is the default file manager for the UKUI Desktop Environment. It makes it easy to manage, manipulate, and customize files and directories. It has a set of interfaces based on GIO and Qt and has its own plugin mechanism.
10+
11+
[Peony]: https://github.com/ukui/peony
12+
13+
## Project description
14+
15+
The purpose of this project is to provide support and implementation of file preview features for Peony File Manager, which allows it to support preview of file content for different types of files in the right preview panel.
16+
17+
* For text type files, such as PDF, txt, etc. Support simple editing functions.
18+
* For image type files, such as PNG, JPEG, etc. Support simple editing functions of orientation and resizing.
19+
* For video and audio type files, support a quick glimpse of playback.
20+
* For compressed archive type files, such as GZ, ZIP, etc. Support show the files it contains.
21+
22+
## Technical Requirements
23+
24+
**Required**
25+
26+
* C++, basic
27+
* Data structure, basic
28+
29+
**Optional**
30+
31+
* Qt5, basic
32+
33+
## Features CheckList
34+
35+
* [ ] Text preview and edit
36+
37+
| File type | MIME type | Preview Support | Edit Support |
38+
|---------------------------------------------|-------------------------------------------------------------------------|:---------------:|:------------:|
39+
| Text | text/plain | ☐ | ☐ |
40+
| Adobe Portable Document Format | application/pdf | ☐ | ☐ |
41+
| Microsoft Word | application/msword | ☐ | ☐ |
42+
| Microsoft Word (OpenXML) | application/vnd.openxmlformats-officedocument.wordprocessingml.document | ☐ | ☐ |
43+
| OpenDocument text document | application/vnd.oasis.opendocument.text | ☐ | ☐ |
44+
| Comma-separated values (CSV) | text/csv | ☐ | ☐ |
45+
| JSON format | application/json | ☐ | ☐ |
46+
| HyperText Markup Language (HTML) | text/html | ☐ | ☐ |
47+
| JavaScript | text/javascript | ☐ | ☐ |
48+
| Hypertext Preprocessor (Personal Home Page) | application/x-httpd-php | ☐ | ☐ |
49+
| Rich Text Format (RTF) | application/rtf | ☐ | ☐ |
50+
| Bourne shell script | application/x-sh | ☐ | ☐ |
51+
52+
* [ ] Image preview and edit
53+
54+
| File type | MIME type | Preview Support | Size Edit Support | Rotation Edit Support |
55+
|--------------------------------|--------------------------|:---------------:|:-----------------:|:---------------------:|
56+
| Icon format | image/vnd.microsoft.icon | ☐ | ☐ | ☐ |
57+
| JPEG images | image/jpeg | ☐ | ☐ | ☐ |
58+
| Portable Network Graphics | image/png | ☐ | ☐ | ☐ |
59+
| Scalable Vector Graphics (SVG) | image/svg+xml | ☐ | ☐ | ☐ |
60+
| WEBP image | image/webp | ☐ | ☐ | ☐ |
61+
62+
63+
* [ ] Media preview
64+
65+
| File type | MIME type | Preview Support |
66+
|-----------------------------|-------------------|:---------------:|
67+
| AAC audio | audio/aac | ☐ |
68+
| MP3 audio | audio/mpeg | ☐ |
69+
| CD audio | application/x-cdf | ☐ |
70+
| OGG audio | audio/ogg | ☐ |
71+
| Opus audio | audio/opus | ☐ |
72+
| Waveform Audio Format | audio/wav | ☐ |
73+
| WEBM audio | audio/webm | ☐ |
74+
| AVI: Audio Video Interleave | video/x-msvideo | ☐ |
75+
| MP4 audio | video/mp4 | ☐ |
76+
| MPEG Video | video/mpeg | ☐ |
77+
| OGG video | video/ogg | ☐ |
78+
| WEBM video | video/webm | ☐ |
79+
80+
* [ ] Compressed archive preview
81+
82+
| File type | MIME type | Preview Support |
83+
|-------------------------|---------------------|:---------------:|
84+
| BZip archive | application/x-bzip | ☐ |
85+
| BZip2 archive | application/x-bzip2 | ☐ |
86+
| GZip Compressed Archive | application/gzip | ☐ |
87+
| RAR archive | application/vnd.rar | ☐ |
88+
| Tape Archive (TAR) | application/x-tar | ☐ |
89+
| ZIP archive | application/zip | ☐ |
90+
91+
## Development Plan
92+
93+
## Contact
94+
95+
* Mentor: [Yue Lan], [Mail to him]
96+
97+
[Yue Lan]: https://github.com/Yue-Lan
98+
[Mail to him]: mailto:[email protected]
99+
100+
## License
101+
102+
[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
103+
104+
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).

‎zh_CN/Peony 文件管理器预览特性的实现.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Peony 文件管理器预览特性的实现
2+
3+
[English] | 简体中文
4+
5+
[English]: ../en_US/Implementation of the Peony File Manager preview feature.md
6+
7+
## 源项目简介
8+
9+
[Peony] 文件管理器是 UKUI 桌面环境的默认文件管理器，它可以很容易的管理、操作和修改文件和目录。它基于 GIO 和 Qt 构建了一套接口，并具有其自己插件机制。
10+
11+
[Peony]: https://github.com/ukui/peony
12+
13+
## 项目介绍
14+
15+
本项目的主旨是为 Peony 文件管理器提供文件预览特性的支持与实现，使其能够在右侧预览窗体中对不同类型的文件支持文件内容的预览。
16+
17+
* 对于文本类型的文件，比如 PDF、txt 等，支持简单的编辑功能；
18+
* 对于图片类型文件，比如 PNG、JPEG 等，支持简单的方向、大小调整的编辑功能；
19+
* 对于视频、音频类型的文件，支持快速的播放预览；
20+
* 对于压缩文件类型文件，支持对其包含内容的预览；
21+
22+
## 技术要求
23+
24+
**必要**
25+
26+
- C++，基础
27+
- 数据结构，基础
28+
29+
**可选**
30+
31+
- Qt5,基础
32+
33+
## 特性检查表
34+
35+
* [ ] 文本文件预览和编辑
36+
37+
| 文件类型 | MIME type | 预览支持 | 编辑支持 |
38+
|-----------------------|-------------------------------------------------------------------------|:--------:|:--------:|
39+
| 文本文件 | text/plain | ☐ | ☐ |
40+
| PDF | application/pdf | ☐ | ☐ |
41+
| doc 文件 | application/msword | ☐ | ☐ |
42+
| docx 文件 | application/vnd.openxmlformats-officedocument.wordprocessingml.document | ☐ | ☐ |
43+
| OpenDocument 文件 | application/vnd.oasis.opendocument.text | ☐ | ☐ |
44+
| CSV 文件 | text/csv | ☐ | ☐ |
45+
| JSON 文件 | application/json | ☐ | ☐ |
46+
| HTML 文件 | text/html | ☐ | ☐ |
47+
| JavaScript 源代码文件 | text/javascript | ☐ | ☐ |
48+
| PHP 源代码文件 | application/x-httpd-php | ☐ | ☐ |
49+
| 富文本文件 | application/rtf | ☐ | ☐ |
50+
| shell 脚本 | application/x-sh | ☐ | ☐ |
51+
52+
* [ ] 图像文件预览和编辑
53+
54+
| 文件类型 | MIME type | 预览支持 | 大小编辑支持 | 旋转支持编辑 |
55+
|-----------|--------------------------|:--------:|:------------:|:------------:|
56+
| icon 文件 | image/vnd.microsoft.icon | ☐ | ☐ | ☐ |
57+
| JPEG 图片 | image/jpeg | ☐ | ☐ | ☐ |
58+
| PNG 图片 | image/png | ☐ | ☐ | ☐ |
59+
| SVG 图片 | image/svg+xml | ☐ | ☐ | ☐ |
60+
| WEBP 图片 | image/webp | ☐ | ☐ | ☐ |
61+
62+
* [ ] 音视频文件预览
63+
64+
| File type | MIME type | Preview Support |
65+
|---------------|-------------------|:---------------:|
66+
| aac 音频文件 | audio/aac | ☐ |
67+
| MP3 音频文件 | audio/mpeg | ☐ |
68+
| CD 音频文件 | application/x-cdf | ☐ |
69+
| OGG 音频文件 | audio/ogg | ☐ |
70+
| Opus 音频文件 | audio/opus | ☐ |
71+
| wav 音频文件 | audio/wav | ☐ |
72+
| WEBM 音频文件 | audio/webm | ☐ |
73+
| AVI 视频文件 | video/x-msvideo | ☐ |
74+
| MP4 视频文件 | video/mp4 | ☐ |
75+
| MPEG 视频文件 | video/mpeg | ☐ |
76+
| OGG 视频文件 | video/ogg | ☐ |
77+
| WEBM 视频文件 | video/webm | ☐ |
78+
79+
* [ ] 压缩文件预览
80+
81+
| 文件类型 | MIME type | 预览支持 |
82+
|------------|---------------------|:--------:|
83+
| BZ 压缩包 | application/x-bzip | ☐ |
84+
| BZ2 压缩包 | application/x-bzip2 | ☐ |
85+
| GZ 压缩包 | application/gzip | ☐ |
86+
| RAR 压缩包 | application/vnd.rar | ☐ |
87+
| TAR 压缩包 | application/x-tar | ☐ |
88+
| ZIP 压缩包 | application/zip | ☐ |
89+
90+
## 开发计划
91+
92+
待定
93+
94+
## 联系
95+
96+
* 导师：[Yue Lan], [邮件联系他]
97+
98+
[Yue Lan]: https://github.com/Yue-Lan
99+
[邮件联系他]: mailto:[email protected]
100+
101+
## 授权条款
102+
103+
[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
104+
105+
本文使用授权协议 [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)。

0 commit comments

Comments
 (0)