https://github.com/linkorb/interlink
Interlink: Advanced hyperlinking across services
https://github.com/linkorb/interlink
Last synced: 3 months ago
JSON representation
Interlink: Advanced hyperlinking across services
- Host: GitHub
- URL: https://github.com/linkorb/interlink
- Owner: linkorb
- License: mit
- Created: 2015-02-28T16:39:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-02-28T16:45:02.000Z (over 11 years ago)
- Last Synced: 2025-08-03T14:13:24.760Z (11 months ago)
- Language: PHP
- Size: 137 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Interlink: Advanced hyperlinking across services
Interlink let's you define custom link handlers for wiki links.
Some example:
Translate `[[wikipedia:Hello world]]` into:
```html
Hello world
```
Translate `[[wikihow:Grow an Orange Tree]]` into:
```html
Grow an Orange Tree
```
Translate `[[mozilla-bugzilla:441207]]` into:
```html
Printing selection causes blank page with header/footer only
```
Translate `[[mytaskdb:14]]` into:
```html
Redesign widgets to optimize alignment with KPI's
```
Using Interlink, you define `Handlers` for link prefixes (Like above: 'wikihow', or 'mytaskdb').
The handler can then automatically translate the link into a working bit of HTML using one of the available `Renderers`.
You can even create your own Renderer if the provided ones are not sufficient.
You can also pass a `LabelResolver` to your handler to translate the code or id into a userfriendly text.
For example, look up a task title in the database using PDO, based on the id in the link.
Or make a REST API call to a webservice to convert a bugid into a readable summary.
## How to use Interlink in your application
Simply add the following to your `require` or `require-dev` section in your [composer.json](http://getcomposer.org) and run `composer update`:
```json
"require": {
"linkorb/interlink": "~1.0"
}
```
## Examples:
Please refer to the `examples/` directory for some simple and advanced examples.
## License
MIT (see [LICENSE.md](LICENSE.md))
## Brought to you by the LinkORB Engineering team
Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering).
Btw, we're hiring!