Page MenuHomeFreeBSD

fdp-primer: Add trademark section (draft)
ClosedPublic

Authored by dbaio on Jun 19 2022, 4:39 AM.
Tags
None
Referenced Files
Unknown Object (File)
Apr 30 2024, 8:31 PM
Unknown Object (File)
Apr 30 2024, 8:30 PM
Unknown Object (File)
Apr 30 2024, 8:30 PM
Unknown Object (File)
Apr 30 2024, 8:29 PM
Unknown Object (File)
Apr 30 2024, 6:43 PM
Unknown Object (File)
Apr 22 2024, 7:32 AM
Unknown Object (File)
Apr 21 2024, 10:05 PM
Unknown Object (File)
Apr 21 2024, 10:05 PM

Details

Summary

Rendered document here.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

dbaio requested review of this revision.Jun 19 2022, 4:39 AM
dbaio created this revision.

It's a good start, thanks.
I added few language corrections and simplifications.

documentation/content/en/books/fdp-primer/trademarks/_index.adoc
59

s/In doubt/When in doubt/

Also, to have fewer commas, maybe write:

When in doubt, research the company on the Internet or the software's website in addition to the ...

64

Maybe: ... provides a template to cite...?
and
s/in a manner of not have to/to avoid/

84

s/trademarks/trademark/

95

s/can make the maintenance of the trademarks/can maintain the trademarks/

@bcr Thanks for reviewing.

carlavilla added a subscriber: carlavilla.

Thanks for doing this :)

This revision is now accepted and ready to land.Jun 20 2022, 8:38 AM
emaste added inline comments.
documentation/content/en/books/fdp-primer/trademarks/_index.adoc
56

We should use ™ and ® where necessary (via AsciiDoc escapes, if applicable), not (TM) or (R). And drop "at least", we do not need to use the symbol on every instance of the trademark. If we need it at all, using it on the first is sufficient.

For reference, the Linux Foundation's request is (https://www.linuxfoundation.org/the-linux-mark/):

  1. For each web page, advertisement, or publication, the first prominent appearance of LINUX should feature the “circle R” character adjacent to the X, as follows:

Linux®

  1. At the end of your web page, advertisement, publication or media broadcast, include the following text in a legible font and size:

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.

Note that this is a request, and it matches our current practice but is probably not necessary. So above I would write "it is customary to cite..."

jhb added inline comments.
documentation/content/en/books/fdp-primer/trademarks/_index.adoc
64

I would say "provides a template for citing trademarks to avoid duplicating trademark information in each document"

66

Maybe:

First, check the project's template for the trademark.
If there is not an existing entry for the trademark, add a new one.
Second, add the trademark to the `trademarks` tag in the `Front Matter` section at the top of the document.

Possibly s/top/start/ or s/top/beginning/

95

Perhaps s/maintain/update/?

  • Address topics from emaste and jhb.
This revision now requires review to proceed.Jul 12 2022, 1:50 AM

Thanks @emaste and @jhb .

Rendered document here.

Regards.

documentation/content/en/books/fdp-primer/trademarks/_index.adoc
56

Thanks for the feedback and information.

(TM) or (R) renders as ™ and ®.

Do you think an example like this from Linux can be useful?

If there's no more corrections. Can we merge this?

No objection from me, we can always iterate on it in the tree if anything new comes up

I'm OK with this new version to be committed.

This revision is now accepted and ready to land.Aug 4 2022, 5:29 PM

Thank you all, I'll push this.

This revision was automatically updated to reflect the committed changes.