*/}}
Browse Source

Updated readme

YimingWu 2 years ago
parent
commit
38d08306a9
1 changed files with 68 additions and 16 deletions
  1. 68 16
      readme.md

+ 68 - 16
readme.md

@@ -1,26 +1,38 @@
-# laMDWiki | 那么的维基
+# 那么的维基使用手册
 
-Share | 分享
+Demo site (on my blog):
 
 **[- [ChengduLittleA.com/lamdwiki](https://ChengduLittleA.com/lamdwiki) -]**
 
-laMDWiki is a super light weight blog/wiki platform running on PHP!
+## What is laMDWiki?
 
-- Twitter-like posts and threads
-- Back-references for both images and posts
-- No database needed
-- Convenient image upload
-- Adapt to English/Chinese user interface
-- Image Shop Functionality
+laMDWiki is a super light weight twitter-like wiki platform, with the real benefit of allowing fluid transition from small notes to long passages, and keeping all back references and histories automatically while you do so, it's best suited for blogging and knowledge organizing.
 
-那么的维基是一个运行在PHP环境中的超级轻量博客/维基平台。
+- Twitter-like posts and threads.
+- Back-references for both images and posts.
+- Wayback mode: to view the entire site as if you were visiting on a specific date.
+- Hook to specific tag in any post.
+- Style sheet optimized for direct printing.
+- No database needed.
+- Convenient image upload.
+- Adapt to English/Chinese user interface.
+- Image Purchasing Link.
+- Alternative website entry point.
 
-- 推特形式的帖子和主题
-- 帖子和图片均具备反引用功能
-- 无数据库
-- 方便上传和查看图片
-- 适应英语和汉语浏览器界面
-- 图片商城功能
+## 那么的维基是什么?
+
+那么的维基是一个超轻量的推特式维基程序,最适合博客和知识整理,真正允许无缝地从短句整合为完整文章,同时记录所有历史和反向引用,非常适合用作发布博客和整理知识。
+
+- 推特形式的帖子和主题。
+- 帖子和图片均具备反引用功能。
+- 时间机器:以过去的特定时间阅读网站的所有内容。
+- 链接到帖子内容的任何位置。
+- 为直接打印而优化的样式表。
+- 无需数据库。
+- 方便上传和查看图片。
+- 适应英语和汉语浏览器界面。
+- 图片购买按钮。
+- 里站入口功能。
 
 (This is actually the forth version I made, it used to be so cramped with functions and not very easy to use)
 
@@ -28,6 +40,13 @@ laMDWiki is a super light weight blog/wiki platform running on PHP!
 
 ## Installation | 安装
 
+### Requirements | 需求
+
+- Apache (.htaccess)
+- PHP ImageMagic (If image uploading is needed | 若需要上传图像)
+
+### Operations | 操作
+
 Copy `index.php`, `translations.md`, `Parsedown.php`, `ParsedownExtra.php` to your server document root and you are good to go.
 
 When entered the site, double click the © symbol on the bottom to log in, default user ID is `admin`, default password is `Admin`. Please change the ID and the password after logging in.
@@ -63,6 +82,10 @@ Post can be referenced using Markdown link, simply put the 14 digit post ID into
 | `![keep_inline original]()` | 图片保持行内,使用原图 |
 | `{big_table}` | 下一个表格是大表格 |
 | `{read_more}` | 帖子预览在这里截断 |
+| `{interesting apple pear}` | 设置话题为有趣表格 |
+| `//(14_digit_id_or_any)` | 跳转标签 |
+| `@category` | 设置话题或帖子分类 |
+| `[link](@category)` | 链接到分类 |
 | `{PRICE my product price}` | 产品价格 |
 | `{SHORT product short description}` | 产品短描述 |
 | `{PURCHASE button name}` | 购买按钮 |
@@ -86,3 +109,32 @@ Purchasing URL can be set when you open a image. If you'd like to set it as a in
 
 点击图像之后可以设置对应图像的购买链接。若要设置为商品帖,则填入14位帖子编号。
 
+
+[-Note:-] laMDWiki V4 will now redirect all connections to HTTPS, Manually change the redirect lines in `WriteHTACCESS()` to change this behavior.
+
+[-注意:-] 所有通过 laMDWiki V4 的连接现在都使用HTTPS,手动修改`WriteHTACCESS()`中的跳转指令以调整该行为。
+
+### Alternative website entry | 里站入口功能
+
+Configure "Experimental Access" inside settings to set an alternative website. Enter your host name (this string is `preg_match()`ed with your `HTTP_HOST`) to activate the function.
+
+在设置中“实验访问”一栏可以设置里站入口。填写主机(将通过`preg_match()`匹配你的`HTTP_HOST`)即可激活里站。
+
+Mark a post as `E` to make it visible to experimental site, meanwhile the post will not be shown in main site if you are not logged in. Experimental site will not show regular posts. Marking the first post in a thread will put the entire thread into experimental site. Marking a post as `S` will restrict the post to only be visible to the administrator (private post).
+
+将帖子标记为`E`以使其在里站可见,与此同时该帖子在主站未登录时不可见。里站不显示常规帖子。若标记了一个话题中的第一个帖子,则整个话题都将放入里站。将帖子标记为`S`则只有管理员可见(隐私帖子)。
+
+Alternative website mode will only show posts and threads, it doesn't have dedicated timeline, gallery or search page. The style of the page will change slightly to allow bigger pictures to be inserted directly into the passage.
+
+里站模式仅显示帖子和对话,它不包含时间线、相册和搜索页。页面的样式稍有改变以允许大图直接插入文章。
+
+## Comments | 评论
+
+Commenting is available now. Enable comments inside settings page to show comment section under each thread.
+
+评论功能现在可用。在设置中启用评论即可调出话题下方的评论栏目。
+
+The server will record the commenter's email, name and IP address for preventing spam.
+
+服务器会记录评论者的电子邮箱、名字和IP地址以控制垃圾评论。
+