Changeset 2164 for FCKeditor.Java/trunk

Show
Ignore:
Timestamp:
2008-07-03 23:07:36 (5 months ago)
Author:
mosipov
Message:

Reworked the properties.apt

Location:
FCKeditor.Java/trunk/src/site/apt
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • FCKeditor.Java/trunk/src/site/apt/connector.apt

    r2151 r2164  
    8383 
    8484  Supply the fully-qualified class names of the implemented classes as described 
    85   in the {{{properties.html}fonfiguration settings}}. 
     85  in the {{{properties.html}configuration settings}}. 
    8686 
    8787  Right now, the integration pack provides two interfaces to extend the Connector: 
  • FCKeditor.Java/trunk/src/site/apt/properties.apt

    r2151 r2164  
    9393  wish. 
    9494 
    95 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    96 || Property                     || Default                       || Valid Values               || Description                                      || 
    97 ||                                  ||                               ||                            ||                                                  || 
    98 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    99 | connector.resourceType.<type  | /<type name>                       | any path                    | Indicates the resource type path to retrieve and store files. | 
    100 | name>.path                                    |                                                                |                                                         |                                                                                                    | 
    101 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    102 | connector.resourceType.<type  |                                        | any extension                           | List with extensions which should be denied.               | 
    103 | name>.extensions.denied               |                                                                |                                                         | separate extensions with a \| (pipe symbol).               | 
    104 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    105 | connector.resourceType.file.  | 7z\|aiff\|asf\|avi\|bmp\|csv\| | any extension                           | List with extensions which should be allowed.              | 
    106 | extensions.allowed                    | doc\|fla\|flv\|gif\|gz\|gzip\| |                                                         | separate extensions with a \| (pipe symbol).               | 
    107 |                                                               | jpeg\|jpg\|mid\|mov\|mp3\|mp4\||                                                         |                                                                                                    | 
    108 |                                                               | mpc\|mpeg\|mpg\|ods\|odt\|pdf\||                                                         |                                                                                                    | 
    109 |                                                               | png\|ppt\|pxd\|qt\|ram\|rar\|  |                                                         |                                                                                                    | 
    110 |                                                               | rm\|rmi\|rmvb\|rtf\|sdc\|sitd\||                                                         |                                                                                                    | 
    111 |                                                               | swf\|sxc\|sxw\|tar\|tgz\|tif\| |                                                         |                                                                                                    | 
    112 |                                                               | tiff\|txt\|vsd\|wav\|wma\|wmv\||                                                         |                                                                                                    | 
    113 |                                                               | xls\|xml\|zip                                  |                                                         |                                                                                                    | 
    114 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    115 | connector.resourceType.flash. | swf\|fla                                               | any extension                           | See above.                                                                                 | 
    116 | extensions.allowed                    |                                                                |                                                         |                                                                                                    | 
    117 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    118 | connector.resourceType.image. | bmp\|gif\|jpeg\|jpg\|png               | any extension                           | See above.                                                                                 | 
    119 | extensions.allowed                    |                                                                |                                                         |                                                                                                    | 
    120 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    121 | connector.resourceType.media. | aiff\|asf\|avi\|bmp\|fla\|flv\|| any extension                           | See above.                                                                                 | 
    122 | extensions.allowed                    | gif\|jpeg\|jpg\|mid\|mov\|mp3\||                                                         |                                                                                                    | 
    123 |                                                               | mp4\|mpc\|mpeg\|mpg\|png\|qt\| |                                                         |                                                                                                    | 
    124 |                                                               | ram\|rm\|rmi\|rmvb\|swf\|tif\| |                                                         |                                                                                                    | 
    125 |                                                               | tiff\|wav\|wma\|wmv                    |                                                         |                                                                                                    | 
    126 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    127 | connector.userFilesPath               | /userfiles                                     | any path                                        | Indicates the path where files are stored.                 | 
    128 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    129 | connector.forceSingleExtension| true                                                   | true, false (boolean)           | Indicates whether file names with multiple extensions are sanitzed.| 
    130 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    131 | connector.fullUrl                     | false                          | true, false (boolean)           | Indicates whether the server url will be prepended.| 
    132 |                                                               |                                                                |                                                         | I.e. prepending http://www.yourdomain.com                  | 
    133 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    134 | connector.secureImageUploads  |true                                                    | true, false (boolean)           | Checks uploaded images for validity.                               | 
    135 |                                                               |                                                                |                                                         | I.e. the uploaded file is a real image and not any | 
    136 |                                                               |                                                                |                                                         | other renamed file type.                                                   | 
    137 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    138 | connector.userActionImpl              |                                                                | any class implementing the  | Provides custom security functions for the File        | 
    139 |                                                               |                                                                | {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}} | Browser Connector. For more details see         | 
    140 |                                                               |                                                                | interface                       | {{{connector.html}here}}. | 
    141 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
    142 | connector.userPathBuilderImpl |                                                                | any class implementing the  | Provides a custom function to construct a user-dependent <<<UserFilesPath>>> for the | 
    143 |                                                               |                                                                | {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | File Browser Connector. For more details see          | 
    144 |                                                               |                                                                | interface                       | {{{connector.html}here}}. | 
    145 *-------------------------------+--------------------------------+-----------------------------+----------------------------------------------------+ 
     95*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     96|| Property                     || Default                                                                      || Valid Values             || Description                                     || 
     97*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     98| connector.resourceType.<type  | /<type name>                                                          | any path                                      | Indicates the resource type path to retrieve and      | 
     99| name>.path                                    |                                                                                       |                                                       | store files.                                                                          | 
     100*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     101| connector.resourceType.<type  |                                                                                       | any extension                         | List with extensions which should be denied.          | 
     102| name>.extensions.denied               |                                                                                       |                                                       | Separate extensions with a \| (pipe symbol).          | 
     103*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     104| connector.resourceType.file.  | 7z\|aiff\|asf\|avi\|bmp\|csv\|doc\|fla\|      | any extension                         | List with extensions which should be allowed.         | 
     105| extensions.allowed                    | flv\|gif\|gz\|gzip\|jpeg\|jpg\|mid\|mov\|     |                                                       | Separate extensions with a \| (pipe symbol).          | 
     106|                                                               | mp3\|mp4\|mpc\|mpeg\| mpg\|ods\|                      |                                                       |                                                                                                       | 
     107|                                                               | odt\|pdf\|png\|ppt\|pxd\|qt\|ram\|rar\|       |                                                       |                                                                                                       | 
     108|                                                               | rm\|rmi\|rmvb\|rtf\|sdc\|sitd\|swf\|          |                                                       |                                                                                                       | 
     109|                                                               | sxc\|sxw\|tar\|tgz\|tif\|tiff\|txt\|vsd\| |                                                   |                                                                                                       | 
     110|                                                               | wav\|wma\|wmv\|xls\|xml\|zip                          |                                                       |                                                                                                       | 
     111*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     112| connector.resourceType.flash. | swf\|fla                                                                      | any extension                         | See above.                                                                            | 
     113| extensions.allowed                    |                                                                                       |                                                       |                                                                                                       | 
     114*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     115| connector.resourceType.image. | bmp\|gif\|jpeg\|jpg\|png                                      | any extension                         | See above.                                                                            | 
     116| extensions.allowed                    |                                                                                       |                                                       |                                                                                                       | 
     117*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     118| connector.resourceType.media. | aiff\|asf\|avi\|bmp\|fla\|flv\|gif\|jpeg\|| any extension                             | See above.                                                                            | 
     119| extensions.allowed                    | jpg\|mid\|mov\|mp3\|mp4\|mpc\|mpg\|           |                                                       |                                                                                                       | 
     120|                                                               | mpeg\|png\|qt\|ram\|rm\|rmi\|rmvb\|           |                                                       |                                                                                                       | 
     121|                                                               | swf\|tif\|tiff\|wav\|wma\|wmv                         |                                                       |                                                                                                       | 
     122*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     123| connector.userFilesPath               | /userfiles                                                            | any path                                      | Indicates the path where files are stored.            | 
     124*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     125| connector.forceSingleExtension| true                                                                          | true, false (boolean)         | Indicates whether filenames with multiple             | 
     126|                                                               |                                                                                       |                                                       | extensions are sanitized.                                                     | 
     127*-------------------------------+-------------------------------------------+-------------------------- +---------------------------------------------------+ 
     128| connector.fullUrl                     | false                                                                         | true, false (boolean)         | Indicates whether the domain name will be                     | 
     129|                                                               |                                                                                       |                                                       | prepended. E.g. <<<http://www.mysite.com>>>           | 
     130*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     131| connector.secureImageUploads  |true                                                                           | true, false (boolean)         | Checks uploaded images for validity.                          | 
     132|                                                               |                                                                                       |                                                       | I.e. the uploaded file is a real image and not any| 
     133|                                                               |                                                                                       |                                                       | other renamed file type.                                                      | 
     134*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     135| connector.userActionImpl              |                                                                                       | any fully-qualified class     | Provides custom security functions for the File       | 
     136|                                                               |                                                                                       | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserAction.html}<<<UserAction>>>}}  | Browser Connector. For more details see {{{connector.html}here}}. | 
     137|                                                               |                                                                                       | implementation                        |                                                                                                       | 
     138*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+ 
     139| connector.userPathBuilderImpl |                                                                                       | any fully-qualified class     | Provides a custom function for constructing a user-dependent <<<UserFilesPath>>> for the File | 
     140|                                                               |                                                                                       | name of a valid {{{java-core/apidocs/net/fckeditor/requestcycle/UserPathBuilder.html}<<<UserPathBuilder>>>}} | Browser Connector. For more details see {{{connector.html}here}}. | 
     141|                                                               |                                                                                       | implementation                        |                                                                                                       | 
     142*-------------------------------+-------------------------------------------+---------------------------+---------------------------------------------------+