Wordpress

Документация wordpress – Все Функции WordPress

10.11.2019

Содержание

Понимание и работа с данными в WordPress. Часть 1. Введение / Habr


Данная статья является переводом первой статьи Rachel McCollin из цикла о данных в WordPress. В ней по полочкам разложена структура данных, типы контента и их взаимосвязь в WordPress. Будет полезна в первую очередь новичкам, но и профессионалы могут найти для себя что-либо новое.
Замечание от переводчикаВ переводе используется терминология согласно кодексу WordPress
  • Post — запись,
  • Page — страница,
  • Attachment — вложение,
  • Revision — редакция,
  • Comment — комментарий,
  • Taxonomy — таксономия,
  • Category — категория
  • Tag — метка,
  • Term — термин (конкретное значение пользовательской таксономии)
  • User — пользователь
  • Metadata — метаданные

Исключение составляет лишь термин content. В большинстве случаев используется не перевод «содержимое», а — «контент». Я считаю, данный перевод является более корректным по тексту.
В некоторых случаях в скобках приводится расшифровка на английском для однозначного понимания.

Замечания об ошибках и опечатках прошу сообщать в личку.

Сайт на WordPress состоит из трех основных элементов:

  • Сама установка WordPress
  • Содержимое каталога wp-content, которое включает темы, плагины и загрузками
  • База данных, где хранится контент в виде данных.

Большинство пользователей WordPress никогда не работают с базой данных напрямую. Они могут быть даже не в курсе, что она постоянно работает, чтобы обеспечить работу их сайт. Когда WordPress показывает любую страницу, то он соединяется к базой данных, чтобы показать контент, который добавили авторы на сайт.

В этой серии статей будет детально рассмотрены аспекты базы данных WordPress. Эта серия состоит из девяти частей:

  1. Вступление (сейчас вы читаете именно его)
  2. Взаимосвязи между данными
  3. Типы контента
  4. Пользовательские данные
  5. Метаданные
  6. Таксономии, категории, метки и термины
  7. Таксономии VS метаданные
  8. Таблица опций
  9. Данные WordPress Multisite

В этом статье рассматриваются таблицы базы данных и как они относятся с типами контента. Данные типы контента используются для работы в WordPress и определяют что, как и где должно храниться.

Типы контента в WordPress


Прежде чем разбирать данные хранящиеся в базе WordPress, рассмотрим типы контента. Существуют такие стандартные типы контента:
  • Записи (posts)
  • Страницы (pages)
  • Пользовательские типы записей (custom post types)
  • Вложения (attachments)
  • Ссылки (links)
  • Элементы меню (navigation menu items)

Эти типы контента имеют такие данные:
  • Категории (categories)
  • Метки (tags)
  • Пользовательские таксономии (custom taxonomies and terms)
  • Метаданные (post metadata)

Кроме того существует типы контента, хранящиеся в ином виде:
  • Виджеты (widgets)
  • Опции (options)
  • Пользователи (users)
  • Сайты для MU WordPress
  • Нестандартный контент (hardcoded content), который добавляют некоторые темы/плагины.
  • Сторонний контент (third party content) (например RSS)

Все эти типы контента хранятся в таблицах базы данных или в файлах настроек тем/плагинов. Каждый тип может быть представлен как отдельной записью в таблице, так и её частью. Кроме, того они могут быть связаны с данными в других таблицах. Например, данные о записях связаны с данными о пользователях, так что WordPress знает, кто является автором, какой записи.

Структура базы данных WordPress


WordPress использует несколько взаимосвязанных таблиц. Между ними установлены связи один ко многим. Например, к одной странице может быть много комментариев. Приведенная ниже диаграмма взята из кодекса WordPress. На ней показаны таблицы и связи между ними:

Большинство таблиц связаны с одной или несколькими другими с помощью одного поля. Это поле будет уникальным идентификатором для каждой записи (пример post_id). Более подробно для каждой таблицы:

