Skip to content

B
bg-az-counter
Commit 46859cce authored by Vadim's avatar Vadim
Browse files
Options

Update README.md

parent f2c93611
Show whitespace changes
Inline Side-by-side
Showing with 107 additions and 2 deletions
README.md
View file @ 46859cce
......@@ -26,13 +26,12 @@
Вставляет на страницу HTML-разметку:
```html
<span class="bg-az-counter" data-type="main" data-type="post" data-ID="1234">
<span class="bg-az-counter" data-project="main" data-type="post" data-ID="1234">
<span class="bg-az-counter-views"></span>
<span class="bg-az-counter-now"></span>
<span class="bg-az-counter-score"></span>
</span>
```
Задавайте функцию `bg_az_counter_views` в шаблоне страниц так:
```php
......@@ -147,3 +146,109 @@
**Внимание!** После удаления плагина файлы `wp-content/uploads/bg_az_counter.json` и `wp-content/uploads/bg_az_rating.json` **НЕ будут удалены**! При необходимости, удалите их вручную.
# Установка файлов плагина на не-WP проекты
_Внимание!_ На странице должен быть подключен jQuery!!!
1. Добавить в `<head>...</head>` страницы следующие строки:
```html
<!-- Bg Az-Counter head START --->
<link rel='stylesheet' id='bg_counter_styles-css' href='https://azbyka.ru/wp-content/plugins/bg-az-counter/css/styles.css' type='text/css' media='all' />
<script>
var path = window.location.pathname;
var filename = path.split("/").pop();
var bg_counter = {
"counterurl":"https:\/\/stat.azbyka.ru\/counters", // Всегда 'https://stat.azbyka.ru/counters'
"rateurl":"https:\/\/stat.azbyka.ru\/rate", // Всегда 'https://stat.azbyka.ru/rate'
"scoreurl":"https:\/\/stat.azbyka.ru\/item-score", // Всегда 'https://stat.azbyka.ru/item-score'
"websocket":"wss:\/\/stat.azbyka.ru\/realtime-view", // Всегда 'wss://stat.azbyka.ru/realtime-view'
"updatesocket":"wss:\/\/stat.azbyka.ru\/updates", // Всегда 'wss://stat.azbyka.ru/updates'
"updatetime":"3000", // Время обновление счетчиков онлайн-посетителей
"project":"\/project\/shemy", // Имя текущего проекта, например, '/shemy'
"type":"post", // Тип объекта 'post', 'category', 'tag', 'index' или пусто
"ID":filename, // ID объекта
"votes5":"голосов",
"votes2":"голоcа",
"vote1":"голос",
"voted":"Вы уже проголосовали",
"price":["тяжко", "слабо", "сносно", "достойно", "чудесно"],
"debug":""}; // Выводить или нет инфу в консоль
jQuery('div.count_views').ready(function() {
jQuery('span.bg-az-counter').attr('data-type',bg_counter.type );
jQuery('span.bg-az-counter').attr('data-ID',bg_counter.ID );
});
jQuery('div.bg_counter_rating').ready(function() {
jQuery('meta[itemprop=itemReviewed]').attr("content", document.title);
});
</script>
<script type="text/javascript" src="https://azbyka.ru/wp-content/plugins/bg-az-counter/js/reconnecting-websocket.min.js"></script>
<script type="text/javascript" src="https://azbyka.ru/wp-content/plugins/bg-az-counter/js/counter.js"></script>
<script type="text/javascript" src="https://azbyka.ru/wp-content/plugins/bg-az-counter/js/rating.js"></script>
<!-- Bg Az-Counter head END --->
```
В зависимости от проекта и типа данных на странице потребуется изменить в объекте `bg_counter` 3 элемента: `project`, `type` и `ID`. См. выше замечания по поводу значений этих параметров.
2. В теле страницы, в том месте, где это необходимо, установить блок для вывода на экран значений счетчиков
```html
<!-- Bg Az-Counter views START --->
<div class="count_views">
<span class="bg-az-counter" data-project="shemy" data-type="" data-ID="">
<i title="Всего просмотров" class="fa fa-eye"></i> <span class="bg-az-counter-views"></span>
<i title="Сейчас читают" class="fa fa-user-o"></i> <span class="bg-az-counter-now"></span>
<i title="Оценка пользователей" class="fa fa-star-o"></i> <span class="bg-az-counter-score"></span>
</span>
</div>
<!-- Bg Az-Counter views END --->
```
Чтобы пиктограмы были видны, шрифт `css/font-awesome.min.css` должен быть доступен.
Если какой-то из параметров не нужен, его достаточно просто удалить.
`data-project, data-type, data-ID` - необходимо указать значения, соответствующие тому, что должно быть отображено в форме вывода. См. выше замечания по поводу значений этих параметров.
3. В теле страницы, в том месте, где это необходимо, установить блок для ввода/вывода рейтинга страницы
```html
<!-- Bg Az-Counter rating START --->
<div class="bg_counter_rating">
<div><ul id="bg_counter_rate_box">
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
</ul>
<span itemscope="" itemtype="http://schema.org/AggregateRating">
<meta itemprop="bestRating" content="5" />
<meta itemprop="worstRating" content="1" />
<meta itemprop="author" content="Азбука веры" />
<meta itemprop="itemReviewed" content="" />
<meta content="" itemprop="ratingValue">
<meta content="" itemprop="ratingCount">
(<span id="bg_counter_votes"></span>&nbsp;<span id="bg_counter_votes_txt"></span>:&nbsp;<span id="bg_counter_score" data-voted="">{$score}</span>&nbsp;из&nbsp;<span id="bg_counter_rating_max">5</span>)
</span></div>
<div id="bg_counter_popup_help"></div>
</div>
<!-- Bg Az-Counter rating END --->
```
Следует иметь ввиду, что содержимое мета-полей itemReviewed, ratingValue и ratingCount заполняется только на этапе отображения страницы на стороне клиента.
Некоторые поисковые боты не запускают JS при анализе страниц и, следовательно, не будут видеть эти значения.
Чтобы избежать потери данных этими ботами необходимо предусматреть заполнение этих полей при формировании страницы на сервере средствами CMS, на которой работает сайт.
Для этого необходимо организовать HTTP GET запрос к серверу статистики https://stat.azbyka.ru/item-score/project/<имя_проекта>/type/id . В ответ вы получите JSON в виде:
```json
{
"success": true,
"data": {
"alreadyVoted":true,
"score": 3.7142857142857144,
"votes": 7
}
}
```
itemReviewed - это, как правило, title страницы - заполняется любым удобным способом.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment