Legacy link fixes (#19)

HofiOne · web-flow · commit a936b421cefa · 2024-05-09T15:38:34.000+02:00
Fixes: #14
diff --git a/_includes/doc/admin-guide/http-batch.md b/_includes/doc/admin-guide/http-batch.md
@@ -1,2 +1,2 @@
 For details on how this option influences HTTP batch mode, see 
-[[this chapter | adm-dest-http-nonjava-batch]]
+[[this chapter|adm-dest-http-nonjava-batch]]
diff --git a/_includes/doc/admin-guide/options/deployment.md b/_includes/doc/admin-guide/options/deployment.md
@@ -7,9 +7,7 @@
 deployment](https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security).
 
 For details on the deployment() option in the sumologic-http()
-destination\'s declaration, see [[Declaration for the sumologic-http()
-destination|adm-dest-sumologic-http]].
+destination\'s declaration, see [[Declaration for the sumologic-http() destination|adm-dest-sumologic-http]].
 
 For details on the deployment() option in the sumologic-syslog()
-destination\'s declaration, see [[Declaration for the sumologic-syslog()
-destination|adm-dest-sumologic-syslog]].
+destination\'s declaration, see [[Declaration for the sumologic-syslog() destination|adm-dest-sumologic-syslog]].
diff --git a/_includes/doc/admin-guide/options/trim-large-messages.md b/_includes/doc/admin-guide/options/trim-large-messages.md
@@ -30,4 +30,4 @@ drivers ignore the trim-large-messages() option.
 
 Available in syslog-ng OSE version 3.21 and later.
 
-Uses the value of the [[global option]] if not specified.
+Uses the value of the global option if not specified.
diff --git a/_includes/doc/admin-guide/options/ts-format.md b/_includes/doc/admin-guide/options/ts-format.md
@@ -11,5 +11,5 @@ ts-format() parameter) for the specific destination. For details, see
 Destinations that use specific protocols (for example, network(), or
 syslog()) ignore this option. For protocol-like destinations, use a
 template locally in the destination, or use the
-[[proto-template]] option.
+proto-template() option.
 {: .notice--info}
diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/009_Structuring_macros/000_Specifying_data_types.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/009_Structuring_macros/000_Specifying_data_types.md
@@ -15,8 +15,7 @@ description: >-
 From syslog-ng OSE version 4.0 onwards, name-value pairs are now
 triplets (name, type, value). Typing support is available for several
 other components, for example, json-parser() and the $(format-json)
-template function. For more information, see [[Components supported by
-data types]].
+template function. For more information, see Components supported by data types.
 
 ![]({{ site.baseurl}}/assets/images/caution.png)
 **CAUTION:** Hazard of data loss!  
@@ -111,8 +110,7 @@ destination.
 Elements without type data are handled as strings.
 
 JSON lists (arrays) are converted to syslog-ng OSE lists, and can be
-manipulated using the [[list-append]]
-template functions.  
+manipulated using the $(list-append) template functions.  
 
 ### set() and groupset() rewrite rules
 
