diff options
| author | Emily <vcs@emily.moe> | 2023-06-22 09:05:03 +0100 |
|---|---|---|
| committer | Emily <vcs@emily.moe> | 2023-06-24 10:48:55 +0100 |
| commit | efe314cdbabaf5cd210d9c658b4ad540437b7ee5 (patch) | |
| tree | 8b00b1c0518922b71311ba2e0c448d6b3e5340d8 /modules/system/defaults | |
| parent | c2716817a8e5fb47889aaf625aa13b89d786da51 (diff) | |
treewide: manually convert some docs to Markdown
These all use DocBook markup too complex for `nix-doc-munge` to handle,
have syntax that clashes with Markdown, or already contain Markdown
syntax that currently isn't rendering correctly.
Converting DocBook list syntax makes me think that maybe Markdown
isn't so bad after all.
Diffstat (limited to 'modules/system/defaults')
| -rw-r--r-- | modules/system/defaults/ActivityMonitor.nix | 30 | ||||
| -rw-r--r-- | modules/system/defaults/dock.nix | 112 | ||||
| -rw-r--r-- | modules/system/defaults/loginwindow.nix | 4 | ||||
| -rw-r--r-- | modules/system/defaults/universalaccess.nix | 2 |
4 files changed, 70 insertions, 78 deletions
diff --git a/modules/system/defaults/ActivityMonitor.nix b/modules/system/defaults/ActivityMonitor.nix index d57c6c0..270c678 100644 --- a/modules/system/defaults/ActivityMonitor.nix +++ b/modules/system/defaults/ActivityMonitor.nix @@ -8,16 +8,16 @@ with lib; system.defaults.ActivityMonitor.ShowCategory = mkOption { type = types.nullOr (types.enum [100 101 102 103 104 105 106 107]); default = null; - description = '' + description = lib.mdDoc '' Change which processes to show. - 100: All Processes - 101: All Processes, Hierarchally - 102: My Processes - 103: System Processes - 104: Other User Processes - 105: Active Processes - 106: Inactive Processes - 107: Windowed Processes + * 100: All Processes + * 101: All Processes, Hierarchally + * 102: My Processes + * 103: System Processes + * 104: Other User Processes + * 105: Active Processes + * 106: Inactive Processes + * 107: Windowed Processes Default is 100. ''; }; @@ -25,13 +25,13 @@ with lib; system.defaults.ActivityMonitor.IconType = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Change the icon in the dock when running. - 0: Application Icon - 2: Network Usage - 3: Disk Activity - 5: CPU Usage - 6: CPU History + * 0: Application Icon + * 2: Network Usage + * 3: Disk Activity + * 5: CPU Usage + * 6: CPU History Default is null. ''; }; diff --git a/modules/system/defaults/dock.nix b/modules/system/defaults/dock.nix index ba62e7a..82c8bef 100644 --- a/modules/system/defaults/dock.nix +++ b/modules/system/defaults/dock.nix @@ -166,92 +166,84 @@ in { system.defaults.dock.wvous-tl-corner = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Hot corner action for top left corner. Valid values include: - <itemizedlist> - <listitem><para><literal>1</literal>: Disabled</para></listitem> - <listitem><para><literal>2</literal>: Mission Control</para></listitem> - <listitem><para><literal>3</literal>: Application Windows</para></listitem> - <listitem><para><literal>4</literal>: Desktop</para></listitem> - <listitem><para><literal>5</literal>: Start Screen Saver</para></listitem> - <listitem><para><literal>6</literal>: Disable Screen Saver</para></listitem> - <listitem><para><literal>7</literal>: Dashboard</para></listitem> - <listitem><para><literal>10</literal>: Put Display to Sleep</para></listitem> - <listitem><para><literal>11</literal>: Launchpad</para></listitem> - <listitem><para><literal>12</literal>: Notification Center</para></listitem> - <listitem><para><literal>13</literal>: Lock Screen</para></listitem> - <listitem><para><literal>14</literal>: Quick Note</para></listitem> - </itemizedlist> + * `1`: Disabled + * `2`: Mission Control + * `3`: Application Windows + * `4`: Desktop + * `5`: Start Screen Saver + * `6`: Disable Screen Saver + * `7`: Dashboard + * `10`: Put Display to Sleep + * `11`: Launchpad + * `12`: Notification Center + * `13`: Lock Screen + * `14`: Quick Note ''; }; system.defaults.dock.wvous-bl-corner = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Hot corner action for bottom left corner. Valid values include: - <itemizedlist> - <listitem><para><literal>1</literal>: Disabled</para></listitem> - <listitem><para><literal>2</literal>: Mission Control</para></listitem> - <listitem><para><literal>3</literal>: Application Windows</para></listitem> - <listitem><para><literal>4</literal>: Desktop</para></listitem> - <listitem><para><literal>5</literal>: Start Screen Saver</para></listitem> - <listitem><para><literal>6</literal>: Disable Screen Saver</para></listitem> - <listitem><para><literal>7</literal>: Dashboard</para></listitem> - <listitem><para><literal>10</literal>: Put Display to Sleep</para></listitem> - <listitem><para><literal>11</literal>: Launchpad</para></listitem> - <listitem><para><literal>12</literal>: Notification Center</para></listitem> - <listitem><para><literal>13</literal>: Lock Screen</para></listitem> - <listitem><para><literal>14</literal>: Quick Note</para></listitem> - </itemizedlist> + * `1`: Disabled + * `2`: Mission Control + * `3`: Application Windows + * `4`: Desktop + * `5`: Start Screen Saver + * `6`: Disable Screen Saver + * `7`: Dashboard + * `10`: Put Display to Sleep + * `11`: Launchpad + * `12`: Notification Center + * `13`: Lock Screen + * `14`: Quick Note ''; }; system.defaults.dock.wvous-tr-corner = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Hot corner action for top right corner. Valid values include: - <itemizedlist> - <listitem><para><literal>1</literal>: Disabled</para></listitem> - <listitem><para><literal>2</literal>: Mission Control</para></listitem> - <listitem><para><literal>3</literal>: Application Windows</para></listitem> - <listitem><para><literal>4</literal>: Desktop</para></listitem> - <listitem><para><literal>5</literal>: Start Screen Saver</para></listitem> - <listitem><para><literal>6</literal>: Disable Screen Saver</para></listitem> - <listitem><para><literal>7</literal>: Dashboard</para></listitem> - <listitem><para><literal>10</literal>: Put Display to Sleep</para></listitem> - <listitem><para><literal>11</literal>: Launchpad</para></listitem> - <listitem><para><literal>12</literal>: Notification Center</para></listitem> - <listitem><para><literal>13</literal>: Lock Screen</para></listitem> - <listitem><para><literal>14</literal>: Quick Note</para></listitem> - </itemizedlist> + * `1`: Disabled + * `2`: Mission Control + * `3`: Application Windows + * `4`: Desktop + * `5`: Start Screen Saver + * `6`: Disable Screen Saver + * `7`: Dashboard + * `10`: Put Display to Sleep + * `11`: Launchpad + * `12`: Notification Center + * `13`: Lock Screen + * `14`: Quick Note ''; }; system.defaults.dock.wvous-br-corner = mkOption { type = types.nullOr types.ints.positive; default = null; - description = '' + description = lib.mdDoc '' Hot corner action for bottom right corner. Valid values include: - <itemizedlist> - <listitem><para><literal>1</literal>: Disabled</para></listitem> - <listitem><para><literal>2</literal>: Mission Control</para></listitem> - <listitem><para><literal>3</literal>: Application Windows</para></listitem> - <listitem><para><literal>4</literal>: Desktop</para></listitem> - <listitem><para><literal>5</literal>: Start Screen Saver</para></listitem> - <listitem><para><literal>6</literal>: Disable Screen Saver</para></listitem> - <listitem><para><literal>7</literal>: Dashboard</para></listitem> - <listitem><para><literal>10</literal>: Put Display to Sleep</para></listitem> - <listitem><para><literal>11</literal>: Launchpad</para></listitem> - <listitem><para><literal>12</literal>: Notification Center</para></listitem> - <listitem><para><literal>13</literal>: Lock Screen</para></listitem> - <listitem><para><literal>14</literal>: Quick Note</para></listitem> - </itemizedlist> + * `1`: Disabled + * `2`: Mission Control + * `3`: Application Windows + * `4`: Desktop + * `5`: Start Screen Saver + * `6`: Disable Screen Saver + * `7`: Dashboard + * `10`: Put Display to Sleep + * `11`: Launchpad + * `12`: Notification Center + * `13`: Lock Screen + * `14`: Quick Note ''; }; diff --git a/modules/system/defaults/loginwindow.nix b/modules/system/defaults/loginwindow.nix index 5f0491a..0fb7096 100644 --- a/modules/system/defaults/loginwindow.nix +++ b/modules/system/defaults/loginwindow.nix @@ -38,8 +38,8 @@ with lib; system.defaults.loginwindow.LoginwindowText = mkOption { type = types.nullOr types.str; default = null; - description = '' - Text to be shown on the login window. Default is "\\U03bb". + description = lib.mdDoc '' + Text to be shown on the login window. Default is "\\\\U03bb". ''; }; diff --git a/modules/system/defaults/universalaccess.nix b/modules/system/defaults/universalaccess.nix index 6d6a974..bb4bec9 100644 --- a/modules/system/defaults/universalaccess.nix +++ b/modules/system/defaults/universalaccess.nix @@ -37,7 +37,7 @@ with lib; system.defaults.universalaccess.closeViewZoomFollowsFocus = mkOption { type = types.nullOr types.bool; default = null; - description = '' + description = lib.mdDoc '' Follow the keyboard focus while zoomed in. Without setting `closeViewScrollWheelToggle` this has no effect. The default is false. |
