7分钟阅读时间 (1330字)

Joomla! 文档

Joomla! Documentation

Joomla! 我们有问题!大家都认为 Joomla! 的文档可以改进。我们不需要过多讨论不足之处。我们更愿意讨论我们新的方法计划,并在描述优点的同时,简要提及该建议解决的问题。

本文描述了一个实验。它不会取代Joomla! 官方文档。只有当我们能够创造出真正、实质上更好的东西,并且有明确的迁移路径时,才会考虑进行更改。本文的目的是激发您的思考。如果您认为我们有未解决的问题,请在下面的评论空间中告诉我们。

我们喜欢您的反馈。我们需要您的反馈。我们需要您的帮助。请自愿帮助。

我们的建议

1. 使用 Joomla!

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

  • 改进的可用性 – CMS 的一项关键优点是它们的模板功能。我们可以通过调整模板来简单地改变文章的可读性。您不再需要扭动脖子来阅读页面。
  • 改进的搜索 – 智能搜索会索引内容,该索引可用于搜索。许多 Joomla! 专家使用 Google 在文档维基中查找他们想要的内容。而且有一种怀疑,即 Google 对该维基的索引可能没有应有的效果。
  • 改进的结构– 我们可以从他人的成功中学习。我们喜欢 MySQL 文档的风格。我们喜欢的关键元素包括
    • 标题菜单将与 Joomla! 风格模式相匹配。
    • 所有页面上都提供版本选择。但 MySQL 与 Joomla! 不同,它具有更多版本,且变化较慢。我们将只需要三个版本。我们应该预计每六个月会有一个新版本。
    • 当前版本的目录表在右侧可见,并且当您深入内容时,会根据您在文档中的路径展开。
    • 每个版本的首页提供几种方法来对该版本的内容进行分类。
    • 每个中间目的地,例如11.3,都会显示一个菜单,列出下面的内容,以及关于此分支含义和功能的描述。
    • 搜索功能适用于整个MySQL网站、本版本的文档以及其他内容。

但我们还喜欢页面上的PHP更改语言和评论选项。试着对PHP发表评论。我们很喜欢这一点。

  • 改进的国际化 – 核心功能与Josetta结合,使我们能够创建不同语言的并行页面。这意味着如果我们用英文创建thispage.html,然后将其翻译成法语thispage.html,用户可以通过选择语言指示器在这两个页面之间切换。无需通过文档网站首页。
  • 更容易的贡献 – 我们文档的作者将是Joomla!用户。他们将熟悉界面和使用编辑器的技巧。无需学习wiki语法和约定。
  • 更容易的翻译 – 利用核心多语言功能和Josetta,翻译志愿者可以轻松地用他们的语言贡献页面。

2. 面向不同的用户群体

Joomla!文档针对各种受众的需求。我们的努力应该培养他们每一个人。我们想象了几个组件。

  • 食谱 – 如何做某事

目前页面描述准确,但读者无法理解为什么一个选项可能比另一个选项更受欢迎。食谱将帮助初学者建立他们的第一个网站,并帮助开发者了解如何链接到Joomla!核心的某些部分。

  • 解释 – 为什么一个方法可能比另一个方法更好?

Joomla!非常灵活。很好。但对于初学者来说可能会感到令人畏惧。他们需要帮助才能做好简单的事情,随着他们的成长,了解如何做更复杂的事情。

  • 诊断 – 为不确定的用户提供帮助。

经验丰富的Joomla!技术用户有有效的解决问题的方法。经验较少的用户可能难以构建他们的问题。不确定的用户能否通过提供可能对他们有用的信息链接来获得帮助?这是一个对Joomla!开发者的技术挑战。

  • 文档 – 详细描述

对有一定Joomla!经验的用户来说,这是参考手册。

3. 定义一个清晰的架构。

文档的结构应尽可能与每个版本保持一致。

用户将学会如何使用这种结构,因此会发现结构更易于使用。我们希望用户会为改进结构做出贡献。

虽然评论文档需要大量监管,但它将为改进其以及其对用户的实用性提供有用的反馈。

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

为Joomla! 2.5构建文档原型。我们的初步努力很简单,下一个版本将在接下来的几周和几个月内扩展。

我们非常感谢您在几个领域的帮助。请发送电子邮件至Tony Davis以获取访问权限。

  • 评论我们提出的结构。
  • 为页面贡献内容。
  • 在内容发展过程中对其进行评论。
  • 贡献翻译 - 在贡献时了解Josetta。

5. 将翻译构建成多种语言

一旦我们有页面,我们就可以将结构复制到外语克隆中。然后它就可通过Josetta访问。

翻译者可以看到原始页面和一个空白表单。我们迄今为止已使用Google翻译创建草稿,然后翻译者(他们了解Joomla! 并在其母语中工作)编辑草稿以创建最终文档。

这很简单,我们都知道。还需要用该语言中Joomla!的等效图像替换所有图像。

我们希望在每个翻译页面上用标志显示翻译完成程度的5点评分。我们相信,部分完成的翻译可能会帮助那些英语不太流利的人理解他们在英语中遇到的难点。

如果您愿意作为志愿者翻译,请告知Tony Davis。

6. 在冻结点将2.5模型迁移到Joomla! 3.0

但是,现在事情变得有趣了。

我们计划在2012年8月初完成这项工作。我们需要您的帮助。

随着Joomla! 3.0达到设计冻结点——即现在只允许进行小幅度修改——我们遵循以下流程。

  • 将所有语言的页面克隆到Joomla! 3.0文档中
  • 将图像复制到Joomla! 3.0目录。
  • 请让英语贡献者开始工作。

7. 升级英语Joomla! 3.0模型以确保准确性。

我们计划将新版本的英语页面与其他语言的翻译页面同等对待。它们将带有标志以显示它们作为文档的检查程度。它们在技术上是否正确?它们已被语言编辑批准吗?图像是否适当?

我们希望这项工作能在Joomla! 3.0发布后大约两周内完成,以提供新的英语版Joomla! 文档。

8. 翻译跟进迅速。

翻译可以在英语页面检查完毕后立即开始。英语页面上的标志将显示转换进度,翻译者可以与他们的英语语言同事并行工作。

我们希望在大约一个月后发布Joomla! 3.0后提供第一版外语版本的Joomla! 文档。

这是一项重大的工作。我们绝对清楚我们不可能完全正确。但是,有了您的帮助和支持,我们将不断改进。

Joomla! 是一个社区。作为社区,我们可以使我们的最爱CMS变得更强大。请帮助。

下个月我们将撰写关于这一发展的进一步影响以及一些具体挑战的文章。

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

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

评论

已经注册? 在此登录
尚未发表评论。成为第一个发表评论的人

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