Skip to content

Commit 16ddd18

Browse files
CNOCTAVECNOCTAVE
committed
various changes
 Add document website. Add bug tracker website. Modify websites of octave_zstd homepage. Fill in BibTeX reference in the document. Fix favicon.ico path of the document. Add how to translate octave_zstd Document into another language guide. Change document.
1 parent 324d497 commit 16ddd18

8 files changed

+63
-701
lines changed

‎DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Description: The octave_zstd package provides functions for compress and
88
decompress about ZSTD format.
99
Depends: octave (>= 8.0.0)
1010
License: GPLv3+
11-
Url: http://octave.sf.net
11+
Url: https://github.com/CNOCTAVE/octave_zstd

‎LICENSE

-674
This file was deleted.

‎NEWS

+10
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1+
** v1.0.0
2+
Add document website.
3+
Add bug tracker website.
4+
Modify websites of octave_zstd homepage.
5+
Fill in BibTeX reference in the document.
6+
Fix favicon.ico path of the document.
7+
Add how to translate octave_zstd Document into another
8+
language guide.
9+
Change document.
10+
-------------------------------------------------------
111
** First release.

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
# octave_zstd
22
The octave_zstd package provides functions for compress and decompress about ZSTD format.
3+
# octave_zstd Document
4+
Check out document: [octave_zstd Document](https://cnoctave.github.io/octave_zstd/index.html)
5+
# How to translate octave_zstd Document into another language
6+
In ./docs directory, index.html is zh-CN simplified Chinese document.
7+
For example, if you want to translate document into English.
8+
1. Copy index.html as another document with different language code as filename,
9+
for example, en-US.html.
10+
2. Translate en-US.html into English.
11+
3. Add dropdown like the picture below to every *.html.
12+
For example, add dropdown "en-US English".
13+
![the dropdown looking](./docs/pic/translate_dropdown.png)
14+
The code for adding dropdown is like the picture below.
15+
![the dropdown code](./docs/pic/translate_dropdown_code.png)
16+
4. PR to octave_zstd.

‎docs/index.html

+35-24
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<meta name="theme-color" content="#00B4FF">
1818
<meta name="mobile-web-app-capable" content="yes">
1919
<meta name="apple-mobile-web-app-status-bar-style" content="default">
20-
<meta name="msapplication-TileImage" content="/favicon.ico">
20+
<meta name="msapplication-TileImage" content="favicon.ico">
2121
<meta name="msapplication-TileColor" content="#000000">
2222
<meta name="apple-mobile-web-app-title" content="octave_zstd文档">
2323
<link href="https://fonts.googleapis.com/css?family=Material+Icons" rel="stylesheet" type="text/css">
@@ -27,8 +27,8 @@
2727
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/quasar.prod.css" rel="stylesheet" type="text/css">
2828
<link href="assets/main.css" rel="stylesheet" type="text/css">
2929
<title>octave_zstd文档</title>
30-
<link rel="icon" href="/favicon.ico" type="image/x-icon">
31-
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
30+
<link rel="icon" href="favicon.ico" type="image/x-icon">
31+
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
3232
<meta name="title" content="octave_zstd文档" data-qmeta="title">
3333
<meta property="og:title" content="octave_zstd文档" data-qmeta="ogTitle">
3434
<meta name="twitter:title" content="octave_zstd文档" data-qmeta="twitterTitle">
@@ -47,7 +47,7 @@
4747
<q-toolbar class="bg-primary text-white q-ny-md shadow-2">
4848
<q-btn stretch flat label="Octave中文网" @click="goTo('index.html')"></q-btn>
4949
<q-separator dark vertical></q-separator>
50-
<q-btn stretch flat label="octave_zstd" @click="scrollToTop()"></q-btn>
50+
<q-btn stretch flat label="octave_zstd文档" @click="scrollToTop()"></q-btn>
5151
<q-separator dark vertical></q-separator>
5252
<q-space></q-space>
5353
<q-separator dark vertical></q-separator>
@@ -153,12 +153,12 @@
153153
<div class="main">
154154
<div class="text-h5 q-ma-md text-red-10">欢迎广大开发者将此文档翻译为其他语言。</div>
155155
<q-btn id="homepage" class="title1 text-white bg-primary" stretch flat
156-
label="项目首页：http://qwqwwqwq.com" @click="goTo('index.html')"></q-btn>
156+
label="项目首页：https://github.com/CNOCTAVE/octave_zstd" @click="goTo('https://github.com/CNOCTAVE/octave_zstd')"></q-btn>
157157
<q-separator></q-separator>
158158
<div id="online_install" class="title1 q-ma-md text-primary">在线安装</div>
159159
<p class="q-ma-md">octave_zstd可以在线安装。</p>
160160
<div class="text-h5 q-ma-md text-red-10">在线安装octave_zstd，代码如下：</div>
161-
<p class="q-ma-md">>> pkg install -forge http://qwqwqwqwq.com/qwqwwqwq.tar.gz</p>
161+
<p class="q-ma-md">>> pkg install -forge https://github.com/CNOCTAVE/octave_zstd/releases/download/1.0.0/octave_zstd-1.0.0.tar.gz</p>
162162
<q-separator></q-separator>
163163
<div id="source_code_install" class="title1 q-ma-md text-primary">源码安装</div>
164164
<p class="q-ma-md">octave_zstd可以直接使用tar包安装。</p>
@@ -180,13 +180,14 @@
180180
<div id="function_usage" class="title1 q-ma-md text-primary">函数用法</div>
181181
<div class="text-h5 q-ma-md text-red-10">zstd_compress</div>
182182
<p class="q-ma-md">Loadable Function: 0 = zstd_compress(FILENAME, COMPRESSED_FILENAME)</p>
183-
<p class="q-ma-md">输入文件名FILENAME和压缩后的文件名COMPRESSED_FILENAME。总是输出0。</p>
183+
<p class="q-ma-md">输入文件名FILENAME和压缩后的文件名COMPRESSED_FILENAME。</p>
184+
<p class="q-ma-md">总是返回0。</p>
184185
<q-separator></q-separator>
185186
<div class="text-h5 q-ma-md text-red-10">zstd_decompress</div>
186187
<p class="q-ma-md">Loadable Function: 0 = zstd_decompress(COMPRESSED_FILENAME,</p>
187188
<p class="q-ma-md">DECOMPRESSED_FILENAME)</p>
188189
<p class="q-ma-md">输入压缩文件名COMPRESSED_FILENAME和解压缩后的文件名</p>
189-
<p class="q-ma-md">DECOMPRESSED_FILENAME。总是输出0。</p>
190+
<p class="q-ma-md">DECOMPRESSED_FILENAME。总是返回0。</p>
190191
<q-separator></q-separator>
191192
<div class="text-h5 q-ma-md text-red-10">zstd_compress_string</div>
192193
<p class="q-ma-md">Loadable Function: COMPRESSED_STRING = zstd_compress_string(STRING)</p>
@@ -199,49 +200,59 @@
199200
<p class="q-ma-md">DECOMPRESSED_STRING。</p>
200201
<q-separator></q-separator>
201202
<div id="common_examples" class="title1 q-ma-md text-primary">常见用例</div>
202-
<div class="text-h5 q-ma-md text-red-10">压缩一个名为file的文件为new_file，代码如下：</div>
203-
<p class="q-ma-md">>> zstd_compress("file", "new_file")</p>
204-
<div class="text-h5 q-ma-md text-red-10">解压缩一个名为new_file的文件为new_file_1，代码如下：</div>
205-
<p class="q-ma-md">>> zstd_decompress("new_file", "new_file_1")</p>
203+
<div class="text-h5 q-ma-md text-red-10">压缩一个名为file的文件为file.zst，代码如下：</div>
204+
<p class="q-ma-md">>> zstd_compress("file", "file.zst")</p>
205+
<div class="text-h5 q-ma-md text-red-10">解压缩一个名为file.zst的文件为new_file，代码如下：</div>
206+
<p class="q-ma-md">>> zstd_decompress("file.zst", "new_file")</p>
206207
<div class="text-h5 q-ma-md text-red-10">压缩一个字符串abcdefg，代码如下：</div>
207208
<p class="q-ma-md">>> compressed_string = zstd_compress_string("abcdefg")</p>
208209
<div class="text-h5 q-ma-md text-red-10">解压缩字符串，代码如下：</div>
209210
<p class="q-ma-md">>> decompressed_string = zstd_decompress_string(compressed_string)</p>
211+
<q-separator></q-separator>
210212
<div id="references" class="title1 q-ma-md text-primary">引用octave_zstd</div>
211213
<div class="text-h5 q-ma-md text-red-10">如果你在学术研究中涉及octave_zstd，那么可以按需引用以下内容。</div>
212214
<div class="text-h5 q-ma-md text-red-10">octave_zstd源码(BibTeX)</div>
213215
<p class="q-ma-md">@misc{CNOCTAVE2024,
214-
author = {Yu, Hongbo},
216+
author = {Yu Hongbo, },
215217
title = {octave_zstd},
216218
year = {2024},
217-
howpublished = {\url{https://github.com/username/repository}},
219+
howpublished = {\url{https://github.com/CNOCTAVE/octave_zstd}},
218220
}</p>
219221
<div class="text-h5 q-ma-md text-red-10">octave_zstd文档(BibTeX)</div>
220222
<p class="q-ma-md">@techreport{CNOCTAVE2024,
221-
author = {Yu, Hongbo},
223+
author = {Yu Hongbo, },
222224
title = {octave_zstd Document},
223225
institution = {BA DU XIN SHANG},
224226
year = {2024},
225227
number = {1},
226228
month = {10},
227-
url = {http://www.someurl.com/path/to/doc.pdf},
229+
url = {https://cnoctave.github.io/octave_zstd/index.html},
228230
urldate = {2024-10-07},
229231
}</p>
230-
<div class="text-h5 q-ma-md text-red-10">octave_zstd: Efficient Compression and Decompression Utilizing the Octave Software with Zstandard(BibTeX)</div>
231-
<p class="q-ma-md" style="white-space: normal;">@unpublished{Hongbo2024,
232-
author = {Yu, Hongbo},
233-
title = {octave_zstd: Efficient Compression and Decompression Utilizing the Octave Software with Zstandard},
232+
<div class="text-h5 q-ma-md text-red-10">octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm(BibTeX)</div>
233+
<p class="q-ma-md" style="white-space: normal;">@article{https://doi.org/10.6084/m9.figshare.27186048.v1,
234+
doi = {10.6084/M9.FIGSHARE.27186048.V1},
235+
url = {https://figshare.com/articles/preprint/octave_zstd_Efficient_File_and_String_Decompression_Utilizing_the_ZSTD_Algorithm/27186048/1},
236+
author = {Yu Hongbo, },
237+
keywords = {Software architecture},
238+
title = {octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm},
239+
publisher = {figshare},
234240
year = {2024},
235-
note = {Available at \url{https://arxiv.org/abs/2410.00000}, arXiv:2410.00000 [cs.SE]},
241+
copyright = {Creative Commons Attribution 4.0 International}
236242
}</p>
237243
</div>
238244
</div>
239245
<q-toolbar class="bg-grey-8 text-white q-my-md shadow-2">
240246
<q-btn-dropdown stretch flat label="版权所有 ©">
241247
<q-list>
242-
<q-item clickable v-close-popup @click="goTo('index.html')">
248+
<q-item clickable v-close-popup @click="goTo('http://cnoctave.cn')">
249+
<q-item-section>
250+
<q-item-label>© 2024 CNOCTAVE</q-item-label>
251+
</q-item-section>
252+
</q-item>
253+
<q-item clickable v-close-popup @click="goTo('https://orcid.org/0009-0007-9436-4161')">
243254
<q-item-section>
244-
<q-item-label>© 2024 Yu Hongbo, CNOCTAVE</q-item-label>
255+
<q-item-label>© 2024 Yu Hongbo</q-item-label>
245256
</q-item-section>
246257
</q-item>
247258
</q-list>
@@ -251,7 +262,7 @@
251262
@click="goTo('https://creativecommons.org/licenses/by-nd/4.0/')"></q-btn>
252263
<q-separator dark vertical></q-separator>
253264
<q-btn stretch flat label="下载此文档的源码"
254-
@click="goTo('index.html')"></q-btn>
265+
@click="goTo('https://github.com/CNOCTAVE/octave_zstd')"></q-btn>
255266
</q-toolbar>
256267
</q-page-container>
257268

‎docs/pic/translate_dropdown.png

24.2 KB
Loading

‎docs/pic/translate_dropdown_code.png

38.2 KB
Loading

‎octave_zstd.metainfo.xml

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ without any warranty.
2222
<keyword>compress</keyword>
2323
<keyword>decompress</keyword>
2424
</keywords>
25-
<url type="homepage">http://octave.sourceforge.net/image</url>
26-
<url type="bugtracker">https://savannah.gnu.org/bugs/?func=additem&amp;group=octave</url>
25+
<url type="homepage">https://github.com/CNOCTAVE/octave_zstd</url>
26+
<url type="bugtracker">https://github.com/CNOCTAVE/octave_zstd/issues</url>
27+
<url type="document">https://cnoctave.github.io/octave_zstd/index.html</url>
2728
<project_license>GPL-3.0+</project_license>
2829
<developer_name>various authors</developer_name>
2930
<update_contact>[email protected]</update_contact>

0 commit comments

Comments
 (0)