跳转至内容

XSLTForms/贡献

来自维基教科书,开放世界中的开放书籍

本页为有兴趣帮助完成和维护此维基教科书的人员提供信息。它描述了本书的风格指南,概述了目前对本书进行改进的路线图,并提供了一份看起来需要做的任务清单。

与 XSLTForms 本身一样,此维基教科书的用户群相对较小,但生命周期很长。小型的社区意味着书中的缺陷和漏洞可能需要一段时间才能得到解决;然而,它的长寿表明这本书对某些人来说确实起到了有用的作用。此页面旨在让本书的工作更容易协调和有效。

风格指南

[编辑 | 编辑源代码]

不要使页面过于拥挤。将不同的主题分成不同的页面(请记住,页面和章节比收缩更常增长:维基上的合作者更愿意添加新材料,而不是删除他人贡献的材料)。

提供具体的例子。使用 syntaxhighlight 元素对它们进行标记。并提供解释和评论,以清楚地说明示例所展示的要点。

使用“命名约定”部分中列出的命名空间前缀;如果您需要某个命名空间超过三次,那么可能值得在那里添加一个条目。显式命名空间声明始终是可以的,只要示例保持易读。

如果您在一个讨论中留下了空白(因为您没有时间完整地处理所有事情,或者因为您知道某个主题需要涵盖但您对此了解不足,无法自行处理),在方括号中添加一个注释,例如“[此处需要对 XYZ 进行更详细的讨论]”,是一种向读者表明覆盖范围不完整,并向其他贡献者表明此处需要填补空白的合理方法。

为了保持一致性,函数和元素的文章最好具有大致相同的结构,并包含以下子标题:

  1. 描述
  2. 语法 / 签名
  3. 示例和用法
  4. 已知问题和问题
  5. 更多信息(获取更多详细信息的地方)

(模板可能会有所帮助。)

当您创建新页面时,请记住确保页面底部出现 {{BookCat}}。

[此处需要更多详细信息。]

路线图

[编辑 | 编辑源代码]

在不久的将来,那些参与本书工作的人的主要任务是填补明显的空白。

  • 在目录中提到(从目录链接)但目前不存在的页面应该创建,并包含相应的内容。
  • 在目录中提到的,但目前没有链接到页面的主题,应该在其自己的页面上进行描述。
  • 由方括号注释标识的散文中的空白应该填补(并删除注释)。
  • 应该为应该涵盖但尚未涵盖的主题创建新页面。在第一次近似中:任何让 XSLTForms 的新用户(或不太熟悉的用户)感到困惑超过一小时的问题(理想情况下)应该在“入门”部分(也许在“常见问题”下)中得到解决。当前覆盖范围中的一些明显差距包括
    • 如何调试 XForms;开发复杂表单的技术
    • 使用多个实例
    • 管理用户界面配置(添加“ui”实例)
    • 数据类型的基础知识
    • 在 XSLTForms 中与文件系统交互;使用 Java applet 读取和保存文件
任何让 XSLTForms 的经验用户感到困惑超过半天或一天的问题(理想情况下)应该在“进一步主题”或“状态”部分中得到解决。明显的候选者包括
  • XSLTForms 中的子表单
  • 使文件上传在 XSLTForms 中工作;使多部分表单提交工作
  • XSLTForms 中的基本创建/检索/更新/删除(CRUD)操作
  • 在 XSLTForms 中使用事件

从长远来看,可能需要为清晰起见对本书进行一些结构调整,并扩展其覆盖范围。有关建议,请参阅本书目录的讨论页面

需要做的事情

[编辑 | 编辑源代码]

如果您没有时间或技能来完成以下任何任务,但您看到了需要做的事情,您可以通过将其添加到此列表中来提供帮助!

  • 关于仅 XSLTForms 的扩展页面的内容应该分成多个页面,每个扩展一个页面;该页面本身应该本质上是一个详细的目录,列出扩展并超链接到其描述。
  • XSLT 转换 xsltforms.xsl 应该使用 XSLTdoc 之类的工具进行注释,并且文档应该在从“贡献者信息”部分的目录链接的页面中提供。
  • Javascript 文档可能需要重新生成(仅在与 Alain Couthures 协商后)。
  • XSLTForms 扩展的列表应该变得更加系统化和完整;这可能需要系统地阅读支持列表的过去档案。
  • 如果本网站上可以有可用的表单,那就太好了。任何有知识和毅力来仔细阅读有关维基教科书的技术和政策信息的人,如果可以找到是否可能,以及如何做到这一点,并在这里记录答案,将为人们提供很大的帮助。
华夏公益教科书