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

Change log message copy to use consistent language #3973

Closed
jelovirt opened this issue Jul 25, 2022 · 1 comment · Fixed by #4287
Closed

Change log message copy to use consistent language #3973

jelovirt opened this issue Jul 25, 2022 · 1 comment · Fixed by #4287
Assignees
@infotexture
Labels
enhancement Changes to an existing feature
Milestone
4.2

Comments

@jelovirt
Copy link
Member

jelovirt commented Jul 25, 2022 •
edited

Description

Attribute names and values

Currently messages_template.xml uses various expressions to reference attribute names and values of attributes.

For example:

Rev attribute
'scope' attribute

cols attribute is "%1"
'format' attribute value 'email'
conref="%1"

Resources

Messages use both "file" and "resource" to reference topics etc. Term "file" is likely more familiar term for most end users. However, the DITA specification uses "resource" and it is more accurate in many cases.

The resource referenced as %1 is capitalized differently on disk

vs.

File '%1' cannot be loaded

Possible Solution

These should be rewritten to use consistent language.
@jelovirt jelovirt added the enhancement Changes to an existing feature label Jul 25, 2022
@jelovirt
Copy link
Member Author

I especially dislike

conref="%1"

Because it's XML syntax fragment in error message.

@infotexture infotexture mentioned this issue Sep 29, 2023
Merged
12 tasks
infotexture added a commit that referenced this issue Oct 29, 2023
@infotexture
Update “file” references to “resource”
0c7753f 
Per #3973:
> the DITA specification uses "resource" and it is more accurate in many cases

- Not all resources are files
- Leave “file” references to DITAVAL files, file encoding, image files, and log files

Signed-off-by: Roger Sheen <roger@infotexture.net>
@infotexture infotexture linked a pull request Nov 9, 2023 that will close this issue
Revise log messages for #3973 #4287
Merged
12 tasks
infotexture added a commit that referenced this issue Dec 20, 2023
@infotexture
Update “file” references to “resource”
39abbf7 
Per #3973:
> the DITA specification uses "resource" and it is more accurate in many cases

- Not all resources are files
- Leave “file” references to DITAVAL files, file encoding, image files, and log files

Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit that referenced this issue Dec 29, 2023
@infotexture
Update “file” references to “resource”
6531a8f 
Per #3973:
> the DITA specification uses "resource" and it is more accurate in many cases

- Not all resources are files
- Leave “file” references to DITAVAL files, file encoding, image files, and log files

Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit to dita-ot/docs that referenced this issue Dec 30, 2023
@infotexture
Copyedit message details for dita-ot/dita-ot#3973
8c17224 
Complements changes for dita-ot/dita-ot#4287

Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit that referenced this issue Jan 7, 2024
@infotexture
Merge pull request #4287 from dita-ot/feature/3973-log-messages
1d75a16 
Revise log messages for #3973
@infotexture infotexture added this to the Next milestone Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@infotexture infotexture

Labels
enhancement Changes to an existing feature
Projects
No open projects
4.2
Status: Done
Milestone
4.2
Development

Successfully merging a pull request may close this issue.

Revise log messages for #3973 dita-ot/dita-ot
2 participants
@jelovirt @infotexture