From nobody Thu Aug 04 22:46:03 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4LzP300n1sz4YBWw for ; Thu, 4 Aug 2022 22:46:04 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4LzP300HxLz415X; Thu, 4 Aug 2022 22:46:04 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1659653164; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Ac7TNLgpo1nJ8bT6lXFhDcoyDz7jti/ImdW8OcNYJxE=; b=ImGx1y/YZpXEe9+Fy7SUG9gzPyZ428Refaj1DKV9Wh3QeLihSdAHtv0xxHN4EtWHQTJEL+ X7nMZrvGoMhotjQ0BPG1NWnV+VEYBSHOMpLc24qttudVFI0ZTlTtnAyjSzwwzb/eBe+fYa Ss5X57jCguFtiuLPaiAh2gprIdtRknt35Tq9fAxK0ezZWloRR5SC88Sdlyrta5ms+cD8jy MoNT05cdN1YCpjRCJYt1jzt3Q55l+6YNwL2rSsmEvBXLQve2ni8kI5czfDoBIUbMwY99Zd kBGJqscv6XVv22XrdFUaa6mEuW1SFT0C2X4gHvibinObRr1EAb5n1SZ5nSXTsg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4LzP2z6SyMzX9r; Thu, 4 Aug 2022 22:46:03 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 274Mk3PT076574; Thu, 4 Aug 2022 22:46:03 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 274Mk3uu076573; Thu, 4 Aug 2022 22:46:03 GMT (envelope-from git) Date: Thu, 4 Aug 2022 22:46:03 GMT Message-Id: <202208042246.274Mk3uu076573@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: "Danilo G. Baio" Subject: git: 311e6e3d5e - main - fdp-primer: Add Trademarks section List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: dbaio X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 311e6e3d5e7476cda9107107d779a145241f11fa Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1659653164; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Ac7TNLgpo1nJ8bT6lXFhDcoyDz7jti/ImdW8OcNYJxE=; b=l56ZzsZbcsS6V2O/9XoNwrzLatxE4LHw7ZM9qaqu9ie/zgBjVKgjXxS6mh5nh0s7M7pxdZ tEsKKpWXWCtfiUSMo2K3zd2DOxkh35VwwbMa4uJXl6otk00HbMc/SgN6xQ3JaI/pVUJJoz NCIisiftduI4nq+1ePloK37M6aiYP1ggFNfOMAGTCnBFwbE7oSZ5XxTFUvYdLKfZXQwCMm HVP6KsqBRHVECusbiYVvuY0b/U+EW+cVy1MeI7sb57NB7bsb6zaaAFwWAYnO60jKYbGQGC 0J8oahDVJ7ndfYORBbVsRPjxZevQRZW43Ydyid5k3ApgrE8mtIxcZHdyvn8g/A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1659653164; a=rsa-sha256; cv=none; b=hIJ0XZnCny7vKkbVMRgKDgM44cvaQza8Ej1M+SlS39jRN1BqBHPUJPNCOKmdZb3paYuzS2 UXhCKIxW344NhiXiasUMn5A22Bk3pBD0NXa8K6sf1HSI9a1VGShDSFCOS4eVi241jmGtc9 yPl7dkntSkcQq3x1zpFBW5hhe49QmQU9TSc+SbnBHVmSeYiLuo88MMecAK2xiQpMaShb+K kKUGOTPBFXmtVXxNn8L0b3A09w+U1O0b6sQIoqIhv3rLijweZGDUruUq3+vPWKGCKGy3qG GvmsqyIOkhNUodbxKmPbCAuDZJSmqCzHwvJ3SIHWD26HTVQO0kZ8ECbXyyj5+Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by dbaio: URL: https://cgit.FreeBSD.org/doc/commit/?id=311e6e3d5e7476cda9107107d779a145241f11fa commit 311e6e3d5e7476cda9107107d779a145241f11fa Author: Danilo G. Baio AuthorDate: 2022-08-04 22:26:24 +0000 Commit: Danilo G. Baio CommitDate: 2022-08-04 22:27:14 +0000 fdp-primer: Add Trademarks section PR: 262202 Reported by: pauamma Reviewed by: bcr, carlavilla, emaste, jhb Differential Revision: https://reviews.freebsd.org/D35521 --- .../content/en/books/fdp-primer/book.adoc | 2 + .../en/books/fdp-primer/editor-config/_index.adoc | 2 +- .../en/books/fdp-primer/examples/_index.adoc | 2 +- .../en/books/fdp-primer/see-also/_index.adoc | 8 +- .../en/books/fdp-primer/trademarks/_index.adoc | 96 ++++++++++++++++++++++ 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] 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 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 :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 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]] += 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 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]] +== 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 +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 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.