Please login or register.

Login with username, password and session length
Advanced search  

Author Topic: [STICKY] DOCUMENTATION (so far)  (Read 4429 times)

Patric Ahlqvist

  • Nobodys perfect, but Im pretty effing close
  • ULTIMATE member
  • ******
  • Karma: 65
  • Posts: 4867
  • I'm a self-made man and worships my creator.
    • p-ahlqvist.com
[STICKY] DOCUMENTATION (so far)
« on: September 10, 2006, 11:34:21 AM »

Originally posted by Mika

DOCUMENTATION

Admin Panel - Site settings

SETTINGS:
- Website Title: text displayed in the tag on your site
- Home Title: "Home" link title displayed in the upper navigation bar, and in breadcrumb navigation bar
- Home SEF: Search Engine Friendly addition to the "Home" title, used as link to your Home, i.e. index page
- Default descripion META Tag: short and informative description of your site; used for search engines (note: just a few of them are still using this kind of information about your site)
- Default keywords META Tag: keywords separated by comma; used for search engines (note: just a few of them are still using this kind of information about your site)

CONTACT INFO:
- Email and Contact Form "Subject" are used as a basic sender informations in contact form

TIME AND LOCALE SETTINGS:
- sNews Language: default language is english (EN). if you want to use some other language, please create and upload your translation file to your site root - filename must be snews_XY.php where XY is your language acronym (snews_ES.php, snews_FR.php, snews_RU.php and so on...). after successfull uploading, edit the default acronym according to your language file
- Default charset: character set used for proper alphabet localizaton and display. we recommend to use UTF-8, but if you encounter on some special character issues, please change this value to fit your local alphabet settings.

CONTENTS:
- Articles per page limit: number of articles visible on your home/index page
- RSS Articles limit: number of RSS feeds available on your server generated xml file
- Use "Page" as "Home page": user can change which page will be served as index. if "None" is selected, then home page will be default "Home". Other options are available only after user creates some "Pages" in content management panel
- Display new articles on Home: if this option is marked/enabled, all new articles will be visible in your index page regardless of their category. if this option is left unmarked/disabled, only uncategorized articles will be visible on index page
- Display Pagination on articles: enabling or disabling article paginator menu (<>). if this option is enabled, paginator menu will be visible only if there are more articles than defined in "Articles per page limit"
- Display number of articles next to a category: simple counter used to quickly determine how many articles are in each category

COMMENTS:
- Approve comments before publishing: if this option is enabled, every comment must be verified by administrator first. if this option is disabled, all comments are published without verification
- Comments order: order in which comments are displayed. we suggest not to change comments order very often because if your permalinks (available in "New comments" panel on the index page) are bookmarked by the visitors, they may not work properly
- Enable Badwords filter: if enabled, filter will check and supress all the profanities and spam words defined in "bad_word.txt" file
- Badwords filter file: repository of most used profanities and spam words, must be uploaded to your server in order to work (v1.4 bad_word.txt can be used as well)
- Badwords replacement word: substitute result upon filtering comment against profanities. usually is ****** but you can use any other string to substitute profanity found in comment

CHANGE USERNAME AND PASSWORD:
- default username: test
- default password: test
- please use non-intuitive username and password in order to increase your site security level. we suggest to use alphanumeric set of characters that cannot be found in dictionary, mix of lowercase and uppercase letters and numbers. please avoid using non-english characters, spaces and special characters such as ,.;:-+?=()/&%$#"!
- if you forget your username and/or password, the only way to retrieve it is entering your server database through phpmyadmin
Logged
"It's only dead fish that goes with the flow... "
Updated

Mika

  • Hero Member
  • *****
  • Karma: 9
  • Posts: 1377
    • http://www.ni5ni6.com/
[STICKY] DOCUMENTATION (so far)
« Reply #1 on: September 10, 2006, 12:42:03 PM »

Admin panel - content management

CATEGORIES: ADD NEW
- Name: the name of your category (must be unique)
- Search Engine Friendly Title: used as link to your category (must be unique)
- Description:  title attribute of your category link (Category)
- Publish: automatic publishing is enabled by default. Note: Category link will be visible only if there is at least one article attached to it (see Articles: Add New section); if category has no contents at all, it will be visible only through admin category view listing
IMPORTANT: when category is deleted, all the articles in it are demoted to default "Home"
Category order
- this mode is enabled only if there's more than one category present
- by inserting numbers in ascending order, you can customize the order of displaying category links on your site

ARTICLES: ADD NEW
- Title: the title of your article (must be unique)
- Search Engine Friendly Title: used as link to your article (must be unique)
- Text: for now, textarea is strictly html enabled, therefore you can use all html tags to create/edit your contents
- the basic and most common html tag buttons below are already at your disposal:
- B
- I
- Strike
- Image image alternative text
- Link link
- [Break] tag is a new feature which splits your article in two sections: the first one is visible on your index/category page, and the other is visible through read more link (in sNews v1.4 you had to manually add the number of characters in order to achieve the same thing). this tag can be applied only once (don't worry if you insert it more than once - only the first occurance is active, and the [break] tag itself is invisible to the visitors). we suggest that you apply this tag outside html tags in order to achieve proper html validation*
- [Include] tag is an external file inclusion feature inherited from the previous sNews version. with it you can virtually add any** external file directly to your article contents. by default, allowed file types for inclusion are .php/.txt/.inc, and you can change these fileytype options through administrative language settings ($l['file_include_extensions'] = 'php,txt,inc';) at the top of snews.php file
- Preview: live html generating preview of your article; all html tags are parsed automatically as you type
- Publish: article is published by default, if you don't want to publish it immediately, disable this option: then it will be visible only in admin article view listing

Customize
- Category: choose the category for your article. default is Home, and this option is enabled only if there is at least one category previously created
- Default descripion META Tag: short and informative description of your article; used for search engines (note: just a few of them are still using this kind of information about your site)
- Default keywords META Tag: keywords separated by comma; used for search engines (note: just a few of them are still using this kind of information about your site)
- Display Title: article title visible by default. Note: if you apply [break] tag to your article, title will become an active link with the same role as read more link
- Display info line (read more/ comments/ date): article footer visible by default. Note: read more and comments links are visible only if you enable commenting and/or [break] tag. when you are logged in as admin, there is also an edit link which is visible at all times regardless to this option.
- Enable comments: enabled by default.  Note: if there are comments present, and this option is disabled, previously posted comments will be invisible to the visitors
- Freeze comments: visible only in article editing mode. Note: if there are comments present, and this option is disabled, previously posted comments will still be visible but any further commenting will be impossible

Publish date
- Enable: if you want to postpone article publishing for some time in the future, enable this option and set the new publishing time in the option menu below. Note: there is a server time display as well and it may not be synchronized with your local time - please contact your hosting company for more info if these times are different
IMPORTANT: when article is deleted, all the comments in it are deleted as well.
______________________________
*
example:
- INVALID

your contents goes [break] here

lorem ipsum...
- VALID

your contents goes here

[break]

lorem ipsum...
**
- php files are automatically parsed, but there may be possible limitations regarding session, cookie or sending header informations (for more info please visit http://www.php.net)
- valid html file comes with complete set of html tags (including header tags <meta> and <body>) - if you want to include external html file, please remove all those tags (leaving ONLY what's between <body> and </body>), and rename it to "your-file<strong>.txt</strong>" or "your-file<strong>.inc</strong>" - html tags in it will still be parsed<br /><br /><br /><span style="color: red;" class="bbc_color">...more to come...</span></div> </div> </div> <div class="moderatorbar"> <div class="smalltext floatleft" id="modified_12850"> </div> <div class="smalltext largepadding floatright"> <img src="http://snewscms.com/forum/Themes/core/images/ip.gif" alt="" border="0" /> Logged </div> <div class="signature" id="msg_12850_signature"><a href="http://www.ni5ni6.com/" class="bbc_link" target="_blank">http://www.ni5ni6.com/</a> - Tutorials, Mods and How-To's about sNews CMS<br /><a href="http://www.ni5ni6.com/home/snews-16-developers-edition/" class="bbc_link" target="_blank">sNews 1.6 Developers Edition</a> - commented sNews 1.6 version</div> </div> </div> </div> </form> </div> <a id="lastPost"></a> <div class="clearfix marginbottom" id="postbuttons_lower"> <div class="nav floatright"> <div class="buttonlist"> <ul class="reset clearfix"> <li class="last"><a class="button_strip_print" href="http://snewscms.com/forum/index.php?action=printpage;topic=1622.0" rel="new_win nofollow"><span>Print</span></a></li> </ul> </div></div> <div class="middletext floatleft">Pages: [<strong>1</strong>] </div> <div class="clear"><a href="http://snewscms.com/forum/index.php?topic=1622.0;prev_next=prev#new">« previous</a> <a href="http://snewscms.com/forum/index.php?topic=1622.0;prev_next=next#new">next »</a></div> </div> <ul class="linktree" id="linktree_lower"> <li> <a href="http://snewscms.com/forum/index.php"><span>sNews Forum</span></a> > </li> <li> <a href="http://snewscms.com/forum/index.php#c4"><span>Previous sNews versions</span></a> > </li> <li> <a href="http://snewscms.com/forum/index.php?board=75.0"><span>sNews 1.5 RC and pre-release</span></a> > </li> <li> <a href="http://snewscms.com/forum/index.php?board=27.0"><span>sNews 1.5 RC version</span></a> > </li> <li class="last"> <a href="http://snewscms.com/forum/index.php?topic=1622.0"><span>[STICKY] DOCUMENTATION (so far)</span></a> </li> </ul> <div id="moderationbuttons" class="clearfix"></div> <div class="tborder"> <div class="titlebg2" style="padding: 4px;" align="right" id="display_jump_to"> </div> </div><br /> <script type="text/javascript" src="http://snewscms.com/forum/Themes/default/scripts/topic.js"></script> <script type="text/javascript"><!-- // --><![CDATA[ if ('XMLHttpRequest' in window) { var oQuickModify = new QuickModify({ sScriptUrl: smf_scripturl, bShowModify: true, iTopicId: 1622, sTemplateBodyEdit: '\n\t\t\t\t<div id="quick_edit_body_container" style="width: 90%">\n\t\t\t\t\t<div id="error_box" style="padding: 4px;" class="error"><' + '/div>\n\t\t\t\t\t<textarea class="editor" name="message" rows="12" style="width: 100%; margin-bottom: 10px;" tabindex="1">%body%<' + '/textarea><br />\n\t\t\t\t\t<input type="hidden" name="f296085540" value="4142baeca95c334567915372d0d74815" />\n\t\t\t\t\t<input type="hidden" name="topic" value="1622" />\n\t\t\t\t\t<input type="hidden" name="msg" value="%msg_id%" />\n\t\t\t\t\t<div class="righttext">\n\t\t\t\t\t\t<input type="submit" name="post" value="Save" tabindex="2" onclick="return oQuickModify.modifySave(\'4142baeca95c334567915372d0d74815\', \'f296085540\');" accesskey="s" class="button_submit" />  <input type="submit" name="cancel" value="Cancel" tabindex="3" onclick="return oQuickModify.modifyCancel();" class="button_submit" />\n\t\t\t\t\t<' + '/div>\n\t\t\t\t<' + '/div>', sTemplateSubjectEdit: '<input type="text" style="width: 90%" name="subject" value="%subject%" size="80" maxlength="80" tabindex="4" class="input_text" />', sTemplateBodyNormal: '%body%', sTemplateSubjectNormal: '<a hr'+'ef="http://snewscms.com/forum/index.php'+'?topic=1622.msg%msg_id%#msg%msg_id%" rel="nofollow">%subject%<' + '/a>', sTemplateTopSubject: 'Topic: %subject%  (Read 4429 times)', sErrorBorderStyle: '1px solid red' }); aJumpTo[aJumpTo.length] = new JumpTo({ sContainerId: "display_jump_to", sJumpToTemplate: "<label class=\"smalltext\" for=\"%select_id%\">Jump to:<" + "/label> %dropdown_list%", iCurBoardId: 27, iCurBoardChildLevel: 1, sCurBoardName: "sNews 1.5 RC version", sBoardChildLevelIndicator: "==", sBoardPrefix: "=> ", sCatSeparator: "-----------------------------", sCatPrefix: "", sGoButtonLabel: "go" }); aIconLists[aIconLists.length] = new IconList({ sBackReference: "aIconLists[" + aIconLists.length + "]", sIconIdPrefix: "msg_icon_", sScriptUrl: smf_scripturl, bShowModify: true, iBoardId: 27, iTopicId: 1622, sSessionId: "4142baeca95c334567915372d0d74815", sSessionVar: "f296085540", sLabelIconList: "Message Icon", sBoxBackground: "transparent", sBoxBackgroundHover: "#ffffff", iBoxBorderWidthHover: 1, sBoxBorderColorHover: "#adadad" , sContainerBackground: "#ffffff", sContainerBorder: "1px solid #adadad", sItemBorder: "1px solid #ffffff", sItemBorderHover: "1px dotted gray", sItemBackground: "transparent", sItemBackgroundHover: "#e0e0f0" }); } // ]]></script> <script type="text/javascript"><!-- // --><![CDATA[ var verificationpostHandle = new smfCaptcha("http://snewscms.com/forum/index.php?action=verificationcode;vid=post;rand=efbbd662a10fef10581020722eec9000", "post", 1); // ]]></script> </div> <div id="footerarea" class="headerpadding topmargin clearfix"> <ul class="reset smalltext"> <li class="copyright"> <span class="smalltext" style="display: inline; visibility: visible; font-family: Verdana, Arial, sans-serif;"><a href="http://snewscms.com/forum/index.php?action=credits" title="Simple Machines Forum" target="_blank" class="new_win">SMF 2.0.14</a> | <a href="http://www.simplemachines.org/about/smf/license.php" title="License" target="_blank" class="new_win">SMF © 2017</a>, <a href="http://www.simplemachines.org" title="Simple Machines" target="_blank" class="new_win">Simple Machines</a> </span></li> <li><a id="button_xhtml" href="http://validator.w3.org/check?uri=referer" target="_blank" class="new_win" title="Valid XHTML 1.0!"><span>XHTML</span></a></li> <li><a id="button_rss" href="http://snewscms.com/forum/index.php?action=.xml;type=rss" class="new_win"><span>RSS</span></a></li> <li class="last"><a id="button_wap2" href="http://snewscms.com/forum/index.php?wap2" class="new_win"><span>WAP2</span></a></li> </ul> </div> </div> </body></html>