Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

As currently defined, namespacesynopsis is not very useful #223

Closed
ndw opened this issue Nov 13, 2021 · 0 comments · Fixed by #224 or #226
Closed

As currently defined, namespacesynopsis is not very useful #223

ndw opened this issue Nov 13, 2021 · 0 comments · Fixed by #224 or #226

Comments

@ndw
Copy link
Contributor

ndw commented Nov 13, 2021

At the last DocBook TC meeting, we concluded that

  1. The namespacesynopsis element is not very useful. It really should be a container for other declarations.
  2. The use of "namespace" in the name is potentially confusing in an XML vocabulary where "namespace" is both common and means something else entirely.

Although some languages, like C++ and C#, call the container that is used for providing scoped names a "namespace", many languages call them something else. Java, Perl, and Python, for example, all call them "packages".

The word "package" is overloaded in computer software as well, but it's not so immediately confusing in an XML vocabulary.

The proposal is to recast the construct as a packagesynopsis and make it a container.
@ndw ndw mentioned this issue Nov 13, 2021
Merged
@ndw ndw closed this as completed in #224 Nov 14, 2021
@ndw ndw reopened this Nov 14, 2021
@ndw ndw mentioned this issue Nov 14, 2021
Merged
@ndw ndw closed this as completed in #226 Nov 15, 2021
qtprojectorg pushed a commit to qt/qttools that referenced this issue May 27, 2022
@dourouc05
Use the tag packagesynopsis to follow the changes in DocBook 5.2
bddd702 
The previous tag was based on a prerelease of DocBook 5.2, this patch
brings it to the current prerelease (which is highly unlikely to change
much).

The change was introduced in the specification following
docbook/docbook#223

Change-Id: I1abf388cdf9f8777dbf5e9e3f700a52334d5275d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@ndw