Fossil SCM

Add documentation for various settings that influence the display of timelines, but only display them if their values are different from the default.

drh 2025-03-19 11:21 trunk
Commit 1f78e794d35e4e651b2fa3d5a5e11094f69a6a855f7828ae70b3cf82ee6f863b
Parent 486f81b931dea1a…
4 files changed +25 +25 +17 +17
~ src/printf.c ~ src/printf.c ~ src/timeline.c ~ src/timeline.c
M src/printf.c
+25
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239239
 int n = 0;
240240
 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241241
 return n;
242242
 }
243243
 #endif
244
+
245
+/*
246
+** SETTING: timeline-plaintext boolean default=off show-only-if-changed
247
+**
248
+** If enabled, no wiki-formatting is done for timeline comment messages.
249
+** Hyperlinks are activated, but they show up on screen using the
250
+** complete input text, not just the display text. No other formatting
251
+** is done.
252
+*/
253
+/*
254
+** SETTING: timeline-block-markup boolean default=off show-only-if-changed
255
+**
256
+** If enabled, block markup (paragraph brakes, tables, lists, headings, etc)
257
+** is enabled while rendering check-in comment message on the timeline.
258
+** This is disabled by default, because the timeline works best if the
259
+** check-in comments are short and do not take up too much vertical space.
260
+*/
261
+/*
262
+** SETTING: timeline-hard-newlines boolean default=off show-only-if-changed
263
+**
264
+** If enabled, the timeline honors newline characters in check-in comments.
265
+** In other words, newlines are coverted into <br> for HTML display.
266
+** The default behavior, when this setting is off, is that newlines are
267
+** treated like any other whitespace character.
268
+*/
244269
245270
 /*
246271
 ** Return an appropriate set of flags for wiki_convert() for displaying
247272
 ** comments on a timeline. These flag settings are determined by
248273
 ** configuration parameters.
249274
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239 int n = 0;
240 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241 return n;
242 }
243 #endif
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
244
245 /*
246 ** Return an appropriate set of flags for wiki_convert() for displaying
247 ** comments on a timeline. These flag settings are determined by
248 ** configuration parameters.
249
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239 int n = 0;
240 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241 return n;
242 }
243 #endif
244
245 /*
246 ** SETTING: timeline-plaintext boolean default=off show-only-if-changed
247 **
248 ** If enabled, no wiki-formatting is done for timeline comment messages.
249 ** Hyperlinks are activated, but they show up on screen using the
250 ** complete input text, not just the display text. No other formatting
251 ** is done.
252 */
253 /*
254 ** SETTING: timeline-block-markup boolean default=off show-only-if-changed
255 **
256 ** If enabled, block markup (paragraph brakes, tables, lists, headings, etc)
257 ** is enabled while rendering check-in comment message on the timeline.
258 ** This is disabled by default, because the timeline works best if the
259 ** check-in comments are short and do not take up too much vertical space.
260 */
261 /*
262 ** SETTING: timeline-hard-newlines boolean default=off show-only-if-changed
263 **
264 ** If enabled, the timeline honors newline characters in check-in comments.
265 ** In other words, newlines are coverted into <br> for HTML display.
266 ** The default behavior, when this setting is off, is that newlines are
267 ** treated like any other whitespace character.
268 */
269
270 /*
271 ** Return an appropriate set of flags for wiki_convert() for displaying
272 ** comments on a timeline. These flag settings are determined by
273 ** configuration parameters.
274
M src/printf.c
+25
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239239
 int n = 0;
240240
 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241241
 return n;
242242
 }
243243
 #endif
244
+
245
+/*
246
+** SETTING: timeline-plaintext boolean default=off show-only-if-changed
247
+**
248
+** If enabled, no wiki-formatting is done for timeline comment messages.
249
+** Hyperlinks are activated, but they show up on screen using the
250
+** complete input text, not just the display text. No other formatting
251
+** is done.
252
+*/
253
+/*
254
+** SETTING: timeline-block-markup boolean default=off show-only-if-changed
255
+**
256
+** If enabled, block markup (paragraph brakes, tables, lists, headings, etc)
257
+** is enabled while rendering check-in comment message on the timeline.
258
+** This is disabled by default, because the timeline works best if the
259
+** check-in comments are short and do not take up too much vertical space.
260
+*/
261
+/*
262
+** SETTING: timeline-hard-newlines boolean default=off show-only-if-changed
263
+**
264
+** If enabled, the timeline honors newline characters in check-in comments.
265
+** In other words, newlines are coverted into <br> for HTML display.
266
+** The default behavior, when this setting is off, is that newlines are
267
+** treated like any other whitespace character.
268
+*/
244269
245270
 /*
246271
 ** Return an appropriate set of flags for wiki_convert() for displaying
247272
 ** comments on a timeline. These flag settings are determined by
248273
 ** configuration parameters.
249274
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239 int n = 0;
240 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241 return n;
242 }
243 #endif
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
244
245 /*
246 ** Return an appropriate set of flags for wiki_convert() for displaying
247 ** comments on a timeline. These flag settings are determined by
248 ** configuration parameters.
249
--- src/printf.c
+++ src/printf.c
@@ -239,10 +239,35 @@
239 int n = 0;
240 while( (N-- != 0) && *(z++)!=0 ){ n++; }
241 return n;
242 }
243 #endif
244
245 /*
246 ** SETTING: timeline-plaintext boolean default=off show-only-if-changed
247 **
248 ** If enabled, no wiki-formatting is done for timeline comment messages.
249 ** Hyperlinks are activated, but they show up on screen using the
250 ** complete input text, not just the display text. No other formatting
251 ** is done.
252 */
253 /*
254 ** SETTING: timeline-block-markup boolean default=off show-only-if-changed
255 **
256 ** If enabled, block markup (paragraph brakes, tables, lists, headings, etc)
257 ** is enabled while rendering check-in comment message on the timeline.
258 ** This is disabled by default, because the timeline works best if the
259 ** check-in comments are short and do not take up too much vertical space.
260 */
261 /*
262 ** SETTING: timeline-hard-newlines boolean default=off show-only-if-changed
263 **
264 ** If enabled, the timeline honors newline characters in check-in comments.
265 ** In other words, newlines are coverted into <br> for HTML display.
266 ** The default behavior, when this setting is off, is that newlines are
267 ** treated like any other whitespace character.
268 */
269
270 /*
271 ** Return an appropriate set of flags for wiki_convert() for displaying
272 ** comments on a timeline. These flag settings are determined by
273 ** configuration parameters.
274
M src/timeline.c
+17
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221221
 vid = db_lget_int("checkout", 0);
222222
 }
223223
 zPrevDate[0] = 0;
224224
 mxWikiLen = db_get_int("timeline-max-comment", 0);
225225
 dateFormat = db_get_int("timeline-date-format", 0);
226
+ /*
227
+ ** SETTING: timeline-truncate-at-blank boolean default=off show-only-if-changed
228
+ **
229
+ ** If enabled, check-in comments displayed on the timeline are truncated
230
+ ** at the first blank line of the comment text. The comment text after
231
+ ** the first blank line is only seen in the /info or similar pages that
232
+ ** show details about the check-in.
233
+ */
226234
 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
