Fossil SCM

Add a Help submenu item to the /timeline page, so that advanced users can quickly see all of the query parameters, and perhaps start to enter them directly on the URL.

drh 2017-11-26 02:04 trunk
Commit 44a5ac416e64d522386b7127cb102eb12766a485b3abe65e423436912bea687d
Parent 58cfff2a4aa7ae4…
1 file changed +40 -36
~ src/timeline.c
M src/timeline.c
+40 -36
--- src/timeline.c
+++ src/timeline.c
@@ -1605,51 +1605,54 @@
16051605
 /*
16061606
 ** WEBPAGE: timeline
16071607
 **
16081608
 ** Query parameters:
16091609
 **
1610
-** a=TIMEORTAG After this event
1611
-** b=TIMEORTAG Before this event
1612
-** c=TIMEORTAG "Circa" this event
1613
-** m=TIMEORTAG Mark this event
1614
-** n=COUNT Suggested number of events in output
1615
-** p=CHECKIN Parents and ancestors of CHECKIN
1616
-** d=CHECKIN Descendants of CHECIN
1617
-** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1618
-** t=TAG Show only check-ins with the given TAG
1619
-** r=TAG Show check-ins related to TAG, equivalent to t=TAG&rel
1620
-** rel Show related check-ins as well as those matching t=TAG
1621
-** mionly Limit rel to show ancestors but not descendants
1622
-** ms=STYLE Set tag match style to EXACT, GLOB, LIKE, REGEXP
1623
-** u=USER Only show items associated with USER
1624
-** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1625
-** ng No Graph.
1626
-** nd Do not highlight the focus check-in
1627
-** v Show details of files changed
1628
-** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1629
-** from=CHECKIN Path from...
1630
-** to=CHECKIN ... to this
1631
-** shortest ... show only the shortest path
1632
-** uf=FILE_HASH Show only check-ins that contain the given file version
1633
-** chng=GLOBLIST Show only check-ins that involve changes to a file whose
1634
-** name matches one of the comma-separate GLOBLIST
1635
-** brbg Background color from branch name
1636
-** ubg Background color from user
1637
-** namechng Show only check-ins that have filename changes
1638
-** forks Show only forks and their children
1639
-** ym=YYYY-MM Show only events for the given year/month
1640
-** yw=YYYY-WW Show only events for the given week of the given year
1641
-** ymd=YYYY-MM-DD Show only events on the given day
1642
-** datefmt=N Override the date format
1643
-** bisect Show the check-ins that are in the current bisect
1644
-** showid Show RIDs
1645
-** showsql Show the SQL text
1610
+** a=TIMEORTAG After this event
1611
+** b=TIMEORTAG Before this event
1612
+** c=TIMEORTAG "Circa" this event
1613
+** m=TIMEORTAG Mark this event
1614
+** n=COUNT Maximum number of events. "all" for no limit
1615
+** p=CHECKIN Parents and ancestors of CHECKIN
1616
+** d=CHECKIN Children and descendants of CHECKIN
1617
+** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1618
+** t=TAG Show only check-ins with the given TAG
1619
+** r=TAG Show check-ins related to TAG, equivalent to t=TAG&rel
1620
+** rel Show related check-ins as well as those matching t=TAG
1621
+** mionly Limit rel to show ancestors but not descendants
1622
+** ms=STYLE Set tag match style to EXACT, GLOB, LIKE, REGEXP
1623
+** u=USER Only show items associated with USER
1624
+** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1625
+** ng No Graph.
1626
+** nd Do not highlight the focus check-in
1627
+** v Show details of files changed
1628
+** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1629
+** from=CHECKIN Path from...
1630
+** to=CHECKIN ... to this
1631
+** shortest ... show only the shortest path
1632
+** uf=FILE_HASH Show only check-ins that contain the given file version
1633
+** chng=GLOBLIST Show only check-ins that involve changes to a file whose
1634
+** name matches one of the comma-separate GLOBLIST
1635
+** brbg Background color from branch name
1636
+** ubg Background color from user
1637
+** namechng Show only check-ins that have filename changes
1638
+** forks Show only forks and their children
1639
+** ym=YYYY-MM Show only events for the given year/month
1640
+** yw=YYYY-WW Show only events for the given week of the given year
1641
+** ymd=YYYY-MM-DD Show only events on the given day
1642
+** datefmt=N Override the date format
1643
+** bisect Show the check-ins that are in the current bisect
1644
+** showid Show RIDs
1645
+** showsql Show the SQL text
16461646
 **
16471647
 ** p= and d= can appear individually or together. If either p= or d=
16481648
 ** appear, then u=, y=, a=, and b= are ignored.
16491649
 **
16501650
 ** If both a= and b= appear then both upper and lower bounds are honored.
1651
+**
1652
+** CHECKIN or TIMEORTAG can be a check-in hash prefix, or a tag, or the
1653
+** name of a branch.
16511654
 */
