Как сделать автоматически создаваемое содержание статьи с помощью js/jquery.
Недавно начал делать новый контентный проект. Покупаю достаточно объемные статьи (5 килознаков) и добавляю к ним картинки и видео, разбиваю текст на несколько (около 5) подзаголовков. В результате страницы получаются огромными, а для мобильных юзеров прокручивать такие странички становится делом очень неюзабельным. Поэтому решил сделать блок «содержание статьи», примеры таких блоков навигации можно найти в википедии.
Конечно, можно делать навигацию вручную, но мы ведь живем в XXI веке, так что пусть это делает за нас компьютер!
Я знаю что в интернете есть несколько мануалов о том как это сделать, но они меня не устроили, поэтому решил написать свой скрипт и хочу им с вами поделиться.
Суть работы скрипта заключается в том, что он автоматически делает навигацию из подзаголовков (<h2>), найденных на странице. Посмотреть работу скрипта можно по этой ссылке. Также несколько видоизмененный скрипт я поставил на этот блог.
Особенности скрипта
Почему я решил написать свой скрипт?
Во-первых, все те скрипты что я находил в интернете требуют создания дополнительного div-блока в коде страницы, где и будет размещаться навигация. Мой скрипт этого не требует, а значит хлопот намного меньше. Особенно это актуально для сложных (WordPress-) шаблонов, где сложно понять, какой php-файл непосредственно отвечает за вывод контента.
Во-вторых, я хотел сделать так, чтобы скрипт не создавал навигацию для страниц, у которых всего 1-2 подзаголовка или вообще их нет. Иначе, зачем такая навигация нужна?
Ну и, в третьих, скрипт крохотный, удобный и не содержит багов (в найденных на просторах интернета скриптах я такое обнаруживал).
Как установить скрипт на свой сайт
Простой алгоритм действий:
- Скачиваем скрипт
- копируем его к себе на сайт, я рекомендую создать на сайте папку /js/ и скопировать скрипт туда
- В шаблоне вашей CMS (для WordPress это «footer.php») перед закрывающим тегом <body> пишем следующее:
<script type='text/javascript' src='http://code.jquery.com/jquery-1.11.1.min.js'></script>
<script type='text/javascript' src='ПУТЬ/К/СКРИПТУ/contents.js'></script>
Некоторые CMS (например, WordPress) в большинстве случаев по умолчанию подключают jQuery (это также зависит от используемого шаблона), поэтому первую строчку можно не копипастить чтобы уменьшить время загрузки страницы.
После добавления кода перезагрузите страничку своего сайта и наслаждаетсь полученным результатом или…
Если не работает
В идеале ваш сайт должен быть сверстан на html5, а основной текст статьи содержаться в теге <article>. Внутри этого тега сначала идет тег <h1>, в котором содержится основной заголовок (Название статьи). После него — текст с картинками, внутри которого встречаются подзаголовки, обрамленные тегами <h2>.
На большинстве современных сайтах делается именно так, поэтому если у вас так — то проблем быть не должно. Если же нет — то читайте дальше.
В том случае если у вас старая div-вестка, то находите тот div-тег, в котором находится текст статьи и запоминаете его класс (либо добавляете свой собственный для удобства). На многих WordPress-темах этот класс называется «post», поэтому покажу на его примере.
Итак, открываете скрипт в текстовом редакторе, находите строчку:
subheader = ‘article h2′;
и меняете ‘article h2′ на ‘.post h2′ (обязательно укажите точку перед post). Т.е. должно выглядеть вот так:
subheader = ‘.post h2′;
Теперь сохраняете файл, загружаете его снова на сервер и перезагружаете страницу. Должно работать.
В том случае, если вы хотите выводить содержимое странице не после тега h1, а в другом месте или если у вас несколько тегов h1, то найдите в скрипте эту строчку:
$(‘h1′).after(contents);
И вместо ‘h1′ укажите CSS-представление для объекта, после которого следует выводить навигацию по странице. Например, у моего блога это заголовок с классом ‘entry-title’. Перед названием класса следует указать точку. Поэтому в моем случае это будет выглядеть так:
$(‘.entry-title‘).after(contents);
Оформление блока навигации
Разумеется, после добавления кода следует оформить блок навигации, хотя это и не обязательно. Для этого используется старый добрый CSS. Например:
nav.autocontents{background:#ffd;width:300px;padding:5px 20px;box-shadow:0 0 2px 2px grey;}
nav.autocontents h3{margin-left:30px;}
nav.autocontents a{text-decoration:none;}
nav.autocontents a:hover{text-decoration:underline;}
Я надеюсь у вас все получилось. и навигация для страницы создается автоматически.
Всем добра!
Статья опубликована 29 августа 2014: цены, тарифы и интерфейсы упомянутых сервисов с тех пор могли измениться.
По теме: справочник веб-мастера Web-Faq — создание сайтов, SEO, CMS WordPress и Joomla, хостинг и VDS.