Template:Helping Give Away Psychological Science Banner/doc

Usage
This template will add the banner to the top of a page. It will also index your page in our Banner list.

Practice
You can practice formatting at this sandbox copy of the banner template.

Here is a link you can use to practice editing the banner before sending it out to our pages: Template:Helping Give Away Psychological Science Banner/sandbox

Your current practice banner looks like:

Preface
Hello HGAPS and others,

This is a the final implementation for the emergency crisis banner made by Cody Naccarato. As it stands, the banner tool is ready to use for all of our wiki pages. This template page is an educational tool for HGAPS members to learn how to use, create, and disseminate quality banners for our HGAPS pages. There are many tutorials here to help explain things to wikitext newcomers. Before getting started, please review the following links to acquaint yourself with the necessary syntax. Check out Cody Naccarato's talkpage to see the template implemented properly!

Use the links below to learn more about editing Wikipedia in general and editing source code. You should have a solid foundation in editing the source code before changing and adding banners:

--> for a basic intro to everything wikiediting: https://en.wikipedia.org/wiki/Help:Editing

--> for an in-depth coverage of wikitext (i.e. source code) editing: https://en.wikipedia.org/wiki/Help:Wikitext

--> HTML syntax (useful for formatting in some situations): https://en.wikipedia.org/wiki/Help:HTML_in_wikitext

Use the link below to learn more about template syntax. It's good to give the entire document a read. You can do some really interesting stuff with the right syntax!

--> general understanding: https://en.wikipedia.org/wiki/Help%3ATemplate,

--> templates on Wikiversity: https://en.wikiversity.org/wiki/Wikiversity:FAQ/Template

Only after a firm grasp on the concepts above should you proceed with attempting to edit banners.

Important Info
By successfully changing the code on this template page, you are not editing one Wikiversity page, you are editing EVERY page we have implemented the template on (potentially dozens if we proceed with this functionality). You should not attempt to change or add banners unless you have a confident understanding of Wiki code. User beware. Please take your time to understand this code. Editing with source code is the best way to edit the banner functions. Do not attempt to implement banners using the visual editor. You need to code for it to work properly.

Templates are a versatile tool used for a variety of special cases on Wiki projects. Specifically, this template is using transclusion to "copy and paste" the banner code to any page we call the template to. When editing this page, it automatically copies the new content to our destination pages. This allows us to update many pages by editing sections found in a source page. We are using this function to implement a "banner" of sorts to our wiki pages. The idea is that this will act a lot like the banners on many webpages (think COVID-19 and nimh.nih.gov; or maybe how some pages use banners to alert users to future maintenance). By including the tepmlate call at the top of our wiki pages and formatting the template to be eye-catchy and bright, we can effectively insert banners into any of our wiki pages! Once you paste the template code into the first line of your page's source code, you never have to edit that page's banner code again. We achieve this because all of our magic is happening in the page you are on now. By editing the wikitext on the main template page, we can make banners appear and disappear on these pages as needed. To remove all banners from all pages, simply comment out the banner code on the main template page.

This page contains three very important sections: "Practice," "Usage," and "Past Crises." The Practice section is a sandbox for you to use to get your code looking the way you intend. Please finish your code here BEFORE moving it to the main template section. This will ensure that you get your banner put in place correctly the FIRST time. We technically could use the "revert page" function Wiki provides, but that still allows for the potential for any poor formatting to get beamed across our wiki pages. Once you finish with the "Practice" sandbox section, please reset it for the next person to use. The original, unedited code is found in a subsection inside "Practice." Use this to reset the sandbox or fix the code if you or someone else breaks it. Also note that any code added inside of the Practice sandbox is only saved locally, meaning that all work in this sandbox section is not sent out to the wiki pages. Our template call is only looking at the code in the main template page, and only stuff under this main template page will get beamed to wiki pages. The main template page of the template is where all the magic happens. When this section is commented out (surrounded by comment syntax), no banner will be displayed on any page! This allows us to create banners as crises come up. The Past Crises section is where you will move your crisis after it has passed. This is a library of all public service announcements we have sent out and is used to eventually streamline banner implementation and act as a repository of links and resources.

Below you will find two guides, one for adding the banner to a wiki page and another for editing the contents of the banner. Once you implement banner template code into the desired wiki page, you don't have to touch the code you pasted.

If this is confusing, please see the appendix section to find examples of what your code should look like in various use cases.

One final note, please look at a few of the wiki pages the banner is or is not supposed to appear after every banner change to check and see if you have achieved your desired result.

