Fossil SCM
Added a warning about EOL normalization of files with mixed EOL styles.
Commit
b83ff3f42192c5b56e4c2c363eef3285cb6476e0a1bddeb916510a2516afa608
Parent
909a48e3788cbba…
1 file changed
+7
-6
+7
-6
| --- www/fileedit-page.md | ||
| +++ www/fileedit-page.md | ||
| @@ -24,11 +24,12 @@ | ||
| 24 | 24 | them. *You Have Been Warned.* |
| 25 | 25 | - Similarly, though every effort is made to retain the end-of-line |
| 26 | 26 | style used by being-edited files, the round-trip through an HTML |
| 27 | 27 | textarea element may change the EOLs. The Commit section of the |
| 28 | 28 | page offers 3 different options for how to treat newlines when |
| 29 | - saving changes. | |
| 29 | + saving changes. Files with mixed EOL styles *will be normalized | |
| 30 | + to a single EOL style* when modified using `/fileedit`. | |
| 30 | 31 | - `/fileedit` **is not a replacement for a checkout**. A full-featured |
| 31 | 32 | checkout allows far more possibilities than this basic online editor |
| 32 | 33 | permits, and the feature scope of `/fileedit` is intentionally kept |
| 33 | 34 | small, implementing only the bare necessities needed for performing |
| 34 | 35 | basic edits online. |
| @@ -103,16 +104,16 @@ | ||
| 103 | 104 | text, and thus the example above limits its work to that type of |
| 104 | 105 | preview. It won't work with `htmlIframe`, as that represents an |
| 105 | 106 | iframe element which contains a complete HTML document. |
| 106 | 107 | - `element`: the DOM element in which the preview is rendered. |
| 107 | 108 | - `mimetype`: the mimetype of the being-previewed content, as determined |
| 108 | - by fossil (by its file extension). | |
| 109 | + by Fossil (by its file extension). | |
| 109 | 110 | |
| 110 | -The event listener callback doesn't use the `mimetype`, but makes used | |
| 111 | -of the other two. It fishes all `code` blocks out of the preview which | |
| 112 | -explicitly have a CSS class named `language-`something, and then asks | |
| 113 | -highlightjs to highlight them. | |
| 111 | +The event listener callback shown above doesn't use the `mimetype`, | |
| 112 | +but makes used of the other two. It fishes all `code` blocks out of | |
| 113 | +the preview which explicitly have a CSS class named | |
| 114 | +`language-`something, and then asks highlightjs to highlight them. | |
| 114 | 115 | |
| 115 | 116 | ## Integrating a Custom Editor Widget |
| 116 | 117 | |
| 117 | 118 | *Hypothetically*, though this is currently unproven "in the wild," it |
| 118 | 119 | is possible to replace `/filepage`'s basic text-editing widget (a |
| 119 | 120 |
| --- www/fileedit-page.md | |
| +++ www/fileedit-page.md | |
| @@ -24,11 +24,12 @@ | |
| 24 | them. *You Have Been Warned.* |
| 25 | - Similarly, though every effort is made to retain the end-of-line |
| 26 | style used by being-edited files, the round-trip through an HTML |
| 27 | textarea element may change the EOLs. The Commit section of the |
| 28 | page offers 3 different options for how to treat newlines when |
| 29 | saving changes. |
| 30 | - `/fileedit` **is not a replacement for a checkout**. A full-featured |
| 31 | checkout allows far more possibilities than this basic online editor |
| 32 | permits, and the feature scope of `/fileedit` is intentionally kept |
| 33 | small, implementing only the bare necessities needed for performing |
| 34 | basic edits online. |
| @@ -103,16 +104,16 @@ | |
| 103 | text, and thus the example above limits its work to that type of |
| 104 | preview. It won't work with `htmlIframe`, as that represents an |
| 105 | iframe element which contains a complete HTML document. |
| 106 | - `element`: the DOM element in which the preview is rendered. |
| 107 | - `mimetype`: the mimetype of the being-previewed content, as determined |
| 108 | by fossil (by its file extension). |
| 109 | |
| 110 | The event listener callback doesn't use the `mimetype`, but makes used |
| 111 | of the other two. It fishes all `code` blocks out of the preview which |
| 112 | explicitly have a CSS class named `language-`something, and then asks |
| 113 | highlightjs to highlight them. |
| 114 | |
| 115 | ## Integrating a Custom Editor Widget |
| 116 | |
| 117 | *Hypothetically*, though this is currently unproven "in the wild," it |
| 118 | is possible to replace `/filepage`'s basic text-editing widget (a |
| 119 |
| --- www/fileedit-page.md | |
| +++ www/fileedit-page.md | |
| @@ -24,11 +24,12 @@ | |
| 24 | them. *You Have Been Warned.* |
| 25 | - Similarly, though every effort is made to retain the end-of-line |
| 26 | style used by being-edited files, the round-trip through an HTML |
| 27 | textarea element may change the EOLs. The Commit section of the |
| 28 | page offers 3 different options for how to treat newlines when |
| 29 | saving changes. Files with mixed EOL styles *will be normalized |
| 30 | to a single EOL style* when modified using `/fileedit`. |
| 31 | - `/fileedit` **is not a replacement for a checkout**. A full-featured |
| 32 | checkout allows far more possibilities than this basic online editor |
| 33 | permits, and the feature scope of `/fileedit` is intentionally kept |
| 34 | small, implementing only the bare necessities needed for performing |
| 35 | basic edits online. |
| @@ -103,16 +104,16 @@ | |
| 104 | text, and thus the example above limits its work to that type of |
| 105 | preview. It won't work with `htmlIframe`, as that represents an |
| 106 | iframe element which contains a complete HTML document. |
| 107 | - `element`: the DOM element in which the preview is rendered. |
| 108 | - `mimetype`: the mimetype of the being-previewed content, as determined |
| 109 | by Fossil (by its file extension). |
| 110 | |
| 111 | The event listener callback shown above doesn't use the `mimetype`, |
| 112 | but makes used of the other two. It fishes all `code` blocks out of |
| 113 | the preview which explicitly have a CSS class named |
| 114 | `language-`something, and then asks highlightjs to highlight them. |
| 115 | |
| 116 | ## Integrating a Custom Editor Widget |
| 117 | |
| 118 | *Hypothetically*, though this is currently unproven "in the wild," it |
| 119 | is possible to replace `/filepage`'s basic text-editing widget (a |
| 120 |