Fossil SCM

Added a section to javascript.md on the new /fileedit feature.

wyoung 2020-08-19 21:19 trunk
Commit 100b4868ddf070040caa90c7f9d7a6b477da9ca417b2d0ac7dd2bc8a7a089b08
1 file changed +29
--- www/javascript.md
+++ www/javascript.md
@@ -224,10 +224,39 @@
224224
reader.
225225
226226
[fwc]: /help?cmd=wiki
227227
[fwt]: ./wikitheory.wiki
228228
229
+
230
+### <a id="fedit"></a>The File Editor
231
+
232
+Fossil 2.12 adds the [optional file editor feature][fedit], which works
233
+much like [the new wiki editor](#wedit), only on files committed to the
234
+repository.
235
+
236
+The original designed purpose for this feature is to allow [embedded
237
+documentation][edoc] to be interactively edited in the same way that
238
+wiki articles can be. (Indeed, the associated `fileedit-glob` feature
239
+allows you to restrict the editor to working *only* on files that can be
240
+treated as embedded documentation.) This feature operates in much the
241
+same way as the new wiki editor, so most of what we said above applies.
242
+
243
+_Workaround:_ This feature is an alternative to Fossil’s traditional
244
+mode of file management: clone the repository, open it somewhere, edit a
245
+file locally, and commit the changes.
246
+
247
+_Graceful Fallback:_ There is no technical reason why someone could not
248
+write a `<noscript>` wrapped alternative to the current JavaScript based
249
+`/fileedit` implementation. It would have all of the same downsides as
250
+the old wiki editor: the users would lose their place on each save, they
251
+would have no local backup if something crashes, etc. Still, we are
252
+likely to accept such a [contribution][cg] as long as it doesn’t
253
+interfere with the new editor.
254
+
255
+[edoc]: /doc/trunk/www/embeddeddoc.wiki
256
+[fedit]: /help?cmd=/fileedit
257
+
229258
230259
### <a id="ln"></a>Line Numbering
231260
232261
When viewing source files, Fossil offers to show line numbers in some
233262
cases. ([Example][mainc].) Toggling them on and off is currently handled
234263
--- www/javascript.md
+++ www/javascript.md
@@ -224,10 +224,39 @@
224 reader.
225
226 [fwc]: /help?cmd=wiki
227 [fwt]: ./wikitheory.wiki
228
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
229
230 ### <a id="ln"></a>Line Numbering
231
232 When viewing source files, Fossil offers to show line numbers in some
233 cases. ([Example][mainc].) Toggling them on and off is currently handled
234
--- www/javascript.md
+++ www/javascript.md
@@ -224,10 +224,39 @@
224 reader.
225
226 [fwc]: /help?cmd=wiki
227 [fwt]: ./wikitheory.wiki
228
229
230 ### <a id="fedit"></a>The File Editor
231
232 Fossil 2.12 adds the [optional file editor feature][fedit], which works
233 much like [the new wiki editor](#wedit), only on files committed to the
234 repository.
235
236 The original designed purpose for this feature is to allow [embedded
237 documentation][edoc] to be interactively edited in the same way that
238 wiki articles can be. (Indeed, the associated `fileedit-glob` feature
239 allows you to restrict the editor to working *only* on files that can be
240 treated as embedded documentation.) This feature operates in much the
241 same way as the new wiki editor, so most of what we said above applies.
242
243 _Workaround:_ This feature is an alternative to Fossil’s traditional
244 mode of file management: clone the repository, open it somewhere, edit a
245 file locally, and commit the changes.
246
247 _Graceful Fallback:_ There is no technical reason why someone could not
248 write a `<noscript>` wrapped alternative to the current JavaScript based
249 `/fileedit` implementation. It would have all of the same downsides as
250 the old wiki editor: the users would lose their place on each save, they
251 would have no local backup if something crashes, etc. Still, we are
252 likely to accept such a [contribution][cg] as long as it doesn’t
253 interfere with the new editor.
254
255 [edoc]: /doc/trunk/www/embeddeddoc.wiki
256 [fedit]: /help?cmd=/fileedit
257
258
259 ### <a id="ln"></a>Line Numbering
260
261 When viewing source files, Fossil offers to show line numbers in some
262 cases. ([Example][mainc].) Toggling them on and off is currently handled
263

Keyboard Shortcuts

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