DOC-8240-C9 -- rationalize declaration of snippet attribute (#437)

* DOC-8240-C9 -- Remove use of separate P2P snippets module

* DOC-8240-C9 -- rationalize declaration of snippet attribute

Author: ibsoln

modules/ROOT/.DS_Store

@@ -22,7 +22,7 @@ include::ROOT:partial$_glossary-links.adoc[]
 // :module: {param-module}
 // :packageNm: couchbase-lite-{module}
 // :source-language: {param-name}
-// :snippet: {snippets-content--all}
-// :snippet-p2psync-ws: {snippets-p2psync-ws--all}
+// snippet: {snippets-content--all}
+// // :snippet-p2psync-ws: {snippets-p2psync-ws--all}
 // :url-download-package: {url-download-all}
 // END::Local page attributes

modules/ROOT/pages/_partials/_std-cbl-hdr-root.adoc

@@ -7,7 +7,7 @@
 
 // Begin required attributes
 // :cbl-log-version: the required cbl-log version number (eg 2.7.0)
-// :snippet: the path to the language specific example code_snippets
+// snippet: the path to the language specific example code_snippets
 // :fn-2x5: footnote content
 :fn-2x5: footnote:fn-2x5[From version 2.5]
 ifndef::version-full[:version-full: UNDEFINED-VERSION]

modules/ROOT/pages/_partials/commons/common-logging.adoc

@@ -58,7 +58,7 @@ Use the {url-api-class-tlsidentity} class's  {url-api-method-tls-identity-import
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-check-keychain, indent=0]
+include::{snippet}[tag=p2p-tlsid-check-keychain, indent=0]
 
 ----
 --
@@ -71,7 +71,7 @@ include::{snippet-p2psync-ws}[tag=p2p-tlsid-check-keychain, indent=0]
 
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-check-bundled, indent=0]
+include::{snippet}[tag=p2p-tlsid-check-bundled, indent=0]
 
 ----
 --
@@ -84,7 +84,7 @@ include::{snippet-p2psync-ws}[tag=p2p-tlsid-check-bundled, indent=0]
 
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-import-from-bundled, indent=0]
+include::{snippet}[tag=p2p-tlsid-import-from-bundled, indent=0]
 
 ----
 --
@@ -95,7 +95,7 @@ include::{snippet-p2psync-ws}[tag=p2p-tlsid-import-from-bundled, indent=0]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-store-in-keychain, indent=0]
+include::{snippet}[tag=p2p-tlsid-store-in-keychain, indent=0]
 
 ----
 --
@@ -106,7 +106,7 @@ include::{snippet-p2psync-ws}[tag=p2p-tlsid-store-in-keychain, indent=0]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-return-id-from-keychain, indent=0]
+include::{snippet}[tag=p2p-tlsid-return-id-from-keychain, indent=0]
 
 ----
 --
@@ -119,7 +119,7 @@ include::{snippet-p2psync-ws}[tag=p2p-tlsid-return-id-from-keychain, indent=0]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-delete-id-from-keychain,indent=0]
+include::{snippet}[tag=p2p-tlsid-delete-id-from-keychain,indent=0]
 
 ----
 

modules/ROOT/pages/_partials/commons/common-p2psync-websocket-manage-tls-id.adoc

@@ -40,7 +40,7 @@ You should configure and initialize a replicator for each Couchbase Lite databas
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=p2p-act-rep-func, indent=0]
+include::{snippet}[tags=p2p-act-rep-func, indent=0]
 
 ----
 ifdef::is-android[]
@@ -132,7 +132,7 @@ This example shows basic authentication using user name and password:
 
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags="p2p-act-rep-auth", indent=0]
+include::{snippet}[tags="p2p-act-rep-auth", indent=0]
 
 ----
 ====
@@ -161,7 +161,7 @@ This example shows client certificate authentication using an identity from secu
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=p2p-tlsid-tlsidentity-with-label, indent=0]
+include::{snippet}[tags=p2p-tlsid-tlsidentity-with-label, indent=0]
 
 ----
 

modules/ROOT/pages/_partials/commons/common-p2psync-websocket-using-active.adoc

@@ -31,15 +31,15 @@ You should configure and initialize a listener for each Couchbase Lite database
 There is no limit on the number of listeners you may configure -- <<simple-listener-initialization>> shows a simple initialization and configuration process.
 
 // Example 1
