Manual version 1.0
Up-to-date for openDevApps v1.0
Open a PR to improve it, add/update a translation or just fix a typo!.
When you just installed the extension for the first time, you got a interface like this:
As you can see, there is no link and no category.
As suggested, open the Settings by clicking on the settings icon:
Okay, but before managing links and categories, how are these elements organised together ?
You can create links (with URL, name and if it's local or not) and then add them to 0, 1 or n categories. Each category can have 0, 1, or multiple links (but not several times the same). All is just the view with all existing links.
Let's create a first link pointing on github.com/company/greatproject. Enter the link (in the bottom text input New link + Enter) and hit enter.
Then as suggested by the placeholder (Set name + Enter), set a name and hit Enter.
Then check or uncheck the checkbox depending if the app is hosted/running in local ? You can presse Space key to check or uncheck (or use the mouse obviously) then hit Enter. Then the link appear (you see the name and on hover you can see the link as popup title).
Our link has been created ! We can click on its name to open a new tab to the website set.
Mention: Currently there is a maximum limit of 15 links.
After having created several links, it's the time to organise them inside categories. So let's create a first category:
Enter a name in the top input (New category + Enter) and hit Enter. We are going to create a category for Job apps:
The new category is directly selected and a new zone to add a link has appeared.
No idea about naming categories ? Think about separating links by projects, domains, by pro/perso, by activities, or anything else you want.
Here, in addition to Great Project at Company, we would like to add the link Alina Repository (that is an app made by our company) to the Job apps category (choose and click Add):
To remove a link from a category, just click on the "unlink" icon.
When link or category are created, deleted, added, or removed, this is saved in local memory (synced across your browsers if you use Firefox Sync).
When closing preferences or closing/reopening the extension, the links are displayed and you click on them to open URLs.
Bottom icons:
- Repository to find source code
- Link to this manual, in case you need it later
- Settings icon to open/close settings
Top tricks: You can always hover option to see the purpose with the title info displayed after 1 second. Version number hover displays release date of the installed version.
- To delete links: click on the little trash 2 times
- To delete categories: click on the little trash 3 times (relations to links are deleted, but links themself are not).
A basic validation of each link is made with a Regex at the link creation. This is not perfect, especially for IP addresses and port range. I preferred to keep it not to restrictive finally. You can test and edit the Regex on regexr.com. The Regex is currently:
^(((https?:\/\/)|(www\.)|())((([A-Z\d_-]+\.)+)([A-Z\d]+)|(localhost))((:\d{1,4})?))(([\/\?].*)?)$