235
+ /*
236
+ ** SETTING: timeline-tslink-info boolean default=off show-only-if-changed
237
+ **
238
+ ** The hyperlink on the timestamp associated with each timeline entry,
239
+ ** on the far left-hand side of the screen, normally targets another
240
+ ** /timeline page that shows the entry in context. However, if this
241
+ ** option is turned on, that hyperlink targets the /info page showing
242
+ ** the details of the entry.
243
+ */
227244
 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
228245
 if( (tmFlags & TIMELINE_VIEWS)==0 ){
229246
 tmFlags |= timeline_ss_cookie();
230247
 }
231248
 if( tmFlags & TIMELINE_COLUMNAR ){
232249
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221 vid = db_lget_int("checkout", 0);
222 }
223 zPrevDate[0] = 0;
224 mxWikiLen = db_get_int("timeline-max-comment", 0);
225 dateFormat = db_get_int("timeline-date-format", 0);
 
 
 
 
 
 
 
 
226 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
 
 
 
 
 
 
 
 
 
227 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
228 if( (tmFlags & TIMELINE_VIEWS)==0 ){
229 tmFlags |= timeline_ss_cookie();
230 }
231 if( tmFlags & TIMELINE_COLUMNAR ){
232
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221 vid = db_lget_int("checkout", 0);
222 }
223 zPrevDate[0] = 0;
224 mxWikiLen = db_get_int("timeline-max-comment", 0);
225 dateFormat = db_get_int("timeline-date-format", 0);
226 /*
227 ** SETTING: timeline-truncate-at-blank boolean default=off show-only-if-changed
228 **
229 ** If enabled, check-in comments displayed on the timeline are truncated
230 ** at the first blank line of the comment text. The comment text after
231 ** the first blank line is only seen in the /info or similar pages that
232 ** show details about the check-in.
233 */
234 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
235 /*
236 ** SETTING: timeline-tslink-info boolean default=off show-only-if-changed
237 **
238 ** The hyperlink on the timestamp associated with each timeline entry,
239 ** on the far left-hand side of the screen, normally targets another
240 ** /timeline page that shows the entry in context. However, if this
241 ** option is turned on, that hyperlink targets the /info page showing
242 ** the details of the entry.
243 */
244 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
245 if( (tmFlags & TIMELINE_VIEWS)==0 ){
246 tmFlags |= timeline_ss_cookie();
247 }
248 if( tmFlags & TIMELINE_COLUMNAR ){
249
M src/timeline.c
+17
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221221
 vid = db_lget_int("checkout", 0);
222222
 }
