使用 Homebrew, apk, apt, dnf, MacPorts, Nix, pacman, zypper 安装 yelp-tools

项目链接

• 主页

命令和别名

• yelp-build
• yelp-check
• yelp-new

项目历史

Yelp itself is GNOME's help viewer, and the GNOME wiki describes Yelp development as having produced related tools and XSLT modules under the Yelp umbrella. Yelp-tools separated the authoring and build utilities from the viewer so documentation teams could generate and validate help content without launching the application.

The yelp-tools NEWS file begins with a 3.1.1 initial release in 2011. Early 3.x development quickly added Mallard page status checks, EPUB generation, itstool and xmllint checks, faster HTML/cache generation, href validation, stricter validation, and DocBook link support.

The toolset followed GNOME's help-stack evolution: support for Mallard Sites appeared in the 3.17 series, Mallard stack files arrived in the 3.31 series, and the 40.alpha cycle converted `yelp-build`, `yelp-check`, and `yelp-new` to Python while moving to Meson and adding `.yelp-tools.cfg` support.

采用历史

Adoption follows GNOME documentation infrastructure. The wiki presents yelp-tools as the package for creating and publishing Mallard or DocBook documentation, and downstream package indexes show it distributed broadly across Linux, BSD, MSYS2, Homebrew, MacPorts, Nix, and other ecosystems.

Because many GNOME and GTK-adjacent projects ship localized help, yelp-tools is more important than its small executable list suggests. It packages the boring but essential checks that keep help pages buildable, linkable, translatable, and publishable.

使用方式

`yelp-build` creates output such as HTML and EPUB from Mallard or DocBook sources. The GNOME wiki documents HTML generation from page files, directories of Mallard pages, or a top-level DocBook file.

`yelp-check` validates documents, checks links and hrefs, detects orphaned pages, checks media, statuses, page IDs, comments, licenses, and custom checks. `yelp-new` creates new documents and pages from templates, while `yelp.m4` helps integrate help builds into Autotools-era projects.

为什么软件包爱好者会关心

yelp-tools is package-nerd significant because it is infrastructure for documentation packages, not the documentation itself. It turns GNOME help authoring conventions into repeatable build and validation commands that distributions can rely on.

It is also a good example of a desktop project splitting runtime viewing, XSLT transformation, translation extraction, validation, and templates into separate packages so maintainers can depend on only the build-time pieces they need.

时间线

• 2011-05-08: The NEWS file records yelp-tools 3.1.1 as the initial release.
• 2011-05-23: The 3.1.3 line adds Mallard status checking and EPUB building.
• 2012-03-26: The 3.4.0 line adds DocBook support for `yelp-check` links and hrefs commands.
• 2015: The 3.17 series adds Mallard Sites support across yelp-build and yelp-check.
• 2019: The 3.31 series adds initial support for Mallard 1.2 stack files.
• 2021-02-06: The 40.alpha line moves to Meson, converts the main tools to Python, adds improved templates, and introduces `.yelp-tools.cfg`.
• 2022-10-30: The 42.1 tag fixes a DocBook path issue and remains a widely packaged line.

Related projects

• Related projects include Yelp, yelp-xsl, Mallard, Project Mallard, DocBook, itstool, xmllint, GNOME Help, GNOME Documentation Project workflows, ScrollKeeper/Rarian-era help infrastructure, and Autotools/Meson documentation builds.

来源

• https://archlinux.org/packages/extra/any/yelp-tools/
• https://github.com/GNOME/yelp
• https://gitlab.gnome.org/GNOME/yelp-tools
• https://gitlab.gnome.org/GNOME/yelp-tools/-/raw/master/NEWS
• https://gitlab.gnome.org/api/v4/projects/GNOME%2Fyelp-tools
• https://gitlab.gnome.org/api/v4/projects/GNOME%2Fyelp-tools/repository/tags?per_page=100&page=1
• https://packages.msys2.org/package/yelp-tools
• https://wiki.gnome.org/Apps%282f%29Yelp.html
• https://wiki.gnome.org/Apps/Yelp/Tools
• https://www.freshports.org/textproc/yelp-tools