16521655
 void page_timeline(void){
16531656
 Stmt q; /* Query used to generate the timeline */
16541657
 Blob sql; /* text of SQL used to generate timeline */
16551658
 Blob desc; /* Description of the timeline */
@@ -1849,10 +1852,11 @@
18491852
 }else{
18501853
 bisectOnly = 0;
18511854
 }
18521855
18531856
 style_header("Timeline");
1857
+ style_submenu_element("Help", "%R/help?cmd=/timeline");
18541858
 login_anonymous_available();
18551859
 timeline_temp_table();
18561860
 blob_zero(&sql);
18571861
 blob_zero(&desc);
18581862
 blob_append(&sql, "INSERT OR IGNORE INTO timeline ", -1);
18591863
--- src/timeline.c
+++ src/timeline.c
@@ -1605,51 +1605,54 @@
1605 /*
1606 ** WEBPAGE: timeline
1607 **
1608 ** Query parameters:
1609 **
1610 ** a=TIMEORTAG After this event
1611 ** b=TIMEORTAG Before this event
1612 ** c=TIMEORTAG "Circa" this event
1613 ** m=TIMEORTAG Mark this event
1614 ** n=COUNT Suggested number of events in output
1615 ** p=CHECKIN Parents and ancestors of CHECKIN
1616 ** d=CHECKIN Descendants of CHECIN
1617 ** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1618 ** t=TAG Show only check-ins with the given TAG
1619 ** r=TAG Show check-ins related to TAG, equivalent to t=TAG&rel
1620 ** rel Show related check-ins as well as those matching t=TAG
1621 ** mionly Limit rel to show ancestors but not descendants
1622 ** ms=STYLE Set tag match style to EXACT, GLOB, LIKE, REGEXP
1623 ** u=USER Only show items associated with USER
1624 ** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1625 ** ng No Graph.
1626 ** nd Do not highlight the focus check-in
1627 ** v Show details of files changed
1628 ** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1629 ** from=CHECKIN Path from...
1630 ** to=CHECKIN ... to this
1631 ** shortest ... show only the shortest path
1632 ** uf=FILE_HASH Show only check-ins that contain the given file version
1633 ** chng=GLOBLIST Show only check-ins that involve changes to a file whose
1634 ** name matches one of the comma-separate GLOBLIST
1635 ** brbg Background color from branch name
1636 ** ubg Background color from user
1637 ** namechng Show only check-ins that have filename changes
1638 ** forks Show only forks and their children
1639 ** ym=YYYY-MM Show only events for the given year/month
1640 ** yw=YYYY-WW Show only events for the given week of the given year
1641 ** ymd=YYYY-MM-DD Show only events on the given day
1642 ** datefmt=N Override the date format
1643 ** bisect Show the check-ins that are in the current bisect
1644 ** showid Show RIDs
1645 ** showsql Show the SQL text
1646 **
1647 ** p= and d= can appear individually or together. If either p= or d=
1648 ** appear, then u=, y=, a=, and b= are ignored.
1649 **
1650 ** If both a= and b= appear then both upper and lower bounds are honored.
 
 
 
1651 */
1652 void page_timeline(void){
1653 Stmt q; /* Query used to generate the timeline */
1654 Blob sql; /* text of SQL used to generate timeline */
1655 Blob desc; /* Description of the timeline */
@@ -1849,10 +1852,11 @@
1849 }else{
1850 bisectOnly = 0;
1851 }
1852
1853 style_header("Timeline");
 