Таблица Данные Связи с другими таблицами
wp_posts
Записи, страницы, вложения, редакции, пользовательские записи
wp_postmeta через post_id
wp_term_relationships через post_id
wp_postmeta
Метаданные записей, страниц и т.д. wp_posts через post_id
wp_comments
Комментарии wp_posts через post_id
wp_commentmeta
Метаданные комментариев wp_comments через comment_id
wp_term_relationships
Связи между таксономиями и записями, страницами и т.д. wp_posts через post_id
wp_term_taxonomy через term_taxonomy_id
wp_term_taxonomy
Таксономии (включая категории и метки) wp_term_relationships через term_taxonomy_id
wp_terms
Ваши категории, метки и термины пользовательских таксономий
wp_term_taxonomy через term_id
wp_links
Ссылки в вашем блоке (как правило, сейчас не используется) wp_term_relationships через link_id
wp_users
Пользователи wp_posts через post_author
wp_user_meta
Метаданные для каждого пользователя wp_users через user_id
wp_options
Опции и настройки сайта
(устанавливаются в админке на странице настроек и в темах/плагинах)
Отсутвуют

Стоит отметить несколько вещей:
  • Таблицы базы данных по умолчанию имеют префикс wp_. Вы можете его изменить (например, при установке).
  • Таблица wp_posts является самой важно. Именно в ней храниться большинство данных.
  • Только одна таблица не связанна с другими — таблица wp_options. В ней хранятся данные о сайте и настройках WordPress, которые не имеют отношения к записям или пользователям.
  • Две таблицы используются для хранения данных о таксономии. Об это будет отдельная статья.
  • В таблицах wp_users и wp_comments данные не связаны. В настройках WordPress можно указать, что только зарегистрированные пользователи могут оставить комментарий. Не смотря на это, WordPress не хранит связи о комментариях и пользователе, который их отправил.
  • WordPress MU иметь некоторые дополнительные таблица. Их рассмотрение выходит за рамки данной статьи.

Связь контента и таблиц базы данных

Ознакомившись с типами контента в WordPress и таблиц базы данных, используемых для их хранения, можно провести между ними соотвествие. В приведенном ниже перечне показано, какие таблицы базы данных используется для хранения какого типа контента.

Тип контента Таблица
Записи (posts) wp_posts
Страницы (pages) wp_posts
Пользовательские типы записей (custom post types) wp_posts
Вложения (attachments) wp_posts
Ссылки (links) wp_links
Элементы меню (navigation menu items) wp_posts
Категории (categories) wp_terms
Метки (tags) wp_terms
Пользовательские таксономии (custom taxonomies) wp_term_taxonomy
Термины пользовательских таксономий (custom terms) wp_terms
Метаданные (post metadata) wp_post_meta
Виджеты (widgets) wp_options
Опции (options) wp_options
Пользователи (users) wp_users
Нестандартный контент (hardcoded content) wp_posts (если добавлен к записям)
wp_options (если добавлен к виджетам)
Файлы тем/плагинов
Стороний контент (third party content) wp_posts (если добавлен к записям)
wp_options (если добавлен к виджетам)
Файлы тем/плагинов

Легко заметить, что не все таблицы используются в перечне. Так происходит потому, что некоторые из них используются для хранения метаданных. Другие используются для хранения связей. Оба варианта будут рассмотрены в последующих статьях.

Заключение

Надеюсь, что теперь вы лучшее понимаете, как и где WordPress хранит различные типы данных, как использует базу данных. Более подробно элементы этого процесса будут рассмотрены в последующих статьях. Так в следующей статье будут рассмотрены взаимосвязи между данными. А так же мы остановимся более подробно на том, как конкретные таблицы связаны и как некоторые из них используются исключительно для хранения данных об взаимосвязях.

habr.com

Документация – WordPress plugin | WordPress.org България

Документация is intended to provide sound basic structures for a Documentation Management System.

Leveraging WordPress’ framework and internal structures, the system provides a completely new section to manage documents independently from normal posts or pages.
Documents are complemented by their dedicated document categories and document tags, which allows to keep the documentation structures separate from the more blog-oriented posts or CMS-like pages.

It can be used to build a dedicated documentation site, a subsite for documentation in a multisite network or other creative deployments.

Documents can be attached to products in WooCommerce using WooCommerce Documentation.

Джаджи

The plugin provides several widgets that are used to display document links:

  • Document Hierarchy : facilitates navigating and viewing the document hierarchy
  • Document Children : displays links to children of documents
  • Documents : to display sets of document links
  • Document Categories : to display links to document categories

Шорткоди

