====== DokuWiki使用须知 ====== ===== 一、用户 ===== DokuWiki的理念是提供一个开放的平台。每一个参与者有责任使这个平台健康有序地发展。所以我们的理念是充分信任每一个参与者，充分授权，尽量不限制参与者的权限。 为了便于控制，现在采取的是“发邮件给管理员”进行人工分配账号和密码。 使用“组”的概念来分来管理用户，默认存在两个两个组，admin 组和 user 组。新注册的用户默认被添加进入 user 组。管理员可以单独每个组设置权限。 ===== 二、编辑使用 ===== **如何创建一个页面** * 可以从一个“不存在的页面”创建。不存在的页面可以是来自于搜索不存在的内容或者直接通过http://192.168.20.24//doku/doku.php?id=pagename。 **如何删除一个页面** * 如果将一个页面编辑为空白，然后保存，那么这个页面就被删除了。 * 可以通过Page Management进行页面的重命名或删除。 **什么是命名空间** * 命名空间是一个目录，可以将同类的页面归类在一起。 **如何创建命名空间** * 创建页面时，在名称前面加上冒号’：’。参见http://192.168.20.24//doku/doku.php?id=playground:test。 **如何参与共同创作** * 如果需要对已有的页面进行修改，点击“编辑本页”，即可进行编辑。编辑中可以预览格式。编辑完保存即可。 **如何上传图片或文件** 已经测试过可以通过媒体管理器上传文件格式有：图片、office文件、压缩包【本站暂无大小限制】得到\\ {{playground:python_i_i_.pdf}} {{playground:python_i_i_.pdf}}可点开链接 ===== 三、内容管理 ===== **如果页面内容被编辑掉** * 每一次的修改都有版本记录，都可以任意回溯。 **如果页面被删除** * 管理员可以在管理界面进入“还原管理器”，管理和恢复被删除的内容。 **如何控制页面的访问权限** * 管理员可以使用“访问控制列表（ACL）管理器”来进行管理设置 ===== 四、使用原则 ===== **不要编辑别人的代码** * 不要轻易删掉别人的东西，除非你确保你写的比别人好，不然，更好的方式是添加你的内容而保留别人的内容不变。 对于代码，不要编辑别人的代码，如果有更好的代码，可以另开一段 ( //__你的代码__// )来补充， 比如一些bug的修复，更好的算法等等的，可以新开一段来记录。 当然，对于别人的代码，做一些缩进的调整，语法高亮的添加等不影响源代码实质内容的编辑则是允许的。 **“命名空间”及“页面”应该命名规范** * namespace现在已经定义的有：项目、个性化、售后、制度等，根据内容所属选择。如有其它分类需求，提出同意后，再在该空间上放页面。 * “页面”名称也不要太长，可以将必要的“更多描述”添加到连接外 *[[个性化:双色箭头|个性化箭头(双色)]]：使用ggplot2, 精确拼图 *显示的效果是这样的——[[个性化:双色箭头|个性化箭头(双色)]]：使用ggplot2, 精确拼图 **优良的代码风格** *这里说的是缩进、换行等能够让人读起来更容易以及愉悦的风格，不要让自己的代码排列乱糟糟的，那非常有损自己的形象，也不能为我们的部门增彩。这方面可以参考[[https://google.github.io/styleguide/Rguide.xml|Google's R Style Guide]]、[[http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/contents/|Python 风格指南]]([[https://google.github.io/styleguide/pyguide.html|Google Python Style Guide]])、[[http://zh-google-styleguide.readthedocs.org/en/latest/google-shell-styleguide/contents/|Shell 风格指南]]([[http://google.github.io/styleguide/shell.xml|Shell Style Guide]])等等。 **先预览没问题之后再保存** *每次编辑保存都会有记录，所以预览好之后再保存，可以让编辑记录更简洁。 **退出之前确定保存或取消** *退出之前不保存或取消，会导致其他人不能打开编辑。