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

dm:translation tags in non-modifiable files..? #16

Open
ghost opened this issue Jan 11, 2021 · 0 comments
Open

dm:translation tags in non-modifiable files..? #16

ghost opened this issue Jan 11, 2021 · 0 comments
Labels
cat-bug scope-tool For the doc-kit tool itself

Comments

@ghost
Copy link

ghost commented Jan 11, 2021

@tbazant has the issue that he needs dm:translation tags in the intro documents for SES.
As translation tags need to be filled with either "yes" or "no" depending on the context, having translation tags in a file that is not supposed to be modified downstream is a conceptual issue. I am not 100% sure that translation tags really need to be part of the intro though ... would it not be enough to have them in the MAIN? Translation tags are file-based, so yes, they need to be in each individual file.

Specifically for the intro though, translation tags can just always be set to "yes" currently, because the intro pretty much always needs to be translated (and if none of the documents from the repo are translated, nothing will evaluate those tags, so what they are set to does not matter in that case anyway).

Zooming out and looking at the general issue though, this would only be properly solvable if we could mark up sections that can be changed in some way.

...
<!-- dk-ignore-start -->
<dm:translation>yes</dm:translation>
<!-- dk-ignore-end -->
...

But of course since doc-kit is supposed to be document type-agnostic, you'd have to make sure that whatever comment markup is needed for the file type is supported somehow. I don't know where to start, except maybe by defining that *.xml means that <!--these--> are comments and *.js means that //these\n are comments and ... where to stop. Seems like an endless hole.

@ghost ghost added cat-bug scope-tool For the doc-kit tool itself labels Jan 27, 2022
@ghost ghost changed the title dm:translation tags dm:translation tags in non-modifiable files..? Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat-bug scope-tool For the doc-kit tool itself
Projects
None yet
Development

No branches or pull requests

0 participants