summaryrefslogtreecommitdiff
path: root/sites/all/modules/ckeditor_link_file/readme.txt
blob: cfcb90c9c7bf28060e698b67c98e9f89d050a0dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Usage
 * Sponsors

INTRODUCTION
------------

Current Maintainers:

 * Devin Carlson <http://drupal.org/user/290182>

CKEditor Link File provides integration between CKEditor Link and File entity,
allowing editors to link to files from within CKEditor.

CKEditor Link File gives editors three important tools:

 * A simple method of linking to existing files (promoting file reuse and
   helping to eliminate duplicate files).
 * The ability to link to files, file URLs or file downloads (configurable by an
   administrator).
 * The ability to restrict links to certain file types such as audio, video,
   images or documents (configurable by an administrator).

REQUIREMENTS
------------

CKEditor Link File has two dependencies.

Contributed modules
 * CKEditor Link
 * File entity

INSTALLATION
------------

To install CKEditor Link File:

 * CKEditor Link File can be installed using the standard module installation
   process (http://drupal.org/documentation/install/modules-themes/modules-7).

USAGE
-----

CKEditor Link File adds file support to CKEditor Link.

With CKEditor Link File installed, users can link to files in addition to menu
items, taxonomy terms and nodes which CKEditor Link supports out of the box.

CKEditor Link File provides three file link methods: file, URL and download.
 * File
    Provide a link to view the file entity itself (file/%fid)
 * URL
    Link to a web-accessible URL of the file (example.com/files/image.jpg)
 * Download
    A special link to the file which forces the visitor's browser to download
    the file instead of opening it.

Sponsors
--------

Development of CKEditor Link File is sponsored by the Ontario Ministry of
Northern Development and Mines (http://www.mndm.gov.on.ca).