From nobody Mon Nov 07 21:11:54 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 4N5kSV6XsTz4gNwK for ; Mon, 7 Nov 2022 21:11:54 +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 4N5kSV5Nw1z5XnT; Mon, 7 Nov 2022 21:11:54 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667855514; 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=71Bh/YZdtV1DRs82tJ1QiExVQRJwcts98R0NpEov+Xc=; b=GTtv8QImZctKBdCkaGF8kHutRCcmfzg+wsezlJW5w1fYmHWES8XzFK6HP5Y4XHDfTsYo1u HT47VYDDrJzyW2pAcIy601HLy0wcay46/2nJxD5bLWK7CmEl7WxLoyEEHGmHiTVixGIHIn z5eEz/XmIWLNwHgDW8oCW/7K6Mt5I0giXWCWbjUbxHOvEvmaIIa7HuDXBH6G5fuVNvME5C DZwQnHsDFpUcYBeoXMGxZk0eDWjUOQJNS3kzEJBfiKuACszi0gMf1B/jxbszneuhkos68r itf/prjCbZZ9X7zu9YWZTnTswNoWyWLM0ADNnIzXOYVOXJgXS1fSyEQNx+CZoA== 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 4N5kSV4VcVzGPj; Mon, 7 Nov 2022 21:11:54 +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 2A7LBsiA037501; Mon, 7 Nov 2022 21:11:54 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2A7LBsRw037500; Mon, 7 Nov 2022 21:11:54 GMT (envelope-from git) Date: Mon, 7 Nov 2022 21:11:54 GMT Message-Id: <202211072111.2A7LBsRw037500@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Pau Amma Subject: git: a2b2b5696c - main - Language tweaks in 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: pauamma X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: a2b2b5696cd3c8ccfdba66dc149d32088b7d7a4a Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667855514; 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=71Bh/YZdtV1DRs82tJ1QiExVQRJwcts98R0NpEov+Xc=; b=Q7Wqe3ZHU6Tofcdxqi6r0z0YH77ZNBFitaFiSfKKCiKg6XgLQDYopddPt1klZTWLe7eUA1 DY74fSoq23C6x0wYwSdfVMHNNkygNJCMB08q8uAqk52sZtoUHnhf79DAJx2mAzUB0snl4O K6KwnmBTSYPRT1xn5RFWp7IZJeQF59VIm1s+qY+PJs9aQrdJHaSIYazGrlJy5hLg7ueH5S 7vNjj9JvAVlv4xawDkAi35P3WeDUr/2NDxSUc9dpjQjZnmQtiZfqQpvm2EVFIdqtTCs8/t BnsDIZeJnJF/zOQy5SPLQ3dFzuqZOcXn3eGVGaNz2pJG17axc1dloKir7QP7BA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1667855514; a=rsa-sha256; cv=none; b=DAmU9ZAxCjK7f1PBf2cA24F1xSTrFlm1zskX6GfozfuqswCxGGLP61jeCIp2qG6qx3C3su pnIaAVz7UUgw3r5KP1vrX1nzb0M5cJuxPu4LaB2o4qzVXHM09K8E5UXFEW/PkRU990WzKy SpPwPCf3N7DcLR/1FVkBdEmq8GOx2dWY2JqjOkiLfVlS5sbzpeTKgslmmWVlS1i3csLw+/ +VwuPWFJX6JXfz2koeW6DRZNgFol+oxER5TPo2/YW2E3agJ/tevof38syLxiKiaxcGc6UO yuOVF4AF/WOLHEGm2agIHMLQRUcapOcBv8Qd9k96zi2WNvq0EO/LD5Irv3LnKA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by pauamma: URL: https://cgit.FreeBSD.org/doc/commit/?id=a2b2b5696cd3c8ccfdba66dc149d32088b7d7a4a commit a2b2b5696cd3c8ccfdba66dc149d32088b7d7a4a Author: Pau Amma AuthorDate: 2022-11-03 12:59:22 +0000 Commit: Pau Amma CommitDate: 2022-11-07 21:06:11 +0000 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 --- .../content/en/books/fdp-primer/trademarks/_index.adoc | 13 +++++++------ .../content/en/books/fdp-primer/writing-style/_index.adoc | 2 +- 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.