The following shortcodes are available:

  • [documentation_documents] Lists documents, also useful to list documents in a category.
  • [documentation_categories] Renders a list of links to the document categories.
  • [documentation_hierarchy] Provides a means to navigate the documentation structure, equivalent to the Document Hierarchy widget.
  • [documentation_list_children] Lists the children of a document like the Document Children widget.
  • [documentation_search_form] Renders a dynamic search form. Use Search Live for a more flexible search form.

Recommended Useful Additions

You should have a look at these tools. They will help you get the most out of this Documentation Management System.

  • WooCommerce Documentation This extension for WooCommerce and the Documentation plugin for WordPress allows to link documentation pages to products and display them automatically on the product pages.
  • Groups Groups is designed as an efficient, powerful and flexible solution for group-oriented memberships and content access control. Use it to control who can view documents and more.
  • Groups Restrict Categories An extension based on Groups, provides access restrictions for categories and tags, custom post types and taxonomies. Very useful to restrict whole sets of documents based on their document categories or tags.
  • Search Live Search Live supplies effective integrated live search facilities and advanced search features. Makes it really easy to find the desired documents.
  • Widgets Control Widgets Control is a toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. This is very useful to show content and widgets in context.
  • Widgets Control Pro Widgets Control Pro is the advanced version of the Widgets Control toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. With its additional features, it is even more useful to show document-specific content and widgets, including the options to show widgets on documents and related pages only.
  • Decent Comments Decent Comments shows what people say. If you want to show comments along with their author’s avatars and an excerpt of their comment, then this is the right plugin for you. Use it to show comments posted on documents only or including them.
  • Open Graph Protocol Framework The Open Graph protocol enables any web page to become a rich object in a social graph. For instance, this is used on Facebook to allow any web page to have the same functionality as any other object on Facebook. This will automate the process of adding basic and optional metadata to documents.

Документация

Please refer to the documentation pages for details.

Съобщение

Feedback is welcome!

If you need help, have problems, want to leave feedback or want to provide constructive criticism, please do so here at the Documentation plugin page.

Please try to solve problems there before you rate this plugin or say it doesn’t work. There goes a lot of work into providing you with free quality plugins! Please appreciate that and help with your feedback. Thanks!

Twitter

Follow @itthinx on Twitter for updates on this and other plugins.

  1. Upload or extract the documentation folder to your site’s /wp-content/plugins/ directory. You can also use the Add new option found in the Plugins menu in WordPress.
  2. Enable the plugin from the Plugins menu in WordPress.
Where is the documentation?

The documentation pages are here.

Don’t work on older versions of WP. But very god plugin. translations maybe?

Convenient way to catalog/list/provide documents.

Please keep it going. This is a wonderful plugin. I love using it.

This has worked really well on my site — thank you for developing it! Dan

Прочетете всички 9 отзива

“Документация” е софтуер с отворен код. Към разширението са допринесли следните хора.

Сътрудници

bg.wordpress.org

WP Docs — Плагин для WordPress

WP Docs is a documents management plugin with refresh based directory browsing facility. Breadcrumb bar is available.

WP Docs Basic
  • Breadcrumb bar is available for a better navigation.
  • Front end refresh based files browser.
  • Document preview and thumbnails available for most file types.
  • Posts created for each new directory and your library items will be considered as file items using meta fields for post efficiently.
  • The ability to create, edit and delete directories and sub-directories.
WP Docs Premium
  • A smooth navigation experience based on jQuery/Ajax instead of page refresh.
  • Each folder can have a separate shortcode so you can use different pages for different directory listing and files inside.

License

This WordPress Plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.

This free software is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this software. If not, see http://www.gnu.org/licenses/gpl-2.0.html.

From the WordPress plugin menu click on Add New and search for WP Docs

Instead of searching for a plugin you can directly upload the plugin zip file by clicking on Upload:

Use the browse button to select the plugin zip file that was downloaded, then click on Install Now. The plugin will be uploaded to your blog and installed. It can then be activated.

«WP Docs» is available in left admin menu.

Uninstalling WP Docs

When you uninstall the plugin, files will still remain in your WordPress library.

I can easily manage its front-end customization and client can take care of back-end complex directory structure. It was a headache to manage the things with categories and pages on front. Its better to use a shortcode. Huge thanks for this plugin, i am expecting some ready made front-end themes either free or premium but it will save a lot of time to customize front-end. I hope that other users will vote up for my request too. Keep up the good work.

