Format commands as code

[alexander-mart]

For simplify translation process, for example this

[zkochan]

I am not sure about this because it changes the way it is rendered.

[zkochan]

maybe we could capitalize instead.

what do you think @pnpm/collaborators ?

# --filter=PACKAGE_NAME

[shellscape]

capitalizing is good by me

[Aankhen]

These aren’t code, though. They should be marked up using <kbd> with <var> inside it for the parts that change.

EDIT: I don’t think the version numbers should be marked up as either.

[zkochan]

Looks like this with <kbd>:

I think it is fine just to remove the < and >. Even capitalizing is not required.

[Aankhen]

I can’t comment on what what be most useful for the translation, but to format this correctly you’d need to use <kbd> and <var> together:

<kbd>--filter <var>package_name</var></kbd>

Which would give you:

--filter package_name

I can understand if that’s a lot to repeat for every instance.

[nikoladev]

@GreenRobot777 How do these changes simplify the translation process?

---

@Aankhen just now introduced me to <kbd> and <var> and it seems to be a very good way to use semantic HTML to give proper meaning. I think this would help people using assistive technology (like screenreaders).

As for how much work it would be to implement: I feel that the work can be reduced by having a template that the translators copy, paste, and edit. But I've never really done translating work so I can't say for sure.

---

I don’t the version numbers should be marked up as either.

I agree with this.