Editing Project:Observatory Users Manual (section)

===== How to insert an Info or Talk page into an Article or other main page content =====
 
====== Insert a blank placeholder pop-up icon in the Article ======
# In the Article/main page you’re editing’s Edit mode (Visual editing, not Source editing), put your cursor in the exact placement in the text where you want to insert the pencil icon and click.
# Click '''the Comment icon''' (a speech bubble with a plus sign inside) in the Edit top toolbar of the Visual Editor to insert a pencil icon where your cursor was left in the text.
# Click the blue '''Save changes''' button on the page.
#* You now have a placeholder with an empty pencil icon to fill out. It will appear red until you create an Info page for it (and won’t appear on a Public site page if left unfinished); after you create a page for it, it will turn black.
# '''Refresh''' your browser on the page (this is the easy solution if nothing happens when you click the icon in the next step).
# Go to the spot where the new red pencil icon is and hover over it. Click “'''Create'''” in the bottom left of the pop-up.
 
====== Create the Info or Talk page connected to the placeholder pop-up icon ======
Fill in the Info page form fields:
# '''Pop-Up Heading'''
#* This will appear as both the title of the Info page and the header in the top blue part of the pop-up on the Article page.
#* You can either select something preexisting from the dropdown menu (recommended; many Pop-Up Headings already exist), or create a new one that will be both used in your case and added as a dropdown option for others to use. This field works like the Tags field on Articles with typing and a dropdown menu, except that you can only have one selection in the field.
#*# You can start '''looking through preexisting options''' in one of two ways:
#*## Click in the text box and '''scroll through preexisting options alphabetically'''. This is unwieldy if you have a good keyword instead, but this will give you a general sense of preexisting options to choose from.
#*## Start '''typing a keyword''' that would be in the Pop-Up Heading in the text box (such as Citation, Fact-Check, Illustration, Map, Add a Section…).
#*# '''Click on the preexisting option that applies to your query in the dropdown menu.''' It will appear in the text box as a gray-background button. If you change your mind, replace it by clicking the x on the left side of the button (or clicking in the field, selecting all, and backspacing) and repeat the steps above to find something fitting.
#*# If no preexisting option applies to your query, you can '''create a new option''' by typing it in exactly as it should appear in the pop-up, and then clicking the new dropdown option directly below the text field. Note that your new Pop-Up Heading option will be available to you and all other Users after you Save the Info page.
#*#* Follow the rules of preexisting options: look at other Pop-Up Headings and follow their lead. Keep your new Pop-Up Heading short, and use [[Project:Style Guide/Editorial Process#Headline-Style Capitalization|headline-style capitalization and punctuation]]. (Unlike for Headlines, no verb is required for Pop-Up Headings.)
#*# After you’re done typing, '''click the dropdown menu item''' or hit enter; otherwise, your Pop-Up Heading will be lost if you click outside the field after typing something in, and the vague default (“Collaborative Research”) will be inserted instead.
#* If you leave this field blank before Saving the Info page form, the vague default (“Collaborative Research”) will be inserted instead. If you see “Collaborative Research” as the Pop-Up Heading/Info page title later, you can always go back in and Edit the Info page form to add the Pop-Up Heading later. You might want to search for “Collaborative Research” on a page’s See All Queries page to find accidentally blank Pop-Up Heading fields to fill in.
# '''Prompt Type'''
## This controls the text that appears in the white part/body text of the pop-up. It will not appear on the Info page. Keep it short (one or two short sentences). '''Think of it as a pop-up subheading.'''
## Choose from Manual or Predefined using the radio buttons.
### '''Manual:''' Select Manual, and then type your desired text into the text box that appears. You can use the Visual Editor if you want to include links or bold or italic formatting.
###* Remember: it’s a pop-up, so it should be short! You can put more detail in the Talk field.
###* '''Type in your Manual Prompt below:''' Summarize the Talk field (the full query text) in one or two short sentences here. If your Talk field contents above the <nowiki>{{CollabPost}}</nowiki>} template are short, you may copy them here, adapting the text for the context of only being visible in the pop-up on the Article page if necessary. For example:
###** Strip links, especially internal links to the Article page. It is recommended not to include any links in this field, or to keep them limited, in order to encourage researchers to open the query through the emphasized links of the Pop-Up Heading, right-facing arrow, or Open link.
###** Do not include any templates in this field (for example, <nowiki>{{CollabPost}}</nowiki> templates).
### '''Predefined:''' Click inside the dropdown text field that appears after selecting Predefined, below the text “Click to choose from the Predefined text options (hover to preview at right).” The available options will appear in the dropdown menu. Scroll through and hover over each one to see a preview at right of what will appear for each. If you pick one and want to preview others, click the x button or delete everything in the field and hover over the options (you may type to search).
# '''Quoted Text (this is a fragment of the original content for discussion; it is optional)'''
#* This is where you might copy-paste text from the Article page near the pop-up icon that’s relevant to the query. It has Visual Editor built in that should allow copy-pasting normally even with rich text like links and italics, but if there are more complicated rich text elements such as section headings and footnotes, you can copy the source code from the Article (we recommend changing Info page tags <nowiki>{{i|</nowiki><span style="color:#e83e8c;">UUID</span><nowiki>}}</nowiki> into interquery links <nowiki>[[Info:</nowiki><span style="color:#e83e8c;">UUID|visible text</span><nowiki>]]</nowiki> if any appear in your selection) and paste it into this form field in code mode.
# '''Talk'''
## This is where we put more information about what we are soliciting feedback about. You can use the Visual Editor for this field. It becomes the body of the Info page, so it can be as long and complex as you want.
##* One example of an Illustration Query that is a good sample to recreate is [[Info:5ec6f361-e25e-47ce-943d-cebf8c3d617d|this one]]. Note the use of interquery links <nowiki>[[Info:</nowiki><span style="color:#e83e8c;">UUID|visible text</span><nowiki>]]</nowiki><nowiki> rather than pop-ups {{i|</nowiki><span style="color:#e83e8c;">UUID</span><nowiki>}} on an Info page.</nowiki>
##* Remember, the Prompt field will not appear on the Info page (only the pop-up), so it is very common to repeat what was in the Prompt field here if you want the same text to appear in the pop-up as on the Info page.
## '''CollabPost''' (Info page button for Contact form)
### Every Info page needs to add the <nowiki>{{CollabPost}}</nowiki> template at the bottom (information on including more than one is explained with the following two asterisks*). This inserts a green-background ribbon with text and a button leading readers to a Contact page form to answer the question asked on that specific Info page.
### '''To insert a CollabPost template into the Info page Talk field:'''
#### Add a line break at the bottom of your Text field below the normal text. Click your cursor at the end where you want to insert the CollabPost line.
#### In the Visual Editor ribbon at the bottom of this field, click the '''envelope icon''' at right (two to the right of the “Cite” button or open-quotation mark icon). If you hover over it, it says “Collaborator form.”
#### The default CollabPost template text and button text will be inserted.
#### If you’d like to change the text to '''customize''' to your query:
##### Click anywhere in the green text/button part of the Talk field for a pop-up to appear.
##### Click the '''“Edit”''' button to open the template pop-up.
##### '''Filling in CollabPost template fields:'''
###### The defaults are generally fine, but if you make customizations, click “'''Apply changes'''” in the CollabPost template pop-up after making changes to any of the following three CollabPost template fields ('''Button text''', '''Prompt text''', and/or '''Hashtag'''). Then Save the page.
###### If you want to customize the button text, edit what is in the '''Button text''' field.
######* The default button (including if you remove all text here or never alter it) is to show “'''Reply'''” with an '''arrow'''.
###### If you want to customize the green text at left, edit what is in the '''Prompt text''' field.
######* The default green text (including if you remove all text here or never alter it) is: “'''Suggest an edit or addition for this query. Join the research!'''”
###### *'''Hashtag''' field (checkmark at left in the CollabPost template menu) is optional to check or change:
######* Do this only if you are using multiple CollabPosts on the same page or have some other reason to mark emails filled out via this form with your specific query:
######*# Check the Hashtag checkbox at left to indicate you will use it (uncheck it if you change your mind later).
######*# Fill in the newly appeared Hashtag field with a keyword/keywords (without spaces, punctuation, or special characters including #). (The default is “'''collaborativeresearch'''.”)
######* Note that Hashtags are visible to the public in the Collaborative Research Contact form (as readonly).
######* A Hashtag is a tool for Authors and editors to recognize the source of a query that led a reader to fill in the form. Imagine you have two occurrences of the CollabPost on the same page and need to know which one triggered the post. You can assign ''a'' to one occurrence and ''b'' to the other, making it easy to tell them apart when you receive an answer (you probably want to be specific and use keywords instead of letters). The Hashtag field is not suggested by default when using the “Insert”→“Template” menu in Visual Editor. You can simply leave it out if there is only one CollabPost on the page, or if the context that triggered the post is not important to you.
###You can insert multiple* CollabPost templates per Info page if you have more than one query on the page and want people to have more than one Contact form about each; see “Hashtag field” above if you insert more than one.
###You can always '''edit''' the contents of a CollabPost by editing the page (via “Edit with form” mode), then clicking anywhere in the green ribbon so “Template” pop-up appears, then clicking the “'''Edit'''” button.
# '''Save page'''
## Save your newly created Info page.
##* or: use the “Cancel” button to cancel your edits (this is only if you want to abandon your changes).
##** Note that if you click the “Cancel” button next to the “Save” button to abandon your edits, if nothing happens, that’s because you opened in a new tab and your browser doesn’t know what page to open with a “Back” button. Simply close the tab if you wish to cancel/abandon your edits in this case.
# You will '''automatically be redirected to the Info page you just created''', and on the Article page where the pencil icon appears, this pencil icon will automatically be updated to display as black instead of red, indicating it now links to your newly created Info page!
#* '''Refresh''' the Article page in your browser if the pop-up does not appear when you hover over the pencil icon (this is normal). You may need to use a keyboard shortcut for a hard refresh (ignoring the cache) rather than the browser refresh button for a soft refresh if refreshing multiple times does nothing. Keyboard shortcuts for hard refreshes are:
#*# Mac: command+shift+r
#*# PC: control+shift+r (OR control+F5)