Updated version can handle unlimited directory/files browsing by jQuery on front-end. Admin side is still limited to 10+ depth in nested sub-directory level.

Посмотреть все 3 отзыва

«WP Docs» — проект с открытым исходным кодом. В развитие плагина внесли свой вклад следующие участники:

Участники
1.2.8
  • Delete functionality improved with long filename. [Thanks to Lubomir]
1.2.7
  • Delete functionality revised. [Thanks to boneceklp]
1.2.6
1.2.5
  • Bootstrap based front-end reviewed. [Thanks to Abu Usman]
1.2.4
  • Bootstrap based front-end revised. [Thanks to boneceklp]
1.2.3
  • Bootstrap based front-end released. [Thanks to Team Ibulb Work]
1.2.2
  • Languages added. [Thanks to Abu Usman]
1.2.1
  • Multiple uploads refined.
1.2.0
  • Legacy option removed, please don’t update this version if you’re using legacy.
1.1.9
  • Fixed: WordPress Plugin Security Vulnerability / Missing Validation on TLS Connections
1.1.8
  • New functionality added with downward compatibility.
1.1.6
1.1.5
  • Sanitized input and fixed direct file access issues.
1.1.4
  • Fixed multiple level child directory issue in Pro version.
1.1.3
  • Fixed 2nd level child directory addition problem. [Thanks to Joe & Mike]
1.1.1
  • Fixed parent directory related files display.
1.1.0
  • Releasing with complex directory structure and improved jQuery files browser on front-end.
1.0
  • Initial Release of WP Docs

ru.wordpress.org

Как создать оnline-документацию для вашего продукта с помощью WordPress

Когда вы открываете свой бизнес, начинаете все лучше понимать, что время — это ограниченный ресурс. Постоянно находятся какие-то неотложные дела, которые требуют вашего пристального внимания. Вам нужно принимать звонки, отправлять важные письма потенциальным и уже существующим клиентам и решать кучу других вопросов, которые отнимают у вас драгоценное время.

Вот почему необходимо иметь онлайн документацию для своего продукта или услуги. Хорошо организованная система статей, которые помогут людям лучше узнать о вашей продукции и смогут значительно сократить количество вопросов относительно поддержки и предпродаж, которые вы получаете.

Смотрите также:

Плагин Online Product Documentation

Сегодня мы познакомимся с плагином Online Product Documentation. С его помощью вы сможете легко создать раздел «Документация» на вашем сайте.

Описание | Демо | Купить за $19

В данном плагине вы найдете такие удобные и полезные функции:

  • Поддержка Категорий, для лучшей организации вашей документации.
  • Публичные голосования или голосования только для зарегистрированных пользователей, с помощью которых посетители могут определить, полезны ли им ваши статьи.
  • Адаптивный дизайн для использования на мобильных устройствах.
  • Возможность выбора цвета, для того, чтобы раздел соответствовал дизайну существующего сайта.
  • Возможность добавлять документацию в существующие страницы или посты с помощью шорткодов.

Начало работы

Во-первых, вам нужно установить плагин. Самый простой способ: загрузить .zip файл, который вы скачали, через консоль WordPress. После установки плагина не забудьте активировать его.

Теперь, когда вы установили и активировали плагин, вы увидите новый пункт меню, созданный внутри WordPress под названием «Documents«.

Прежде чем мы начнем создавать документацию, давайте перейдем в Настройки → PA Document и посмотрим, какие настройки нам доступны.

Настройки плагина

Радует тот момент, что окно настроек очень простое. Существуют следующие настройки:

  • Упорядочивание: есть возможность вносить изменения порядка постов и категорий с помощью drag-and-drop интерфейса.
  • Голосование: возможность создания голосований.
  • Иконки: Если вы решаете разместить у себя на странице голосование, то можете выбрать значок для отображения рядом с ним.
  • Цвет: Выбирайте цвет для ссылок и заголовков категорий.

Там также существует область, в которой вы можете добавлять пользовательский CSS.

Как вы видите, сделать настройки действительно просто. Теперь настало время создавать саму документацию!

Создание документации

В нашем примере мы создадим документацию для сервиса, который занимается веб-дизайном. Прежде, чем мы будем писать документацию, давайте создадим несколько категорий, перейдя в Documents → Categories в меню WordPress.