-// include::{snippet-p2psync-ws}[tags="listener-initialize;!listener-local-db;!listener-config-tls-disable;!listener-config-tls-id-caCert;!listener-config-tls-id-SelfSigned;!listener-config-tls-id-set;!listener-config-client-auth-root;!listener-config-client-auth-lambda", indent=0]
+// include::{snippet}[tags="listener-initialize;!listener-local-db;!listener-config-tls-disable;!listener-config-tls-id-caCert;!listener-config-tls-id-SelfSigned;!listener-config-tls-id-set;!listener-config-client-auth-root;!listener-config-client-auth-lambda", indent=0]
 [#simple-listener-initialization]
 .Listener configuration and initialization
 ====
 
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-initialize, indent=0]
+include::{snippet}[tags=listener-initialize, indent=0]
 
 ----
 
@@ -115,7 +115,7 @@ In this example `thisDB` has previously been declared as an object of type Datab
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-db, indent=0]
+include::{snippet}[tags=listener-config-db, indent=0]
 
 ----
 
@@ -139,7 +139,7 @@ The Listener will automatically select an available port if you do not specify o
 ====
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags=listener-config-port, indent=0]
+include::{snippet}[tags=listener-config-port, indent=0]
 ----
 
 *Notes on example:*
@@ -161,7 +161,7 @@ The Listener will listen on all network interfaces by default.
 ====
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags=listener-config-netw-iface, indent=0]
+include::{snippet}[tags=listener-config-netw-iface, indent=0]
 ----
 ====
 
@@ -190,7 +190,7 @@ ifdef::param-include[]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-get-network-interfaces, indent=0]
+include::{snippet}[tags=listener-get-network-interfaces, indent=0]
 
 ----
 
@@ -210,7 +210,7 @@ Both valuable benefits, especially when network bandwidth is constrained.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-delta-sync, indent=0]
+include::{snippet}[tags=listener-config-delta-sync, indent=0]
 
 ----
 
@@ -279,8 +279,8 @@ Import an identity from a secure key and certificate data source.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-tls-enable, indent=0]
-include::{snippet-p2psync-ws}[tags="listener-config-tls-id-full;!listener-config-tls-id-SelfSigned;!listener-config-tls-id-anon", indent=0]
+include::{snippet}[tags=listener-config-tls-enable, indent=0]
+include::{snippet}[tags="listener-config-tls-id-full;!listener-config-tls-id-SelfSigned;!listener-config-tls-id-anon", indent=0]
 
 ----
 
@@ -313,8 +313,8 @@ The system generates a self-signed certificate.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-tls-enable, indent=0]
-include::{snippet-p2psync-ws}[tags="listener-config-tls-id-full;!listener-config-tls-id-caCert;!listener-config-tls-id-anon", indent=0]
+include::{snippet}[tags=listener-config-tls-enable, indent=0]
+include::{snippet}[tags="listener-config-tls-id-full;!listener-config-tls-id-caCert;!listener-config-tls-id-anon", indent=0]
 
 ----
 
@@ -337,8 +337,8 @@ Generated certificates are held in {securestorage}.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-tls-enable, indent=0]
-include::{snippet-p2psync-ws}[tags=listener-config-tls-id-anon, indent=0]
+include::{snippet}[tags=listener-config-tls-enable, indent=0]
+include::{snippet}[tags=listener-config-tls-id-anon, indent=0]
 
 ----
 
@@ -392,7 +392,7 @@ include::{root-partials}p2p-api.adoc[tag=ListenerPasswordAuthenticator]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-client-auth-pwd, indent=0]
+include::{snippet}[tags=listener-config-client-auth-pwd, indent=0]
 
 ----
 
@@ -429,7 +429,7 @@ Configure the server (listener) to authenticate the client against a list of one
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=listener-config-client-auth-root, indent=0]
+include::{snippet}[tag=listener-config-client-auth-root, indent=0]
 
 ----
 
@@ -454,7 +454,7 @@ Configure the server (listener) to authenticate the client using user-supplied l
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-config-client-auth-lambda, indent=0]
+include::{snippet}[tags=listener-config-client-auth-lambda, indent=0]
 
 ----
 
@@ -487,7 +487,7 @@ endif::[]
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-tlsid-delete-id-from-keychain]
+include::{snippet}[tag=p2p-tlsid-delete-id-from-keychain]
 
 ----
 // include::{snippet}[tags=listener-config-delete-cert-full, indent=0]