Quick Guide
This section is meant to act as a quick reference to provide an overview of the banner process. Using this, you should be able to get a sense of the workflow. Use the appendix to go in depth on any topic.  Copy the banner code below into the first line of the page you want to have the banner appear.  Choose your banner format (crisis, announcement, spotlight).  Copy and paste your chosen banner code into the sandbox provided on this page.  Use the sandbox to perfect your banner.  Copy and paste your perfected banner into the main template page, specifically between the appropriate editors comments detailing where to insert your code.  When removing or replacing a banner, place the old one in the "Past Crisis" section of the template's 'doc' page so we can keep a log of our banners.



Tutorials
Below is a guide to add the banner to any wiki page you want :  Navigate to the page you wish to add a banner to. Go to "edit." '''Be sure to edit the source code of your page. No visual code.'''  Copy the code found below: 
 * The template tells wiki to use the banner function on this page
 * The template also automatically generates a list of indexed pages for us under the, where we can see every page our banner has been implemented on.

 Paste the code above all of the source code in your desired wiki page.  Summarize your edits and click publish changes.  You have now successfully implemented banner functionality onto the wiki page. You never have to edit this code again.  Check out Cody Naccarato's talkpage to see the template implemented properly! 

Below is a guide for editing the banner :  Begin by clicking "edit" on the main template page and navigate to the source code editor. <li> If there is no crisis and the banner is not being beamed to all wiki pages, please delete the comment that is being used to "comment out" the banner on the main template page. <li> Between the two "Note to editors" lines found in the "Banner Formatting" code, within the "Current Crisis" section, you find this header: HGAPS ALERT: YOUR HEADER HERE
 * The above code is also surrounded on each side by  syntax. These flanking pieces of code insert our HGAPS pictures into each corner of the banner and are actually clickable images that will take you to the HGAPS wiki homepage.
 * The wikilink you see allows for  in our title to link back to our main page.
 * The  modifier will make your header bigger, and the three   will bold it. The reason you want to do this is that it will add a header to your banner without giving people the option to edit the content. If you just use the   syntax in the source code or the "Header" functionality in the visual editor it will actually give anyone who sees the banner an edit option. We do not want random people editing or griefing our banners. However, the banner template will be a protected page eventually due to its high visibility.

<li> After your header, add a link to the redirect page you created that leads you to your desired resources in between the "Note to editors" lines. <li> Please be aware that we are using the "Note to editors" comments in order to determine what is transcluded to our wiki pages. When editing the template, you MUST preserve these comments as to keep things easy to follow for newcomers who may wish to edit banners. Please make all of your edits within these tags.

<li> After an appropriate length of time and you are ready to remove the banner, please copy all code on the template page and comment out the banner. Add the sources and information you included between the "Note to editors" lines to a new section under "Past Crises" on the /doc page. These steps will completely remove all banners from our wiki pages and store the legacy banner in our repository for later use/reference. It would also be good practice to "reset" the template code fo rthe next person's use. </ol>

Banner Formatting

When there is information you want to beam across all of HGAPS wiki, please copy and paste the red box syntax into the main banner template page. Please comment out the "banner formatting" code once you take down a crisis and no longer wish to beam the banner to all wiki pages. If you do not comment out your sources and this syntax, there will be random links and/or a red box across all of our wiki pages. The only way to completely take down a banner is to make sure the "banner formatting" is commented out on the main banner template page. Add your information in-between the "Note to editors" line. Please keep the "Note to editors" comment preserved within the main template! If these comments are missing, it will make it difficult for others to edit properly.

Editing the banner is super easy! You should only be replacing the background color in line 1, the "YOUR TITLE HERE" in line 5, and the "YOUR RESOURCES AND CRISIS HERE" in line 8. The bulk of your content will be placed in line 8.

The extra spaces/lines in the code above are for instructional purposes only and help give the reader a better sense of what's going on in the code. Please be aware that any extraneous "enter" or "return" keypresses or forced breaks will result in unnecessary space added to the first few lines of your page. Be sure to have compact code, even if it is harder to read.

Banner Formats
The main purpose of this section is to have different color backgrounds for our banners with the idea that in the distant future, we can use banners for more than just crises. What if we did outreach through wiki banners that raised awareness for certain disorders? Or what if we included links to charities on certain awareness days? What if we get an awesome publication, mention in the news, or conference invite? These are all things we can communicate through banners to help increase our visibility ON wiki itself. Not to mention that this will make us look super professional and well put-together. Later, we can add specific formats for different banners (i.e. adding specific sections for crisis banners, announcement banners, etc.). Use hex codes to change the background color. Use this link for a list of colors.