1854 login_anonymous_available();
1855 timeline_temp_table();
1856 blob_zero(&sql);
1857 blob_zero(&desc);
1858 blob_append(&sql, "INSERT OR IGNORE INTO timeline ", -1);
1859
--- src/timeline.c
+++ src/timeline.c
@@ -1605,51 +1605,54 @@
1605 /*
1606 ** WEBPAGE: timeline
1607 **
1608 ** Query parameters:
1609 **
1610 ** a=TIMEORTAG After this event
1611 ** b=TIMEORTAG Before this event
1612 ** c=TIMEORTAG "Circa" this event
1613 ** m=TIMEORTAG Mark this event
1614 ** n=COUNT Maximum number of events. "all" for no limit
1615 ** p=CHECKIN Parents and ancestors of CHECKIN
1616 ** d=CHECKIN Children and descendants of CHECKIN
1617 ** dp=CHECKIN The same as d=CHECKIN&p=CHECKIN
1618 ** t=TAG Show only check-ins with the given TAG
1619 ** r=TAG Show check-ins related to TAG, equivalent to t=TAG&rel
1620 ** rel Show related check-ins as well as those matching t=TAG
1621 ** mionly Limit rel to show ancestors but not descendants
1622 ** ms=STYLE Set tag match style to EXACT, GLOB, LIKE, REGEXP
1623 ** u=USER Only show items associated with USER
1624 ** y=TYPE 'ci', 'w', 't', 'e', or (default) 'all'
1625 ** ng No Graph.
1626 ** nd Do not highlight the focus check-in
1627 ** v Show details of files changed
1628 ** f=CHECKIN Show family (immediate parents and children) of CHECKIN
1629 ** from=CHECKIN Path from...
1630 ** to=CHECKIN ... to this
1631 ** shortest ... show only the shortest path
1632 ** uf=FILE_HASH Show only check-ins that contain the given file version
1633 ** chng=GLOBLIST Show only check-ins that involve changes to a file whose
1634 ** name matches one of the comma-separate GLOBLIST
1635 ** brbg Background color from branch name
1636 ** ubg Background color from user
1637 ** namechng Show only check-ins that have filename changes
1638 ** forks Show only forks and their children
1639 ** ym=YYYY-MM Show only events for the given year/month
1640 ** yw=YYYY-WW Show only events for the given week of the given year
1641 ** ymd=YYYY-MM-DD Show only events on the given day
1642 ** datefmt=N Override the date format
1643 ** bisect Show the check-ins that are in the current bisect
1644 ** showid Show RIDs
1645 ** showsql Show the SQL text
1646 **
1647 ** p= and d= can appear individually or together. If either p= or d=
1648 ** appear, then u=, y=, a=, and b= are ignored.
1649 **
1650 ** If both a= and b= appear then both upper and lower bounds are honored.
1651 **
1652 ** CHECKIN or TIMEORTAG can be a check-in hash prefix, or a tag, or the
1653 ** name of a branch.
1654 */
1655 void page_timeline(void){
1656 Stmt q; /* Query used to generate the timeline */
1657 Blob sql; /* text of SQL used to generate timeline */
1658 Blob desc; /* Description of the timeline */
@@ -1849,10 +1852,11 @@
1852 }else{
1853 bisectOnly = 0;
1854 }
1855
1856 style_header("Timeline");
1857 style_submenu_element("Help", "%R/help?cmd=/timeline");
1858 login_anonymous_available();
1859 timeline_temp_table();
1860 blob_zero(&sql);
1861 blob_zero(&desc);
1862 blob_append(&sql, "INSERT OR IGNORE INTO timeline ", -1);
1863

Keyboard Shortcuts

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