@@ -554,7 +554,7 @@ Once you have completed the Listener's configuration settings you can initialize
 ====
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags=listener-start, indent=0]
+include::{snippet}[tags=listener-start, indent=0]
 
 ----
 include::{module-callouts}[tags=listener-start, indent=0]
@@ -573,7 +573,7 @@ You should note that these counts can be extremely volatile. So, the actual numb
 ====
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags=listener-status-check, indent=0]
+include::{snippet}[tags=listener-status-check, indent=0]
 ----
 
 *Notes on example:*
@@ -589,19 +589,19 @@ include::{example_callouts}[tags=listener-status-check, indent=0]
 
 // [source, {source-language}]
 // ----
-// include::{snippet-p2psync-ws}[tags=listener-pv-cfg-conflict, indent=0]
+// include::{snippet}[tags=listener-pv-cfg-conflict, indent=0]
 // ----
 
 == Stop Listener
-// include::{snippet-p2psync-ws}[tags=stopWebsocketsListener"]config
+// include::{snippet}[tags=stopWebsocketsListener"]config
 It is best practice to check tha status of the listener's connections and stop only when you have confirmed that there are no active connections -- see <<get-connection-counts>>.
 
 // Example 12
 .Stop listener using `stop` method
 ====
 [source, {source-language}]
 ----
-include::{snippet-p2psync-ws}[tags=listener-stop, indent=0]
+include::{snippet}[tags=listener-stop, indent=0]
 ----
 ====
 

modules/ROOT/pages/_partials/commons/common-p2psync-websocket-using-passive.adoc

@@ -123,7 +123,7 @@ endif::[]
 == Basic Setup
 You can configure a peer-to-peer synchronization with just a few lines of code as shown in <<simple-configuration>>.
 
-// include::{snippet-p2psync-ws}[tags=listener-initialize, indent=0]
+// include::{snippet}[tags=listener-initialize, indent=0]
 [#simple-configuration]
 .Simple configuration
 =====
@@ -139,7 +139,7 @@ This simple configuration will give you a listener ready to participate in an en
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=listener-simple, indent=0]
+include::{snippet}[tags=listener-simple, indent=0]
 
 ----
 
@@ -158,7 +158,7 @@ This simple replicator configuration will give you an encrypted, bi-directional
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=replicator-simple, indent=0]
+include::{snippet}[tags=replicator-simple, indent=0]
 
 ----
 

modules/ROOT/pages/_partials/commons/common-p2psync-websocket.adoc

@@ -17,7 +17,7 @@
 // :module: {lang-mod-swift}
 // :packageNm: couchbase-lite-{module}
 // :source-language: {lang-name-swift}
-// :snippet: {snippets-content--swift}
+// snippet: {snippets-content--swift}
 // :url-issues: {url-github-cbl}{module}/issues
 //
 // // END::Local page attributes

modules/ROOT/pages/_partials/commons/common-p2psync-workflow.adoc

@@ -20,7 +20,7 @@
 // :this-lang-title: {par-lang-title}
 // :this-packageNm: {par-packageNm}
 // :this-source-language: {par-source-language}
-// :snippet: {par-snippet}
+// snippet: {par-snippet}
 //:this-url-issues: {par-url-issues}
 // END::REQUIRED EXTERNALS
 

modules/ROOT/pages/_partials/commons/common-query.adoc

@@ -30,7 +30,7 @@ Set the client to expect and accept only CA attested certificates.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=p2p-act-rep-config-cacert, indent=0]
+include::{snippet}[tags=p2p-act-rep-config-cacert, indent=0]
 
 ----
 *Notes on Example*
@@ -49,7 +49,7 @@ Set the client to expect and accept only self-signed certificates
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tags=p2p-act-rep-config-self-cert, indent=0]
+include::{snippet}[tags=p2p-act-rep-config-self-cert, indent=0]
 
 ----
 *Notes on Example*
@@ -68,11 +68,11 @@ Set the client to expect and accept only a pinned certificate.
 [source, {source-language}]
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-act-rep-config-cacert-pinned, indent=0]
+include::{snippet}[tag=p2p-act-rep-config-cacert-pinned, indent=0]
 
 ----
 
-include::{snippet-p2psync-ws}[tag=p2p-act-rep-config-cacert-pinned-callouts, indent=0]
+include::{snippet}[tag=p2p-act-rep-config-cacert-pinned-callouts, indent=0]
 
 --
 ====