-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
executable file
·99 lines (62 loc) · 3.47 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
== Hydrogen Directory ===
Contributors: LBell
Donate link: https://github.com/sponsors/lbell
Tags: directory, student, employee, people list, board members, church, club, officers
Requires at least: 3.0
Tested up to: 5.9.3
Stable tag: 1.0.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
The simplest, lightest way to manage and display a directory of anything.
== Description ==
Finally!
A ridiculously light, stupidly-simple plugin to manage and display a directory of anything: production cast, blog contributors, businesses, collectors items, church members, books, club officers, chickens in your flock, departmental employees, students, bowling league teams... you get the point.
Most "directory" plugins out there are way too complicated. One of the more popular ones weighs in at 30 MB! That's almost as much code as Wordpress Core. That's uranium heavy. Be careful of meltdowns...
*Enter Hydrogen Directory.*
This plugin is light and simple, just like hydrogen. Weighing just 33kb zipped, it's so tiny it might float away.
Whether you need to just list the 3 members on your team, are looking to showcase the 200 cars in your pinewood derby league, or need to import 10,000 employees, Hydrogen Directory manages it all with ease, speed, and predictable grace.
Highlights:
1. Quickly add or updated listings in wordpress using familiar interface.
1. Organize entries into buckets using taxonomies.
1. Display your directories anywhere on your site using shortcodes.
That's it! Get on to more important things in your life.
== Installation ==
1. Upload the `hydrogen-directory` folder to the `/wp-content/plugins/` directory.
1. Activate `Hydrogen Directory` through the 'Plugins' menu in WordPress dashboard.
1. Use the shortcode `[hydrogen-directory]` directly in your page or post content.
**Shortcode Arguments:**
**tax:** use to display entries from a single taxonomy
**term:** use to display entries from a single term in a taxonomy
**style:** display style (default "list")
**columns:** number of columns to display (default 1)
**header:** whether to include tax / term headers in the output (default 1 = yes)
Example:
`[hydrogen_directory tax="role" term="Alter Boy" style="card" columns=3]`
== Screenshots ==
1. Included "list" style.
2. Included "card" style.
3. Included "text" style.
4. Custom avatar style.
5. Settings page (There isn't one. It's that simple.)
== Frequently Asked Questions ==
= Can I import entries from a CSV? =
Yes - you can import using standard CSV import pathways. Although WordPress does not offer CSV import function natively, there are a number of plugins that will add this feature. This plugin has been tested successfully with the "Really Simple CSV Importer" plugin. (Note, entries in the file must be **comma** separated.)
= How do I theme the output? =
You have several options:
1. Add custom css to your theme to tweak the look.
1. Override the default templates by copying any of the `directory-list-entry-{type}.php` files into your theme, and modifying it there.
1. Use the plugin hooks (filters / actions) to customize specific parts.
= Can this plugin do X,Y or Z? =
Probably not. But it could!
Hydrogen Directory is purposefully simple and easy. But it can extended in powerful ways. Contact me for requests for additional functionality.
== Changelog ==
= 1.0.3 =
* Bugfix: activation error (submenu permission)
* Tested to WP 5.9.3
= 1.0.2 =
* CSS Fix
= 1.0.1 =
* Position Meta Box fix
* Code cleanup
= 1.0.0 =
* Initial Release