Changes between Version 7 and Version 8 of EditFilesPlugin

Timestamp:

Dec 23, 2016, 7:38:32 PM (7 years ago)

Author:

figaro

Comment:

Moved example to functional description

EditFilesPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-= Edit Files Plugin
+= Edit files from within Trac
 
 == Description
 
-A plugin that allows TRAC_ADMIN to edit files on the Trac server. Files can be specified in the configuration file. Paths may be absolute, or relative to the Trac environment. The user running the server must have appropriate permissions for the files in order to view or save them.  
+This is a plugin that allows Trac administrators (`TRAC_ADMIN`) to edit files on the Trac server. The editable files can be specified in the configuration file. Paths may be absolute, or relative to the Trac environment. The user running the server must have appropriate permissions for the files in order to view or save them.  
+
+Sample `trac.ini` file with the editable files listed in the custom `[edit_file]` section:
+{{{#!ini
+[edit_file]
+files = conf/trac.ini, /home/matt/public_html/notebook/TRACI/auth.db
+}}}
+
+'''Note''': Relative paths will be computed relative to the location of `trac.ini`. Most Trac instances are laid out with folders like `conf/`, `db/`, `htdocs/` and so on. If your `trac.ini` file is in an odd place, this may not work the way you expect and you might want to use absolute paths instead. 
 
 == Bugs/Feature Requests
@@ -29 +37 @@
 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 
-== Example
-
-{{{#!ini
-[edit_file]
-files = conf/trac.ini, /home/matt/public_html/notebook/TRACI/auth.db
-}}}
-
-'''Note''': relative paths will be computed relative to the location of `trac.ini`. Most Trac instances are laid out with folders like conf/, db/, htdocs/, and so on. If your `trac.ini` file is in an odd place, this may not work the way you expect and you might want to be sure and use absolute paths. 
-
 == Recent Changes