Категории

Добавление категорий — точно такой же процесс, как и добавлений категорий блога в разделе постов. Просто присвойте категории имя и нажмите кнопку “Add New Category”. В этом примере мы назовем категории следующим образом: “Pre-Sales Questions” и “Customer Support“.

В вашем списке категорий для онлайн документации вы найдете шорткод для каждой из категорий. Таким образом, вы можете просто скопировать и вставить эти шорткоды на любую страницу или пост.

Статьи документации

Теперь, когда у нас есть основные категории, следует создать несколько статей для них. Перейдите в меню Documents → Add New и вы сможете добавить необходимый материал очень быстро.

Просто напишите свою статью, присвойте ей название и категорию, в которой вы хотите ее разместить. Вы можете работать со статьями точно так же, как и с любыми другими постами или страницами. То есть, вы с легкостью сможете изменить контент, добавить какие-то новые материалы, форматировать текст и так далее.

Результаты

Вы готовы выставлять ваши статьи на сайт? Проще всего будет создать новую страницу (нашу мы назвали “Documentation”) и добавить в нее необходимый шорткод:

[document]

Этот шорткод будет автоматически отображать все категории, которые мы создали, и статьи, которые в них находятся. Помните, что у вас также есть возможность показывать только одну категорию на определенной странице, используя шорткоды из раздела Documents > Categories.

На нашей странице с левой стороны находится интерактивное меню, а с правой — контент выбранной статьи. Удобно то, что левая колонка опускается по мере того, как пользователь читает статью, поэтому меню будет всегда перед глазами. Это поможет посетителям легко найти то, что они ищут.

Следует добавить, что все статьи размещены на одной странице, так что вы также можете просто пройтись по каждой из них, не прибегая к использованию меню.

Заключение

Online Product Documentation — это простой, но достаточно мощный инструмент, который можно использовать для создания качественной документации. Вы легко сможете установить данный плагин, но в случае возникновения каких-то проблем, в плагин включено полезное руководство в формате PDF.

Меню плагина составлено достаточно хорошо. Оно позволяет сосредоточиться на содержании и не беспокоиться о том, как это все работает. Для очень обширной документации есть возможность отображения каждой категории на отдельной странице.

Если вы хотите быстро и качественно добавить документацию на ваш сайт, то Online Product Documentation будет отличным решением данной проблемы. Вы справитесь с этой задачей в кратчайшие сроки и непременно будете довольны полученным результатом.

Источник: envato.com

Насколько полезным был этот пост?

Нажмите на звезду, чтобы оценить этот пост!

Отправить рейтинг

Средний рейтинг: / 5. Количество голосов:

Пока нет голосов! Будьте первым, кто оценит этот пост.

Смотрите также:

hostenko.com

Кодекс WordPress

