In order to use the Youneeq Panel, this site must be registered with the Youneeq database. Please contact a Youneeq representative in order to enable recommendations on this site.

## Adding Recommendations to a Page

The recommendation panel can be added to a page in one of two ways: as a widget (easiest method), or through page templates (more advanced). To add the Youneeq Panel as a widget:

* Go to the 'Widgets' menu (under the 'Appearance' section in the admin menu)
* Select one of the three Youneeq widgets. Note that the Youneeq Observer widget does not actually display any recommendations, and the Youneeq Panel (Landing) widget does not send Post metadata to the Youneeq server.
* To add the widget to the page, either click and drag it into the desired widget container on the right side, or click it and select the desired widget container from the drop-down menu.
* Customize the widget's title, maximum article count and category filter in the widget settings if desired

To add the Youneeq Panel to a page template, add the following line of code to your template where you want the panel to appear: `Youneeq_Panel\recommend(-1);`

If you want to include more than one recommendation panel in a page template, each one must have a different identifier (change -1 to a unique value). To customize the behavior of the panel, see the code documentation in "lib/yq_panel.php".

## Configuration

The site-wide appearance and behavior of the recommendation panel can be configured in the Youneeq settings menu. Hover over the 'Settings' option on the admin menu and select 'Youneeq' from the list that appears.

Most of the options in the setting page can be moused over to see a description of their effects and valid input.

### Layout

The Layout tab allows the content and structure of each recommended article in the recommendation panel to be customized. The first article in the panel can have a different layout than the other articles in the panel.

To add a layout component, open one of the submenus of the Layout Components list and drag the desired component onto one of the elements in the Main Layout or First Article Layout boxes. Components can be reordered by dragging or with the arrow buttons. The trash button removes a component from the layout.

The three buttons below the component name allow the behavior of the specific component to be modified:

* The link option turns the component into a clickable link. This may be a link to the article itself (in the case of Title, Image, or Basic Link type components) or link to something specific to that component type (Linked Categories link to that category page, etc).
* The key option turns the component into a toggle switch. When clicked, items with the lock option will be displayed or hidden. This can be used to create an interactive layout (such as clicking the title to display the article excerpt and a link). Note that a component cannot be a link and a toggle switch at the same time.
* The lock option turns the component into a toggleable item and hides it by default. This component will become visible when a component with the key option is clicked. 

### Display

The Display tab contains general options for the behavior and appearance of recommended articles.

### Interact

The Interact tab determines user interactivity with the recommendation panel, including the position of the Youneeq modal button, the ability for users to remove articles from the panel, and "toaster" cards.

### Recommend

The Recommend tab allows filtering control over recommended articles, such as cross-site recommendations, publish date, and categories.

### Observe

The Observe tab affects the article metadata stored in the Youneeq database, such as image resolution and categories.

### Domains

The Domains tab allows the various sites on a network to be registered and associated with a display name. Site-specific cross site recommendations can also be configured.

### Advanced

The Advanced tab currently contains the option to allow the WordPress plugin updater to draw from the beta release branch when updating the Youneeq Panel plugin. This is included for testing purposes and should generally not be enabled on production sites.