User:AstRoBot/How to set up automatic updates

It is fairly straightforward to set the bot up for any article. Before doing so, it is strongly recommended that you notify other editors of your intention to set up automatic updates, either on the article's talk page, or the WikiProject Spaceflight talk page if several articles are affected. As a courtesy, please inform the bot's operator, {{user|WDGraham}}, that pages have been added to the bot's run.

Only articles about individual spacecraft in Earth orbit are suitable for automatic updating.

===Setting up automatic updates===

====Infobox parameters====

:These instructions only apply to articles using {{lt|Infobox spaceflight}}. For articles using older (or no) infoboxes, use the method given for the article body.

1. Ensure the orbit_epoch field in the infobox is present and contains some kind of text, preferably an accurate epoch
2. Ensure the SATCAT field in the infobox is set correctly
3. Add auto=all, auto=general or auto=orbit or auto=none to the infobox
4. :auto=general only updates the orbit count
5. :auto=orbit updates all orbital parameters but not the orbit count
6. :auto=all updates all orbital parameters and the orbit count
7. :auto=none does not update the infobox
8. Add the fields you want updated to the infobox (the bot will update all the relevant fields it can find in the box)
9. Ensure no new references are present in any of the fields the bot is going to edit (i.e. "...") - calling existing references (e.g. "") is fine. Old references should be moved to the article body or deleted as necessary, the bot will add its own.
10. (optional) Add {{tl|Orbit}} templates to the body of the article if desired (see step 3 below)

:The bot will edit {{tl|Orbit}} templates in the body of the article regardless of which setting is used in the infobox

:As long as the SATCAT, orbit_epoch and auto fields are set, the SATCAT and current epoch date can be read from the article, eliminating the need

====Article body====

If {{lt|Infobox spaceflight}} is not present you will need to configure a catalogue number and epoch date. If the infobox is present, check that it is set up (see above), and skip to step 3.

1. Specify the Satellite Catalog Number (SCN)
2. If the SCN is already present in the article, add {{Orbit|satcat|}} around it
3. If the SCN is not present but can be added to the text, add it using the same format.
4. If the SCN is not present and cannot be added, add {{Orbit|satcat||hide}} at the end of the article, between templates/navboxes and categories.
5. :Replace with the satellite's catalogue number
6. Specify the orbit epoch
7. This should be stated in the text to give context to the orbital elements. Specify it using {{Orbit|epoch|}}
8. If you cannot state the epoch in the text, use {{Orbit|epoch||hide}} at the end of the article: however this is not recommended
9. Tag orbital elements to be updated
10. Use {{Orbit||}}
11. A list of parameter names can be found on Template:Orbit/doc
12. You must enter initial values manually; it is recommended that you use data from Heavens-Above for this purpose.
13. Add references
14. Use {{Orbit|ref|}} - although if this reference is not already defined in the article, you will need to enter a full reference, using {{tl|Cite web}} in the first instance of the template.