__() Возвращает переведенную строку. wp-includes / l10n.php
_e() Выводит переведенную строку. wp-includes / l10n.php
_ex() Функция — аналог echo _x(). wp-includes / l10n.php
_n() Переводит строку с учетом ее формы множественного числа. wp-includes / l10n.php
_x() Функция позволяет перевести одну и ту же фразу по разному — с учетом её использования в контексте. wp-includes / l10n.php
absint() Преобразует переданное значение в неотрицательное целое число. wp-includes / functions.php
add_action() Позволяет запустить произвольную функцию на месте указанного хука с заданным набором параметров. wp-includes / plugin.php
add_filter() Вешает функцию на указанный фильтр. wp-includes / plugin.php
add_image_size() Регистрирует размер изображения. wp-includes / media.php
add_magic_quotes() Экранирует спецсимволы во всех элементах указанного массива. wp-includes / functions.php
add_post_type_support() Добавляет поддержку определенных стандартных метабоксов для указанного типа постов. wp-includes / post.php
add_query_arg() Добавляет параметры в строку URL-вида. wp-includes / functions.php
add_term_meta() позволяет создать мета поле в таксономию и добавить в него любую информацию. wp-includes/taxonomy.php
add_theme_support() Добавляет поддержку дополнительных возможностей: форматов постов, миниатюр, произвольных фонов и заголовков, меню. wp-includes / theme.php
add_user_meta() Добавляет параметр пользователю и сохраняет его в базу данных. wp-includes / user.php
admin_url() Возвращает URL админки WordPress. wp-includes / link-template.php
antispambot() Функция для защиты email адресов от спам-ботов. Преобразует символы email в HTML сущности. wp-includes / formatting.php
apply_filters() Позволяет повесить фильтр на значение переменной. wp-includes / plugin.php
author_can() Позволяет проверить роли и возможности автора поста. wp-includes / capabilities.php
backslashit() Добавляет обратные слэши перед всеми латинскими буквами в строке и перед цифрами в начале строки. wp-includes / formatting.php
balanceTags() В зависимости от настроек в админке, исправляет некорретный XHTML-код (закрывает незакрытые теги, расставляет их в правильном порядке) или же возвращает исходную строку. Расширенный вариант функции force_balance_tags(). wp-includes / formatting.php
body_class() Выводит атрибут класс и его содержимое для <body> страницы. wp-includes / post-template.php
bool_from_yn() Функция возвращает логическое true в случае, если в качестве значения аргумент указано y или Y, во всех остальных случаях возвращает false. wp-includes / functions.php
cache_javascript_headers() Проставляет кэширующие заголовки для JavaScript на 10 дней. wp-includes / functions.php
cat_is_ancestor_of() Проверяет, является ли указанная категория родительской для другой указанной категории. wp-includes / category.php
category_description() возвращает описание рубрики с указанным в параметрах ID, либо описание текущей рубрики, если ID не указан wp-includes / category-template.php
comment_form() Выводит форму комментирования. wp-includes / comment-template.php
comments_open() Проверяет, разрешено ли комментирование указанного / текущего поста. wp-includes / comment-template.php
content_url() Возвращает абсолютный URL директории wp-content на сайте. wp-includes / link-template.php
deactivate_plugins() Деактивация плагинов через код. wp-admin / includes / plugin.php

misha.blog

Хранилище документов с возможностью поиска и сортировки

Модератор SeVlad

(@sevlad)

wp.me/3YHjQ

Я понимаю, что тут нужно работать с настраиваемыми полями, но не знаю, как это все сделать

В ВП есть масса плагинов для решения 99,9% популярных задач. Ваша не входит в число эксклюзивных. В зависимости от конкретных нюансов Вы наверняка сможете подобрать готовый плагин в оф каталоге.

Напр. Download Attachments может многое из того, что Вы перечислили, но он выводит таблицу на одной странице. Устроит ли это Вас..

Кроме того — есть масса плагинов таблиц с динамическим поиском и тп. Никто не мешает заполнить их ссылками на загруженные документы.

Download Attachments точно не подходит. Я смотрел плагин Custom Post Types, он вроде бы позволяет настраивать нужные поля и создавать форму ввода, но вывод списка с возможностью сортировки предусмотрен только в платной версии. Может быть подскажете что-то подобное?

Модератор SeVlad

(@sevlad)

wp.me/3YHjQ

Download Attachments точно не подходит.

Вы даже не объяснили почему.

Может быть подскажете что-то подобное?

Я Вам рассказал про кирпичи — где и какие бывают, а Вы спрашиваете про глину из которой они делаются.
CPT же как и множество др подобных плагинов всего лишь инструмент для удобного управления ПП. Мощный, да. Но применение подобных плагинов имеет смыл для эксклюзивных задач. В числе прочего потребуется написание и интерфейсов на фронте (=обжиг той самой глины для получения кирпича).

Я вроде критерии выбора плагина указал. В download attachments ничего этого нет, это просто плагин для прикрепления файла с минимумом полей, ещё и добавить ничего нельзя, в отличие от подобного расширения в joomla (там хоть пару полей прикрутить можно). Попробую подробнее объяснить: на сайт нужна база нормативных актов, с возможностью внесения новых документов по мере их появления. При внесении документа в дополнительных полях автором должны указываться тип документа, принявший орган, дата принятия, номер, статус, ссылка на изменяющий или отменяющий документ (если есть) и др. Соответственно, если есть база документов, то должна быть и страница вывода их перечня с возможностью фильтрации по указанным выше параметрам и с поиском по ключевым словам. Как-то так. Про кирпичи и глину я уяснить, но хотелось бы ближе к практике.

Посмотрите Organizing. Там есть не все, что вам нужно, попробуйте немного расширить функционал.

