| Line 3: |
Line 3: |
| | | mod_summary = Adds a forum system to TNG, for logged in users | | | mod_summary = Adds a forum system to TNG, for logged in users |
| | | mod_validation = The mod is XHTML compliant.[[Image:Valid-xhtml10.png|44px]] | | | mod_validation = The mod is XHTML compliant.[[Image:Valid-xhtml10.png|44px]] |
| − | | download_link = for {{Tv1013}}[https://xerxx.se/modSupport/click/click.php?id=89 Forum_for_tng_mod_v10.1.3.alfa0.zip] | + | | download_link = DOWNLOAD STOPPED! |
| | | download_stats = [https://xerxx.se/modSupport/click/index.php?action=stats&groupid=17 Forum for TNG] | | | download_stats = [https://xerxx.se/modSupport/click/index.php?action=stats&groupid=17 Forum for TNG] |
| | | mod_author = Erik Hoppe | | | mod_author = Erik Hoppe |
| Line 27: |
Line 27: |
| | == THIS PAGE IS UNDER DEVELOPMENT! == | | == THIS PAGE IS UNDER DEVELOPMENT! == |
| | | | |
| − | The mod can be downloaded nevertheless.<br/> | + | The mod can NOT be downloaded.<br/> |
| − | Translations are made at this very moment and will be added to the v.0 release.<br/>
| + | Last minute changes and translations are made at this very moment and will be added to the v.0 release that is coming soon.<br/> |
| | See this thread, [https://tng.community/index.php?/forums/topic/11778-mod-forum-for-tng-translators-wanted/ in the TNG Community forum] | | See this thread, [https://tng.community/index.php?/forums/topic/11778-mod-forum-for-tng-translators-wanted/ in the TNG Community forum] |
| | | | |
| | | | |
| − | == NOTE: This is an ALFA version == | + | == Integrated into TNG == |
| | | | |
| − | '''This mod should be installed in a TEST environment!'''<br/>
| + | The forum system acts as a part of your TNG installation: |
| − | You have to be prepared to maybe lose what's been posted when a production version is published.<br/>
| + | * Logged-in users don't have to register or log in |
| − | There will probably be an upgrade version from alfa to .0 when it's released but there can be no 100% promises.<br/>
| + | * TNG design and template colours are used |
| − | This is a complicated system to thoroughly test alone and therefore '''TESTERS ARE WANTED''' (needed).
| + | * The Forum link is found in the Info dropdown menu |
| | + | * The "New post" signal appears in the menu heading and the menu link |
| | + | * A person or family ID can be used as a header for a thread and becomes a link |
| | + | * Persons or families in thread headers get an Individ or Family event "Forum" = a link to the thread |
| | + | * You can create threads and full forums only visible for ''Editors'' and/or ''Administrators'' |
| | + | * Database tables are handled in ''Tools'' (Backup, Restore...) |
| | | | |
| | | | |
| Line 50: |
Line 55: |
| | * Danish: Mogens C. Fenger | | * Danish: Mogens C. Fenger |
| | * Dutch: Marco van den Heuvel | | * Dutch: Marco van den Heuvel |
| − | '''''Please make this list include your name and language'''''
| + | * French: Christophe Potié |
| | + | * German: Hendrik Martius |
| | | | |
| | | | |
| | == Testers == | | == Testers == |
| | | | |
| − | My sincere '''Thank You''' to these persons who have been brave enough to install and run the beta version and then reported back to me: | + | My sincere '''Thank You''' to these persons who have been brave enough to install and run the beta and alpha versions and then reported back to me: |
| | * Mogens C. Fenger | | * Mogens C. Fenger |
| | * Marco van den Heuvel | | * Marco van den Heuvel |
| − | '''''Please make this list include your name'''''
| + | * Hendrik Martius |
| | + | * Christophe Potié |
| | + | * Ken Roy |
| | | | |
| | | | |
| Line 85: |
Line 93: |
| | | | |
| | | | |
| − | == Installation and Forum setup == | + | == Installation and First Forum setup == |
| − | <br/>
| |
| − | <span style="color:#FF00FF;">'''NOTE:''' If you have '''uninstalled''' this mod previously, f.ex. to upgrade TNG or this mod:<br/>'''Read below under ''Uninstalling the mod''''' as there is vital information there!</span><br/><br/>
| |
| | # Click on the download link, shown in the summary in the upper right corner of the page. | | # Click on the download link, shown in the summary in the upper right corner of the page. |
| | # You will receive a zipped file. Unzip it and open the folder. | | # You will receive a zipped file. Unzip it and open the folder. |
| | # Inside you will find: | | # Inside you will find: |
| − | * A ModManager config file: ''forum_for_tng_mod_v10.1.3.alfa0.cfg'' | + | * A file named '''''READ_THIS.txt''''' <== '''Important! |
| − | * A folder named ''forum_for_tng_mod_v10.1.3.alfa0''<br/>FTP or copy both to the '''mods''' folder in your '''TEST-intallation''' of TNG
| + | * A ModManager config file: ''forum_for_tng_mod_v11.0.1.0.cfg'' |
| − | * A second folder named ''ForumIcons_Save_on_PC'' - Save this on your computer:<br/>It contains all TNG 40x40 px icons and can be used for your Forums.<br/>If you have these icons somewhere on your PC already or want to use your own, you don't need this folder. | + | * If you downloaded the '''Update''' package: A second ModManager config file: ''forum_for_tng_mod_v10.1.3.alfa0UPDATE.cfg'' |
| − | | + | * A file named ''Use_News_Signal_Yourself.txt'' |
| − | {| border="1" cellspacing="5" cellpadding="2" width="100%" class="wikitable"
| + | * A folder named ''forum_for_tng_mod_v11.0.1.0'' |
| − | |-
| + | * A folder named ''Forum link to index Mods'' |
| − | | colspan="2" align="center" | <br/>4. '''Now follow these steps and you will (probably ;-) have a trouble-free installation.'''<br/><br/>
| + | * A folder named ''ForumIcons_Save_on_PC'' |
| − | |-
| + | # Open the '''''READ_THIS.txt''''' file and read it, so you understand WHAT, WHEN and HOW to use the contents. |
| − | | width="570px" | [[File:Forumb0.png]]<br/><br/>
| + | # When the correct files are uploaded to the '''mods''' folder at your server,<br/>follow the instructions in [https://xerxx.se/forumDemo/forum_Manual/index.html '''Forum For TNG - The Admin Manual''']<br>The four necessary steps - ''Install, Create, Set up'' and ''Release'' - are fully explained. Plus a lot more. |
| − | | valign="top" | So this is what the .cfg file looks like in ''ModManager''.<br/>
| |
| − | <br/>The installation is done in three steps:<br/>
| |
| − | # Create tables and folders, copy files (both automatic) and provide some basic data
| |
| − | # Setting up your first forum - or several
| |
| − | # ModManager install
| |
| − | '''Note''' that the MM button "Install" is '''last''' in this procedure.<br/>
| |
| − | <br/>In the '''simplest case''' the three steps include no more than this:<br/>
| |
| − | # Click the first button, click "OK", enter your e-mail, (copy and paste the same), enter a collective forum name, click the "Finish" button and close the browser window.
| |
| − | # Click the second button, enter a forum name, enter a forum description, enter a starting thread name, click a checkbox, select an icon, click the "Save" button and close the browser window.
| |
| − | # Click the ModManager "Install button". Leave the Admin area...
| |
| − | Done. The first forum is created and live. You can add more forums later.<br/>
| |
| − | <br/>In the '''worst case''' (you decide) you '''also''' have to, in step
| |
| − | # Enter a second e-mail, select two languages (in dropdown menus) and enter an extra name.
| |
| − | # Enter an extra forum name, extra description, extra name for the starting thread (all for the second language) and two texts (two languages) for the starting post.<br/>And repeat this step for a new forum.<br/>
| |
| − | ''(This was only to show that the below is more images and explaining texts than hard work for you...)''
| |
| − | |-
| |
| − | | align="center" valign="top" colspan="2" | <br/>'''Okay. Let's start by clicking the first button:'''<br/>
| |
| − | <span style="color:#FF00FF;">But '''not''' if you have previously uninstalled the mod!</span> (Read ''"Uninstalling..."'' below)<br/>[[File:Forumb1.png]]<br/><br/>
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb2.png]]<br/><br/>
| |
| − | | valign="top" | You get this alert and you should take it seriously:<br/>Your database and files '''WILL''' be modified and therefore they '''may''' be corrupted.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb3.png]]<br/><br/>
| |
| − | | valign="top" | A new window/tab will open. (This page is only available in English).
| |
| − | <p>First you will get reports of what is happening.<br/>
| |
| − | As long as everything goes okay the reports will say so, one by one.<br/>Four in total.</p>
| |
| − | When all is okay you will get a form to complete.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb4.png]]<br/><br/>
| |
| − | | valign="top" | E-mail address(es):
| |
| − | * The system may send you messages - Reported posts are currently the only ones but nonetheless:<br/>Enter an e-mail address in the top box to where such messages shall be sent.<br/>This e-mail is '''mandatory'''.
| |
| − | * If you provide an e-mail address in the second box, your users will have the option to "Watch" threads:<br/>When someone else posts to a "Watched" thread, a mail will be received as a notification.<br/>(Max 1 mail per day per watched thread)<br/>This e-mail address is the '''from''' address in the sent mails.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb5.png]]<br/><br/>
| |
| − | | valign="top" | If your site default language is translated, that will be your default forum language.<br/>
| |
| − | If there is no translation, '''English''' will be the default.
| |
| − | <p>If you '''use''' more than one language at your site:<br/>
| |
| − | If there is no translation for your default but for other languages that you '''use''', English is ''suggested'' but you may select another one of the translated ones.</p>
| |
| − | <p>If you '''use''' more than one language, you may also select a second language to make your forum(s) '''bi-lingual''':<br/>
| |
| − | You can (as you whish) set up forums in one '''or''' two languages.(You write both versions)<br/>
| |
| − | Users may (as they whish) post in one '''or''' two languages.<br/>
| |
| − | Users who don't use your site default language will get the texts displayed in the second language.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb6.png]]<br/><br/>
| |
| − | | valign="top" | Finally give your forum system a name.<br/>This name is displayed at the top of all pages and will link to the forum starting page.<br/>If you have selected a second language above, you '''have to''' provide a name for that language too.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb7.png]]<hr/>[[File:Forumb8.png]]<hr/>[[File:Forumb9.png]]<br/><br/>
| |
| − | | valign="top" | Now click the ''Finish Setup'' button and you will see the ''Attempting...'' message and then the page will shrink into the final message if no errors occured.<br/>
| |
| − | Close the window (tab) and return to ''ModManager''.
| |
| − | |-
| |
| − | ! colspan="2" | <br/>'''Okay, you're back in ''ModManager''.<br/>Now for the second button:''' [[File:Forumb10.png]]<br/><br/>
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb11.png]]<br/><br/>
| |
| − | | valign="top" | When you click that button, a new window/tab will open.<br/>'''''Please read carefully what the text says'''''.<br/><br/>When you see this text, it's safe to close the tab to, f.ex, take a break. Your work is saved.<br/>You return to this page by the same button in ''ModManager''.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb12.png]]<br/><br/>
| |
| − | | valign="top" | As this is your first forum, you are taken directly to the '''New Forum''' form.<br/><br/>If you have selected a second language (in the previous step) you have the option to write your texts in two languages. (Whatever you choose here, your users may post in one or two languages as they please.)<br/><br/>
| |
| − | Do you see the checkbox by the "'''?'''"..? Check it and a short help-text will appear.<br/>All fields in the form has one.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb13.png]]<br/><br/>
| |
| − | | valign="top" | You have to give the forum a name and a descriptive text.<br/>Both can be edited later - also after installation.<br/><br/>I named, and described, my forums by the subject they are supposed to handle: ''Persons'', ''Familes''... Se my [https://xerxx.se/forumDemo/indexDemo.php Forum Demo]
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb14.png]]<br/><br/>
| |
| − | | valign="top" | All forums start with a "''Sticky''" (always on top) and ''Locked'' (users can't post) thread with one starting post.<br/>(Administrators can add more posts later.)<br/>You can describe the purpose of the forum in detail or maybe set forum rules.
| |
| − | <br/>You '''have to''' give it a title (maybe something like ''Read This First!'').<br/>
| |
| − | If you are going to use only one forum, you check the checkbox and the textbox will disappear, making the descriptive text you wrote above, the contents of the first post.<br/>
| |
| − | If you later add forums, this can be changed.<br/>(You ''may'' check the box if you are lazy and want to re-use the descriptive text, also if you will have more than one forum)
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb15.png]]<br/><br/>
| |
| − | | valign="top" | '''Forum Restrictions:'''<br/>What you select here, affects '''this''' forum, all threads and all posts. You should have at least one forum with no restrictions as the link to the forums is visible for all logged-in users - editors or not.<br/>Threads in other forums can be tagged as ''"Editor only"'' by the author if it's an Editor or Administrator.<br/><br/>There are examples of both an editor-only forum and thread in my [https://xerxx.se/forumDemo/indexDemo.php Forum Demo]<br/><br/>
| |
| − | '''Forum Type:'''<br/>
| |
| − | A ''"Help-forum"'' is a special kind in that it shows all posts, except the first of a thread, in a collapsed state with a headline to click to expand it.<br/>This is handy for manuals and help-files that can be divided into chapters.<br/>A ''"Help-forum"'' is locked (except for Administrators).<br/><br/>
| |
| − | A ''"Question-forum"'' will have all threads marked as a question and therefore is suited for subjects where users help eachother - like we use one such to help eachother interpret handwritten texts, for ex.<br/><br/>There is an example of both in my [https://xerxx.se/forumDemo/indexDemo.php Forum Demo] (copies of actual threads)
| |
| − | |-
| |
| − | | align="left" valign="top" colspan="2" | '''Select an icon:''' Included in the mod package is a folder named ''"Forumicons_Save_on_PC"''.<br/>It contains all the original TNG 40x40px icons (plus two I use) for your convenience.<br/>If you want to use your own, they shall be no larger than '''40 x 40 pixels''' and shall be of the type '''.jpg''' or '''.gif'''.<br/>Click the ''"Browse..."'' button, select the icon of your choice and click ''"OK"''.
| |
| − | |-
| |
| − | | align="center" valign="top" colspan="2" | [[File:Forumb16.png]]<br/><br/>
| |
| − | |-
| |
| − | | align="center" valign="top" colspan="2" | <br/>'''And so you click the ''"Save"'' button and...<br/><br/>
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb17.png]]<br/><br/>
| |
| − | | valign="top" | ... you have created your first forum.<br/>
| |
| − | Let's have a look what it looks like - click the ''"Test you forum(s)"'' button (test mode - looking only) and a new window/tab will open.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb18.png]]<br/><br/>
| |
| − | | valign="top" | As there is currently only one forum, that forum will open.<br/>
| |
| − | If you decide to keep with one, this will also be the default for all users, including yourself:<br/>
| |
| − | You reach the ''"Setup and Edit"'' screen by the button at the bottom.<br/><br/>
| |
| − | As it's test mode, everything is disabled except the link to open the thread (the thread name).
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb19.png]]<br/><br/>
| |
| − | | valign="top" | Clicking the thread name opens it.<br/><br/>Here you see the Administrator panel: You (all Administrators) can<br/>
| |
| − | * Make or Un-make Sticky, Editors, Question, Solved question, Discussions and Locked threads.<br/>
| |
| − | * Move the whole thread to another forum (if there are any)
| |
| − | * Delete the whole thread.
| |
| − | (Single posts are deleted by a button inside the post.)<br/><br/>As at the previous page, all actions are disabled in test mode.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb20.png]]<br/><br/>
| |
| − | | valign="top" | ''(I'm sorry for the language confusion in the images below - it's my fault: I manipulated a file instead of doing it the proper way...)''<br/><br/>
| |
| − | '''Sorting the forums'''<br/>Now, this was so fun and easy ;-) that you created two more forums.<br/><br/>But you discover that the third (bottom) one should be at the top.<br/>
| |
| − | The order you see them in here, is the order they will appear in at the Start page.<br/><br/>You want #3 to be #1 so you click the radiobutton #1 for that forum.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb21.png]]<br/><br/>
| |
| − | | valign="top" | This will make forum #3 switch places with the currently #1<br/>If you have many forums to order, do it at the same time.<br/><br/>When you are satisfied you click the button ''"Click to sort"''.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb22.png]]<br/><br/>
| |
| − | | valign="top" | The page will re-load with the forums in the wanted order (no image).<br/><br/>A click on the ''"Test..."'' button will open the ''Start page'' - there are more than one forum now.<br/><br/>At the bottom there is also a fourth forum: It is the link to the ''"Setup and Edit forums"'' screen.<br/>It is disabled as it is test mode but you can open forums and threads.
| |
| − | |-
| |
| − | | align="center" valign="top" colspan="2" | <br/>'''And so you decide that it's time to ''INSTALL'''''.<br/><br/>
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb23.png]]<br/><br/>
| |
| − | | valign="top" | You close the window/tab and return to ''ModManager''.<br/>And click the ''"Install"'' button...
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb25.png]]<br/><br/>
| |
| − | | valign="top" | And it is installed.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb26.png]]<br/><br/>
| |
| − | | valign="top" | At the bottom of the '''Info dropdown menu''' you will find the Forum link.<br/>When you are logged-in, that is.
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb27.png]]<br/><br/>
| |
| − | | valign="top" | And the forums have gone live...
| |
| − | |-
| |
| − | | align="center" valign="top" | [[File:Forumb30.png]] [[File:Forumb31.png]]<br/><br/>
| |
| − | | valign="top" | When someone makes a post, all logged-in users will have a signal in the menu, both in the heading and in the selection, as well as in the forum.<br/>
| |
| − | The signal appears when you open any page.<br/>
| |
| − | It will disappear when you have opened all the threads in question '''or''' when you log in the next time.<br/>
| |
| − | (To get rid of all signals everywhere immediately: Log out and then log in again)
| |
| − | |-
| |
| − | |}
| |
| | | | |
| | | | |
| Line 240: |
Line 117: |
| | == Uninstalling the mod == | | == Uninstalling the mod == |
| | | | |
| − | If you uninstall this mod, you have to remember this:<br/>
| + | |
| − | * ''ModManager'' revert the changes made to the original TNG files.<br/>This takes away the menu link.
| + | |
| − | * ''ModManager'' revert one change made to ''config_forum.php'' in the ''forum'' folder.<br/>This makes the forum(s) unavailable using a URL (browser favourite/bookmark f.ex).
| + | == Forum For TNG - The Admin Manual == |
| − | '''Nothing''' is deleted or removed from your database. No files are deleted.<br/>
| + | |
| − | This means that if you want to '''re-install''' the mod '''with''' the forums later, you should '''''only''''' click the ''ModManager '''Install''''' button.<br/>
| + | Did you miss the link above, under '''Install'''? Here it is again: [https://xerxx.se/forumDemo/forum_Manual/index.html '''Forum For TNG - The Admin Manual'''] |
| − | <span style="color:#FF00FF;">'''Do not attempt the two first steps in this case!'''</span><br/><br/>
| |
| − | You '''delete''' complete forums from the ''Setup and Edit forums panel!'' After uninstall, you can click the '''second button''' to get there.<br/>
| |
| − | The database tables will not be deleted, but emptied if you delete all forums.<br/>
| |
| − | If you run the first step again, the attempt to add keys will fail and the script stops, but no real harm will be done.<br/>
| |
| − | Nonetheless: <span style="color:#FF00FF;">'''Don't ever run the first step a second time.'''</span>
| |
| | | | |
| | | | |
| | == Custom Text Additions == | | == Custom Text Additions == |
| | | | |
| − | The system includes the English language custom text.<br />There are Danish, Dutch and Swedish translations if they are present in your TNG system.<br/> | + | The system includes the English language custom text.<br />There are Danish, Dutch, French, German and Swedish translations if they are present in your TNG system.<br/> |
| − | Those language files are stored in a separate language folder and the cust_text.php files are not touched.<br/> | + | Those language files are stored in a separate language folder inside the forum folder.<br/>There are almost 200 entries in each file... - '''Please volonteer to translate.'''<br/>The cust_text.php files are also somewhat modified. |
| − | There are almost 200 entries in each file... - '''Please volonteer to translate.''' | |
| | | | |
| | == Revision History == | | == Revision History == |