| 1 | <?PHP | ||
| 2 | |||
| 3 | /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| 4 | Our Help Sections | ||
| 5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */ | ||
| 6 | $help_sections = array(); | ||
| 7 | |||
| 8 | //---------------------------------- | ||
| 9 | // Including the News | ||
| 10 | //---------------------------------- | ||
| 11 | $help_sections["including"] = <<<HTML | ||
| 12 | <h1>Including The News</h1> | ||
| 13 | After CuteNews is successfully installed you can start posting your news. To display the news you must include the | ||
| 14 | file <b>show_news.php</b> (located in the main cutenews folder). To include show_news.php on your page you must use a code like this: | ||
| 15 | <div class="code"><?PHP<br> | ||
| 16 | include("path/to/show_news.php");<br> | ||
| 17 | ?></div> | ||
| 18 | And you must replace <i>path/to/show_news.php</i> with the real path to show_news.php, <b>NOT</b> the URL !!!<br> | ||
| 19 | Examples:<br> | ||
| 20 | <font color=green>CORRECT</font>: include("cutenews/show_news.php");<br> | ||
| 21 | <font color=red>WRONG </font>: include("http://site.com/cutenews/show_news.php");<br> | ||
| 22 | <br> | ||
| 23 | Remember that to be able to use the php code, the extension of the file where you include it must be .php<br> | ||
| 24 | If you want to include the code in .html page, you can rename he .html to .php and everything will work normal | ||
| 25 | HTML; | ||
| 26 | |||
| 27 | //---------------------------------- | ||
| 28 | // All possible variables while including | ||
| 29 | //---------------------------------- | ||
| 30 | $help_sections["variables"] = <<<HTML | ||
| 31 | <h1>All Variables You are Allowed to Use</h1> | ||
| 32 | Here is a list of all possible variables that you are allowed to use when including news or archives:<BR> | ||
| 33 | <div class="code" style='font-family: Verdana, Arial, Helvetica, sans-serif;'><?PHP<br><br> | ||
| 34 | <b>\$number = "<X>";</b> <i>// show only the X newest articles.</i><br> | ||
| 35 | <b>\$template = "<NAME>";</b> <i>// load another template, if you don't use it the default template will be loaded.</i><br> | ||
| 36 | <b>\$static = TRUE;</b> <i>// included news will not load on this location, for more info see 'Using Multiple Includes'.</i><br> | ||
| 37 | <b>\$category = "<ID>";</b> <i>// show only news from the selected category where <ID> is the id of category.</i><br> | ||
| 38 | <b>\$start_from = "<NUMBER>";</b> <i>// show the news starting not from the first newest but from <NUMBER>, it is required to use \$start_from = "<NUMBER>"; | ||
| 39 | only when you use \$number = "X";.</i><br> | ||
| 40 | |||
| 41 | <br>include("path/to/show_news.php");<br> | ||
| 42 | ?></div> | ||
| 43 | All of the above variables are optional and you may wish don't to use them. | ||
| 44 | HTML; | ||
| 45 | |||
| 46 | //---------------------------------- | ||
| 47 | // Using Multiple Includes | ||
| 48 | //---------------------------------- | ||
| 49 | $help_sections["multiple_includes"] = <<<HTML | ||
| 50 | <h1>Using Multiple Includes on One Page</h1> | ||
| 51 | Now will examine the situation when you want to use more than one include on a single page. For example if you want to show 5 headlines (using template headlines) | ||
| 52 | and below them to be shown all other news. The problem in this situatuion situation is that when you click on a headline CuteNews won't understand where to show the result, | ||
| 53 | on the headlines part or where all other news are included. The solution is to use the variable <b>$static = TRUE;</b> before including the headlines. When you use | ||
| 54 | this variable CuteNews won't display any result on the place where you use $static.<br> | ||
| 55 | Here is the correct code of the above example with the headlines and news: | ||
| 56 | <div class="code"><?PHP<br> | ||
| 57 | <u>Our Latest 5 Headlines</u>:<br> | ||
| 58 | \$static = TRUE;<br> | ||
| 59 | \$number = "5";<br> | ||
| 60 | \$template = "Headlines";<br> | ||
| 61 | include("path/to/show_news.php");<br> | ||
| 62 | <br> | ||
| 63 | <u>The News</u><br> | ||
| 64 | include("path/to/show_news.php");<br> | ||
| 65 | ?></div> | ||
| 66 | Now When you click on a headline it will be displayed on the place of the other news and the | ||
| 67 | list with the latest 5 headlines will still be showed.<br><br> | ||
| 68 | Make some test with <b>\$static = TRUE;</b> yourself to understand how it works exactly and how powerful | ||
| 69 | it can be. | ||
| 70 | |||
| 71 | HTML; | ||
| 72 | |||
| 73 | //---------------------------------- | ||
| 74 | // Users Section | ||
| 75 | //---------------------------------- | ||
| 76 | $help_sections["users"] = <<<HTML | ||
| 77 | <h1>Understanding User Levels</h1> | ||
| 78 | For better security and control of your users there four types of user-levels implemented in CuteNews. | ||
| 79 | Each user-level has limited permissions in doing specified actions and these permissions can not be changed.<br> | ||
| 80 | The user-levels are as fallows:<br> | ||
| 81 | <ol> | ||
| 82 | <li><b>Administrators</b> - administrators are allowed to do anything they want: edit others posts, comments, ban users, edit system configurations | ||
| 83 | and everything else ... so be careful when adding users as administrators !!!</li> | ||
| 84 | <br> | ||
| 85 | <li><b>Editors</b> - the users from this level are allowed to post news, they can edit own posts and the news posted from all other users. They can also approve news which are added by the 'Journalists'</li> | ||
| 86 | <br> | ||
| 87 | <li><b>Journalists</b> - this level is for users who only need to post and edit news. They can edit only own posts !. When journalist add's new article it will not be active and instead will be marked as 'Unapproved', In order for this article to become visible admin or editor must approve it.</li> | ||
| 88 | <br> | ||
| 89 | <li><b>Commenters</b> - when users from this level login, they are allowed only to change their passwords. Can not post, edit news or perform any other action. | ||
| 90 | This is useful when some user wants his username to be password protected when posting comments and no one else to be able to post with his username. You can also deny unregistered users to be able to post comments.</li> | ||
| 91 | </ol> | ||
| 92 | HTML; | ||
| 93 | |||
| 94 | //---------------------------------- | ||
| 95 | // Categories Section | ||
| 96 | //---------------------------------- | ||
| 97 | $help_sections["categories"] = <<<HTML | ||
| 98 | <h1>What are Categories and How To Use Them</h1> | ||
| 99 | When adding new category, it will appear in the "Add News" section. Therefore when you post your news you'll be able to | ||
| 100 | specify a category to which the article will belong (selecting category it optional), that way you can organize your news. | ||
| 101 | Now, when adding new category you'll be able to specify name for this category and optionally URL to icon for this category. | ||
| 102 | Automatically an ID number will be set for the new category, this ID is used when using include script to show all news <b>only</b> | ||
| 103 | from this category. Example code:<div class="code"><?PHP<br> | ||
| 104 | \$category = "<b>2</b>";<br>include("path/to/show_news.php");<br> | ||
| 105 | ?></div> | ||
| 106 | the above PHP code included on your page will display all news from category with ID 2<br> | ||
| 107 | If you for example have 5 categories and want to display news on one page from only 3 of the categories, you can use the fallowing code: | ||
| 108 | <div class="code"><?PHP<br> | ||
| 109 | \$category = "<b>2</b>,<b>3</b>,<b>5</b>";<br>include("path/to/show_news.php");<br> | ||
| 110 | ?></div> | ||
| 111 | the above code will display all news from categories with ID 2, 3 and 5.<br> | ||
| 112 | When you does <b>not</b> use \$category = "<ID>"; CuteNews will display the news from all categories, but when using this code, only news from the specified category(s) will be shown.<br><br> | ||
| 113 | The category icon can be shown together with your news, to do this you must put {category-icon} in your news templates. | ||
| 114 | HTML; | ||
| 115 | |||
| 116 | //---------------------------------- | ||
| 117 | // Templates Section | ||
| 118 | //---------------------------------- | ||
| 119 | $help_sections["templates"] = <<<HTML | ||
| 120 | <h1>Understanding Templates</h1> | ||
| 121 | Templates are used for easy editing the news look and the way news are displayed. | ||
| 122 | You can view the different parts of the template that are used for different parts of your news look. | ||
| 123 | For example the "Active News" part of the default template is used to modify the look of the active news, "Full Story" for the way your full story will look like, | ||
| 124 | "Comment" is the part corresponding to the appearance of the comments posted by users etc.<br><br> | ||
| 125 | When editing parts of the template you can use HTML in them to build different structures etc. Now you'll need to add some special tags in your templates | ||
| 126 | to specify the place where the title of your news will be displayed and the author name and the date when the news was pasted etc... these tags are | ||
| 127 | explained above each part of the template.<br> | ||
| 128 | Lets take the "Active News" part for example: when you expand this part, a list of allowed tags for this part will be displayed and under them will be the | ||
| 129 | text area. One very common and easy tag is <b>{title}</b>, wherever you put this tag in your template it will be replaced with the real title of your news.<br><br> | ||
| 130 | You can have more than one template, this is useful if you want to include the news on different pages of your site with different look of the news.<br> | ||
| 131 | After creating more templates you must use specific code when including news to indicate whit which template the news to be shown.<br> | ||
| 132 | example code:<div class="code"><?PHP<br> | ||
| 133 | \$template = "my_test_template";<br>include("path/to/show_news.php");<br> | ||
| 134 | ?></div>With the above code, all news will be showed using the my_test_template that you have created yourself. | ||
| 135 | if you don't specify what template to use, all news will use Default template which can not be deleted. | ||
| 136 | HTML; | ||
| 137 | |||
| 138 | //---------------------------------- | ||
| 139 | // Archives Section | ||
| 140 | //---------------------------------- | ||
| 141 | $help_sections["archives"] = <<<HTML | ||
| 142 | <h1>Explaining Archives and Their Usage</h1> | ||
| 143 | When you send your news to the archive, CuteNews will automatically create a new archive file under the ./archives/ folder with extension .arch . | ||
| 144 | Then all news that you selected for archiving will be moved from news.txt (where only the active news are hold) to the newly created file in archives/ | ||
| 145 | Therefore the news you have archived won't be visible from show_news.php but from show_archives.php where all available archives are nicely listed.<br> | ||
| 146 | Once the news are archived CuteNews don't have built-in feature for moving back news from archive to active news, so the only way to do it is by manually | ||
| 147 | opening the archive file and copying its content to news.txt<br><br> | ||
| 148 | When you send all your active news to the archive there won't be left active news, but if you use<br> \$number = <b>X</b>; in your include code, CuteNews will | ||
| 149 | automatically show the X newest news from the archive.<br><br> | ||
| 150 | Sending your news to archive is optional and you may never use it, but it is useful if you have many news articles and | ||
| 151 | want to organize them. Using archive is also recommended when you have more than 3000 active news. | ||
| 152 | HTML; | ||
| 153 | |||
| 154 | //---------------------------------- | ||
| 155 | // Adding News Options | ||
| 156 | //---------------------------------- | ||
| 157 | $help_sections["addnews_options"] = <<<HTML | ||
| 158 | <h1>Options When Adding News</h1> | ||
| 159 | When adding/editing news, you have several options that you can choose to apply to the specified article. | ||
| 160 | <ul> | ||
| 161 | <li><b>Convert new lines to <br /></b> - if checked, this option will convert all the new lines in your article to the HTML equivalent for new line.</li> | ||
| 162 | <li><b>Use HTML in this article </b> - if checked, CuteNews will parse this article as HTML elements + text, if unchecked - your article will be treated as pute text.</li> | ||
| 163 | <li><b>Normal</b> adding of Article - if you are adding your article as normal it will be immediately desplayed</li> | ||
| 164 | <li><b>Draft</b> adding of Article - this option will add the article but it will not be visible for your visitors until you activate (approve) it later. | ||
| 165 | <li><b>Postpone</b> Article - if you postpone your article you must select a date when it will automatically be published and became visible for your visitors, when the specified that is reached the article will be added as new with this date. | ||
| 166 | </ul> | ||
| 167 | HTML; | ||
| 168 | |||
| 169 | /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| 170 | Load the specified section in PopUp Window | ||
| 171 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */ | ||
| 172 | if(isset($section)){ | ||
| 173 | if(!isset($help_sections["$section"])){ die("Can not find the specified section <b>$section</b>"); } | ||
| 174 | echo"<HTML> | ||
| 175 | <style type=\"text/css\"> | ||
| 176 | <!-- | ||
| 177 | a:active,a:visited,a:link {color: #446488; text-decoration: none; font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 8pt;} | ||
| 178 | a:hover {color: #00004F; text-decoration: none; font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 8pt; } | ||
| 179 | .code { | ||
| 180 | font-family : Andale Mono, Courier; | ||
| 181 | border: 1px solid #BBCDDB; | ||
| 182 | margin:10px; | ||
| 183 | padding:4px; | ||
| 184 | background:#FBFFFF; | ||
| 185 | } | ||
| 186 | h1 { | ||
| 187 | background-color : #BBCDDB; | ||
| 188 | border-bottom : #000000 1px solid; | ||
| 189 | border-top : #000000 1px solid; | ||
| 190 | color : #000000; | ||
| 191 | font-family : Tahoma, Verdana, Arial, Helvetica, sans-serif; | ||
| 192 | font-size : 16px; | ||
| 193 | font-weight : bold; | ||
| 194 | margin : -10px 0px 10px 0px; | ||
| 195 | padding-bottom : 5px; | ||
| 196 | padding-left : 10px; | ||
| 197 | padding-right : 10px; | ||
| 198 | padding-top : 5px; | ||
| 199 | text-decoration : none; | ||
| 200 | margin-left: -10px; | ||
| 201 | margin-right: -8px; | ||
| 202 | } |