Fossil SCM
Doc tweaks only - no code changes.
Commit
b5496da66fd49fc12c1a1351a54186fdd62916eefe7f7661c7f9a3ed2837aa79
Parent
9120ff5faa21fad…
2 files changed
+36
-18
+2
-2
+36
-18
| --- src/fileedit.c | ||
| +++ src/fileedit.c | ||
| @@ -1531,42 +1531,60 @@ | ||
| 1531 | 1531 | } |
| 1532 | 1532 | |
| 1533 | 1533 | /* |
| 1534 | 1534 | ** WEBPAGE: fileedit |
| 1535 | 1535 | ** |
| 1536 | -** Enables the online editing and committing of individual text files. | |
| 1537 | -** Requires that the user have Write permissions. | |
| 1536 | +** Enables the online editing and committing of text files. Requires | |
| 1537 | +** that the user have Write permissions and that a user with setup | |
| 1538 | +** permissions has set the fileedit-glob setting to a list of glob | |
| 1539 | +** patterns matching files which may be edited (e.g. "*.wiki,*.md"). | |
| 1540 | +** Note that fileedit-glob, by design, is a local-only setting. | |
| 1541 | +** It does not sync across repository clones, and must be explicitly | |
| 1542 | +** set on any repositories where this page should be activated. | |
| 1538 | 1543 | ** |
| 1539 | 1544 | ** Optional query parameters: |
| 1540 | 1545 | ** |
| 1541 | 1546 | ** filename=FILENAME Repo-relative path to the file. |
| 1542 | 1547 | ** checkin=VERSION Checkin version, using any unambiguous |
| 1543 | -** supported symbolic version name. | |
| 1544 | -** | |
| 1545 | -** Internal-use parameters: | |
| 1546 | -** | |
| 1547 | -** name=string The name of a page-specific AJAX operation. | |
| 1548 | -** | |
| 1549 | -** Noting that fossil internally stores all URL path components after | |
| 1550 | -** the first as the "name" value. Thus /fileedit?name=blah is | |
| 1551 | -** equivalent to /fileedit/blah. The latter is the preferred | |
| 1552 | -** form. This means, however, that no fileedit ajax routes may make | |
| 1553 | -** use of the name parameter. | |
| 1554 | -** | |
| 1555 | -** Which additional parameters are used by each distinct ajax value is | |
| 1556 | -** an internal implementation detail and may change with any given | |
| 1557 | -** build of this code. An unknown "name" value triggers an error, as | |
| 1558 | -** documented for ajax_route_error(). | |
| 1548 | +** symbolic version name. | |
| 1549 | +** | |
| 1550 | +** If passed a filename but no checkin then it will attempt to | |
| 1551 | +** load that file from the most recent leaf checkin. | |
| 1552 | +** | |
| 1553 | +** Once the page is loaded, files may be selected from any open leaf | |
| 1554 | +** version. The only way to edit files from non-leaf checkins is to | |
| 1555 | +** pass both the filename and checkin as URL parameters to the page. | |
| 1556 | +** Users with the proper permissions will be presented with "Edit" | |
| 1557 | +** links in various file-specific contexts for files which match the | |
| 1558 | +** fileedit-glob, regardless of whether they refer to leaf versions or | |
| 1559 | +** not. | |
| 1559 | 1560 | */ |
| 1560 | 1561 | void fileedit_page(void){ |
| 1561 | 1562 | const char * zFileMime = 0; /* File mime type guess */ |
| 1562 | 1563 | CheckinMiniInfo cimi; /* Checkin state */ |
| 1563 | 1564 | int previewRenderMode = AJAX_RENDER_GUESS; /* preview mode */ |
| 1564 | 1565 | Blob err = empty_blob; /* Error report */ |
| 1565 | 1566 | const char *zAjax = P("name"); /* Name of AJAX route for |
| 1566 | 1567 | sub-dispatching. */ |
| 1567 | 1568 | |
| 1569 | + /* | |
| 1570 | + ** Internal-use URL parameters: | |
| 1571 | + ** | |
| 1572 | + ** name=string The name of a page-specific AJAX operation. | |
| 1573 | + ** | |
| 1574 | + ** Noting that fossil internally stores all URL path components | |
| 1575 | + ** after the first as the "name" value. Thus /fileedit?name=blah is | |
| 1576 | + ** equivalent to /fileedit/blah. The latter is the preferred | |
| 1577 | + ** form. This means, however, that no fileedit ajax routes may make | |
| 1578 | + ** use of the name parameter. | |
| 1579 | + ** | |
| 1580 | + ** Which additional parameters are used by each distinct ajax route | |
| 1581 | + ** is an internal implementation detail and may change with any | |
| 1582 | + ** given build of this code. An unknown "name" value triggers an | |
| 1583 | + ** error, as documented for ajax_route_error(). | |
| 1584 | + */ | |
| 1585 | + | |
| 1568 | 1586 | /* Allow no access to this page without check-in privilege */ |
| 1569 | 1587 | login_check_credentials(); |
| 1570 | 1588 | if( !g.perm.Write ){ |
| 1571 | 1589 | if(zAjax!=0){ |
| 1572 | 1590 | ajax_route_error(403, "Write permissions required."); |
| 1573 | 1591 |
| --- src/fileedit.c | |
| +++ src/fileedit.c | |
| @@ -1531,42 +1531,60 @@ | |
| 1531 | } |
| 1532 | |
| 1533 | /* |
| 1534 | ** WEBPAGE: fileedit |
| 1535 | ** |
| 1536 | ** Enables the online editing and committing of individual text files. |
| 1537 | ** Requires that the user have Write permissions. |
| 1538 | ** |
| 1539 | ** Optional query parameters: |
| 1540 | ** |
| 1541 | ** filename=FILENAME Repo-relative path to the file. |
| 1542 | ** checkin=VERSION Checkin version, using any unambiguous |
| 1543 | ** supported symbolic version name. |
| 1544 | ** |
| 1545 | ** Internal-use parameters: |
| 1546 | ** |
| 1547 | ** name=string The name of a page-specific AJAX operation. |
| 1548 | ** |
| 1549 | ** Noting that fossil internally stores all URL path components after |
| 1550 | ** the first as the "name" value. Thus /fileedit?name=blah is |
| 1551 | ** equivalent to /fileedit/blah. The latter is the preferred |
| 1552 | ** form. This means, however, that no fileedit ajax routes may make |
| 1553 | ** use of the name parameter. |
| 1554 | ** |
| 1555 | ** Which additional parameters are used by each distinct ajax value is |
| 1556 | ** an internal implementation detail and may change with any given |
| 1557 | ** build of this code. An unknown "name" value triggers an error, as |
| 1558 | ** documented for ajax_route_error(). |
| 1559 | */ |
| 1560 | void fileedit_page(void){ |
| 1561 | const char * zFileMime = 0; /* File mime type guess */ |
| 1562 | CheckinMiniInfo cimi; /* Checkin state */ |
| 1563 | int previewRenderMode = AJAX_RENDER_GUESS; /* preview mode */ |
| 1564 | Blob err = empty_blob; /* Error report */ |
| 1565 | const char *zAjax = P("name"); /* Name of AJAX route for |
| 1566 | sub-dispatching. */ |
| 1567 | |
| 1568 | /* Allow no access to this page without check-in privilege */ |
| 1569 | login_check_credentials(); |
| 1570 | if( !g.perm.Write ){ |
| 1571 | if(zAjax!=0){ |
| 1572 | ajax_route_error(403, "Write permissions required."); |
| 1573 |
| --- src/fileedit.c | |
| +++ src/fileedit.c | |
| @@ -1531,42 +1531,60 @@ | |
| 1531 | } |
| 1532 | |
| 1533 | /* |
| 1534 | ** WEBPAGE: fileedit |
| 1535 | ** |
| 1536 | ** Enables the online editing and committing of text files. Requires |
| 1537 | ** that the user have Write permissions and that a user with setup |
| 1538 | ** permissions has set the fileedit-glob setting to a list of glob |
| 1539 | ** patterns matching files which may be edited (e.g. "*.wiki,*.md"). |
| 1540 | ** Note that fileedit-glob, by design, is a local-only setting. |
| 1541 | ** It does not sync across repository clones, and must be explicitly |
| 1542 | ** set on any repositories where this page should be activated. |
| 1543 | ** |
| 1544 | ** Optional query parameters: |
| 1545 | ** |
| 1546 | ** filename=FILENAME Repo-relative path to the file. |
| 1547 | ** checkin=VERSION Checkin version, using any unambiguous |
| 1548 | ** symbolic version name. |
| 1549 | ** |
| 1550 | ** If passed a filename but no checkin then it will attempt to |
| 1551 | ** load that file from the most recent leaf checkin. |
| 1552 | ** |
| 1553 | ** Once the page is loaded, files may be selected from any open leaf |
| 1554 | ** version. The only way to edit files from non-leaf checkins is to |
| 1555 | ** pass both the filename and checkin as URL parameters to the page. |
| 1556 | ** Users with the proper permissions will be presented with "Edit" |
| 1557 | ** links in various file-specific contexts for files which match the |
| 1558 | ** fileedit-glob, regardless of whether they refer to leaf versions or |
| 1559 | ** not. |
| 1560 | */ |
| 1561 | void fileedit_page(void){ |
| 1562 | const char * zFileMime = 0; /* File mime type guess */ |
| 1563 | CheckinMiniInfo cimi; /* Checkin state */ |
| 1564 | int previewRenderMode = AJAX_RENDER_GUESS; /* preview mode */ |
| 1565 | Blob err = empty_blob; /* Error report */ |
| 1566 | const char *zAjax = P("name"); /* Name of AJAX route for |
| 1567 | sub-dispatching. */ |
| 1568 | |
| 1569 | /* |
| 1570 | ** Internal-use URL parameters: |
| 1571 | ** |
| 1572 | ** name=string The name of a page-specific AJAX operation. |
| 1573 | ** |
| 1574 | ** Noting that fossil internally stores all URL path components |
| 1575 | ** after the first as the "name" value. Thus /fileedit?name=blah is |
| 1576 | ** equivalent to /fileedit/blah. The latter is the preferred |
| 1577 | ** form. This means, however, that no fileedit ajax routes may make |
| 1578 | ** use of the name parameter. |
| 1579 | ** |
| 1580 | ** Which additional parameters are used by each distinct ajax route |
| 1581 | ** is an internal implementation detail and may change with any |
| 1582 | ** given build of this code. An unknown "name" value triggers an |
| 1583 | ** error, as documented for ajax_route_error(). |
| 1584 | */ |
| 1585 | |
| 1586 | /* Allow no access to this page without check-in privilege */ |
| 1587 | login_check_credentials(); |
| 1588 | if( !g.perm.Write ){ |
| 1589 | if(zAjax!=0){ |
| 1590 | ajax_route_error(403, "Write permissions required."); |
| 1591 |
+2
-2
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -16,12 +16,12 @@ | ||
| 16 | 16 | Do not allow "fossil open" to open in a non-empty working directory |
| 17 | 17 | unless the --keep option or the new --force option is used. |
| 18 | 18 | * Enhance the markdown formatter to more closely follow the |
| 19 | 19 | [https://spec.commonmark.org/0.29/#emphasis-and-strong-emphasis|CommonMark specification] |
| 20 | 20 | with regard to text highlighting. |
| 21 | - Underscores in the middle of identifiers (ex: fossil_printf() | |
| 22 | - no longer need to be escaped). | |
| 21 | + Underscores in the middle of identifiers (ex: fossil_printf()) | |
| 22 | + no longer need to be escaped. | |
| 23 | 23 | * The markdown-to-html translator can prevent unsafe HTML |
| 24 | 24 | (for example: <script>) on user-contributed pages like forum and |
| 25 | 25 | tickets and wiki. The admin can adjust this behavior using |
| 26 | 26 | the [/help?cmd=safe-html|safe-html setting] on the Admin/Wiki page. |
| 27 | 27 | The default is to disallow unsafe HTML everywhere. |
| 28 | 28 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -16,12 +16,12 @@ | |
| 16 | Do not allow "fossil open" to open in a non-empty working directory |
| 17 | unless the --keep option or the new --force option is used. |
| 18 | * Enhance the markdown formatter to more closely follow the |
| 19 | [https://spec.commonmark.org/0.29/#emphasis-and-strong-emphasis|CommonMark specification] |
| 20 | with regard to text highlighting. |
| 21 | Underscores in the middle of identifiers (ex: fossil_printf() |
| 22 | no longer need to be escaped). |
| 23 | * The markdown-to-html translator can prevent unsafe HTML |
| 24 | (for example: <script>) on user-contributed pages like forum and |
| 25 | tickets and wiki. The admin can adjust this behavior using |
| 26 | the [/help?cmd=safe-html|safe-html setting] on the Admin/Wiki page. |
| 27 | The default is to disallow unsafe HTML everywhere. |
| 28 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -16,12 +16,12 @@ | |
| 16 | Do not allow "fossil open" to open in a non-empty working directory |
| 17 | unless the --keep option or the new --force option is used. |
| 18 | * Enhance the markdown formatter to more closely follow the |
| 19 | [https://spec.commonmark.org/0.29/#emphasis-and-strong-emphasis|CommonMark specification] |
| 20 | with regard to text highlighting. |
| 21 | Underscores in the middle of identifiers (ex: fossil_printf()) |
| 22 | no longer need to be escaped. |
| 23 | * The markdown-to-html translator can prevent unsafe HTML |
| 24 | (for example: <script>) on user-contributed pages like forum and |
| 25 | tickets and wiki. The admin can adjust this behavior using |
| 26 | the [/help?cmd=safe-html|safe-html setting] on the Admin/Wiki page. |
| 27 | The default is to disallow unsafe HTML everywhere. |
| 28 |