aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPau Amma <pauamma@FreeBSD.org>2022-11-03 12:59:22 +0000
committerPau Amma <pauamma@FreeBSD.org>2022-11-07 21:06:11 +0000
commita2b2b5696cd3c8ccfdba66dc149d32088b7d7a4a (patch)
treed5cb6ae147ed366c529e95182962a4587f2b404f
parent5c8cc20333c4e87dd5d3a562ad87f5c18254d5fd (diff)
downloaddoc-a2b2b5696c.tar.gz
doc-a2b2b5696c.zip
Language tweaks in trademarks section.
While there, fix number agreement in link target section. Reviewed by: gjb Approved by: gjb (mentor) Differential Revision: https://reviews.freebsd.org/D37251
-rw-r--r--documentation/content/en/books/fdp-primer/trademarks/_index.adoc13
-rw-r--r--documentation/content/en/books/fdp-primer/writing-style/_index.adoc2
2 files changed, 8 insertions, 7 deletions
diff --git a/documentation/content/en/books/fdp-primer/trademarks/_index.adoc b/documentation/content/en/books/fdp-primer/trademarks/_index.adoc
index c0a457e114..a57a2755c8 100644
--- a/documentation/content/en/books/fdp-primer/trademarks/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/trademarks/_index.adoc
@@ -47,22 +47,23 @@ toc::[]
include::../../../../../shared/asciidoctor.adoc[]
endif::[]
-For all documents on the FreeBSD Documentation Project, it is necessary to cite registered trademarks, and that is a duty of every writer and contributor.
+For all documents on the FreeBSD Documentation Project, citing registered trademarks is necessary and other trademarks is customary, and that is a requirement for every writer and contributor.
[[trademark-symbols]]
== Trademark Symbols
-Add a registered trademark symbol (TM), (R), or other symbols in the first occurrence of the company or software name, and always when using logos.
-Also, write the company or software name following its trademark guidelines.
+Append a trademark symbol ((TM), (R), or other) to the first occurrence of the trademarked name, and always when using logos.
+Use the extref:{fdp-primer}/writing-style/#writing-style-special-characters[equivalent ASCII sequence], which will be rendered as the actual Unicode character.
+Also, write the trademarked name following its trademark guidelines.
-When in doubt, research the company on the Internet or the software's website in addition to the link:https://www.uspto.gov/trademarks[United States Patent and Trademark Office site].
+When in doubt, research the trademark owner's website, the product's website, and or the link:https://www.uspto.gov/trademarks[United States Patent and Trademark Office trademark search website].
[[trademark-citing]]
== Trademark Citing
-It is customary to cite trademarks in technical documentation, and the FreeBSD Documentation Project provides a template for it, which also avoids duplicating trademarks in the documents.
+The FreeBSD Documentation Project provides a template for citing trademarks, which also avoids duplicating trademarks in the documents.
-First, check the project's link:https://cgit.freebsd.org/doc/tree/documentation/themes/beastie/i18n/en.toml#n197[template] for the trademark and then add it to the trademarks tag on the `Front Matter` section of the document, placed at the beginning of each document.
+First, look for the trademark in the link:https://cgit.freebsd.org/doc/tree/documentation/themes/beastie/i18n/en.toml#n328[Copyright section in the project's template], then add it to the trademarks tag on the `Front Matter` section of the document, located at the beginning of each document.
The following is an example of the `Front Matter` of the extref:{contributing}[Contributing to FreeBSD] article:
diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
index ba17cdf890..1fe5811de1 100644
--- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
@@ -179,7 +179,7 @@ Use Semantic Line Breaks in the documentation, a technique called "one sentence
The idea of this technique is to help the users to write and read documentation.
To get more information about this technique read the link:https://sembr.org/[Semantic Line Breaks] page.
-This is an example which don't use "one sentence per line".
+This is an example which does not use "one sentence per line".
....
All human beings are born free and equal in dignity and rights. They are endowed with reason and conscience and should act towards one another in a spirit of brotherhood.