Documentation / Help

Accessing the Dashboard

To access the dictionary in the dashboard do the following:

Go to the Concrete 5 Full Dashboard. Check the Dictionary section in the Dashboard. Alternatively you can use the following url: https://[yourconcrete5website].com/index.php/dashboard/dictionary

This should direct you to the words page where you can see the list of your created words. In your dashboard you can also see an attributes and settings pages, we’ll get to that later.

Adding words

On the "Words"-page there should be a green button on the top right of the screen that says “Add Word” clicking on it will direct you to a form page with 2 sections. "Details" and "Attributes".

In details you have 3 textboxes named: "Word", "Handle" and "Letter".

  • Word is self explanatory, it’s the word that will be displayed in the Block and in the hub page of the dictionary.
  • Handle is what the word will be saved in the files. This should be automatically filled in with the name of the word itself.
  • Letter is where the word will be indexed, this is usually the first letter of the word and it’s what it will be automatically filled in. This is important for when you’re planning to use the legend feature of the block.

Then there is a Text Area called “Explanation” where you put the definition of the word.

Lastly there is a dropdown menu where you can select or not you want the word to be active. Active meaning it will show up in the block/website.

In the section attributes you can toggle which attributes you’d like to add to the word. In order to do we need to define attributes first. Please check the section attributes for that.

Edit a word

In the words page you can right click any word and press "edit" and if will bring you to a form similar to the one where you add words. Where u can change the details/attributes of the word you selected. When your done press save.

Activate/Deactivate

If a word is active it means it will show up in the block, by default every word you add should be active. In order to (de)activate a word simply right click the word and press. (de)activate.

Delete a word

To delete a word simply right click on the word and press "Delete". If you want to delete your entire word list there is a "Delete All" button in the top right of the page, under the “Add Word” button.
Note: Deleting a word or all the words is definit. Please make sure have a backup!

Importing words

The import feature allows you to import any .csv (Microsoft Excel or Google Spreadsheets) or .txt file. This is useful in situations where u need to add a large quantity of words. 

The file should contain 3 Columns in the following order: Word, Explanation, Active.

  • Under the column Word you fill in the name of the world.
  • Under the column Explanation you give the definition of the word.
  • Under the column Active you give a simply "1" or "0" depending if u want the word to be active or not.
When you are using attributes for words, these columns will be processed also. The order of the columns are available when you click on the "Import"-button.

If you’re using a spreadsheet it’s a matter of making sure it’s 3 columns and a row for each word.

There are also settings you can use while importing a file: 

  • Choosing your own delimiter and enclosure when importing files
  • Skipping the first row in the import, this is for when the first row of the spreadsheet consists of headers
  • Clear all current dictionary words, DELETES EVERYTHING BEFORE IMPORTING.

Note: Importing words could take a while. Please be patient!

Backing-up existing words

You also get the option export your current dictionary into a .csv file or .xls file.
.csv files are used by both Microsoft Excel and Google Spreadsheet while .xls files are used only by Microsoft Excel. Exporting is recommended for when you wanna make a backup for your dictionary or if you want to import it in a different website.
Note: The backup-files are very different then import-files. You can use the backup-files for importing purposes, but you need to remove certain data.

Searching words

You can search for words in the search bar next to the add word button, there is also advanced settings to refine your search results.

Attributes

It’s possible to give attributes to words, but in order to do so we need to define said attributes.
What you can do with these attributes is completely up to the user. You can for example search for words if they only have a certain attribute to them, search words that have a certain topic/tag. The possibilities are endless.

The attributes will be exported if you were to export the dictionary.

The Dictionary Block:

After installing the add on you should have a new block available that is like any other Concrete5 Block that will contain the dictionary. This block has multiple settings that you can find in the add/edit block section.

The settings are as follows:

  • Show list on load, this is a yes or no option that allows the user to choose if they want to show the entire dictionary straight away or only show results that are searched.
  • Legend, you can have the option to show the legend and the position of it in the legend tab.
  • Search, the search tab shows options for the search box. Including enabling/disabling the search bar, if u want to autofill the search box and the position of the search box.

After you’re done configuring the settings to your liking simply hit save and exit edit mode to see the results.