Skip to content

Mark up unspecific constants as replaceable #1963

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.

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

Closed
wants to merge 2 commits into from

Conversation

cmb69
Copy link
Member

@cmb69 cmb69 commented Nov 7, 2022

Great idea of @Girgias, in my opinion.

@Girgias
Copy link
Member

Girgias commented Nov 9, 2022

Does our DTD really not allow <constant>LC_<replaceable>*</replaceable></constant>?

Otherwise, LGTM, but I would wait a bit before merging to not put too much strain on translation before the release of 8.2.

@Girgias
Copy link
Member

Girgias commented Nov 10, 2022

Does our DTD really not allow <constant>LC_<replaceable>*</replaceable></constant>?

Otherwise, LGTM, but I would wait a bit before merging to not put too much strain on translation before the release of 8.2.

Now that I think about it, having the replaceable tag be just after the constant one will probably help if (one can dream) we get links to constants automatically generated as those will need to be ignored

@cmb69
Copy link
Member Author

cmb69 commented Nov 10, 2022

Does our DTD really not allow <constant>LC_<replaceable>*</replaceable></constant>?

Yeah, I got a failure when running configure, although the constant spec says:

Mixed Content Model
constant ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
beginpage)*

Now that I think about it, having the replaceable tag be just after the constant one will probably help if (one can dream) we get links to constants automatically generated as those will need to be ignored

Indeed, avoinding mixed content in <constant>s should make that easier.

@salathe
Copy link
Contributor

salathe commented Nov 10, 2022

My preference would be to only mark up the replaceable part as replaceable.

I don't buy the argument that <constant><replaceable>FOO_*</replaceable></constant> should be (any meaningful amount) easier to work with than <constant>FOO_<replaceable>*</replaceable></constant> (e.g. for adding links, generating lists of constants, etc.).

Regardless, either way is an improvement on what we have now.

Yeah, I got a failure when running configure

What was the failure? A quick search/replace to the <constant>FOO_<replaceable>*</replaceable></constant> format didn't result in a failure for me locally.

@cmb69
Copy link
Member Author

cmb69 commented Nov 16, 2022

What was the failure? A quick search/replace to the <constant>FOO_<replaceable>*</replaceable></constant> format didn't result in a failure for me locally.

I've tried again, and indeed it works. I must have messed something up in my first attempt.

I don't buy the argument that <constant><replaceable>FOO_*</replaceable></constant> should be (any meaningful amount) easier to work with than <constant>FOO_<replaceable>*</replaceable></constant> (e.g. for adding links, generating lists of constants, etc.).

Well, there isn't probably much of a difference, so I'm pushing a commit where only the *s are <replaceable>.

phansys added a commit to phansys/php-doc-en that referenced this pull request Feb 20, 2023
phansys added a commit to phansys/php-doc-en that referenced this pull request Feb 20, 2023
phansys added a commit to phansys/php-doc-en that referenced this pull request Feb 20, 2023
phansys added a commit to phansys/php-doc-en that referenced this pull request Mar 15, 2023
phansys added a commit to phansys/php-doc-en that referenced this pull request Aug 25, 2023
phansys added a commit to phansys/php-doc-en that referenced this pull request Aug 25, 2023
@cmb69
Copy link
Member Author

cmb69 commented Sep 21, 2024

This has at least partially been done already, so I'm closing this PR.

@cmb69 cmb69 closed this Sep 21, 2024
@cmb69 cmb69 deleted the cmb/replace-const branch September 21, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants