JomSocial Documentation - User contributions [en]

Email Digest

2016-11-24T02:03:47Z

Ndezteaq:

{{alert|<center>'''Only available for JomSocial version > 4.2'''</center>|alert-danger}}

==Overview==
Email digest will notify inactive members about new public activities happening on the site. It is very effective tool to keep lost users coming back to your website but if miss-configured, it can also be very dangerous, so read carefully.

==Important Things to Know==
# '''Know your email limit''' - Many hosting providers have a limit of emails that can be sent per hour. If you're not sure how to check for this limit, contact your hosting provider. Once you know what is the limit, adjust the number of emails that are sent per one cron run. Don't try to send more than what limit is. Also, consider emails from mail queue. Those emails count too.
# '''Send as less images as possible''' - If you try to send too many images in email body, service providers can put your site on the blacklist and consider all future emails originating from the site to be the spam messages.

==How to Configure Email Digest==
The most important thing to know is how many emails can you send per one hour. 
On shared servers this number is very limiting, almost never over 100 or 200. For the exact number, please contact your hosting provider. 
For this purpose, lets say our emails per hour limit is '''100'''. This means we can only send out 100 emails from our site within 1 hour, but we have 2000 inactive users in queue. 
[[Setting up Cron Job|Set Cron Job]] to run every 10 minutes and in Email Digest configuration, set '''Number of emails per cron run''' to '''10'''. 
Now lets calculate this: 
* 1 Cron job every 10 minutes means it will be total of 6 crons per hour.
* Email Digest will be triggered 6 times, and will dispatch total of 60 emails.
* Because our limit is 100 emails per hour 60 will be reserved for Email Digest, while 40 will be used for other emails originating from your site, such are emails from JomSocial Mail Queue, new registration emails or even third-party component emails.
* With this setup, Email Digest should dispatch 1440 emails within one day.

==Images In Email Body==
While JomSocial Email Digest allows the liberty of choosing what images to send, we strongly advise to actually send a less images as possible, because email filters will treat emails with many images as a spam, and you don't want to end up on black list. 
Because of this, all images-related configuration options are set to '''NO''' by default.

==See Also==
* [[Setting up Cron Job]]

Email Digest

2016-11-24T02:01:47Z

Ndezteaq:

{{alert|<center>'''Only available for JomSocial > 4.2'''</center>|alert-danger}}

==Overview==
Email digest will notify inactive members about new public activities happening on the site. It is very effective tool to keep lost users coming back to your website but if miss-configured, it can also be very dangerous, so read carefully.

==Important Things to Know==
# '''Know your email limit''' - Many hosting providers have a limit of emails that can be sent per hour. If you're not sure how to check for this limit, contact your hosting provider. Once you know what is the limit, adjust the number of emails that are sent per one cron run. Don't try to send more than what limit is. Also, consider emails from mail queue. Those emails count too.
# '''Send as less images as possible''' - If you try to send too many images in email body, service providers can put your site on the blacklist and consider all future emails originating from the site to be the spam messages.

==How to Configure Email Digest==
The most important thing to know is how many emails can you send per one hour. 
On shared servers this number is very limiting, almost never over 100 or 200. For the exact number, please contact your hosting provider. 
For this purpose, lets say our emails per hour limit is '''100'''. This means we can only send out 100 emails from our site within 1 hour, but we have 2000 inactive users in queue. 
[[Setting up Cron Job|Set Cron Job]] to run every 10 minutes and in Email Digest configuration, set '''Number of emails per cron run''' to '''10'''. 
Now lets calculate this: 
* 1 Cron job every 10 minutes means it will be total of 6 crons per hour.
* Email Digest will be triggered 6 times, and will dispatch total of 60 emails.
* Because our limit is 100 emails per hour 60 will be reserved for Email Digest, while 40 will be used for other emails originating from your site, such are emails from JomSocial Mail Queue, new registration emails or even third-party component emails.
* With this setup, Email Digest should dispatch 1440 emails within one day.

==Images In Email Body==
While JomSocial Email Digest allows the liberty of choosing what images to send, we strongly advise to actually send a less images as possible, because email filters will treat emails with many images as a spam, and you don't want to end up on black list. 
Because of this, all images-related configuration options are set to '''NO''' by default.

==See Also==
* [[Setting up Cron Job]]

Built-in Module Positions

2016-07-29T07:13:14Z

Ndezteaq: /* Stacked Positions */

From JomSocial 1.6 forward, you can insert Joomla modules into any part of the JomSocial template. This will allow you to have greater flexibility in customizing the look and feel of JomSocial to your own liking.

== Module Position Lists ==
We categorize module positions to 3 classes.
# '''Global''' - One position that is shown on various different pages
# '''Page specific''' - These positions will only show on certain JomSocial pages
# '''Only Mine''' - These module positions are only available on the profile page and are show to the owner of a profile

=== Global Positions ===
# '''js_side_top''' - Placed on top of the side column (sidebar) of Frontpage, Profile, Groups and Events Pages.
# '''js_side_bottom''' - Same as js_side_top except that is placed on the bottom of the sidebar.

=== Profile Positions ===
On profile page, all Global Positions are available as well as
# '''js_profile_top''' - Placed between the Toolbar and the Profile Page.
# '''js_profile_mine_top''' - Placed between the Toolbar and the Profile Page only for the profile owner
# '''js_profile_feed_top''' - Placed before the Activity Stream section of the Profile Page.
# '''js_profile_feed_bottom''' - Placed after the Activity Stream section of the Profile Page.
# '''js_profile_side_top''' - Placed before any JomSocial content on the side column of Profile Page and after js_side_top.
# '''js_profile_mine_side_top''' - Only shown to the owner of aprofile on top of the side column
# '''js_profile_mine_side_bottom''' - Shown only to the owner of a profile at the bottom of side column
# '''js_profile_side_bottom''' - Placed after any JomSocial content on the side column of the Profile Page and before js_side_bottom.
# '''js_profile_mine_bottom''' - Placed at the bottom of the profile page and visible only for profile owner
# '''js_profile_bottom''' - Placed at the bottom of Profile Page.

=== Groups Positions ===
All global positions are available on the individual group page and there are two more additional positions you can use
# '''js_groups_side_top''' - Placed before any JomSocial content on the side column of the Groups Page and after js_side_top.
# '''js_groups_side_bottom''' - Placed after any JomSocial content on the side column of the Groups Page and before js_side_bottom.

=== Events Positions ===
All Global Positions are available on Event Page as well as two more
# '''js_events_side_top''' - Shown at the top of the side column in events page
# '''js_events_side_bottom''' - Shown at the bottom of the side column in events page

=== Frontpage Positions ===
All global positions are available on this page. In addition, you can use one more position
# JomSocial 4 '''js_side_frontpage_top''' - Top frontpage position. On clean installation will show Members and Who's Online modules.
# '''js_side_frontpage''' - Middle frontpage position. On clean installation will show Photos and Videos module.
# JomSocial 4 '''js_side_frontpage_bottom''' - Bottom frontpage position. On clean installation will show Group and Event modules

=== No Access Page ===
No access page features two module positions only
# '''js_noaccess_top''' - Shown at the top of the page
# '''js_noaccess_bottom''' Shown at the bottom of the page

== Stacked Positions ==
'''Since 4.0.2:''' A new set of stacked module positions have been added. Simply add "_stacked" at the end of available position name and publish the modules in it

Example:
* '''js_side_top''' - will display modules in tabs
* '''js_side_top_stacked''' - will display modules stacked on top of each other

==How to Insert a Module into JomSocial?==
In the Joomla Administrator Backend, go to '''Module Manager''' (Extensions > Module Manager). On the '''Module Manager''' page, you can either create a new module or select an existing module you would like to place in JomSocial. In the '''Edit Module''' page, under the '''Details''' field set, there is a parameter called '''Position'''. '''''Manually enter''''' the name of the module position (you may refer to the list of built-in module positions above). Click '''Save''' and your module will appear in your desired area.

::: [[File:Js profile side top.png]]

==Adding Your Own Module Position==
You can add your module position name and insert it anywhere within any JomSocial template files. The '''Code Snippet''' that does this for tabbed module layout is:
<syntaxhighlight lang="php">
<div class="joms-module__wrapper"><?php $this->renderModules('PositionName'); ?></div>
</syntaxhighlight>
 
While for the stacked layout you would use:
<syntaxhighlight lang="php">
<div class="joms-module__wrapper--stacked"><?php $this->renderModules('PositionName_stacked'); ?></div>
</syntaxhighlight>
 

==Module Positions in the Templates==
<center>{{alert|'''NOTE:''' The images show the JomSocial 3.2 layout which might differ in JomSocial 4|alert-danger}}</center>
This is the overview of '''Module Positions''' within the JomSocial Component:

=== Frontpage ===
::: [[File:Frontpage.jpg]]

=== Profile ===
::: [[File:Profilepage.jpg ]]

===Group===
::: [[File:Grouppage.jpg ]]

===Event===
::: [[File:Eventpage.jpg ]]

===No Access===
::: [[File:Modulepositionnoaccess.png]]

===Module Class Suffix===
{{alert-deprecated}}
If you want your modules to look like the rest of the JomSocial boxes, you can use these '''Module Suffixes''':
* '''For jomSocial 2.6 and below''' - " cModule"
* '''For jomSocial 2.8 till JomSocial 3.2.1''' - " app-box'

{{alert|Note: Add module sufixes without quotes, but with white space in the name.|alert-info}}

::: [[File:Moduleclasssufix.png]]

====Why Module Class Suffix are Removed in JomSocial 4?====
Module class suffixes have been used in JomSocial 3.2 and lower because it was the only way for users to style additional modules exactly as other JomSocial template elements so that they blend into design like its outlined on image bellow:
:::[[File:Module suffixes.png]]

In JomSocial 4 this is not needed anymore because all modules will blend in by default

==See Also==
* [[Modules|Modules Documentation Page]]

Remove description field from app info

2015-06-08T03:00:37Z

Ndezteaq: /* Instructions */

==Overview==
This hack will remove showing description of the application

==Instructions==
# Navigate to ''ROOT/components/com_community/templates/jomsocial/application.item.php'' find this code and delete it:
<syntaxhighlight lang="php">
<?php echo $this->escape( JText::_( $app->description ) ); ?>
</syntaxhighlight>

and delete this code as well :
<syntaxhighlight lang="php">
<?php echo $this->escape($app->description); ?>
</syntaxhighlight>
 

# Navigate to ''ROOT/components/com_community/templates/jomsocial/apps.about.php'' find this code and delete it:
<syntaxhighlight lang="php">
<div class="joms-form__group">
<?php echo JText::_('COM_COMMUNITY_APPS_DESCRIPTION');?>
<?php echo $this->escape( JText::_( $app->description ) ); ?>
</div>
</syntaxhighlight>
 

==See Also==
[[Remove JomSocial from URL]]
[[Translate Plugin]]

Remove description field from app info

2015-06-08T03:00:19Z

Ndezteaq: /* Instructions */

==Overview==
This hack will remove showing description of the application

==Instructions==
# Navigate to ''ROOT/components/com_community/templates/jomsocial/application.item.php'' find this code and delete it:
<syntaxhighlight lang="php">
<?php echo $this->escape( JText::_( $app->description ) ); ?>
</syntaxhighlight>

and delete this code :
<syntaxhighlight lang="php">
<?php echo $this->escape($app->description); ?>
</syntaxhighlight>
 

# Navigate to ''ROOT/components/com_community/templates/jomsocial/apps.about.php'' find this code and delete it:
<syntaxhighlight lang="php">
<div class="joms-form__group">
<?php echo JText::_('COM_COMMUNITY_APPS_DESCRIPTION');?>
<?php echo $this->escape( JText::_( $app->description ) ); ?>
</div>
</syntaxhighlight>
 

==See Also==
[[Remove JomSocial from URL]]
[[Translate Plugin]]

Disable author display

2015-06-08T02:57:42Z

Ndezteaq: /* Here's how */

==Overview==
Applications in JomSocial profile are nothing more than Joomla! plugins and as such are required to have '''<nowiki><author></nowiki>''' tag in the respective XML file. We use that tag to display the author of the plugin, but you can disable it easily in template configuration.
:::[[File:Aboutapp.png]]

{{alert|Warning: This configuration is not available on newest JomSocial version 4.x.x |alert-error}}

==Here's how==
Navigate to [[Control Panel|JomSocial's Dashboard]] and from the left-hand menu select ''Configuration->Templates'' 
Choose '''default''' template or whatever template you are using. 
Set '''Show plugin author''' to '''hide'''
:::[[File:Pluginauthor.png]]

==References to JomSocial are still in description==
Not only to JomSocial, it will most likely be shown to all other third-party developers if they make the reference to their name in the description. 
We are looking into ways to either provide a way to disable showing description as well, or make some kind of standardization and require not have references to company names in descriptions. Meanwhile, you can do [[Remove description field from app info|this hack]] to remove it.

==See also==
[[Translating Plugin]]

Latest Events

2015-05-01T07:06:52Z

Ndezteaq:

{{alert-obsolete}}

==Overview==
This module is designed to display desired number of events, from specific or all categories, or even showing only featured events.

==Backend Settings==
[[File:Latestevents.png]]
* '''Caching''' - Select whether to cache the content of the module
* '''Total Events''' - Number of events to be displayed
* '''Description Length''' - Length of description text
* '''Include Group Events''' - Set this to yes if you want to include events from groups
* '''Show Featured Events Only''' - Display only featured events
* '''Events Ordering''' - Chose the ordering of events in the module
* '''Category''' - Select the category you want the module to display events from
* '''Group''' - Select the group you want the module to display events from

==Module View==
[[File:Latestevents1.png]]

==See also==
* [[Installing Module]]
* [[Translating Module]]

Mail Queue

2015-04-27T04:30:22Z

Ndezteaq:

{{alert|<center>'''Doc page is not available yet'''</center>|alert-info}}