标签: documentation

我发现手册页格式写起来非常痛苦。是否有 GUI（WYSIWYG或WYSIWYM）编辑器可用于简化此任务？我希望有一个应用程序可以像Kompozer对网页一样处理手册页。

我尝试过gmanedit但发现它基本上只是一个带有一些易于获得的片段的文本编辑器 - 必须知道使用它的手册页格式，并且编辑区域只是一个文本小部件。

虽然我更喜欢官方 Ubuntu 存储库中的软件，但我可以使用不受支持的方法进行安装，例如 PPA 或从源安装。

升级到 Ubuntu 14.04 后，我删除了官方的 qtcreator，以便从软件中心安装修改后的版本，因为我想尝试 SDK。

幸运的是，这些文档现在包含在官方安装中。不幸的是，仍然缺少一些东西：官方示例。幸运的是，我的旧的和官方的安装仍然在我的硬盘上，然后，经过一些尝试，我将示例复制到/usr/lib/x86_64-linux-gnu/qt5/examples并更改了权限。然后 QtCreator 检测到示例，我能够从示例部分中选择它们。

但是仍然存在两个问题：

首先，我无法找到所有示例，例如仍然缺少网络示例（如 Fortuneclient）。为了测试，我将示例文件夹的权限更改为777. 因此，许可应该不是问题。

其次，缺少一些示例的帮助文档。因此，单击示例后，我得到了一个普通的编辑器和一个空白的右侧部分。

在 CentOS 中我可以做yum install kernel-doc然后阅读/usr/share/doc/kernel-doc/Documentation/filesystems/proc.txt.

我将如何在 Ubuntu 中做同样的事情？谷歌教授告诉我它在源代码中，所以我做了，apt install linux-source但我找不到proc.txt任何地方。

我猜在 Ubuntu 中有一种不同的方法。

我对自己的项目越来越认真，需要有关 python 的 appindicator 模块的良好文档。到目前为止我发现了什么：

1. dev.ubuntu.com 上的 API 文档
2. 社区维基条目
3. C 代码的 API 文档
4. 不错的博文

他们怎么了：

1. 只是一个列表，不解释参数、返回值和方法的作用
2. 只有设计考虑和背景 - 对实际编程几乎没有帮助
3. 缺少python模块的东西（例如create_menu_from_desktop）
4. 许多有用的信息被压缩但不完整

所以基本上我需要像 3. 一样详细的东西，但是对于 python 模块。

我的问题示例：

void build_menu_from_desktop (desktop_file, desktop_profile)

参数应该是什么，该方法有什么作用？我的猜测是，该方法从“*.desktop”文件创建菜单条目。但如果是这样，为什么它需要更多的参数而不仅仅是那个文件？它从文件中的哪些条目中获取菜单项？像这样的问题我很难找到答案。

假设我能够abc在命令行中输入并且它会运行（所以 shell 不会说“abc: command not found”）。

我怎样才能知道abc是什么或做什么？是脚本吗？程序？别名？

抱歉，如果这是一个如此明显的问题，但是 Ubuntu 将 Python、node.js、redis、mysql、mongodb 和其他应用程序的文档包放在哪里？

为什么我无法通过python-doc在终端中输入来访问它？

我正在安装一些程序，每个程序都有一个XXX-doc包。我想它是用于文档，甚至可能用于手册页？因为我在线获得了文档，因此在这种情况下我可以删除所有 -doc包吗？我只需要基本的手册页，而不是整个文档，那么它们真正应该包括什么？

例如：vim-doc仅由 .html 文件组成（使用检查dpkg），所以我认为没有手册页，那么 doc 包有什么用？

它是安全的：sudo apt-get purge (or remove) .*-doc？

我能找到的关于将应用程序与消息菜单集成的唯一文档是旧的和过时的：http : //gnomejournal.org/article/67/an-introduction-to-the-message-indicator。即使那样也没有整个 API 的文档。是否有任何关于 libindicate 的文档，无论是 python 还是 C 版本？

man echo作品。但出于好奇，echo 是否有类似于--help标志/参数的东西？

Unity 将为我们大多数人引入一种新的桌面范式。因此，很多人可能想知道如何执行他们的常见用例，例如：

• 如何打开应用程序？
• 如何找到应用程序？
• 如何配置我的桌面？
• 如何以有意义的方式使用虚拟桌面？
• 如何将应用程序添加到启动器？
• 如何在打开的应用程序之间切换？
• 我如何对我的应用程序进行分类，就像我在旧菜单中所做的那样？
• 我如何为我最喜欢的应用程序分配个人热键（不是数字）？
• 等等 ...

是否有可帮助用户过渡到新桌面的指南或文档？