Crisis Format
The below banner is red. It is intended to alert the public of crises. Notice the  background selection in the first line of code.

Test color:

HGAPS Announcement Format
The below banner is purple. It is intended to alert the public of HGAPS announcements (i.e. new assessment centers, new pages, new projects, exciting HGAPS publications, keynote appearances at conferences, workshops, etc...). Notice the  background selection.

Test color:

Disorder Awareness Format
The below banner is blue. It is intended to inform the public of disorder awareness weeks (depression awareness, autism awareness, etc...). Notice the  background selection.

Test color:

Measuring Impact
One more piece of the puzzle is being able to gather analytics data to see how impactful our banner is. In essence, we want to know how many people are using the links within the banner. To do this, we use the redirect function on Wikiversity to give each link in our banner a redirect page. By using a [|toolforge analysis], we can look at how many views these pages get by date, effectively allowing us to see how many people are arriving at our resource pages through the links provided in the banner. The flow is as follows:

Link on banner --> redirect page --> resource page

Expand the table below to view the redirect pages.

Here is an explanation of each heading:
 * Banner Name: this is the column that you use to identify which banner your link is in
 * Date Banner Was Implemented: this is the column that you use to note the day you updated the banner
 * Resource Page Linked To: this is where you put a copy of the link you used in your banner, using the exact same format found inside of the banner
 * Redirect Page Name Used: this column is where you put the name of your redirect page you used in your banner link. When making a banner, you should link to the redirect page first, and then have your redirect page take you to your final destination. Your redirect page name can be any string of letters or numbers, so long as its named in such a way that no one would feasibly try to recreate a page with the same name.

List of Banner Impacts

 * Covid 19 and You: https://pageviews.toolforge.org/?project=en.wikiversity.org&platform=all-access&agent=user&redirects=0&range=all-time&pages=Hgaps_unc_resource_1_suicidalthoughts|Hgaps_unc_resource_2_suicideprevention|Hgaps_unc_resource_3_copingwithcovid|Hgaps_unc_resource_4_socialisolation|Hgaps_unc_resource_5_findingatherapist|Hgaps_unc_resource_6_otherresources

Past Crises
Please place your legacy content between  and. Please add this to the /doc page.This allows for your content to be displayed centered as it would in a banner but without an overload of color on the page. If you ever want to reuse one of the legacy banners, the "div" syntax will be replaced with the banner formatting above: YourContentHere change the above code back to the below code when reusing an old banner--->

We change the flanking code back to  when moving banners out of the library. This is done so we can re-add color functionality to our banners. Each type of banner should also be matched with the appropriate hex color. When moving stuff into the library, it's also a good idea to add a small summary just to give context to whoever is reading it. Also, put a date for how old it is!

Template of Past Event Storage
Recap: provide some context for future HGAPS members Date: give the date for better context Type: provide some context for future HGAPS members

Above is the syntax for storage. Do not copy the  found in the source code when moving this template. This code exists only to visibly show you the source code without wiki executing the code's functions. This  format centers text as it would appear in the banner.

Fabricated Example of Past Crisis
Recap: Recent school shooting in Parkland. This was the second prototype announcement banner created for this page. Date: 26 April 2020 Type: Crisis

HGAPS ALERT: School Shootings and You School shootings are tragic and incomprehensible. If you or a loved one has been affected by the recent shooting, please know that you are not alone and there are resources for you. Link to Resources: ~Coping With a Shooting ~ Finding a Therapist ~ Other Resources ~ ~ More at HGAPS.org ~

Fabricated Example of Past HGAPS Announcement
Recap: Our publication on the effects of team outreach (faux). This was the first prototype announcement banner created for this page. Date: 26 April 2020 Type: Announcement

HGAPS ANNOUNCEMENT: New Publication!

HGAPS is proud to announce a new journal publication on the effectiveness of HGAPS-related information discrimination! Check out the link here! As you can see, we reach thousands of people and are effective at getting good psychological science to the public! ~ More at HGAPS.org ~

Fabricated Example of Past Sexual Assault Awareness Month
Recap: Sexual Assault Awareness Month (faux). This was the first prototype awareness banner created for this page. Date: 26 April 2020 Type: Awareness

