Links and Redirects
See Prototype page.
Links can also be described as Incoming Links, Crosslinks, or xref.
xref elements are usually empty and depend on the Nav Title from the original page to display their text to the user. If the Nav Title doesn't make sense in the flow of the sentence, it can be set manually. Examples:
- Add a verb before link, like in "generate" Billing List.
- Add "window" after a link, like in Claim window.
- Supply plural or singular alternate, like if you are talking about multiple Adjustments.
If one page contains multiple outgoing links to the same page, we generally only make the first one an actual link. Subsequent instances are usually just text without a link, but still with first letters capitalized. A second link is fine if you think the reader will have trouble finding the first link farther up the page.
Adding New Page
If you add a page to the head version and add it to search terms, that page will be missing in the stable manual folder, and will cause a 404 error message when using that search term. In that case, add a redirect. There are plans to add this functionality into the "Add Page Copy" button so that it will happen automatically.
How to make a redirect:
1. Copy the template file \opendental.com\manual182\discountplan.html to the stable folder: \opendental.com\manual\
2. Rename it to match the name of the new file. For example, \opendental.com\manual\newfile.html
3. Edit the file. There are two URLs which must both be changed to point to the head, similar to this:
https://www.opendental.com/manual191/newfile.html
4. Add to SVN
5. Put to live server.
6. Test
This redirect will become naturally archived later, as new versions are added.
Rename File
When Jordan renames a file, a redirect from new filename to old filename is automatically placed in stable to handle search results.
Manual to Site
When Jordan moves a file from Manual to Site, redirects are not automatic. There are two reasons why we might want a manual redirect:
1. If we are likely to change a page, and we don't want customers to be confused, Jordan will add two redirects from both stable and head to site. This is rare. Example: versions.xml.
2. If there are known or likely external links to a page, we might want a long term redirect. This would be a single redirect from manual head to site which would persist. Example: vendorscomputer.xml
In both of the above cases, the redirect that's in the head will persist until we manually remove it later.