Woffice Documentation

Informations :

Alkaweb Team
July 2017
contact@alka-web.com

Requirements :

WordPress 4.0 +
Installed & Updated (It's not that hard to click on the "update" button ;))

Thank you !

Thank you for purchasing our theme. If you have any questions feel free to open a ticket via our Support center.

Theme Set Up It's easy !

There are many ways to install a WordPress theme, we are going to take a look to the easiest one here. (More Informations)

Here is a video tutorial to illustrate this part and the steps underneath. It's for the business demo case but it works almost the same for the other.

Using the new demo content extension (Recommended and easier)

  1. Login into your fresh WordPress installation, once in the dashboard :
  2. If you want to use the ONE CLICK demo import, please follow this article :One Click Install for Woffice
    Please also activate the Project & Wiki extensions if you want to include the demo content (since version 1.0.3)
  3. If you want to use the ONE CLICK demo import, please follow this article :One Click Install for Woffice
  4. If you see any error : All is explained here (https://alkaweb.ticksy.com/article/4617/)
  5. Enhance your Woffice with Plugins (tested plugins)

Main presentation

Multisite Setup

You can find details about the Multisite installation here :

Using the .xml demo files

Woffice Setup from scratch with demo import from doubleF on Vimeo.

WPBakery Visual Composer

From the version 2.5.4, Woffice includes WPBakery Visual Composer in the package. It works much better than the Unyson Page Builder and we belive that our customers deserve it. However there are still some important points to note:

1. The demo data

The demo data are still stored with the Unyson page builder. This means that if you are using Visual Composer instead of Unyson Page Builder and you import the demo content, then some page won't work correctly and you will have to create them by yourself. Some examples: Contact Us, File Manager, Learndash pages. So basically only the pages that use visual elements, which are the very smaller part.

2. The compatibility between the two plugins

We did many tests with both Unyson plugin and WPBakery plugin active at the same time. Despite they might work, we have faced many troubles with the editor trying to use it, in some cases we had to switch from one to another and vice versa to make things workings. So, in order to have a better experience and be sure that your content won't be deleted by mistake, we strongly suggest you to keep only one of the two plugins actived.

Network Set Up BuddyPress

Make sure BuddyPress is installed please.

Set Up BuddyPress

Once the plugin activated you can change the settings :

Set Up the cover image (NEW > 1.4.1)

Go to the Unyson page and activate the "Woffice Cover Extension" :

Create an user

Every user will be able to edit his profile (social links, email, name...) from the frontend.

Users Profile Fields

If the Xprofile component is enabled (it's enabled by default), you can extend the users informations with additional custom fields.

Some fields are created by default:

  • Social Fields: They are created automatically on the Theme Activation, you will find them in the group "Social".
  • Location Field: It is created if the Unyson extension "Woffice Members Map" is active. It cannot be deleted if the extension is active.
  • Woffice_Notes Field: It is created if option "Personal Note", in Theme Settings > BuddyPress is enabled. It cannot be deleted if the option is enabled.

Create new fields:

You can create new custom fields in Users > Profile Fields (see above).

If you want display the new fields in the members directory, then you can go in Theme Settings > BuddyPress and you will find two options for each profile field:

If you want add the field to the Advanced Members Search, you can use the remaining option on the same panel:

Setup Map Extension:

To setup the map you need the Map Extension (Unyson) enabled then for the Maps Geocoding API see :

Building the forum

It's really easy in fact, you'll just have to install the BBpress plugin. Once done, you'll find a lot of new options in the settings and 2 new post types (forums and topics). You just have to fill them and add your forum from the menu page. If you need a "main page" for the forum, you'll have to create a "parent" forum.

More

Hare are some cool tutorials and guide to handle BuddyPress :

Permissions Set Up

From the version 1.9, in Woffice Settings (Appearance > Theme Settings) there is a new tab that makes the permissions management much easier.

Access to website and single pages

First of all you have to set if you want that your website is public or is accesible only to loggedin users (that's perfect for elearning or company sites):

If you have set your website as private, you can select some pages to exclude, they will remain available for not logged in users:

Then you have to set the same permissions about the buddypress pages: Members directory page, Groups directory page and Activity page:

On the other hand, if you want that your website remains public, except few pages, you can set the website public using the option showed in the first image. Then you can create (or edit) a new page and in the single page settings (scroll down a bit) you can find this option:

Create elements by frontend

Woffice allow to create many elements by frontend, these are: blog posts, wiki articles, projects and directory elements.

In the Permissions tab, the options are organized by groups:

In each group you can find an option like this:

All roles selected here will be able to create that post type by frontend. A button will be created in the corresponding directory page, for instance, for wiki:

NOTE: This option affect only the front end, in the backend, the users continue to use the default capabilities of WordPress assigned by default to each role.

NOTE ALSO: The administrator users are ALWAYS able to create elements by frontend, it doesn't matter what you set in this option.

Edit elements by frontend

Woffice allow to edit many elements by frontend, these are: blog posts, wiki articles, projects and directory elements.

In the Permissions tab, the options are organized by groups:

In each group you can find an option like this:

All roles selected here will be able to edit that post type by frontend. A button will be created each element page.

NOTE: This option affect only the front end, in the backend, the users continue to use the default capabilities of WordPress assigned by default to each role.

NOTE ALSO: The administrator users and the author of each element are ALWAYS able to edit elements by frontend, it doesn't matter what you set in this option.

Restrict the editing permissions

You have set up the roles that are allowed to edit the elements by frontend, but maybe you want that some specific elements have to be edited only by authors of the posts or by administrators users, you can achieve this easily. You have just to uncheck this checkbox in single post/wiki options:

Projects permissions

The permissions settings about projects are a bit different from the wiki and blog post permissions.

You can select what roles can create projects by frontend, but there is not an option for editing. This because, by default, the projects are editable by all members assigned to the project itself, by author of the project and by administrators.

If you want, you can disallow the members of the projects to edit it. So only the administrators and the author of the project will be able to edit it.

If an user want, he can disallow the members of the projects to edit it. So only the administrators and the author of the project will be able to edit it. In order to do this the user have to check this option during the process of project creation:

User Role Editor

User Role Editor is an useful that makes user roles and capabilities changing easy. You can edit/add/delete WordPress user roles and capabilities from the User Role Settings:

Until the version 1.9, the changes of the capabilities have affected only the backend permissions. From this version is possible to use the meta capabilities also to handle the frontend permissions.

In Appearance > Theme Settings > Permissions you can find this option for wiki and posts.

This option disables the roles selected above and enable the meta caps also by frontend.

By default the permissions for wiki assigned to the roles follow the standard of WordPress caps for blog posts permissions. Below there is a list of the default capabilities for wiki posts, assigned to Editors, Authors and Contributors (Administrators of corse have always all capabilities):

IMPORTANT: Are you not able to see the wiki button menu in the backend using the Admin account?

Allow users to register

This means every user with your site URL could be able to register and see the content. Please just make sure this box is enabled and Woffice will take care of the rest.

Restrict user registration

For some reasons (eg. Company Private Intranet which can't be IP restricted due to the number of locations in which your company is set up), you may want to only make specific users be able to register onto your Intranet.

In such cases, Alkaweb offers you two possibilities out of the box.

1. First Possibility

First of all, you can restrict registration for one or several email domain name. This can be achieved from Appearance > Theme Settings > Login/Register > Register Options.

NB: The 'Allow anyone to register' option detailed in the section above has to be set.

Please not that we recommend you to keep the 'Auto Login' field unchecked, and keep the 'Email verification' field checked under this Login/Register settings. Otherwise, you could imagine, in edge-case, that someone could make up an email address.



2. Second Possibility

In other cases, you may want to allow anyone to register, but also control who register, ie. validate the sign-up before the end user is able to log in.

For this matter, we have developed our dedicated plugin: Eonet Manual User Approve.

Customization Your own way

To customize Woddice we will talk about 3 different ways :

  • Appearance (layout, color, fonts...) :

    Most of the settings for this theme are located in the "Appearance" -> "Theme Settings" tab. You can change here, many settings about the design and some content such as the page title, header, extra footer...We will not describe here every fields. But you have to take some time to choose the best options for you. (Note : we do not use the theme live customizer in this theme, all is centralized in the theme settings tabs).

  • Content :

    As you may know, all the content is managed by WordPress. The theme uses mostly the pages but also some custom post types. You'll find in this documentation all the informations to fill them in the right way. (Use the menu at the left).

  • Functionalities :

    All the functionalities of the theme are managed by Unyson Framework, more informations here :

Login Page

1. Create the "login" page

2. Set the options in the theme settings

3. Set the page page for email confirmation

Create a new page, call it "Active"" (Or whatever you want) and leave it blank. Then set it as user activation page:

4. Remove the Worpdress topbar for unlogged users

4. Social Networks Login

Dashboard Widgets time

1. Create the "dashboard" page

2. Add the widgets

3. Make it the front end page

Projects (Post Type)

Make sure the "Woffice Projects" extension is enabled. You'll have to create a projects page which will display all the project posts (second screenshot). The post type name is "project".

1. Create the "projects" page

2. Create a project

Sync with BuddyPress groups

First, to sync the Woffice projects with any BuddyPress group you'll need to enable this option from the Theme Settings :

Once enabled, that'll create a new Project category for each BuddyPress group. Whenever a project has a Group name set as its category. All members will be automatically suyncronized and the project will be added to the BuddyPress group page.

Customize the file away shortcode for the projects files

If you need to customize the FileAway shortcode in the projects file section, you can just ovveride it pasting this function in the functions.php of your child theme and add or remove attributes that you prefer.


/**
 * Returns the File Away file manager :
 */
function woffice_projects_fileway_manager($post_slug) {

    $sub_name = "projects_" . $post_slug;

    /* We output the directory */
    echo do_shortcode('[fileaway base="1" makedir="true" sub="' . $sub_name . '" type="table" directories="true" paginate="false" makedir="true"  flightbox="images" bulkdownload="on"]');

    /* We output the file uploader */
    echo do_shortcode('[fileup base="1" makedir="true" sub="' . $sub_name . '"]');

}
                    

Projects permissions

To learn more about project permissions read this section.

Wiki (Post Type)

Make sure the "Woffice Wiki" plugin is enabled. You'll have to create a wiki page which will display all the wiki posts (second screenshot). The post type name is "wiki".

1. Create the "wiki" page

2. Create a wiki article

Trick! Enable the page builder on the Wiki and Project page : You have to go to the Unyson page in WordPress, then go to the Page builder's settings page. Check "Wiki" and "Project".

Another Trick! Multiple wiki pages: After many requests we have created a little tutorial that allow you to create multiple wiki pages.

Wiki posts permissions

To learn more about creating/editing permissions read this section.

News Blog

  1. Create a new page in Worpdress
  2. Call it Blog or News, assign it the blog template.
  3. Publish it
  4. Be sure to NOTassign to post page:

Posts permissions

To learn more about creating/editing permissions read this section.

Courses Lessons, Topics

We advise you to use Learndash (Website) which is 1000 times more complete. However the license isn't cheap, but it worth it !

Woffice is 100% compatible with Learndash, regarding the plugin itself you must see their documentation for all the details (Documentation).

The theme will give you an elegant design for Learndash elements which fits in the Theme and your customizations. We also added a shortcode generator which is available in the page Builder.

BuddyPress Integration

You can use the following plugin, it's compatible with Woffice and really useful for BuddyPress & Leanrdash.

BadgeOS Integration

You can use the following plugins :

Page/Graph/Forms

This is just some informations to create a simple page with Woffice:

Create a page

  1. WordPress Dashboard, Pages -> New Page :

Use graphs

You need to enable the Visualizer plugin, then just follow their instructions. You'll also find a widget for them.

Use forms

You need to enable the Contact form 7 plugin, then just follow their instructions. You'll also find a widget for them.

Title box

The defaults settings of the box can be changed in the theme settings -> Title Box.

Calendar

It's important to note that we had an important change about the calendar feature from Woffice since version 2.1.2. In fact, Woffice use to includes by default EventON plugin but we've changed this plugin to Pro Event Calendar. You can find all the reasons about this change here. But keep in mind that both plugins are supported and it's your choice.

Pro Event Calendar

Since Woffice 2.1.2, the Pro Event Calendar is suggested on any new installation. Therefore, it comes with a specific integration on Woffice. Including custom design and built-in page builder element with many options ready for you. We recommend you to have a look directly on the Settings page whenever you're ready with the Woffice setup. Furthermore, we highly recommend you, if you've any issue to check out their awesome documentation. Everything is clearly explained, all features will work on Woffice.

EventON

Woffice includes EventON calendar plugin and the Full calendar add-on, once both plugins activated you'll be able to manage events and schedule as you like with a lot of options. For detailed information, please refer to their documentation :

Installation

You can find EventON installable plugin file in woffice/inc/, you'll see "EventON.zip" and "eventon-full-cal.zip". Go on the Plugins page in WordPress, select "Add New" > "Upload" and upload the plugin zip files. Once activated you can use EventON, everything works fine and you the plugins updates are bundled within Woffice's updates.



Licenses and activation



Shortcodes and view

We advise you to use the built-in shortcode included in the page builder but you can still play with their shortcodes (copy/past in a text block the generated shortcode):




Files Manager (Multiverso or Fileway)

(NEW) After version 1.4.4 with File-Away

Since version 1.4.4 we're using File Away instead of Multiverso, means that Multiverso is no longer required in the installation. However it's still present in woffice/inc/ So you can still use it. File Away, has more options, it's way stronger and act as real file reader (like a FTP in some way). The only disadvantage is that you need to setup the roots first (see this link).

(OLD) Before version 1.4.4 with Multiverso

Woffice includes Multiverso File sharing plugin, once the plugin activated you'll be able to manage and share file across the whole site. For detailed informations, please refer to their documentation :

Settings

Category page

Not required, but it's better.

Multiverso shortcode

Pagebuilder / Shortcodes (Unyson)

You just need to enable the page builder extension : (see #Unyson)

Then you'll see in every page : (once clicked on "Visual Page Builder")

(DEV) the shortcodes included by the theme are in woffice/framework-customizations/extensions/shortcodes/shortcodes/ (see #Unyson).

Header, Menus, Megamenus (Navigation)

There is a complete page of options for the header in the Theme Settings(see #Customization)

Top bar header

You can find all the options here :

Revolution Slider

Since Version 1.2.9, we've added the compatibility with the famous Revolution Slider. What does that mean ? The plugin is not included with the theme BUT we provide full support. So if you have a license, just activate the plugin on your Woffice setup. You'll be able to add slider in any page content and to replace the page title box by a Revolution slider (as you can see on the community demo homepage). You'll find this option in every page settings.

Menu

The theme accepts One location so you just have to create one menu. You can create more and use them in the widgets.

Icons & Megamenu

Yep, you can add icons and create megamenus. For that you'll need to enable the "Megamenu" Unyson extension (see #Unyson)

User Menu

If you have enabled it, your website has an user menu like this:

You can add custom links to this menu. Create a new WordPress menu and assign it to location "[Woffice] Dropdown User Menu", your link will be added right before the Logout link, that is the last link in the menu.

If you want edit existing links, than you have to haev a look to the function woffice_user_sidebar into the file woffice/inc/buddypress.php.

This functions render the whole user menu. It's present a filter for every menu item, so if you want remove some item you have to use filters to override them.

The list of filters is:

apply_filters( 'woffice_activity_personal_li', $activity_personal_li, $profile );
apply_filters( 'woffice_xprofile_personal_li', $xprofile_personal_li, $profile );
apply_filters( 'woffice_notifications_personal_li', $notifications_personal_li, $profile );
apply_filters( 'woffice_messages_personal_li', $messages_personal_li, $profile );
apply_filters( 'woffice_friends_personal_li', $friends_personal_li, $profile );
apply_filters( 'woffice_groups_personal_li', $groups_personal_li, $profile );
apply_filters( 'woffice_settings_personal_li', $settings_personal_li, $profile );
apply_filters( 'woffice_courses_personal_li', $courses_personal_li, $profile );
                        

Widgets / Sidebar

3 Widgetized areas

Woffice comes with 3 widgetized areas in 3 locations. They need to contain at least one widget to be enabled. (screenshot below) :

Make sur that the option "Show the Footer Widgets" is set as "show" in the theme settings. Note that you can also choose the columns number.

Available Widgets

There are many Widgets that you can choose and use directly in any area. However, some of them may have some design issues sometimes (plugins conflicts). if so, just get in touch with us please.

Poll Widget

Set up the poll :

This is a first version and we're looking for your suggestions to improve it ;)

  1. Go to the Extension settings : This action will create a new tab in the database which will be deleted when the extension is deactivated.
  2. Add the answers :
  3. Add the widget :

See the result :

How to start a new poll or refresh the results ?

For now, you just have to deactivate and then activate again the extension that'll empty the data in database.

Fun facts Widget

This is the same system as the Poll one, so you can find the settings here :

Then you just have to drag the widget in the good sidebar.

Birthdays Widget

The birthday widget works exactly the same way as the fun fact widget or any other WordPress widget. You'll find a "Birthday" field in the profile's tab once the extension activated. You'll have several options available to change the format Unyson > Woffice Birthdays > Settings

Chat Widget

The Chat is possible thanks to Wise Chat Plugin. You just need to install it from your Plugins and then add the "Wise Chat" widget to any sidebar. You can choose the Channel it doesn't matter and the Theme will take care of the style.

The Activation Key Issue

Woffice is bundled with many premium plugins, such as Eventon Calendar and Slider Revolution.

It means when you purchase a Woffice license these plugins will be automatically installed beside Woffice and their updates are including with Woffice's updates

BUT:

  • We don't provide support for these plugins, we'll try to help you but our help is limited on Woffice area
  • You have not any purchase code (there is only 1 purchase code and it's ours, see Extended licenses on Themeforest)
  • We won't add any other addon to Woffice

IMPORTANT: Some of these plugin ask you to insert your activation code in order to active them. It's not the Woffice purchase code and as we said, you have not the activation code, but you don't need it in order to use the plugins, you can continue to use them without problems.

Dev Guide

(For developers) You're of course free to improve and customize the theme code ! Here is some informations which may help you. Note that it's better to use a child theme as explained bellow. If you have any question, feel free to contact us (button in the top right corner).

Use a child theme

It's better to use a child theme as you won't lose any of your changes when you'll update the theme. So we advice you to use the one included in the main package files :

Where are the premium plugins files ?

If you're looking for the EnventOn, Multiverso plugins zipped files. Please go to woffice/inc all the zipped files inside are plugins that you can directly install from the Plugins page in WordPress (if the auto install doesn't works, Multisites case for example).

Theme Structure

Please refer to the WordPress theme documentation & Unyson one (link below)

Theme Hooks, Filters and Helpers

We have recently released our developer documentation detailing all the helpers, filters and hooks used in our theme. Please refer to our hub
here and enjoy it!

.

Intranet Set Up (OPTIONAL)

Woffice was first thought as an Intranet however there is no tutorial from our team now because there are such great articles about that on the web. Here is a selection of useful tutorials to create an Intranet with WordPress

Languages WPML

You have to work with the famous plugin WPML (unfortunately not free BUT powerful). It is compatible with the theme and a language switcher will be added automatically in your top bar (if you checked the option in the theme settings). So how to translate ? just download the plugin and follow the instructions of the plugin. The .PO & .MO files are in woffice/languages and are ready to be translated.
Here is some useful resources :

FAQ

How to rename buddypress pages (members, groups, activities)

As suggested from buddypress support, the best way is use a langauge file: More information here

Missing users in the Members page

We have an article in the support area about this: More information here

What is the size for Title Page background?

We have an article in the support area about this: More information here

Troubleshooting

Woffice installation not working

Some of you may stumble across an installation error when trying to import Woffice from Wordpress theme importer. We cannot do anything for that from our end, it's a Wordpress core related hitch.

If this issue persists when trying to install again, we highly recommend you not to spend time on it. We have a straightforward hack for you.

Please not that this can be applied to install the Woffice child theme as well. Here are the few steps to deal with it:

  • Extract (unzip) the Woffice theme folder
  • Connect to your web server using any FTP client, and upload this extracted folder within the wp-content/themes folder ; You should now see a new folder called woffice within this /themes folder.
  • Then, go back to your Wordpress Admin Panel and head to the Appearance > Themes section
  • You should now be able to activate the Woffice theme.

If you think, this documentation or this theme are not complete enough, let us know please ! :) We are ready to improve it !! Thank you for reading.