HGAPS AWARENESS: Spotlight on Sexual Assault HGAPS would like to spotlight “National Sexual Assault Awareness Month” for the month of April. Please check out these resources! ~Healthy Relationships ~ Sexual Assault ~ Reporting Sexual Assault ~ Other Resources ~ ~ Consider donating to these charities! ~ ~ More at HGAPS.org ~

COVID-19 and YOU
Recap: Suicide and self-help resources. This was the first prototype crisis banner created for this page. Date: 26 April 2020 Type: Crisis Impact: https://pageviews.toolforge.org/?project=en.wikiversity.org&platform=all-access&agent=user&redirects=0&range=latest-20&pages=Hgaps_unc_resource_1_suicidalthoughts|Hgaps_unc_resource_2_suicideprevention|Hgaps_unc_resource_3_copingwithcovid|Hgaps_unc_resource_4_socialisolation|Hgaps_unc_resource_5_findingatherapist|Hgaps_unc_resource_6_otherresources

HGAPS ALERT: COVID-19 and You It is understandable to feel hopeless right now. This is an unprecedented time in our lives and it is okay to feel angry, frustrated, or helpless. Below are some important resources you can use to improve mental health and find relief. If you are having thoughts of suicide please seek help. Please know you are not alone. There is help. Link to Suicide Resources:

~ National suicide hotline 24/7:  1-800-273-8255 ~ Crisis Textline 24/7:  Text HOME to 741741 ~ ~ Coping With Suicidal Thoughts ~ Suicide Prevention in Schools ~

Not suicidal but still want help? Click on a link below! ~ Coping with COVID-19 ~ Coping with Social Isolation ~ Finding a Therapist ~ Other Resources ~

~ More at HGAPS.org ~

Resources for ABCT 2020
Recap: Used as a demonstration during ABCT 2020. Date: 21 November 2020 Type: Announcement

HGAPS resources for ABCT 2020 Click here to go to the page with copies of the slides and other goodies

~ More at HGAPS.org ~

(next crisis here)
Recap: Date: Type:

Appendix - Use Cases and Code Implementation: Brownies, Cookies, and Assessment
Please refer to the sections below for various use cases. Note that sometimes parentheses are a way of communicating to the reader and will not be in the final code. We also trimmed some code here for the sake of brevity. You will notice that the practice implementation box is less robust than what is located in the sandbox page. The same ideas and editing format is the same, however.

Adding a Banner To a New Wiki Page
This case often occurs when we create new pages for HGAPS. Please add this banner functionality so we can reach as many people with our crisis banners. Here, the coding action happens on "Helping Give Away Psychological Science/SUBPAGE" or other associated Wikiversity page.

Let's pretend we created a new HGAPS Wikiversity page on a new assessment tool for bipolar disorder. An example of correct implementation of code into this new page is listed below. Note this is described in wikitext source code. The source code for this page might look something like this:

(start of page) = Super Cool Awesome Assessment Tool 9000 = (rest of page)
 * This assessment has good reliability.
 * This assessment has good validity.
 * Eric loves this thing!

In order to implement a new banner into this new assessment page, we must copy and paste the code for the banner template above all source code. We do this because banners are typically the first thing you see on a webpage. After pasting, we get the following source code:

(start of page)

= Super Cool Awesome Assessment Tool 9000 = (rest of page)
 * This assessment has good reliability.
 * This assessment has good validity.
 * Eric loves this thing!

The first line of our source code is the template defined for our crisis banner. This allows for our messages to be at the top of each page. Once this has been inserted, you never have to touch it again and it will automatically update as we push out banners. It will also automatically disappear if we wish to remove banners. By editing the main template page of our Banner template, we can make banners appear and disappear as needed. Check out Cody Naccarato's talkpage to see the template implemented properly!

Putting Up a New Banner
This case often occurs when there has been a great length of time since the past crisis. Follow the implementation below as a reference. Note this is described in wikitext source code. Working code is found in the "Introduction" and "Practice" sections. Here, the coding action happens on "Template:Helping Give Away Psychological Science Banner".

Okay, so you have your banner code implemented into your desired page. Now it's time to put some crisis info on it! Navigate to the Banner template of Helping Give Away Psychological Science (Hint: you are already here). This is the page where you will implement the following code. Remember, the only thing you had to do on the page where you actually wanted the banner was copy and paste the template code in the first use case. In the event that there is NOT an ongoing crisis, the code of this page will look like this:

In order to ensure smooth sailing, the "Practice" section is for you to tinker with your banner design before pushing out the final product. Note that the "Practice" sandbox currently prints this: Practice Implementation

Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

