No documentation
-
Sorry I want to give this higher, but there is no documentation to help people out.
-
This topic was modified 8 years ago by
PaulBart1974.
-
This topic was modified 8 years ago by
-
“No documentation”? Did you just completely ignore the plugin’s readme file?
I did yes. I can’t see any clear information on which functions do what. For example if I only want sites of a certain category to be listed.
Maybe I’m missing something? I spent the best part of a day trying to figure it out. I’m not a PHP expert but I thought I knew enough.
Unfair of me to mark your plugin down perhaps. But would be nice if there was a couple of examples which you would use within a page template.
If I call the function get_site_directory_logo for example, within a page temple all I get returned is the logo for the main site (id 1).
If I use the widget I get a list of all site – which is great but I need to be able to only list certain categories on certain pages. Also you mention creating 2 files –
*archive-network_directory.php
*taxonomy-subsite_category.phpAre these page templates? Again a bit more explanation would go a long way i.e. What comments do they need at the head of the file, in order for wordpress to override the index.php / taxonomy.php? At the moment as a widget they appear on every page.
I know a lot of people using this plugin are probably experts, but would be nice for some extra explanation of us lesser mortals…
-
This reply was modified 8 years ago by
PaulBart1974.
-
This reply was modified 8 years ago by
PaulBart1974.
I can’t see any clear information on which functions do what.
In addition to the documentation in the readme file, there is full documentation in the source itself. For example, there is a PHP DocBlock prepended to literally every single template function provided by the plugin, including
get_site_directory_logo(). If you don’t know what PHP DocBlocks are, read about them before you read the source code.Also you mention creating 2 files –
* archive-network_directory.php
* taxonomy-subsite_category.phpAre these page templates? Again a bit more explanation would go a long way…
Again, you really ought to consider spending some time with the very basics of WordPress Theme development. There is, of course, a Codex page all about the topic of Theme Development and beyond that, if it’s new to you, the WordPress Theme Handbook is a good place to start. It sounds like you are a little confused about how WordPress templates work, so I would further suggest you pay special attention to the Template Hierarchy section.
Rating a plugin badly simply because you haven’t the experience as a developer to develop your own custom design with a plugin that is not, was not, and will never be intended to be a design tool does seem very unfair to me. Do your own homework rather than punishing Free Software developers for not doing it for you.
-
This reply was modified 8 years ago by
The topic ‘No documentation’ is closed to new replies.