Skip to content

Commit 449536a

Browse files
committed
#209 implement Antora feedback from @balusgit (#540497)
1 parent 172e875 commit 449536a

32 files changed

+56
-91
lines changed

antora-playbook.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ ui:
8989
/* Make links more visible: */
9090
.doc a { text-decoration: underline; }
9191
.doc a code { text-decoration: underline; color: #1565c0; }
92+
/* Make nav bar wider */
93+
.nav-container { width:19rem; }
9294
/* Tab header fonts aren't rendered good, adjusting the font weight: */
9395
.tablist > ul li { font-weight: 500; }
9496
/* `page-toclevels` greater than 4 are not supported by Antora UI, patching it: */
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
<release xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
33
xmlns="https://logging.apache.org/xml/ns"
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
5-
date="2025-05-21"
5+
date="2025-05-11"
66
version="3.1.0"/>

src/changelog/3.1,0/209-migrate-log4net-site-to-antora.xml renamed to src/changelog/3.1.0/209-migrate-log4net-site-to-antora.xml

File renamed without changes.
File renamed without changes.

src/site/antora/modules/ROOT/nav.adoc

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,31 @@
1919
* xref:development.adoc[]
2020
* xref:manual/index.adoc[]
2121
** xref:manual/introduction.adoc[]
22-
** xref:manual/appenders.adoc[]
22+
** xref:manual/supported-frameworks.adoc[]
23+
** xref:manual/installation.adoc[]
2324
** xref:manual/configuration.adoc[]
24-
*** xref:manual/configuration/examples.adoc[]
25-
**** xref:manual/configuration/adonetappender.adoc[]
26-
**** xref:manual/configuration/bufferingforwardingappender.adoc[]
27-
**** xref:manual/configuration/coloredconsoleappender.adoc[]
28-
**** xref:manual/configuration/consoleappender.adoc[]
29-
**** xref:manual/configuration/eventlogappender.adoc[]
30-
**** xref:manual/configuration/fileappender.adoc[]
31-
**** xref:manual/configuration/rollingfileappender.adoc[]
32-
**** xref:manual/configuration/forwardingappender.adoc[]
33-
**** xref:manual/configuration/localsyslogappender.adoc[]
34-
**** xref:manual/configuration/managedcoloredconsoleappender.adoc[]
35-
**** xref:manual/configuration/memoryappender.adoc[]
36-
**** xref:manual/configuration/outputdebugstringappender.adoc[]
37-
**** xref:manual/configuration/remotesyslogappender.adoc[]
38-
**** xref:manual/configuration/smtpappender.adoc[]
39-
**** xref:manual/configuration/smtppickupdirappender.adoc[]
40-
**** xref:manual/configuration/traceappender.adoc[]
41-
**** xref:manual/configuration/udpappender.adoc[]
25+
*** xref:manual/configuration/appenders.adoc[]
26+
**** xref:manual/configuration/appenders/adonetappender.adoc[]
27+
**** xref:manual/configuration/appenders/bufferingforwardingappender.adoc[]
28+
**** xref:manual/configuration/appenders/coloredconsoleappender.adoc[]
29+
**** xref:manual/configuration/appenders/consoleappender.adoc[]
30+
**** xref:manual/configuration/appenders/eventlogappender.adoc[]
31+
**** xref:manual/configuration/appenders/fileappender.adoc[]
32+
**** xref:manual/configuration/appenders/forwardingappender.adoc[]
33+
**** xref:manual/configuration/appenders/localsyslogappender.adoc[]
34+
**** xref:manual/configuration/appenders/managedcoloredconsoleappender.adoc[]
35+
**** xref:manual/configuration/appenders/memoryappender.adoc[]
36+
**** xref:manual/configuration/appenders/outputdebugstringappender.adoc[]
37+
**** xref:manual/configuration/appenders/remotesyslogappender.adoc[]
38+
**** xref:manual/configuration/appenders/rollingfileappender.adoc[]
39+
**** xref:manual/configuration/appenders/smtpappender.adoc[]
40+
**** xref:manual/configuration/appenders/smtppickupdirappender.adoc[]
41+
**** xref:manual/configuration/appenders/traceappender.adoc[]
42+
**** xref:manual/configuration/appenders/udpappender.adoc[]
43+
*** xref:manual/configuration/filters.adoc[]
44+
*** xref:manual/configuration/layouts.adoc[]
4245
** xref:manual/examples.adoc[]
4346
** xref:manual/faq.adoc[]
44-
** xref:manual/filters.adoc[]
45-
** xref:manual/layouts.adoc[]
46-
** xref:manual/installation.adoc[]
47-
** xref:manual/supported-frameworks.adoc[]
4847
* xref:features.adoc[]
4948
* xref:release-notes.adoc[]
5049
* xref:release-review.adoc[]

src/site/antora/modules/ROOT/pages/manual/configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ We could just as easily log to an email address or redirect all `Animals.Carnivo
234234
to a remote syslog server.
235235
236236
For more examples of configuring appenders with `XmlConfigurator`, see
237-
xref:manual/configuration/examples.adoc[].
237+
xref:manual/configuration/appenders.adoc[].
238238
239239
[#configuration-attributes]
240240
== Configuration Attributes
@@ -573,7 +573,7 @@ The `<appender>` element supports the following child elements:
573573
574574
|===
575575
576-
For examples of configuring appenders see xref:manual/configuration/examples.adoc[Example Appender Configuration].
576+
For examples of configuring appenders see xref:manual/configuration/appenders.adoc[Example Appender Configuration].
577577
578578
[#filters]
579579
== Filters

src/site/antora/modules/ROOT/pages/manual/appenders.adoc renamed to src/site/antora/modules/ROOT/pages/manual/configuration/appenders.adoc

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Every Appender must implement the `IAppender` interface.
2323
While not strictly required by the log4net architecture, most appenders inherit from `AppenderSkeleton` and:
2424
2525
* delegate the filtering of log events to an implementation of `IFilter`.
26-
See xref:manual/filters.adoc[] for more information.
26+
See xref:manual/configuration/filters.adoc[] for more information.
2727
* delegate the formatting of log events to an implementation of `ILayout`.
28-
See xref:manual/layouts.adoc[] for more information.
28+
See xref:manual/configuration/layouts.adoc[] for more information.
2929
* only directly handle the writing of log event data to the target destination.
3030
3131
Appenders always have a name so that they can be referenced from a
@@ -39,7 +39,7 @@ log4net ships with the following appenders
3939
|===
4040
|Type |Description
4141
42-
|AdoNetAppender
42+
|xref:manual/configuration/appenders/adonetappender.adoc[]
4343
|Writes logging events to a database using either prepared statements or stored procedures.
4444
4545
|AnsiColorTerminalAppender
@@ -48,59 +48,64 @@ log4net ships with the following appenders
4848
|AspNetTraceAppender
4949
|Writes logging events to the ASP trace context. These can then be rendered at the end of the ASP page or on the ASP trace page.
5050
51-
|BufferingForwardingAppender
51+
|xref:manual/configuration/appenders/bufferingforwardingappender.adoc[]
5252
|Buffers events and then forwards them to attached appenders.
5353
54-
|ColoredConsoleAppender
54+
|xref:manual/configuration/appenders/coloredconsoleappender.adoc[]
5555
|Writes color highlighted logging events to the application's Windows Console.
5656
57-
|ConsoleAppender
57+
|xref:manual/configuration/appenders/consoleappender.adoc[]
5858
|Writes logging events to the application's Console.
5959
The events may go to either the standard our stream or the standard error stream.
6060
6161
|DebugAppender
6262
|Writes logging events to the .net debugger (https://web.archive.org/web/20240930165834/https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.debug?view=net-8.0[System.Diagnostics.Debug]).
6363
64-
|EventLogAppender
64+
|xref:manual/configuration/appenders/eventlogappender.adoc[]
6565
|Writes logging events to the Windows Event Log.
6666
67-
|FileAppender
67+
|xref:manual/configuration/appenders/fileappender.adoc[]
6868
|Writes logging events to a file in the file system.
6969
70-
|LocalSyslogAppender
70+
|xref:manual/configuration/appenders/localsyslogappender.adoc[]
7171
|Writes logging events to the local https://datatracker.ietf.org/doc/html/rfc3164[syslog] service (UNIX only).
7272
73-
|MemoryAppender
73+
|xref:manual/configuration/appenders/managedcoloredconsoleappender.adoc[]
74+
|Writes color highlighted logging events to the application's Windows Console.
75+
This appender is a managed version of the ColoredConsoleAppender and does not require the use of the Windows Console API.
76+
It is a replacement for the ColoredConsoleAppender and is the recommended appender for logging to the Console.
77+
78+
|xref:manual/configuration/appenders/memoryappender.adoc[]
7479
|Stores logging events in an in memory buffer.
7580
76-
|OutputDebugStringAppender
81+
|xref:manual/configuration/appenders/outputdebugstringappender.adoc[]
7782
|Writes logging events to the debugger (using https://web.archive.org/web/20241118170546/https://learn.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-outputdebugstringw[OutputDebugString]).
7883
If the application has no debugger, the system debugger displays the string.
7984
If the application has no debugger and the system debugger is not active, the message is ignored.
8085
81-
|RemoteSyslogAppender
86+
|xref:manual/configuration/appenders/remotesyslogappender.adoc[]
8287
|Writes logging events to a remote https://datatracker.ietf.org/doc/html/rfc3164[syslog] service using UDP networking.
8388
84-
|RollingFileAppender
89+
|xref:manual/configuration/appenders/rollingfileappender.adoc[]
8590
|Writes logging events to a file in the file system.
8691
The RollingFileAppender can be configured to log to multiple files based upon date or file size constraints.
8792
88-
|SmtpAppender
93+
|xref:manual/configuration/appenders/smtpappender.adoc[]
8994
|Sends logging events to an email address.
9095
91-
|SmtpPickupDirAppender
96+
|xref:manual/configuration/appenders/smtppickupdirappender.adoc[]
9297
|Sends logging events to an email address but writes the emails to a configurable directory rather than sending them directly via SMTP.
9398
9499
|TelnetAppender
95100
|*Clients* connect via Telnet to receive logging events.
96101
97-
|TraceAppender
102+
|xref:manual/configuration/appenders/traceappender.adoc[]
98103
|Writes logging events to the .NET trace system (https://web.archive.org/web/20240907024634/https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.trace?view=net-8.0[System.Diagnostics.Trace]).
99104
100-
|UdpAppender
105+
|xref:manual/configuration/appenders/udpappender.adoc[]
101106
|Sends logging events as connectionless UDP datagrams to a remote host or a multicast group using a UdpClient.
102107
103-
|ForwardingAppender
108+
|xref:manual/configuration/appenders/forwardingappender.adoc[]
104109
|Can be used to wrap another appender, for example to attach additional filters.
105110
106111
|===

src/site/antora/modules/ROOT/pages/manual/configuration/adonetappender.adoc renamed to src/site/antora/modules/ROOT/pages/manual/configuration/appenders/adonetappender.adoc

File renamed without changes.

0 commit comments

Comments
 (0)