diff options
authorDanilo G. Baio <dbaio@FreeBSD.org>2022-08-04 22:26:24 +0000
committerDanilo G. Baio <dbaio@FreeBSD.org>2022-08-04 22:27:14 +0000
commit311e6e3d5e7476cda9107107d779a145241f11fa (patch)
parent154f588c626c478ed72ef05e7464d72aecf6677b (diff)
fdp-primer: Add Trademarks section
PR: 262202 Reported by: pauamma Reviewed by: bcr, carlavilla, emaste, jhb Differential Revision: https://reviews.freebsd.org/D35521
5 files changed, 104 insertions, 6 deletions
diff --git a/documentation/content/en/books/fdp-primer/book.adoc b/documentation/content/en/books/fdp-primer/book.adoc
index 248a2ee0ee..0a0e43a665 100644
--- a/documentation/content/en/books/fdp-primer/book.adoc
+++ b/documentation/content/en/books/fdp-primer/book.adoc
@@ -88,6 +88,8 @@ include::{chapters-path}writing-style/_index.adoc[leveloffset=+1]
diff --git a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
index bb3314bee6..e6218dfb88 100644
--- a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
@@ -1,7 +1,7 @@
title: Chapter 12. Editor Configuration
prev: books/fdp-primer/writing-style
-next: books/fdp-primer/see-also
+next: books/fdp-primer/trademarks
description: Configuration used in the texts editors in the FreeBSD Documentation Project
tags: ["editor", "configuration", "vim", "emacs", "FreeBSD"]
showBookMenu: true
diff --git a/documentation/content/en/books/fdp-primer/examples/_index.adoc b/documentation/content/en/books/fdp-primer/examples/_index.adoc
index 55322389cf..370bda43b2 100644
--- a/documentation/content/en/books/fdp-primer/examples/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/examples/_index.adoc
@@ -4,7 +4,7 @@ prev: books/fdp-primer/see-also/
description: Example of an article and a book used in the FreeBSD Documentation Project
tags: ["examples", "tutorial", "AsciiDoctor", "Book", "Article"]
showBookMenu: true
-weight: 15
+weight: 16
path: "/books/fdp-primer/"
diff --git a/documentation/content/en/books/fdp-primer/see-also/_index.adoc b/documentation/content/en/books/fdp-primer/see-also/_index.adoc
index f41b9b6270..89905aa28d 100644
--- a/documentation/content/en/books/fdp-primer/see-also/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/see-also/_index.adoc
@@ -1,11 +1,11 @@
-title: Chapter 13. See Also
-prev: books/fdp-primer/editor-config/
+title: Chapter 14. See Also
+prev: books/fdp-primer/trademarks/
next: books/fdp-primer/examples
description: More information about the FreeBSD Documentation Project
tags: ["additional information", "AsciiDoctor", "HTML"]
showBookMenu: true
-weight: 14
+weight: 15
path: "/books/fdp-primer/"
@@ -17,7 +17,7 @@ path: "/books/fdp-primer/"
:icons: font
:sectnumlevels: 6
-:sectnumoffset: 13
+:sectnumoffset: 14
:source-highlighter: rouge
diff --git a/documentation/content/en/books/fdp-primer/trademarks/_index.adoc b/documentation/content/en/books/fdp-primer/trademarks/_index.adoc
new file mode 100644
index 0000000000..c0a457e114
--- /dev/null
+++ b/documentation/content/en/books/fdp-primer/trademarks/_index.adoc
@@ -0,0 +1,96 @@
+title: Chapter 13. Trademarks
+prev: books/fdp-primer/editor-config/
+next: books/fdp-primer/see-also
+description: Guidelines for trademarks in the FreeBSD Documentation Project
+tags: ["trademarks", "AsciiDoctor", "HTML"]
+showBookMenu: true
+weight: 14
+path: "/books/fdp-primer/"
+= Trademarks
+:doctype: book
+:toc: macro
+:toclevels: 1
+:icons: font
+:sectnumlevels: 6
+:sectnumoffset: 13
+:source-highlighter: rouge
+:images-path: books/fdp-primer/
+:imagesdir: ../../../../images/{images-path}
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+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.
+== 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.
+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].
+== 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.
+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.
+The following is an example of the `Front Matter` of the extref:{contributing}[Contributing to FreeBSD] article:
+title: Contributing to FreeBSD
+ - author: Jordan Hubbard
+ - author: Sam Lawrance
+ - author: Mark Linimon
+description: How to contribute to the FreeBSD Project
+trademarks: ["freebsd", "ieee", "general"]
+weight: 15
+tags: ["Contributing", "FreeBSD", "Non-Programmer Tasks", "Programmer Tasks"]
+The trademark tags `freebsd`, `ieee`, and `general` will be automatically rendered when building the document like this:
+FreeBSD is a registered trademark of the FreeBSD Foundation.
+IEEE, POSIX, and 802 are registered trademarks of Institute of Electrical and Electronics Engineers, Inc. in the United States.
+Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this document, and the FreeBSD Project was aware of the trademark claim, the designations have been followed by the “™” or the “®” symbol.
+If a trademark is not present in the project's template, it must be submitted.
+Any developer or contributor can update the trademarks.
+The `freebsd` and `general` trademark tags are usually present in all documents.