223223
 zPrevDate[0] = 0;
224224
 mxWikiLen = db_get_int("timeline-max-comment", 0);
225225
 dateFormat = db_get_int("timeline-date-format", 0);
226
+ /*
227
+ ** SETTING: timeline-truncate-at-blank boolean default=off show-only-if-changed
228
+ **
229
+ ** If enabled, check-in comments displayed on the timeline are truncated
230
+ ** at the first blank line of the comment text. The comment text after
231
+ ** the first blank line is only seen in the /info or similar pages that
232
+ ** show details about the check-in.
233
+ */
226234
 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
235
+ /*
236
+ ** SETTING: timeline-tslink-info boolean default=off show-only-if-changed
237
+ **
238
+ ** The hyperlink on the timestamp associated with each timeline entry,
239
+ ** on the far left-hand side of the screen, normally targets another
240
+ ** /timeline page that shows the entry in context. However, if this
241
+ ** option is turned on, that hyperlink targets the /info page showing
242
+ ** the details of the entry.
243
+ */
227244
 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
228245
 if( (tmFlags & TIMELINE_VIEWS)==0 ){
229246
 tmFlags |= timeline_ss_cookie();
230247
 }
231248
 if( tmFlags & TIMELINE_COLUMNAR ){
232249
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221 vid = db_lget_int("checkout", 0);
222 }
223 zPrevDate[0] = 0;
224 mxWikiLen = db_get_int("timeline-max-comment", 0);
225 dateFormat = db_get_int("timeline-date-format", 0);
 
 
 
 
 
 
 
 
226 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
 
 
 
 
 
 
 
 
 
227 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
228 if( (tmFlags & TIMELINE_VIEWS)==0 ){
229 tmFlags |= timeline_ss_cookie();
230 }
231 if( tmFlags & TIMELINE_COLUMNAR ){
232
--- src/timeline.c
+++ src/timeline.c
@@ -221,11 +221,28 @@
221 vid = db_lget_int("checkout", 0);
222 }
223 zPrevDate[0] = 0;
224 mxWikiLen = db_get_int("timeline-max-comment", 0);
225 dateFormat = db_get_int("timeline-date-format", 0);
226 /*
227 ** SETTING: timeline-truncate-at-blank boolean default=off show-only-if-changed
228 **
229 ** If enabled, check-in comments displayed on the timeline are truncated
230 ** at the first blank line of the comment text. The comment text after
231 ** the first blank line is only seen in the /info or similar pages that
232 ** show details about the check-in.
233 */
234 bCommentGitStyle = db_get_int("timeline-truncate-at-blank", 0);
235 /*
236 ** SETTING: timeline-tslink-info boolean default=off show-only-if-changed
237 **
238 ** The hyperlink on the timestamp associated with each timeline entry,
239 ** on the far left-hand side of the screen, normally targets another
240 ** /timeline page that shows the entry in context. However, if this
241 ** option is turned on, that hyperlink targets the /info page showing
242 ** the details of the entry.
243 */
244 bTimestampLinksToInfo = db_get_boolean("timeline-tslink-info", 0);
245 if( (tmFlags & TIMELINE_VIEWS)==0 ){
246 tmFlags |= timeline_ss_cookie();
247 }
248 if( tmFlags & TIMELINE_COLUMNAR ){
249

Keyboard Shortcuts

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