https://github.com/valiot/administrate-field-telephone
https://github.com/valiot/administrate-field-telephone
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/valiot/administrate-field-telephone
- Owner: valiot
- License: mit
- Created: 2017-01-20T16:06:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-20T16:06:51.000Z (over 8 years ago)
- Last Synced: 2025-02-22T18:04:39.752Z (4 months ago)
- Language: Ruby
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Administrate::Field::Telephone
A plugin to show clickable telephones in [Administrate].
This repository is the first field plugin extracted out of Administrate.
Although its structure may change,
it's designed to act as a template for other Administrate field plugins.
## FAQs
**Q: How should I name my gem?**
A: Administrate field gems must be named according to the [Rubygems naming guidelines].
Essentially, name your gem after the field class that it defines.
If there's a namespace in the class name, that gets translated to a dash (`-`) in the gem name.
If the class name is CamelCased, that translates to an underscore (`_`) in the gem name.
Since all administrate field gems are under the namespace `Administrate::Field`,
every field gem name should start with the prefix `administrate-field-`.
Here are some examples (these don't correspond to actual gems):
| Gem Name | Field Name |
|----------------------------|------------------------------|
| `administrate-field-telephone` | `Administrate::Field::TelePhone` |
| `administrate-field-file_upload` | `Administrate::Field::FileUpload` |
| `administrate-field-geocoding-region` | `Administrate::Field::Geocoding::Region` |
| `administrate-field-geocoding-geo_json` | `Administrate::Field::Geocoding::GeoJson` |
[Rubygems naming guidelines]: http://guides.rubygems.org/name-your-gem/
[Administrate]: https://github.com/thoughtbot/administrate