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.

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

Replaced 'break' with 'beginning' for page|line|column|gathering in Guidelines and Specs #2634

Merged
merged 20 commits into from
Jan 20, 2025

Conversation

trishaoconnor
Copy link
Contributor

@trishaoconnor trishaoconnor commented Dec 10, 2024

Replaced 'break' with 'beginning' for page|line|column|gathering in the following files from the Guidelines and Specs:

-     page beginning (<pb>)
-     column beginning (<cb>)
-     att.breaking
-     parameter (<param>)
-     model (<model>)
-     att.edition
-     att.milestoneUnit
-     WD Non Standard Characters
-     SG Gentle Introduction
-     PH Primary Sources
-     NH Non Hierarchical
-     HD Header
-     FT Tables Formulae Graphics
-     DS Default Text Structure
-     DI Print Dictionaries
-     CO Core Elements
-     CH Language Character Sets

There were no mentions of 'break' in the prose of <gb> but I deleted an superfluous space in the prose

The requested changes to <lb> are addressed in PR #2633.

@trishaoconnor trishaoconnor added this to the Guidelines 4.9.0 milestone Dec 10, 2024
@GusRiva GusRiva linked an issue Dec 14, 2024 that may be closed by this pull request
4 tasks
@ebeshero ebeshero requested a review from sydb January 12, 2025 00:23
@ebeshero ebeshero self-assigned this Jan 12, 2025
@ebeshero
Copy link
Member

@sydb Might as well have a look at this while you're at it?

Copy link
Member

@sydb sydb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The majority of my suggestions for change, here, are underpinned by my strong distaste for using the noun “beginning” unless it is being used to gloss an element itself or very specifically about the beginning of a feature. Others may disagree.

@@ -329,7 +329,7 @@ problem for text encoders. Suppose, for example, that we wish to
investigate a diachronic English corpus for occurrences of
<mentioned>tea-pot</mentioned> and <mentioned>teapot</mentioned>, to
find evidence for the point at which this compound becomes
lexicalized. Any case where the word is hyphenated across a linebreak,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This use of the term has nothing to do with our <lb> element, and perhaps should just be left as “line break”. (Note the space — 18 of the 25 occurences of "line.?break" in the Guidelines have a space. (One has a hyphen, and six have the single word version.)

Copy link
Contributor Author

@trishaoconnor trishaoconnor Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Further down on line 353, "line division" is used. For consistency, I've rewritten line 332 using "division" instead of "beginning" and "break". Hopefully, this substitution is acceptable?

"Any case where the word is hyphenated across a linebreak..."

Thank you very much, too, for spotting the different renderings of the term throughout the Guidelines.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine. But with respect to the different renderings of the term, no pat on the back for just finding them; I have not gone out and fixed them, yet. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I searched using the query that @martinascholger kindly provided when opening the issue. I thought that this would have caught every instance, including variations between line-break, line break and linebreak?
(page|line|column|gathering)[\s-]*breaks
I'll search for the occurrences that you found an fix them too. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depends on what regular expression language you are using, I think. (I am not sure on this, but I think in most languages “\s”, when inside square brackets, means “whitespace”; but in some languages means “an ‘s’”. It would be quite conceivable that it means “a backslash or an ‘s”’, too.)

P5/Source/Guidelines/en/CO-CoreElements.xml Outdated Show resolved Hide resolved
P5/Source/Guidelines/en/CO-CoreElements.xml Outdated Show resolved Hide resolved
P5/Source/Guidelines/en/CO-CoreElements.xml Show resolved Hide resolved
P5/Source/Guidelines/en/WD-NonStandardCharacters.xml Outdated Show resolved Hide resolved
P5/Source/Guidelines/en/WD-NonStandardCharacters.xml Outdated Show resolved Hide resolved
P5/Source/Specs/att.breaking.xml Outdated Show resolved Hide resolved
P5/Source/Specs/model.xml Outdated Show resolved Hide resolved
P5/Source/Specs/param.xml Outdated Show resolved Hide resolved
@martindholmes
Copy link
Contributor

@trishaoconnor Just letting you know I've just cherry-picked a single-character commit fix from dev into this branch just to make sure it didn't cause any issues. It was a typo in the boustrophedon section of WD-NonStandardCharacters.xml which just needed an added s, found by @sydb. Doesn't affect any of the other stuff in your branch.

@trishaoconnor
Copy link
Contributor Author

Thank you very much @sydb for your thorough review and thank you too @martindholmes for fixing that typo and merging it to the PR.

I appreciate your point @sydb and thank you very much for highlighting the passages where "beginning" isn't an appropriate substitution for "break". I confess that I still have a preference for using "beginning" instead of "break" and would be in favour of rewriting these passages along similar lines to the example that you supplied above:

<p>In the following lines from the <title level="a">Dream of the Rood</title>, the words <mentioned>lāðost</mentioned> and <mentioned>reord-berendum</mentioned> each start on one line and continue on the next.</p>

Of course, if the general consensus is to revert to "break" instead, I'll happily do so.

@ebeshero ebeshero merged commit 2c69230 into dev Jan 20, 2025
3 checks passed
@ebeshero
Copy link
Member

I'm just merging this now, as it's ready to go for the release.

@ebeshero ebeshero deleted the trishaoconnor_2603 branch January 20, 2025 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

replace * break with * beginning
5 participants