Page MenuHomeFreeBSD
Files F151838884

D35521.id107146.diff
No OneTemporary
Actions

D35521.id107146.diff
View Options

diff --git a/documentation/content/en/books/fdp-primer/book.adoc b/documentation/content/en/books/fdp-primer/book.adoc
--- 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}editor-config/_index.adoc[leveloffset=+1]
+include::{chapters-path}trademarks/_index.adoc[leveloffset=+1]
+
include::{chapters-path}see-also/_index.adoc[leveloffset=+1]
:sectnums!:
diff --git a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
--- 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
--- a/documentation/content/en/books/fdp-primer/examples/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/examples/_index.adoc
@@ -4,7 +4,7 @@
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
--- 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 @@
:icons: font
:sectnums:
:sectnumlevels: 6
-:sectnumoffset: 13
+:sectnumoffset: 14
:partnums:
:source-highlighter: rouge
:experimental:
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
--- /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]]
+= Trademarks
+:doctype: book
+:toc: macro
+:toclevels: 1
+:icons: font
+:sectnums:
+:sectnumlevels: 6
+:sectnumoffset: 13
+:partnums:
+:source-highlighter: rouge
+:experimental:
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+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.
+
+[[trademark-symbols]]
+== Trademark Symbols
+
+Add a registered trademark symbol (TM), (R), or other symbols at least 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.
+
+In doubt, research on the Internet, the company or software website, and the link:https://www.uspto.gov/trademarks[United States Patent and Trademark Office site].
+
+[[trademark-citing]]
+== Trademark Citing
+
+The FreeBSD Documentation Project has on its template a way to cite trademarks on each document in a manner of not have duplicated information.
+
+First, check the project 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 top of each document.
+
+The following is an example of the `Front Matter` of the extref:{contributing}[Contributing to FreeBSD] article:
+
+....
+---
+title: Contributing to FreeBSD
+authors:
+ - 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 trademarks 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 make the maintenance of the trademarks.
+
+The `freebsd` and `general` trademark tags are usually present in all documents.

File Metadata

Mime Type
text/plain
Expires
Sun, Apr 12, 12:36 AM (12 h, 15 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
31318170
Default Alt Text
D35521.id107146.diff (6 KB)

Event Timeline