7分钟阅读时间 (1391 字)

文档 Joomla!

Documentation Joomla!

Joomla! 我们有一个问题!大家一致认为 Joomla! 文档可以改进。我们不会纠结于它的不足。我们更愿意提出一种新的方法,并描述其益处,同时探讨当前面临的挑战。本文旨在激发您的思考。如果您认为我们未处理某个问题,请通过本文下面的评论与我们联系。我们喜欢您的反馈。我们需要您的反馈。我们需要您的帮助。感谢您的参与。

一种新的方法

由 Tony Davis 和 Jon Neubauer 提出
由 Pierre-André Vullioud 和 JCR 翻译成法语

我们的建议

  1. 使用 Joomla!

    Joomla! 是一个内容管理系统。文档就是内容。就这么简单。

    • 改善用户体验 - CMS 的一个主要优点是其使用模板的能力。我们可以简单地通过调整模板来改变文章的可读性。您将不再需要扭动脖子才能阅读页面。

    • 改善搜索 - 智能搜索会索引内容,并且这个索引可用于搜索。许多用户使用 Google 在 Joomla! 文档(wiki)中查找他们想要的内容。我们怀疑 Google 对 wiki 的索引可能并不像我们希望的那样有效。

    • 改善结构 - 我们可以借鉴他人的成功经验。我们喜欢 MySQL 文档的呈现方式。我们喜欢的关键要素包括:

      • 菜单标题会适应 Joomla! 风格
      • 所有页面都有版本选择器。但 MySQL 与 Joomla! 不同,它提供了更多版本,变更速度较慢。我们不需要每个六个月就有一个新版本,并且需要三个以上的版本。
      • 当前版本的目录表在右侧可见。当您浏览内容时,它会根据您的文档路径展开。
      • 每个版本的首页都提供多种内容分类方法。
      • 每个章节页,例如 11.3,都会显示一个菜单,列出不同的子章节,并描述其意义和用途。
      • 搜索可覆盖MySQL网站的各个部分,包括本版本文档以及其他资源。但我们还喜欢PHP在页面语言切换和注释选项方面的能力。尝试对PHP进行注释。我们喜欢这个。改进国际化 Josetta与核心相关的功能使我们能够创建不同语言的对应页面。如果我们用英文创建thispage.html,然后将其翻译成法语thispage.html,用户可以选择语言指示器在两个页面之间切换。无需通过网站首页。

    • 提高贡献者的舒适度 我们文档的作者将是Joomla!用户。他们对编辑器的界面和使用方法都很熟悉。无需学习wiki语法和规范。

    • 改进翻译 使用Joomla!的多语言功能和Josetta,志愿者可以轻松地用他们的语言进行贡献。

  2. 针对不同的用户社区

    Joomla!文档满足不同用户的需求。我们的努力应该支持他们中的每一个人。我们设想了几个组件

    • 菜谱 - 如何做到这一点?

      • 当前页面描述详细,但读者无法理解为什么一个选项可能比另一个选项更可取。菜谱将帮助初学者构建他们的第一个网站,并帮助开发人员了解如何将某些元素与Joomla!核心联系起来!

    • 解释 - 为什么一种方法比另一种方法更好?

      • Joomla!非常灵活。很棒。但对于初学者来说,这可能会让人感到害怕。他们需要帮助高效地完成简单的事情。随着他们的进步,他们会学会做更复杂的事情。

    • 诊断 帮助初学者

      • Joomla!的高级用户有有效解决问题的方法。经验较少的用户可能难以定义他们的问题。初学者是否可以通过提供有关有用信息的链接来获得帮助?这对于Joomla!开发者来说是一个技术挑战。

    • 文档 详细描述

      • 这是有一定Joomla!经验的用户的参考手册。

  3. 定义清晰的结构

    文档的结构应尽可能从一个版本到另一个版本保持一致。用户将学会如何使用这种结构,因此将更容易使用。我们希望用户能够参与到结构的改进中来。即使需要审核,评论文档也能提供有用的信息来改进它。

  4. 构建Joomla! 2.5的文档模型

    为Joomla! 2.5的文档实现一个原型。这个版本是基本的。它将在未来得到改进。此电子邮件地址受到垃圾邮件机器人的保护。您需要启用JavaScript才能查看它。。我们需要在多个领域得到您的帮助。请写信至此电子邮件地址受到垃圾邮件机器人的保护。您需要启用JavaScript才能查看它。以获取访问权限。

    • 对提出的结构提出评论
    • 贡献页面内容
    • 评论现有内容
    • 使用Josetta翻译内容

  5. 构建多语言翻译

    一旦我们有了页面,我们就可以将结构复制到外语中。它就变成了Josetta可以访问的。翻译者看到原始页面和一个空白表单。我们到目前为止一直使用Google翻译来创建草稿,然后翻译者——一个了解Joomla!并使用母语写作的人——编辑草稿以创建最终文档。此外,还需要用目的语言中的等效图像替换所有图像。我们希望在每一页上都用一个5点刻度的国旗来指出翻译级别。我们相信即使是部分翻译也能帮助英语不好的人理解某个特定的点。如果您想帮助我们的翻译工作,您可以联系Tony Davis。

  6. 将2.5模型升级到Joomla! 3.0

    现在变得有趣了。我们计划在2012年8月初完成这项工作。为了做到这一点,我们需要您的帮助。Joomla! 3.0版本已经达到了一个很好的成熟度,现在只允许进行小的更改。我们将遵循以下流程:

    • 在Joomla 3.0中复制所有语言的页面
    • 将图像复制到Joomla! 3.0目录中
    • 要求英语贡献者开始工作

  7. 确保Joomla!的英语模型有效

    我们计划以处理其他语言中翻译的页面的相同方式处理新版本的英语页面。它们将使用一个标志来指示文档质量。它们在技术上正确吗?它们被编辑者批准了吗?图像是否正确?我们希望这项工作能顺利完成,以便在Joomla! 3.0发布后大约两周内提供Joomla!文档的新英文版本。

  8. 快速跟进翻译。

    翻译可以在英语页面被检查后开始。英文页面上的标志将显示翻译的进度。翻译者可以与他们的英语同事并行工作。我们希望在大约一个月后提供Joomla!文档的外语版本的第一版。

    这是一项重要的事业。有了您的帮助和支持,我们将不断提高。有了您的帮助和参与,我们才能不断改进。

    Joomla!是一个社区。作为社区,我们可以让我们的首选CMS变得更加强大。感谢您的贡献。

    下个月,我们将发布关于此类项目的含义以及未来挑战的其他文章。

《Joomla社区杂志》上发布的一些文章代表了作者对特定主题的个人意见或经验,可能与Joomla项目的官方立场不一致。

0
使用PMS简化您的流程
简单安全指南,第1部分
 

评论

已经注册? 在此登录
尚无评论。成为第一个提交评论的人

通过接受,您将访问由 https://magazine.joomla.net.cn/ 外部的第三方提供的服务