-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
214 lines (156 loc) · 17.9 KB
/
readme.txt
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
=== Document Library Lite ===
Contributors: barn2media
Donate link: https://barn2.com
Tags: document library, file manager, download manager, document management, media library
Requires at least: 6.1
Tested up to: 6.7
Requires PHP: 7.4
Stable tag: 1.1.2
License: GPL-3.0
License URI: https://www.gnu.org/licenses/gpl.html
Create a WordPress document library to manage, search and download files.
== Description ==
*Document Library Lite* creates a WordPress document library/download manager. It displays documents in a table layout and allows users to quickly search for, sort and download documents.
View the [plugin demo](https://documentlibrary-free.barn2.com/) to see it in action.
https://www.youtube.com/watch?v=K0H-9FUQgW0
### Features
* Easy document management - add documents of any file type, plus all the document data you want to display.
* List documents in searchable, sortable tables.
* Choose any or all of the following columns: ID, image, title, content, date, categories, plus download button.
* List all files in your document library, or list them by category or status.
* 100% responsive - works on any screen size or mobile device.
Supports the following file types:
* PDF
* DOC, DOCX (Microsoft Word)
* XLS, XLSX (Microsoft Excel)
* PPT, PPTX, PPS, PPSX (Microsoft PowerPoint)
* ODT, ODS, ODP (OpenDocument Format)
* JPG, JPEG, PNG, SVG (image files)
* MP4, MOV (video files)
* .numbers, .pages, .key (Apple document formats)
* And many more
The plugin adds a dedicated 'Documents' section to the Media Library where you can manage documents separately from images and other media types. If you’ve ever wanted Media Library categories then you can filter the media library to view document files only.
The document library makes things easier for your users. Instead of having to read through a long list of document links, they can use the instant search box, sortable columns and category filters to find exactly what they’re looking for. They can click to download documents of any file type straight to their device.
To get started with the WordPress download manager plugin, simply install the plugin, start adding documents and they will instantly appear on the ‘Document Library’ page. You can also use the `[doc_library]` shortcode to insert document libraries anywhere.
### Document Library Pro
Our [Pro version](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) adds lots more functionality to take your WordPress document management to the next level.
[View free & pro comparison table](https://barn2.com/kb/document-library-plugins-free-pro-comparison/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg)
* **Bulk upload** - Add files using drag and drop file upload, CSV import, or import Media Library files to the download manager.
* **Extra layout options** - Display documents in a beautiful grid layout, and optionally structure the WordPress document library into collapsible folders.
* **Add extra columns** - File size, file type, document excerpt, status, last modified date, author, plus custom fields and custom taxonomies. You can also rename the column headings of the document library. Advanced Custom Fields and ACF Pro support.
* **Individual document pages** - Create a separate page for each document.
* **Host documents on third party sites** - As well as displaying files from the Media Library, your WordPress download manager can include documents hosted on third party sites such as Dropbox, Google Drive, and Office 365.
* **Control which downloads to list** - Display documents based on additional factors including author, post type, taxonomy term, custom field, year, month, day, or ID. You can also exclude documents from the file manager by ID or category.
* **Filter dropdowns** - Make it easier for people to find specific documents by adding filter dropdowns for categories, tags and taxonomies.
* **Standalone document search** - As well as the AJAX search box above the document library, you can use the ‘Document search’ widget or [doc_search] shortcode to add a search box anywhere on your site. For example, you can use this to display a ‘Find Downloads’ search box to the homepage, site header, or sidebar.
* **Flexible document links** - Control the links in your WordPress document library including choosing which columns are clickable and opening links in a new tab.
* **Multiple document download** - Allow users to select multiple documents and download them together in a handy zip file.
* **Instant document preview** - Display ‘Preview’ buttons so that users can view documents without downloading them.
* **Display audio and video** - As well as downloadable documents, display embedded audio and video players directly in the WordPress document library.
* **Caching** - Speed up load times with built-in caching.
* **Compatibility with third party plugins** - Tested with [dozens of other plugins](https://barn2.com/kb/dlp-plugin-compatibility/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg).
* **And much more** - PLUS get dozens of extra features for added flexibility, such as the ability to show and hide each part of the WordPress download manager, customize the colors, and more.
### How to Create a WordPress File Manager
You can use *Document Library Lite* to create a download manager which lists documents of any file type. It’s perfect for creating a WordPress document library, resource library, download management, file manager, audio library, video gallery, and much more.
First, install the plugin and choose your settings at **Documents > Settings**. This page gives you full control over the WordPress file manager including which columns to display, and the text of the document download button.
Next, you can start adding documents at **Documents > Add New**. The plugin automatically adds a 'Document Library' page to your WordPress site. This page lists all your documents in a searchable, sortable table. Each file in the download manager appears as a separate row of the table, complete with helpful information such as the filename and summary description. This helps users to learn more about each document before downloading the file to their computer.
For more flexibility, you can use the `[doc_library]` shortcode to list different downloads on different parts of your site. Use the [shortcode options](https://barn2.com/kb/document-library-wordpress-documentation/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg#doc-library-shortcode) to override the global settings and apply different options to each document library. And don’t forget, you can get dozens more shortcode options with our premium [Document Library Pro](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) plugin!
### Full List of Features
* Add documents, document data, and upload a file for each document.
* Supports all file types.
* Built-in ‘Document Library’ page which automatically lists all your downloads.
* `[doc_library]` shortcode for added flexibility.
* List documents in a table with sortable columns.
* Choice of 6 styles for your document download links including buttons, download icons, file type icons, and text.
* Instant AJAX search box to find documents more quickly.
* 'Search on click' feature to filter the WordPress file manager by clicking on a document category.
* Display the number of documents in the table, and allow users to change this number.
* For easier WordPress document management, you can filter the Media Library to view document files only.
* Structure the download manager into categories.
* Choose the number of downloads per page in the document library.
* Optional lazy load setting to list unlimited documents with no performance limitations.
* Change how the WordPress document library is sorted, and customize the sort order for your file manager.
* Display the document featured image and allow users to open the image and view it in a lightbox.
* Configure your file manager centrally on the plugin settings page, and instantly update all your document lists (except where you have overridden specific options in the shortcode).
* Developed, maintained and supported by Barn2 Plugins.
View the [plugin documentation](https://barn2.com/kb/document-library-wordpress-documentation/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) for full details.
### Shortcode options
Options for the `[doc_library]` shortcode:
* **content** - The columns to display in the document library. This can be any combination of the following (comma-separated): id, image, title, content, categories, or date.
* **doc_category** - List downloads from a specific category only.
* **status** - List documents based on their status (e.g. published/draft/private).
* **lightbox** - Enable or disable the feature which opens document featured images in a lightbox modal window.
* **docs_per_page** - Change the number of documents on each page of the library.
* **link_style** - Choose the style of the document download links. This can be any of the following: button, button_icon_text, button_icon, icon_only, icon, or text.
* **lazy_load** - List unlimited documents with no performance limitations.
* **sort_by** - Override the sort order of the WordPress download manager library.
* **sort_order** - Choose whether files are ordered alphabetically in ascending or descending order.
* **scroll_offset** - If your theme has a sticky header then you can use this option to ensure that users are jumped to the correct point of the page when they use the pagination buttons at the bottom of the WordPress document library.
* **wrap** - By default, if the document library contains too much text to fit on one row then it wraps onto multiple rows. If you prefer, then you can truncate the text and ensure that each download only takes up 1 row of the library. This helps to save space if you have a large download manager table.
* **search_on_click** - Allow users to click on a category in the ‘Document categories’ column in order to filter the download library by that column.
For example: `[doc_library doc_category="meetings" content="title,content,link" sort_by="date"]`
View the [full documentation](https://barn2.com/kb/document-library-wordpress-documentation?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg#doc-library-shortcode), check out the [demo](https://documentlibrary-free.barn2.com/), and if you need more features then have a look at [Document Library Pro](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg).
Thank you for using our WordPress document library plugin 🙂
== Installation ==
1. Upload the plugin files to the `/wp-content/plugins/document-library-lite` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the **Plugins** screen in WordPress.
3. Follow the setup wizard or go to **Documents > Settings** and configure your document libraries.
4. View your document library by going to the Document Library page.
== Frequently Asked Questions ==
= How does the free WordPress document library plugin work? =
This free download and file manager plugin adds a 'Documents' section to the WordPress admin. This is where you add and manage your downloadable files.
Each document is added as a separate 'Post' within the Document Manager. You add all the information that you want to display about the document, such as the title and a short description. Of course, you also upload a downloadable file. This is what people will click on in order to download the document to their computer/mobile device.
Once you have added the documents to the library, they will appear in a searchable table on the front end of your website. They appear on a page called ‘Document Library’.
= What information can I list in the document library? =
To control which columns appear on the list of downloads, enter a comma separated list of the following options. You should enter this on the plugin settings page to set the columns for all your document libraries, or enter it as a shortcode option. For example, you might enter title, content, link to create a library containing 3 columns.
* **id** - The document's WordPress database ID.
* **title** - The document title.
* **content** - The document description or summary that you entered on the 'Add Document' page.
* **image** - The document's featured image.
* **date** - The date that the document was added to your WordPress site.
* **doc_categories** - A comma separated list of the document categories.
* **link** - A download button for each file.
= Do I have to list all the file downloads on the same page? =
The main ‘Document Library’ page will list all your documents, and you can delete this if you don’t need it. Instead, you can use the `[doc_library]` shortcode to list different documents in different parts of your WordPress website. For example, you can list documents by category.
See the complete list of shortcode options above
= Is there a maximum number of documents? =
With the free WordPress document library plugin, the number of documents depends on the overall speed of your website and how good your hosting is. Most sites can happily list several dozen documents per page.
If you want to list hundreds (or even thousands) of downloads on the same page, then we recommend upgrading to [Document Library Pro](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg). This comes with built-in lazy load and caching options which allow you to list an unlimited number of documents without any performance issues.
= Can I make the document library private? =
If you want a private WordPress file manager then we recommend using *Document Library Lite* with our other plugin, [Password Protected Categories](https://barn2.com/wordpress-plugins/password-protected-categories/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg). This lets you restrict access to any or all of your download categories.
For example, you can make all the categories private, or show different categories to different people.
For each category, you can:
* Make it password protected so that anyone with the password can see the hidden documents and download files.
* Restrict it to specific WordPress user roles only.
* Give access to specific logged in users only.
= Can I see a demo of the download manager plugin? =
Absolutely! You can see the *Document Library Lite* plugin in action on the [demo site](https://documentlibrary-free.barn2.com).
= Is there a premium version with more features? =
We have designed the free *Document Library Lite* plugin to have all the essential features that you need to create a fully functional document library.
For more advanced document management and display options, you can upgrade to [Document Library Pro](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg). This incredibly popular plugin will supercharge your document library by giving you extra column and layout options, more ways to list documents, plus time-saving features including bulk document import.
[Compare the free and pro plugins](https://barn2.com/kb/document-library-plugins-free-pro-comparison/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) and choose which is best for your site.
= Can you customize the plugin for me? =
We developed this free plugin to be flexible and easy to configure so that it will be suitable for many different websites. The [premium version](https://barn2.com/wordpress-plugins/document-library-pro/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) adds most of the features which you are ever likely to need.
If you would like to modify the plugin to suit your exact requirements, then we recommend posting a task on [Codeable](https://barn2.com/go/codeable/?utm=content&utm_source=wporg&utm_content=document-library-free). They have lots of excellent developers who are experienced in customizing our plugins.
= Where can I find the documentation? =
Like all Barn2 plugins, the free file manager plugin comes with in-depth documentation. You can either read the instructions above, or the [dedicated documentation page](https://barn2.com/kb/document-library-wordpress-documentation/?utm_source=wporg&utm_medium=freeplugin&utm_campaign=freepluginwporg&utm_content=dlw-wporg) on the Barn2 site.
= Where do I report security bugs found in this plugin? =
Please report any security bugs through the [Patchstack Vulnerability Disclosure Program](https://patchstack.com/database/vdp/document-library-lite). The Patchstack team will assist you with verification, CVE assignment, and notify the developers of this plugin.
== Screenshots ==
1. Searching a WordPress document library.
2. Click on a download category to filter the document library.
3. Choose and re-order your document library columns.
4. Optionally display a featured image for each document.
5. Manage downloads from a dedicated section of the Wordpress Dashboard.
6. Easily add documents, downloadable files and document data.
7. Keep the download manager organized by structuring documents into categories.
8. Configure your document libraries centrally on the plugin settings page.
9. Choose which columns of information to include in the document library.
10. Easily list documents anywhere on your site using a simple shortcode.
11. View document downloads separately from other Media Library files.
== Changelog ==
= 1.1.2 =
Release date 26 November 2024
* Dev: Tested up to WordPress 6.7.1
* Dev: Updated the internal libraries
See changelog.txt for more details.