Здравствуйте! Подскажите, Вам не удалось решить данную задачу с хранилищем документов и поиском?.. Столкнулся с точно такой же проблемой — вот уж не думал, что для WordPress нет подходящего плагина ((( WP-Filebase «более-менее» подходит кажется, но плагин больше не поддерживается, к тому же там нет расширенного поиска по полям.

Пока забил на эту проблему. Если проводить аналогию с joomla, то там есть мощная и сложная штука seblod, который интегрируется в базу и значительно расширяет возможности работы с настраиваемыми полями. Вот бы в WP что-то подобное..

Модератор SeVlad

(@sevlad)

wp.me/3YHjQ

Вот бы в WP что-то подобное

Не знаю что как в Джумле, но в ВП всё есть для работы с ПП. Я выше давал ссылки и рассказывал.

О кирпичах и глинке было капец как познавательно

Понятно что кастомными типами записей в wordpress можно сделать все, в том числе и базу документов с фильтром поиска… Вопрос: почему не получается найти готовое решение в виде плагина — задача в общем-то тривиальная? )

Модератор SeVlad

(@sevlad)

wp.me/3YHjQ

Вопрос: почему не получается найти готовое решение в виде плагина

Возможно потому что не так ищите. Или ждёте что кто-то найдёт, то что устроит именно Вас.
Лично мне не интересно заниматься такими розысками.
И пож, см правила форума, п2: не задавайте вопросы в чужих темах — для полноценного обсуждения создайте свою.

ru.wordpress.org

Полезные советы по документации WordPress-тем

Когда у вас имеется вопрос по функционированию тем WordPress, куда вы обычно обращаетесь за дополнительной информацией? Разработчики тем используют мириады разных методов по созданию документации, начиная от привязки doc-файлов и заканчивая ссылками на внешние ресурсы. Если вы уже создали тему и потратили определенное время на написание документации к ней, следующим вашим шагом будет сделать так, чтобы документацию можно было легко найти.

Если документацию будет тяжело обнаружить, пользователи пойдут на форумы, чтобы получить ответы на общие вопросы, которые, возможно, проще было бы кратко раскрыть в виде нескольких лаконичных заметок. Это заметно нагружает вашу службу поддержки. К тому же пользователям придется дольше настраивать тему, т.е. они не смогут пользоваться ей, пока не получат ответы на свои вопросы. Давайте исследуем некоторые способы, с помощью которых можно значительно упростить поиск документации.

Рекомендации по документированию тем WordPress.org

Темы, расположенные на WordPress.org, обычно имеют широкую аудиторию и отличаются наличием пользовательских руководств, которые призваны помочь такой масштабной пользовательской базе. Я поговорил с Чипом Беннеттом, который возглавляет команду обзора тем WordPress.org, чтобы узнать, как WordPress.org рекомендует документировать темы. Эти рекомендации окажутся полезными для вас даже в том случае, если вы документируете коммерческую тему или тему, которая расположена в стороннем хранилище.

Где лучше всего размещать документацию, чтобы пользователи ее заметили?

Беннетт приводит в качестве ответа комбинацию четырех разных методов:

  1. readme.txt. Команда обзора тем рекомендует размещать всю документацию к темам в файле readme, который в идеале должен быть представлен в формате markdown.
  2. Вкладка с контекстной справкой в панели администратора. Еще одно хорошее расположение для документации, которое зачастую обходится вниманием. Темы, включающие в себя страницу настроек, должны обязательно использовать богатый API Contextual Help.
  3. Прилепленные записи на форуме. Для решения запросов в поддержку на форуме можно организовать прилепленные записи.
  4. Ссылки на внешнюю документацию. Наконец, темы могут иметь объявленные Theme URI, которые будут использоваться для указания ссылки на ресурс с информацией/документацией по теме. Если какой-либо из встроенных методов документации покажется вам слишком ограниченным, то в таком случае вы можете применять ThemeURI (который может быть доменом, поддоменом, посадочной страницей или даже GitHub репозиторием/сайтом с документацией к теме).

Лучшие практики и советы по созданию документации к теме


Теперь, когда мы узнали, где поместить документацию к теме, самое время перейти к вопросу, что вообще лучше включать в документацию? Беннетт рекомендует начинать документацию с вопросов лицензирования и разъяснения всех нестандартных аспектов процесса установки темы.

«Лучшие практики по созданию документации темы включают в себя явное указание копирайта/лицензии для всех ресурсов, поставляемых вместе с темой, разъяснение любых необычных/нестандартных инструкций по установке темы, а также описание любой функциональности, которая не относится к ядру темы», отметил Беннетт. «Если касаться встроенной документации, то я советую разработчикам придерживаться стандарта phpDoc, который улучшает удобочитаемость, а также позволяет автоматизировать генерацию документации к теме».

Лучшие практики по созданию документации темы не такие строгие, поэтому вы можете выбирать для себя любой маршрут из четырех приведенных командой обзора тем.

«Поддерживается практически любой метод по созданию документации», говорит Чип. «Разработчики темы могут, конечно, поставлять справочные документы вместе со своими темами. Некоторые используют для этого readme.txt или readme.md, другие обращаются к HTML-файлам, третьи могут включать PDF», отметил Чип.

«Единственный минус такого подхода – отсутствие какого-либо стандартного/простого способа, позволяющего пользователю найти/использовать эти документы», предостерегает Беннетт. «Опять же, Contextual Help API может оказаться полезным (он может использоваться для вывода текста/HTML или ссылки на PDF-файл, к примеру), как и Theme URI».

Беннетт также отметил, что выбранный вами путь реализации опций темы будет напрямую влиять на то, сколько документации вам придется написать. «Другая важная практика заключается в том, чтобы создавать различные возможности на базе ядра WordPress, в результате чего вам придется меньше их документировать», говорит Чип.

«К примеру, применение функций ядра при реализации произвольных изображений в хэдере или произвольных фонов позволяет создать стандартный, интуитивный интерфейс для конечного пользователя. Точно так же, при реализации произвольной статичной главной страницы или произвольного шаблона записей блога грамотное применение иерархии шаблонов позволяет избежать потребности в документировании нестандартного использования этих особенностей».

Беннетт приводит несколько примеров тем, обладающих качественной документацией, которая всегда находится под рукой. Он разработал свою тему Oenology, которая обладает прекрасной документацией. Страница настроек Oenology использует контекстную справку для вывода дополнительной информации по параметрам, популярным вопросам, журналу изменений, поддержке и лицензировании.

Разработчики тем могут посмотреть Oenology, чтобы увидеть, как Беннетт добавил к этой теме всю документацию. Чип также рекомендует проверить тему Underscores, являющуюся образцом прекрасно документированной темы.

На WordPress.org появится больше возможностей по созданию документации

У авторов плагинов на WordPress.org есть возможность добавления дополнительной документации к вкладкам FAQ и Installation. Когда я разговаривал с Беннеттом, он отметил, что у авторов тем нет на данный момент такой возможности.

«Каталог тем гораздо более ограничен. Каталоги тем и плагинов, по существу, выглядят практически одинаково во фронтэнде, однако если залезать «под капот», то это два разных зверя», отметил он. «Инфраструктуры сильно отличаются. В будущем появятся некоторые изменения, которые позволят эмулировать ту же самую (или похожую) функциональность в каталоге тем, основанную на стандартном формате файла readme».

Команда обзора тем еще будет обсуждать то, как именно могут быть реализованы улучшения, однако пока непонятно, как вообще будут выглядеть эти изменения. А пока разработчики тем могут использовать рекомендации, описанные Беннеттом.

Чтобы создать хорошую документацию, нужно продумать стратегию ее предложения своим пользователям, когда им требуется помощь. Подсказки Чипа Беннетта полезны всем авторам тем WordPress, вне зависимости от того, создаете ли вы произвольную тему для клиента, продаете ли коммерческую тему или поддерживаете бесплатную тему на WordPress.org. Комбинация методов с readme.txt, встроенной документацией, контекстной справкой и сторонними документами, заданными в Theme URI, поможет вам создать качественную информационную базу.

Поработайте над созданием высококачественной документации, и вы снимете с себя бремя поддержки пользователей. Как автор темы WordPress.org, я бы предпочел потратить свое свободное время на обновление и разработку новых функций, нежели на решение одних и тех же вопросов со стороны пользователей. Использование ядра для реализации особенностей вкупе с обеспечением качественной документации – лучший способ освободить свое время для создания более интересного материала: красивых тем, которые обязательно полюбят пользователи.

Источник: wptavern.com

oddstyle.ru

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *