Fossil SCM

Documentation for new settings. Improvements to the change log.

drh 2021-03-02 17:13 trunk
Commit aac9093b369759fae3a2c735952fa95ef5970e5a74a0ad3e8ff89761490d9ae3
3 files changed +9 -4 +55 -3 +5 -3
+9 -4
--- src/info.c
+++ src/info.c
@@ -1633,14 +1633,19 @@
16331633
}
16341634
16351635
/*
16361636
** SETTING: preferred-diff-type width=16 default=0
16371637
**
1638
-** Determines the preferred diff format on web pages if the format is not
1639
-** otherwise specified, for example by a query parameter or cookie.
1640
-** The value may be 1 to mean unified diff, or 2 to mean side-by-side
1641
-** diff.
1638
+** The preferred-diff-type setting determines the preferred diff format
1639
+** for web pages if the format is not otherwise specified, for example
1640
+** by a query parameter or cookie. Allowed values:
1641
+**
1642
+** 1 Unified diff
1643
+** 2 Side-by-side diff
1644
+**
1645
+** If this setting is omitted or has a value of 0 or less, then it
1646
+** is ignored.
16421647
*/
16431648
/*
16441649
** Return the preferred diff type.
16451650
**
16461651
** 0 = No diff at all.
16471652
--- src/info.c
+++ src/info.c
@@ -1633,14 +1633,19 @@
1633 }
1634
1635 /*
1636 ** SETTING: preferred-diff-type width=16 default=0
1637 **
1638 ** Determines the preferred diff format on web pages if the format is not
1639 ** otherwise specified, for example by a query parameter or cookie.
1640 ** The value may be 1 to mean unified diff, or 2 to mean side-by-side
1641 ** diff.
 
 
 
 
 
1642 */
1643 /*
1644 ** Return the preferred diff type.
1645 **
1646 ** 0 = No diff at all.
1647
--- src/info.c
+++ src/info.c
@@ -1633,14 +1633,19 @@
1633 }
1634
1635 /*
1636 ** SETTING: preferred-diff-type width=16 default=0
1637 **
1638 ** The preferred-diff-type setting determines the preferred diff format
1639 ** for web pages if the format is not otherwise specified, for example
1640 ** by a query parameter or cookie. Allowed values:
1641 **
1642 ** 1 Unified diff
1643 ** 2 Side-by-side diff
1644 **
1645 ** If this setting is omitted or has a value of 0 or less, then it
1646 ** is ignored.
1647 */
1648 /*
1649 ** Return the preferred diff type.
1650 **
1651 ** 0 = No diff at all.
1652
+55 -3
--- src/setup.c
+++ src/setup.c
@@ -952,10 +952,62 @@
952952
@ </td></tr></table>
953953
@ </div></form>
954954
db_end_transaction(0);
955955
style_finish_page();
956956
}
957
+
958
+/*
959
+** SETTING: mainmenu width=70 block-text
960
+**
961
+** The mainmenu setting specifies the entries on the main menu
962
+** for many skins. The mainmenu should be a TCL list. Each set
963
+** of four consecutive values defines a single main menu item:
964
+**
965
+** * The first term is text that appears on the menu.
966
+**
967
+** * The second term is a hyperlink to take when a user clicks on the
968
+** entry. Hyperlinks that start with "/" are relative to the
969
+** repository root.
970
+**
971
+** * The third term is an argument to the TH1 "capexpr" command.
972
+** If capexpr evalutes to true, then the entry is shown. If not,
973
+** the entry is omitted. "*" is always true. "{}" is never true.
974
+**
975
+** * The fourth term is a list of extra class names to apply to the new
976
+** menu entry. Some skins will classes "desktoponly" and "wideonly"
977
+** to only show the entries when the web browser screen is wide or
978
+** very wide, respectively.
979
+**
980
+** Some custom skins might not use this property. Whether the property
981
+** is used or not a choice made by the skin designer. Some skins may add
982
+** extra choices (such as the hamburger button) to the menu.
983
+*/
984
+/*
985
+** SETTING: sitemap-extra width=70 block-text
986
+**
987
+** The sitemap-extra setting defines extra links to appear on the
988
+** /sitemap web page as sub-items of the "Home Page" entry before the
989
+** "Documentation Search" entry (if any). For skins that use the /sitemap
990
+** page to construct a hamburger menu dropdown, new entries added here
991
+** will appear on the hamburger menu.
992
+**
993
+** This setting should be a TCL list divided into triples. Each
994
+** triple defines a new entry:
995
+**
996
+** * The first term is the display name of the /sitemap entry
997
+**
998
+** * The second term is a hyperlink to take when a user clicks on the
999
+** entry. Hyperlinks that start with "/" are relative to the
1000
+** repository root.
1001
+**
1002
+** * The third term is an argument to the TH1 "capexpr" command.
1003
+** If capexpr evalutes to true, then the entry is shown. If not,
1004
+** the entry is omitted. "*" is always true.
1005
+**
1006
+** The default value is blank, meaning no added entries.
1007
+*/
1008
+
9571009
9581010
/*
9591011
** WEBPAGE: setup_config
9601012
**
9611013
** The "Admin/Configuration" page. Requires Setup privilege.
@@ -1026,11 +1078,11 @@
10261078
@ leading "/".</p>
10271079
@ <p>(Property: "index-page")
10281080
@ <hr>
10291081
@ <p>The main menu for the web interface
10301082
@ <p>
1031
- @
1083
+ @
10321084
@ <p>This setting should be a TCL list. Each set of four consecutive
10331085
@ values defines a single main menu item:
10341086
@ <ol>
10351087
@ <li> The first term is text that appears on the menu.
10361088
@ <li> The second term is a hyperlink to take when a user clicks on the
@@ -1043,12 +1095,12 @@
10431095
@ menu entry. Some skins will classes "desktoponly" and "wideonly"
10441096
@ to only show the entries when the web browser screen is wide or
10451097
@ very wide, respectively.
10461098
@ </ol>
10471099
@
1048
- @ <p>Some custom skins might not use this property. Whether the property
1049
- @ is used or a choice made by the skin designer. Some skins add an extra
1100
+ @ <p>Some custom skins might not use this property. Whether the property
1101
+ @ is used or not a choice made by the skin designer. Some skins may add extra
10501102
@ choices (such as the hamburger button) to the menu that are not shown
10511103
@ on this list. (Property: mainmenu)
10521104
@ <p>
10531105
if(P("resetMenu")!=0){
10541106
db_unset("mainmenu", 0);
10551107
--- src/setup.c
+++ src/setup.c
@@ -952,10 +952,62 @@
952 @ </td></tr></table>
953 @ </div></form>
954 db_end_transaction(0);
955 style_finish_page();
956 }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
957
958 /*
959 ** WEBPAGE: setup_config
960 **
961 ** The "Admin/Configuration" page. Requires Setup privilege.
@@ -1026,11 +1078,11 @@
1026 @ leading "/".</p>
1027 @ <p>(Property: "index-page")
1028 @ <hr>
1029 @ <p>The main menu for the web interface
1030 @ <p>
1031 @
1032 @ <p>This setting should be a TCL list. Each set of four consecutive
1033 @ values defines a single main menu item:
1034 @ <ol>
1035 @ <li> The first term is text that appears on the menu.
1036 @ <li> The second term is a hyperlink to take when a user clicks on the
@@ -1043,12 +1095,12 @@
1043 @ menu entry. Some skins will classes "desktoponly" and "wideonly"
1044 @ to only show the entries when the web browser screen is wide or
1045 @ very wide, respectively.
1046 @ </ol>
1047 @
1048 @ <p>Some custom skins might not use this property. Whether the property
1049 @ is used or a choice made by the skin designer. Some skins add an extra
1050 @ choices (such as the hamburger button) to the menu that are not shown
1051 @ on this list. (Property: mainmenu)
1052 @ <p>
1053 if(P("resetMenu")!=0){
1054 db_unset("mainmenu", 0);
1055
--- src/setup.c
+++ src/setup.c
@@ -952,10 +952,62 @@
952 @ </td></tr></table>
953 @ </div></form>
954 db_end_transaction(0);
955 style_finish_page();
956 }
957
958 /*
959 ** SETTING: mainmenu width=70 block-text
960 **
961 ** The mainmenu setting specifies the entries on the main menu
962 ** for many skins. The mainmenu should be a TCL list. Each set
963 ** of four consecutive values defines a single main menu item:
964 **
965 ** * The first term is text that appears on the menu.
966 **
967 ** * The second term is a hyperlink to take when a user clicks on the
968 ** entry. Hyperlinks that start with "/" are relative to the
969 ** repository root.
970 **
971 ** * The third term is an argument to the TH1 "capexpr" command.
972 ** If capexpr evalutes to true, then the entry is shown. If not,
973 ** the entry is omitted. "*" is always true. "{}" is never true.
974 **
975 ** * The fourth term is a list of extra class names to apply to the new
976 ** menu entry. Some skins will classes "desktoponly" and "wideonly"
977 ** to only show the entries when the web browser screen is wide or
978 ** very wide, respectively.
979 **
980 ** Some custom skins might not use this property. Whether the property
981 ** is used or not a choice made by the skin designer. Some skins may add
982 ** extra choices (such as the hamburger button) to the menu.
983 */
984 /*
985 ** SETTING: sitemap-extra width=70 block-text
986 **
987 ** The sitemap-extra setting defines extra links to appear on the
988 ** /sitemap web page as sub-items of the "Home Page" entry before the
989 ** "Documentation Search" entry (if any). For skins that use the /sitemap
990 ** page to construct a hamburger menu dropdown, new entries added here
991 ** will appear on the hamburger menu.
992 **
993 ** This setting should be a TCL list divided into triples. Each
994 ** triple defines a new entry:
995 **
996 ** * The first term is the display name of the /sitemap entry
997 **
998 ** * The second term is a hyperlink to take when a user clicks on the
999 ** entry. Hyperlinks that start with "/" are relative to the
1000 ** repository root.
1001 **
1002 ** * The third term is an argument to the TH1 "capexpr" command.
1003 ** If capexpr evalutes to true, then the entry is shown. If not,
1004 ** the entry is omitted. "*" is always true.
1005 **
1006 ** The default value is blank, meaning no added entries.
1007 */
1008
1009
1010 /*
1011 ** WEBPAGE: setup_config
1012 **
1013 ** The "Admin/Configuration" page. Requires Setup privilege.
@@ -1026,11 +1078,11 @@
1078 @ leading "/".</p>
1079 @ <p>(Property: "index-page")
1080 @ <hr>
1081 @ <p>The main menu for the web interface
1082 @ <p>
1083 @
1084 @ <p>This setting should be a TCL list. Each set of four consecutive
1085 @ values defines a single main menu item:
1086 @ <ol>
1087 @ <li> The first term is text that appears on the menu.
1088 @ <li> The second term is a hyperlink to take when a user clicks on the
@@ -1043,12 +1095,12 @@
1095 @ menu entry. Some skins will classes "desktoponly" and "wideonly"
1096 @ to only show the entries when the web browser screen is wide or
1097 @ very wide, respectively.
1098 @ </ol>
1099 @
1100 @ <p>Some custom skins might not use this property. Whether the property
1101 @ is used or not a choice made by the skin designer. Some skins may add extra
1102 @ choices (such as the hamburger button) to the menu that are not shown
1103 @ on this list. (Property: mainmenu)
1104 @ <p>
1105 if(P("resetMenu")!=0){
1106 db_unset("mainmenu", 0);
1107
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,11 +1,12 @@
11
<title>Change Log</title>
22
33
<a name='v2_15'></a>
44
<h2>Changes for Version 2.15 (pending)</h2>
5
- * The built-in skins all use the "mainmenu" setting to determine
6
- the content of the main menu. The ability to edit the
5
+ * The built-in skins all use the "[/help?cmd=mainmenu|mainmenu]"
6
+ setting to determine the content of the main menu.
7
+ The ability to edit the
78
"mainmenu" setting is added on the /Admin/Configuration page.
89
* The hamburger menu is now available on most of the built-in skins.
910
* Any built-in skin named "X" can be used instead of the standard
1011
repository skin by adding the URL parameter <tt>skin=X</tt> to the
1112
request. The selection is persisted using the display
@@ -13,11 +14,12 @@
1314
included. The [/skins] page may be used to select a skin.
1415
* The [/cookies] page now gives the user an opportunity to delete
1516
individual cookies. And the /cookies page is linked from the
1617
/sitemap, so that it appears in hamburger menus.
1718
* The [/sitemap] extensions are now specified by a single new
18
- setting "sitemap-extra", rather than a cluster of various
19
+ "[/help?cmd=sitemap-extra|sitemap-extra setting]",
20
+ rather than a cluster of various
1921
"sitemap-*" settings. The older settings are no longer used.
2022
<b>This change might require minor server configuration
2123
adjustments on servers that use /sitemap extensions.</b>
2224
The /Admin/Configuration page provides the ability to edit
2325
the new "sitemap-extra" setting.
2426
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,11 +1,12 @@
1 <title>Change Log</title>
2
3 <a name='v2_15'></a>
4 <h2>Changes for Version 2.15 (pending)</h2>
5 * The built-in skins all use the "mainmenu" setting to determine
6 the content of the main menu. The ability to edit the
 
7 "mainmenu" setting is added on the /Admin/Configuration page.
8 * The hamburger menu is now available on most of the built-in skins.
9 * Any built-in skin named "X" can be used instead of the standard
10 repository skin by adding the URL parameter <tt>skin=X</tt> to the
11 request. The selection is persisted using the display
@@ -13,11 +14,12 @@
13 included. The [/skins] page may be used to select a skin.
14 * The [/cookies] page now gives the user an opportunity to delete
15 individual cookies. And the /cookies page is linked from the
16 /sitemap, so that it appears in hamburger menus.
17 * The [/sitemap] extensions are now specified by a single new
18 setting "sitemap-extra", rather than a cluster of various
 
19 "sitemap-*" settings. The older settings are no longer used.
20 <b>This change might require minor server configuration
21 adjustments on servers that use /sitemap extensions.</b>
22 The /Admin/Configuration page provides the ability to edit
23 the new "sitemap-extra" setting.
24
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,11 +1,12 @@
1 <title>Change Log</title>
2
3 <a name='v2_15'></a>
4 <h2>Changes for Version 2.15 (pending)</h2>
5 * The built-in skins all use the "[/help?cmd=mainmenu|mainmenu]"
6 setting to determine the content of the main menu.
7 The ability to edit the
8 "mainmenu" setting is added on the /Admin/Configuration page.
9 * The hamburger menu is now available on most of the built-in skins.
10 * Any built-in skin named "X" can be used instead of the standard
11 repository skin by adding the URL parameter <tt>skin=X</tt> to the
12 request. The selection is persisted using the display
@@ -13,11 +14,12 @@
14 included. The [/skins] page may be used to select a skin.
15 * The [/cookies] page now gives the user an opportunity to delete
16 individual cookies. And the /cookies page is linked from the
17 /sitemap, so that it appears in hamburger menus.
18 * The [/sitemap] extensions are now specified by a single new
19 "[/help?cmd=sitemap-extra|sitemap-extra setting]",
20 rather than a cluster of various
21 "sitemap-*" settings. The older settings are no longer used.
22 <b>This change might require minor server configuration
23 adjustments on servers that use /sitemap extensions.</b>
24 The /Admin/Configuration page provides the ability to edit
25 the new "sitemap-extra" setting.
26

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button