Pods CMS » Packages » User Guide

User Guide

Version 1.0.0 added 6 months ago by sc0ttkclark

{"meta":{"version":"180","build":"1262712523"},"pods":{"26":{"name":"user_guide","label":"","is_toplevel":"0","detail_page":"","list_filters":"","before_helpers":"","after_helpers":"","fields":[{"name":"examples","label":"Examples","comment":"","coltype":"code","pickval":"","sister_field_id":"0","weight":"6","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"start_version","label":"Start Version","comment":"What version did this get added?","coltype":"txt","pickval":"","sister_field_id":"0","weight":"1","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"slug","label":"Slug","comment":"","coltype":"slug","pickval":"","sister_field_id":"0","weight":"8","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"purpose","label":"Purpose","comment":"What the function does","coltype":"txt","pickval":"","sister_field_id":"0","weight":"2","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"see_also","label":"See Also","comment":"Similar or dependent pages","coltype":"pick","pickval":"user_guide","sister_field_id":"0","weight":"7","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"1"},{"name":"return_values","label":"Return Values","comment":"optional","coltype":"code","pickval":"","sister_field_id":"0","weight":"5","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"parameters","label":"Parameters","comment":"optional","coltype":"code","pickval":"","sister_field_id":"0","weight":"4","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"0","unique":"0","multiple":"0"},{"name":"name","label":"Title","comment":"","coltype":"txt","pickval":"","sister_field_id":"0","weight":"0","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"1","unique":"0","multiple":"0"},{"name":"description","label":"Description","comment":"","coltype":"code","pickval":"","sister_field_id":"0","weight":"3","display_helper":"","input_helper":"","pick_filter":"","pick_orderby":"","required":"1","unique":"0","multiple":"0"}]}},"templates":[{"name":"user_guide_detail","code":"<div id=\"user_guide_page\">\n\n<h1>{@name}<\/h1>\n\n<div id=\"user_guide_purpose\"><?php if ($this->get_field('start_version')) : ?>(Since {@start_version}) -- <?php endif; ?> {@purpose}<\/div>\n\n<div id=\"user_guide_description\">{@description, user_guide_output}<\/div>\n\n<?php if ($this->get_field('parameters')) : ?><div id=\"user_guide_parameters\"><h3>Parameters<\/h3>{@parameters}<\/div><?php endif; ?>\n\n<?php if ($this->get_field('return_values')) : ?><div id=\"user_guide_return_values\"><h3>Returns<\/h3>{@return_values}<\/div><?php endif; ?>\n\n<?php if ($this->get_field('examples')) : ?><div id=\"user_guide_examples\"><h3>Examples<\/h3>{@examples, user_guide_output}<\/div><?php endif; ?>\n\n<?php if ($this->get_field('see_also')) : ?><div id=\"user_guide_see_also\"><h3>See Also<\/h3>{@see_also, user_guide_see_also}<\/div><?php endif; ?>\n\n<\/div>"}],"pod_pages":[{"uri":"user-guide","title":"","phpcode":"<?php\n\/\/ Build link hover popups\n$result = pod_query(\"SELECT purpose, slug FROM wp_pod_tbl_user_guide\");\nwhile ($row = mysql_fetch_assoc($result))\n{\n    $user_guide[$row['slug']] = $row['purpose'];\n}\n?>\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/jquery.qtip-1.0.0-rc3.min.js\"><\/script>\n<script type=\"text\/javascript\">\njQuery(function() {\n    var json = <?php echo json_encode($user_guide); ?>;\n    for (var key in json) {\n        jQuery(\"#user_guideTable a[href^=\/user-guide\/\"+key+\"]\").attr(\"title\", json[key]);\n    }\n    jQuery(\"#user_guideTable a[title!='']\").qtip({\n        style: { name: \"cream\", border: { width: 7, radius: 5 }, tip: \"leftBottom\" },\n        position: { corner: { target: \"rightMiddle\", tooltip: \"leftBottom\" }}\n    });\n});\n<\/script>\n<h1>User Guide<\/h1>\n<table id=\"user_guideTable\">\n<tr>\n<td valign=\"top\" style=\"width:65%\">\n<h3>Getting Started<\/h3>\n<div><a href=\"\/user-guide\/what_is_blank\/\">What is Blank?<\/a><\/div>\n<div><a href=\"\/user-guide\/server_requirements\/\">Server Requirements<\/a><\/div>\n<div><a href=\"\/user-guide\/installation\/\">Installation<\/a><\/div>\n<h3>Using Blank<\/h3>\n<div><a href=\"\/user-guide\/managing_the_blank\/\">Managing the Blank<\/a><\/div>\n<div><a href=\"\/user-guide\/using_the_blank\/\">Using the Blank<\/a><\/div>\n<div><a href=\"\/user-guide\/uninstall\/\">Uninstall<\/a><\/div>\n<\/td>\n<td valign=\"top\" style=\"width:35%\">\n<h3>Global Functions<\/h3>\n<div><a href=\"\/user-guide\/blank_one\/\">blank_one()<\/a><\/div>\n<div><a href=\"\/user-guide\/blank_two\/\">blank_two()<\/a><\/div>\n<div><a href=\"\/user-guide\/blank_three\/\">blank_three()<\/a><\/div>\n<div><a href=\"\/user-guide\/blank_four\/\">blank_four()<\/a><\/div>\n<\/td>\n<\/tr>\n<\/table>","precode":"","page_template":""},{"uri":"user-guide\/*","title":"","phpcode":"<link type=\"text\/css\" rel=\"stylesheet\" href=\"\/wp-content\/themes\/uproot\/js\/highlighter\/styles\/shCore.css\" \/>\n<link type=\"text\/css\" rel=\"stylesheet\" href=\"\/wp-content\/themes\/uproot\/js\/highlighter\/styles\/shThemeDefault.css\" \/>\n<style type=\"text\/css\">\npre {\n    border: 0;\n    padding: 0;\n    background: none;\n}\n<\/style>\n\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/shCore.js\"><\/script>\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/shBrushCss.js\"><\/script>\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/shBrushJScript.js\"><\/script>\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/shBrushPhp.js\"><\/script>\n<script type=\"text\/javascript\" src=\"\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/shBrushSql.js\"><\/script>\n<script type=\"text\/javascript\">\nSyntaxHighlighter.config.clipboardSwf = '\/wp-content\/themes\/uproot\/js\/highlighter\/scripts\/clipboard.swf';\nSyntaxHighlighter.defaults['light'] = true;\nSyntaxHighlighter.defaults['wrap-lines'] = false;\nSyntaxHighlighter.all();\n<\/script>\n\n<?php\n$Record = new Pod('user_guide', pods_url_variable('last'));\nif (false !== $Record->data)\n{\n    echo $Record->showTemplate('user_guide_detail');\n}\nelse\n{\n    echo \"Oops! This page hasn't been created yet.\";\n}\n\nif (pods_access('pod_user_guide'))\n{\n?>\n    <div style=\"border:2px solid #ccc; padding:10px; margin-top:10px; background:#eeeeff\">\n        <?php echo $Record->publicForm(); ?>\n    <\/div>\n<?php\n}\n?>\n","precode":"","page_template":""}],"helpers":[{"name":"user_guide_output","helper_type":"display","phpcode":"<?php\n$value = str_replace('<?php', '&lt;?php', $value);\n$value = str_replace('<script', '&lt;script', $value);\necho $value;"},{"name":"user_guide_see_also","helper_type":"display","phpcode":"<?php\nif (is_array($value) && 0 < count($value))\n{\n    $see_also = array();\n    foreach ($value as $key => $val)\n    {\n        $see_also[] = '<a href=\"\/user-guide\/' . $val['slug'] . '\">' . $val['name'] . '<\/a>';\n    }\n    echo implode(', ', $see_also);\n}"}]}

1.0.0 Notes

Fresh release

About this Package

Easy to manage and user User Guide. Runs off of HTML, but the CSS is not included.