diff --git a/doc/_admin-guide/050_The_configuration_file/007_Managing_complex_syslog-ng_configurations/001_Reusing_config_blocks.md b/doc/_admin-guide/050_The_configuration_file/007_Managing_complex_syslog-ng_configurations/001_Reusing_config_blocks.md
@@ -222,7 +222,7 @@ source s_example {
 ### Example: Using arguments in blocks
 
 The following example is the code of the
-[[pacct() source driver]], which is actually a block that
+[[pacct() source driver|adm-src-pacct]], which is actually a block that
 can optionally receive two arguments.
 
 ```config
diff --git a/doc/_admin-guide/060_Sources/140_Python/003_Fetcher_style_Python_sources.md b/doc/_admin-guide/060_Sources/140_Python/003_Fetcher_style_Python_sources.md
@@ -17,7 +17,7 @@ the log path. This object references a Python class, which is the second
 part of the Python source. The Python class receives or fetches the log
 messages, and can do virtually anything that you can code in Python. You
 can either embed the Python class into your syslog-ng OSE configuration
-file, or [[store it in an external Python file]].
+file, or [[store it in an external Python file|adm-conf-python]].
 
 ```config
 source <name_of_the_python_source>{
diff --git a/doc/_admin-guide/060_Sources/200_systemd-syslog/README.md b/doc/_admin-guide/060_Sources/200_systemd-syslog/README.md
@@ -10,7 +10,7 @@ description: >-
 Note the following points about this driver:
 
 - If possible, use the more reliable
-    [[systemd-journal()]] driver instead.
+    [[systemd-journal() driver|adm-src-systemd-journal]] instead.
 
 - The socket activation of systemd is buggy, causing some log messages
     to get lost during system startup.
diff --git a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/000_Unix_credentials.md b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/000_Unix_credentials.md
@@ -10,7 +10,7 @@ description: >-
 The syslog-ng OSE application can extract the following information on 
 Linux and FreeBSD platforms (examples show the value of the macro for the `su - myuser`
 command). Similar information is available for the
-[[systemd-journal source]].  
+[[systemd-journal source|adm-src-systemd-journal]].  
 
 | Macro             | Description                                     |
 |---|---|
diff --git a/doc/_admin-guide/070_Destinations/050_Graphite/README.md b/doc/_admin-guide/070_Destinations/050_Graphite/README.md
@@ -47,5 +47,5 @@ destination d_graphite { graphite(payload("--key monitor.*")); };
 **NOTE:** The graphite() destination is only a wrapper around the network()
 destination and the graphite-output template function. If you want to
 fine-tune the TCP parameters, use the **network()** destination instead,
-as described in [[graphite-output]].
+as described in $(graphite-output).
 {: .notice--info}
diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/003_hdfs_kerberos_authentication.md b/doc/_admin-guide/070_Destinations/070_HDFS/003_hdfs_kerberos_authentication.md
@@ -30,8 +30,7 @@ for the changes to take effect.
     authentication.
 
 - You have a keytab file and a principal for the host running
-    syslog-ng OSE. For details, see the [Kerberos
-    documentation](http://web.mit.edu/Kerberos/krb5-1.5/krb5-1.5.4/doc/krb5-install/The-Keytab-File.html).
+    syslog-ng OSE. For details, see the [Kerberos documentation](http://web.mit.edu/Kerberos/krb5-1.5/krb5-1.5.4/doc/krb5-install/The-Keytab-File.html).
 
 - You have installed and configured the Kerberos client packages on
     the host running syslog-ng OSE. (That is, Kerberos authentication
diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md b/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md
@@ -143,8 +143,7 @@ hdfs-uri(\"hdfs://\[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210\]:8020\").
 
 {% include doc/admin-guide/options/jvm-options.md %}
 
-You can set this option only as a
-[[global option]], by adding it
+You can set this option only as a global option, by adding it
 to the options statement of the syslog-ng configuration file.
 
 ## kerberos-keytab-file()
diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/README.md b/doc/_admin-guide/070_Destinations/070_HDFS/README.md
@@ -74,7 +74,7 @@ destination d_hdfs {
 - For details on using MapR-FS, see
     [[Storing messages with MapR-FS]].
 - For details on using Kerberos authentication, see
-    [[Kerberos authentication with syslog-ng hdfs()destination]].
+    [[Kerberos authentication with syslog-ng hdfs() destination]].
 - For the list of options, see
     [[HDFS destination options]].
 
diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/002_Flow_control.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/002_Flow_control.md
@@ -18,4 +18,4 @@ You can specify a "high water mark" limit for the Kafka client in the
 properties-file().
 
 For more information about how the C implementation of the kafka()
-destination works with syslog-ng OSE, click [[here]].
+destination works with syslog-ng OSE, click [[here|adm-dest-kafkac]].
diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md
@@ -226,7 +226,7 @@ the message, for example, template(\"$(format-json \--scope rfc5424
 \--exclude DATE \--key ISODATE)\").
 
 For details on formatting messages in JSON format, see
-[[format-json]].
+[[format-json|adm-temp-func#format-json]].
 
 {% include doc/admin-guide/options/throttle.md %}
 
diff --git a/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md b/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md
@@ -13,12 +13,12 @@ This destination is available in syslog-ng OSE version 4.4 and later versions.
 {% include doc/admin-guide/options/batch-lines.md %}
 
 For details on how this option influences batch mode, see
-[[Batch mode and load balancing]]
+Batch mode and load balancing with OpenSearch.
 
 {% include doc/admin-guide/options/batch-timeout.md %}
 
 For details on how this option influences batch mode, see
-[[Batch mode and load balancing]]
+Batch mode and load balancing with OpenSearch.
 
 {% include doc/admin-guide/options/ca-dir.md %}
 
@@ -37,7 +37,7 @@ For details on how this option influences batch mode, see
 
 {% include doc/admin-guide/options/delimiter.md %}
 
-For details on how this option influences batch mode, see [[Batch mode and load balancing]].
+For details on how this option influences batch mode, see Batch mode and load balancing with OpenSearch.
 
 {% include doc/admin-guide/options/disk-buffer.md %}
 
diff --git a/doc/_admin-guide/070_Destinations/200_Python/README.md b/doc/_admin-guide/070_Destinations/200_Python/README.md
@@ -23,7 +23,7 @@ the second part of the Python destination. The Python class processes
 the log messages it receives, and can do virtually anything that you can
 code in Python. You can either embed the Python class into your
 syslog-ng OSE configuration file, or
-[[store it in an external Python file]].
+[[store it in an external Python file|adm-conf-python]].
 
 ```config
 destination <name_of_the_python_destination>{
@@ -102,9 +102,8 @@ Error handling in the python() destination.
 
 The send method sends a message to the target service. It should return
 True to indicate success, or self.QUEUED when using batch mode. For
-other possible return values, see the description of the [[flush()
-method|adm-dest-python#flushself-method-optional]]. Note that for batch mode, the
-flush() method must be implemented as well.
+other possible return values, see the description of the [[flush() method|adm-dest-python#flushself-method-optional]].
+Note that for batch mode, the flush() method must be implemented as well.
 
 This is the only mandatory method of the destination.
 
@@ -208,7 +207,7 @@ The Python destination handles errors as follows.
 
 The purpose of this example is only to demonstrate the basics of the
 Python destination, if you really want to write log messages into text
-files, use the [[file destination]] instead.
+files, use the [[file destination|adm-dest-file]] instead.
 
 The following sample code writes the body of log messages into the
 /tmp/example.txt file. Only the send() method is implemented, meaning
@@ -273,9 +272,8 @@ class TextDestination(object):
 ```
 
 For a more detailed example about sending log messages to an MQTT
-(Message Queuing Telemetry Transport) server, see the [Writing Python
-destination in syslog-ng: how to send log messages to MQTT blog
-post](https://www.syslog-ng.com/community/b/blog/posts/writing-python-destination-in-syslog-ng-how-to-send-log-messages-to-mqtt).
+(Message Queuing Telemetry Transport) server, see the
+[Writing Python destination in syslog-ng: how to send log messages to MQTT](https://www.syslog-ng.com/community/b/blog/posts/writing-python-destination-in-syslog-ng-how-to-send-log-messages-to-mqtt) blog post.
 
 ### Example: Print logs in batch mode
 
@@ -299,4 +297,4 @@ class MyDestination(object):
 ```
 
 For the list of available optional parameters, see
-[[python() destination options]].
+python() destination options.
diff --git a/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md b/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md
@@ -72,6 +72,6 @@ destination d_splunk_hec_raw {
 };
 ```
 
-The options of the `splunk-hec-raw()` destination are similar to the [[splunk-hec-event()]] destination, however, the `channel()` option is mandatory. The `channel()` option must be a globally unique channel identifier (GUID), this ID differentiates the data from different clients. Note that Splunk does not generate this ID, you must create it for yourself. When Splunk sees a new channel identifier, it creates a new channel.
+The options of the `splunk-hec-raw()` destination are similar to the [[splunk-hec-event()|adm-dest-splunk-hec-event]] destination, however, the `channel()` option is mandatory. The `channel()` option must be a globally unique channel identifier (GUID), this ID differentiates the data from different clients. Note that Splunk does not generate this ID, you must create it for yourself. When Splunk sees a new channel identifier, it creates a new channel.
 
-Use the `template()` option to set the content of the log message sent to Splunk. Avoid using the `event()` option, that is used in the [[splunk-hec-event()]] destination.
+Use the `template()` option to set the content of the log message sent to Splunk. Avoid using the `event()` option, that is used in the [[splunk-hec-event()|adm-dest-splunk-hec-event]] destination.
diff --git a/doc/_admin-guide/070_Destinations/310_syslog-ng/README.md b/doc/_admin-guide/070_Destinations/310_syslog-ng/README.md
@@ -7,7 +7,7 @@ description: >-
     syslog-ng node in EWMM format.
 ---
 
-The [[Enterprise-wide message model (EWMM)]] 
+The [[Enterprise-wide message model (EWMM)]]
 allows you to deliver structured messages from the initial
 receiving syslog-ng component right up to the central log server,
 through any number of hops. It does not matter if you parse the messages
@@ -18,11 +18,12 @@ component in your infrastructure has received it, which is important if
 you want to forward a message for example, to a SIEM system. To make use
 of the enterprise-wide message model, you have to use the syslog-ng()
 destination on the sender side, and the
-[[default-network-drivers() source]] on the receiver side.
+[[default-network-drivers() source|adm-src-def-netw]]
+on the receiver side.
 
 The syslog-ng() destination driver is available in version 3.16 and
 later. The node that receives this message must use the
-[[default-network-drivers() source]]
+[[default-network-drivers() source|adm-src-def-netw]]
 to properly handle the messages.
 
 The following is a sample log message in EWMM format.
diff --git a/doc/_admin-guide/080_Log/030_Filters/README.md b/doc/_admin-guide/080_Log/030_Filters/README.md
@@ -13,8 +13,7 @@ The following sections describe how to select and filter log messages.
 - [[Comparing macro values in filters]]
     explains how to evaluate macros in filters.
 
-- [[Using wildcards, special characters, and regular expressions in
-    filters]] provides tips on using
+- [[Using wildcards, special characters, and regular expressions in filters]] provides tips on using
     regular expressions.
 
 - [[Tagging messages]] explains
diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/003_Password_protected_keys.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/003_Password_protected_keys.md
@@ -22,7 +22,7 @@ description: >-
     destination, and you use this destination in a log path that has
     multiple destinations, neither destinations will receive log
     messages until you provide the password. In this cases, always
-    [[use disk-based buffering to avoid data loss]].
+    use disk-based buffering to avoid data loss.
 
 - The path and the filename of the private key cannot contain
     whitespaces.
diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/README.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/README.md
@@ -14,7 +14,7 @@ standard syslog protocols, that is, the network() and syslog() drivers,
 for example, to forward log messages between two syslog-ng nodes, or to
 send log data to syslog-ng Store Box or another log server. Other
 destinations that support TLS-encryption are not discussed in this
-chapter (for example, [[http())]]).
+chapter (for example, [[http())|adm-dest-http-nonjava]]).
 {: .notice--info}
 
 TLS uses certificates to authenticate and encrypt the communication, as
diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/004_Macros_of_syslog-ng.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/004_Macros_of_syslog-ng.md
@@ -483,7 +483,7 @@ The week number of the year, prefixed with a zero for the
 first nine weeks of the year. (The first Monday in the year marks the
 first week.)
 
-See also [[ISOWEEK, C_ISOWEEK, R_ISOWEEK, S_ISOWEEK]].
+See also ${ISOWEEK}, ${C_ISOWEEK}, ${R_ISOWEEK}, ${S_ISOWEEK}.
 
 ## ${WEEK_DAY_ABBREV}, ${C_WEEK_DAY_ABBREV}, ${R_WEEK_DAY_ABBREV}, ${S_WEEK_DAY_ABBREV}
 
diff --git a/doc/_admin-guide/120_Parser/005_Parsing_dates/README.md b/doc/_admin-guide/120_Parser/005_Parsing_dates/README.md
@@ -15,7 +15,7 @@ the entire template or field. Since by default syslog-ng Open Source
 Edition (syslog-ng OSE) uses the ${MESSAGE} part of the log message,
 parsing will fail, unless the log message contains only a date, but that
 is unlikely, so practically you will have to segment the message (for
-example, using a [[csv-parser()]].
+example, using a [[csv-parser()|adm-parser-csv]].
 You can also use date-parser() to parse dates received in
 a JSON or key-value-formatted log message.
 {: .notice--info}
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/002_Correlating_log_messages.md b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/002_Correlating_log_messages.md
@@ -96,5 +96,5 @@ Note the following points about timeout values:
 ```
 
 For details on configuring message correlation, see the
-[[context-id, context-timeout, and context-scope]]
+[[context-id, context-timeout, and context-scope|adm-parser-db-elem-rule#attributes]]
 attributes of pattern database rules.
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md
@@ -43,7 +43,7 @@ when a message matching the rule is received.
         the rule is received.
 
   - *timeout*: Execute the action when the correlation timer
-        ([[context-timeout]] of the
+        ([[context-timeout|adm-parser-db-elem-rule#attributes]] of the
         pattern database rule expires. This is available only if actions
         are used together with correlating messages.
 
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/README.md b/doc/_admin-guide/120_Parser/023_db_parser/README.md
@@ -1,6 +1,5 @@
 ---
-title: 'db-parser: Process message content with a pattern database
-  (patterndb)'
+title: 'db-parser: Process message content with a pattern database (patterndb)'
 short_title: db-parser
 id: adm-parser-db
 ---
diff --git a/doc/_admin-guide/120_Parser/README.md b/doc/_admin-guide/120_Parser/README.md
@@ -32,7 +32,7 @@ parse the messages, or parts of the messages:
 - To parse XML-formatted messages, see [[XML parser]].
 
 - To identify and parse the messages using a pattern database, see
-    [[db-parser: Process message content with a pattern database]].
+    [[db-parser: Process message content with a pattern database (patterndb)]].
 
 - To parse a specially-formatted date or timestamp, see
     [[Parsing dates and timestamps]].
diff --git a/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md b/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md
@@ -60,8 +60,7 @@ The displayed metrics have the following structure.
         To avoid performance issues or even overloading syslog-ng OSE,
         you might want to limit the number of registered dynamic
         counters in the message statistics. To do this, configure the
-        [[stats-max-dynamics()]]
-        global option.
+        max-dynamics() parameter of the stats() global option.
 
     - **o** - This object was once active, but stopped receiving messages.
         (For example, a dynamic object may disappear and become orphan.)
@@ -249,7 +248,7 @@ The displayed metrics have the following structure.
 ## Availability of statistics
 
 Certain statistics are available only if the
-[[stats-level()]] global option is set to a higher value.
+level parameter of stats() global option is set to a higher value.
 
 - Level 0 collects only statistics about the sources and destinations.
 
diff --git a/doc/_admin-guide/150_Statistics_of_syslog-ng/001_Log_statistic_from_internal_source.md b/doc/_admin-guide/150_Statistics_of_syslog-ng/001_Log_statistic_from_internal_source.md
@@ -27,8 +27,7 @@ messages are sent to both destinations.
 
 The statistics include a list of source groups and destinations, as well
 as the number of processed messages for each. You can control the
-verbosity of the statistics using the
-[[stats-level()]] global option.  
+verbosity of the statistics using the level parameter of stats() global option.  
 
 The following is an example output.
 
diff --git a/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/001_msec_hashing.md b/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/001_msec_hashing.md
@@ -11,14 +11,14 @@ description: >-
 ![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:**
 Consider that network-load-balancer() is not a destination, only a script that
 generates the example configuration described in
-[[Load balancing with round robin]].
+[[Load balancing with round robin|adm-pract-round-robin]].
 Also consider that the configuration generator script may change incompatibly
 in the future. As a result, One Identity does not officially support using
 this script, and recommends that you only use this script at your own risk.
 {: .notice--warning}
 
 As an alternative to using the example configuration described in
-[[Load balancing with round robin]], a
+[[Load balancing with round robin|adm-pract-round-robin]], a
 configuration generator script is also available in syslog-ng OSE:
 
 ```config
diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md
@@ -226,7 +226,7 @@ The stats command has the following options:
     >dst.file;#anon-destination0#0;/tmp/2021-08-17.log;o;processed;156
     >dst.file;#anon-destination0#0;/tmp/2021-08-18.log;a;processed;961
 
-    **NOTE:** The [[stats-lifetime()]] can be used to do the same
+    **NOTE:** The stats-lifetime() can be used to do the same
     automatically and periodically, but currently stats-lifetime()
     removes only dynamic counters that have a timestamp field set.
     {: .notice--info}

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`For details on how this option influences HTTP batch mode, see`
`2`		`-[[this chapter \| adm-dest-http-nonjava-batch]]`
	`2`	`+[[this chapter\|adm-dest-http-nonjava-batch]]`
Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ drivers ignore the trim-large-messages() option.`
`30`	`30`
`31`	`31`	`Available in syslog-ng OSE version 3.21 and later.`
`32`	`32`
`33`		`-Uses the value of the [[global option]] if not specified.`
	`33`	`+Uses the value of the global option if not specified.`