As we can see, you have yet to add anything to the banner. Now we can use the "Practice" sandbox to create something awesome. Let's pretend we are creating a banner to alert the public of a new brownie recipe you found. We first need to make a prototype to play with before officially releasing the announcement. Within the "Practice" sandbox, we come up with something like this:

Practice Implementation
Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

This code prints out this: Practice Implementation

Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

However, we see we can do better on the formatting and grammar. The utility of the practice space is now we don't have potentially thousands of people seeing our poor grammar and bad formatting. After revisions, we come up with this:

Practice Implementation
Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

Note that by using the  HTML tag, we can achieve intentional breaks in our code to help us format stuff. This equates to a forced line break. The above code prints out: Practice Implementation

Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

Now that looks like a banner worth sharing! Once we are confident in our formatting and general look, we can move our code from the practice sandbox to the main template page.

Banner Formatting (predicting code here)

Practice Implementation
(reset to original value)

Below is what your finished product will look like. Please use this sandbox before attempting to send out a public service announcement.

Please note our banner was placed INSIDE of the "Note to editors" comments! This is keeping our usages nice and tidy. However, we are not quite finished yet. While we have successfully published the banner, we need to reset the "Practice" sandbox so the next person can easily use it! Please clean up after yourself so the next person can use this page efficiently. The base code for "Practice" sandbox can be found in that section. If ever there seems to be missing code, using older stored version of this page will aid in fixing things.

And just like that, all wiki pages now show the banner and the next person can efficiently navigate a clean workspace! You deserve a cookie, or maybe brownie?

Switching Banners
This case often occurs when a new, more pressing crisis happens on the tail end of another crisis. Follow the implementation below as a reference. Note this is described in wikitext source code. Here, the coding action happens on "Template:Helping Give Away Psychological Science Banner".

Continuing from the last use case, let's say that instead of making a banner about a new brownie recipe we found, we want to replace it with a banner about a new cookie recipe we found. However, because the brownies we found were so awesome, we also want to store these references for later. We accomplish this by moving the brownie banner from the template mainpage to "Past Crises" on the /doc page under a newly labelled section. Let go ahead and create the final draft of the cookie banner as well. Starting out, we see that our current page's code looks something like this:

Past Crisis2
First, let's move our old banner into the past section for storage and later reference. To accomplish this, we create a new header using the triple equals syntax. This syntax allows for our past banners to appear in the table of contents for easy reference. Let's name the new header something specific and easily referenceable. The code should look something like this:

Martha Stewert Brownie Recipe
HGAPS ALERT: Brownies are Good Attention all psychologists. Check out my newfound brownie recipe: https://www.marthastewart.com/1502268/brownie-recipes

We see that our brownie recipe is now our 3rd past crisis in our list. As we fill up this page with a bunch of banners, it is useful to go back and look at past banners for formatting purposes. Our code looks like this:

Martha Stewert Brownie Recipe
HGAPS ALERT: Brownies are Good Attention all psychologists. Check out my newfound brownie recipe: https://www.marthastewart.com/1502268/brownie-recipes

That's it! You have successfully switched out banners correctly.

Taking a Banner Down
This case often occurs when a crisis is outdated and a public service announcement needs to be taken down. Follow the implementation below as a reference. Note this is described in wikitext source code. Here, the coding action happens on "Helping Give Away Psychological Science/Banner".

Let's say that our cookie banner from the previous example has been up for a while and is no longer relevant. Taking it down is super simple. Our current code is this:

Martha Stewert Brownie Recipe
HGAPS ALERT: Brownies are Good Attention all psychologists. Check out my newfound brownie recipe: https://www.marthastewart.com/1502268/brownie-recipes

We start by moving the cookie recipe to the /doc "Past Crises" section, much like we did with the brownie banner. We create a new header under the "Past Crises." By using a well-named header, we are setting up our future to have streamlined banner creation and good templates. We also reset the template mainpage by commenting out our banner code.

Current Crisis
(base code)

}} -->

Martha Stewert Brownie Recipe
HGAPS ALERT: Brownies are Good Attention all psychologists. Check out my newfound brownie recipe: https://www.marthastewart.com/1502268/brownie-recipes

Betty Crocker Cookie Recipe
HGAPS ALERT: Cookies are Better Attention all psychologists. Check out this perfect recipe for cookies: https://www.bettycrocker.com/recipes/dishes/cookie-recipes

And just like that, we have both cleared all wiki pages and stored our banner in our repository!!! Now go show your friends and earn some brownie points! Too corny? Oh well, that's just the way the cookie crumbles.