Fossil SCM

Improve wiki explanation for how home pages work with embedded documents. Change example for home page in setup.c to be trunk, not whatever branch happens to be latest.

danshearer 2021-01-15 13:25 trunk
Commit b32461f72d26e000e781e2cadd5a2efebf9a8cea384c8c19521faf3d14876562
2 files changed +1 -1 +11 -2
+1 -1
--- src/setup.c
+++ src/setup.c
@@ -1009,11 +1009,11 @@
10091009
@
10101010
@ <blockquote><p>%h(g.zBaseURL)/home</p></blockquote>
10111011
@
10121012
@ <p>The default "/home" page displays a Wiki page with the same name
10131013
@ as the Project Name specified above. Some sites prefer to redirect
1014
- @ to a documentation page (ex: "/doc/tip/index.wiki") or to "/timeline".</p>
1014
+ @ to a documentation page (ex: "/doc/trunk/index.wiki") or to "/timeline".</p>
10151015
@
10161016
@ <p>Note: To avoid a redirect loop or other problems, this entry must
10171017
@ begin with "/" and it must specify a valid page. For example,
10181018
@ "<b>/home</b>" will work but "<b>home</b>" will not, since it omits the
10191019
@ leading "/".</p>
10201020
--- src/setup.c
+++ src/setup.c
@@ -1009,11 +1009,11 @@
1009 @
1010 @ <blockquote><p>%h(g.zBaseURL)/home</p></blockquote>
1011 @
1012 @ <p>The default "/home" page displays a Wiki page with the same name
1013 @ as the Project Name specified above. Some sites prefer to redirect
1014 @ to a documentation page (ex: "/doc/tip/index.wiki") or to "/timeline".</p>
1015 @
1016 @ <p>Note: To avoid a redirect loop or other problems, this entry must
1017 @ begin with "/" and it must specify a valid page. For example,
1018 @ "<b>/home</b>" will work but "<b>home</b>" will not, since it omits the
1019 @ leading "/".</p>
1020
--- src/setup.c
+++ src/setup.c
@@ -1009,11 +1009,11 @@
1009 @
1010 @ <blockquote><p>%h(g.zBaseURL)/home</p></blockquote>
1011 @
1012 @ <p>The default "/home" page displays a Wiki page with the same name
1013 @ as the Project Name specified above. Some sites prefer to redirect
1014 @ to a documentation page (ex: "/doc/trunk/index.wiki") or to "/timeline".</p>
1015 @
1016 @ <p>Note: To avoid a redirect loop or other problems, this entry must
1017 @ begin with "/" and it must specify a valid page. For example,
1018 @ "<b>/home</b>" will work but "<b>home</b>" will not, since it omits the
1019 @ leading "/".</p>
1020
+11 -2
--- www/webui.wiki
+++ www/webui.wiki
@@ -100,11 +100,11 @@
100100
changes from your co-workers the next time your repository is synchronized.
101101
102102
You can view and edit <b>wiki</b> by following the "Wiki" link on the
103103
menu bar. Fossil has its own easy-to-remember
104104
[/wiki_rules | markup rules], or if you prefer, it also
105
-support [/md_rules | Markdown]. And, as with tickets, all of
105
+supports [/md_rules | Markdown]. And, as with tickets, all of
106106
your edits will automatically merge with those of your co-workers when
107107
your repository synchronizes.
108108
109109
You can view summary reports of <b>branches</b> in the
110110
check-in graph by visiting the "Branches" link on the
@@ -130,11 +130,20 @@
130130
interface. Templates
131131
for the header and footer of each page can be edited, as can the CSS
132132
for the entire page. You can even change around the main menu.
133133
Timeline display preferences can be edited. The page that is brought
134134
up as the "Home" page can be changed. It is often useful to set the
135
-"Home" page to be a wiki page or an embedded document.
135
+"Home" page to be a wiki page or an embedded document. The built-in
136
+pages <b>/home</b> and <b>/index</b> can be used as the "Home" page.
137
+They have identical effect, which is to instruct Fossil to find and
138
+display a wiki page with the same name as the project, or if that
139
+does not exist, <b>/README.md</b> or <b>/index.wiki</b>.
140
+
141
+An embedded document link such as <b>doc/trunk/README.md</b> can be
142
+used for the "Home" page. If you specify one of the built-in keywords
143
+<b>/home</b> or <b>/index</b>, the page will not be treated as an
144
+embedded document.
136145
137146
<h2>Installing On A Network Server</h2>
138147
139148
When you create a new Fossil project and after you have configured it
140149
like you want it using the web interface, you can make the project
141150
--- www/webui.wiki
+++ www/webui.wiki
@@ -100,11 +100,11 @@
100 changes from your co-workers the next time your repository is synchronized.
101
102 You can view and edit <b>wiki</b> by following the "Wiki" link on the
103 menu bar. Fossil has its own easy-to-remember
104 [/wiki_rules | markup rules], or if you prefer, it also
105 support [/md_rules | Markdown]. And, as with tickets, all of
106 your edits will automatically merge with those of your co-workers when
107 your repository synchronizes.
108
109 You can view summary reports of <b>branches</b> in the
110 check-in graph by visiting the "Branches" link on the
@@ -130,11 +130,20 @@
130 interface. Templates
131 for the header and footer of each page can be edited, as can the CSS
132 for the entire page. You can even change around the main menu.
133 Timeline display preferences can be edited. The page that is brought
134 up as the "Home" page can be changed. It is often useful to set the
135 "Home" page to be a wiki page or an embedded document.
 
 
 
 
 
 
 
 
 
136
137 <h2>Installing On A Network Server</h2>
138
139 When you create a new Fossil project and after you have configured it
140 like you want it using the web interface, you can make the project
141
--- www/webui.wiki
+++ www/webui.wiki
@@ -100,11 +100,11 @@
100 changes from your co-workers the next time your repository is synchronized.
101
102 You can view and edit <b>wiki</b> by following the "Wiki" link on the
103 menu bar. Fossil has its own easy-to-remember
104 [/wiki_rules | markup rules], or if you prefer, it also
105 supports [/md_rules | Markdown]. And, as with tickets, all of
106 your edits will automatically merge with those of your co-workers when
107 your repository synchronizes.
108
109 You can view summary reports of <b>branches</b> in the
110 check-in graph by visiting the "Branches" link on the
@@ -130,11 +130,20 @@
130 interface. Templates
131 for the header and footer of each page can be edited, as can the CSS
132 for the entire page. You can even change around the main menu.
133 Timeline display preferences can be edited. The page that is brought
134 up as the "Home" page can be changed. It is often useful to set the
135 "Home" page to be a wiki page or an embedded document. The built-in
136 pages <b>/home</b> and <b>/index</b> can be used as the "Home" page.
137 They have identical effect, which is to instruct Fossil to find and
138 display a wiki page with the same name as the project, or if that
139 does not exist, <b>/README.md</b> or <b>/index.wiki</b>.
140
141 An embedded document link such as <b>doc/trunk/README.md</b> can be
142 used for the "Home" page. If you specify one of the built-in keywords
143 <b>/home</b> or <b>/index</b>, the page will not be treated as an
144 embedded document.
145
146 <h2>Installing On A Network Server</h2>
147
148 When you create a new Fossil project and after you have configured it
149 like you want it using the web interface, you can make the project
150

Keyboard Shortcuts

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