This page was written with STE version 3.1 in mind. As this version has not yet been released, there are some differences between this tutorial and what you see in your settings dialog at the moment.
The preview feature requires an Internet Connection because it uses the Wikidot API. However, unlike Importing and Exporting, you don't need your own API key to use it!
Requirements:
- Internet Connection
- If you are behind a web proxy, enter the proxy settings into STE
Optional:
- If you have your own API key, you can tell STE to use a page on your own website
How does it work?
When you click the preview button
STE will save the page at Wikidot.com, then retrieve the generated HTML of the page and show it in a window on your computer.
Without an API key
If you are using the default settings (no API key) then the user STEBot is used. To prevent problems when multiple users are previewing from different locations, the name of the page is randomly selected out of a possible 1000 names. What this means is that if Joe and Bob both use the preview feature at the same time, it is extremely unlikely that STE will cause a conflict.
However, it is possible that eventually there will be a conflict. When that happens, you might see someone else's previewed page instead of your own. All you need to do to solve the problem is to attempt previewing again.
With your own private API key
If you have requested your own API key and entered it into the STE settings dialog, the application changes three things:
- The import feature is enabled
- The export feature is enabled
- And thirdly, the preview feature changes to work in private mode instead.
In private mode, the preview feature saves the page exactly where you want it to, on one of your own sites. As of version 3.10 (not yet released at the time of writing), you can specify the site name and the exact page name that the preview feature will use.
Note: To prevent conflicts in this mode, we suggest that any two users planning to use the same Wikidot site make sure that they enter different page names into the settings dialog.
Entering your API key into STE's settings dialog
Simply follow these instructions:
- Open the settings dialog from "Edit" > "Settings…" (or press F12)
- Navigate to the "Wikidot API" tab (or press Alt + 4)
- Place a tick the box titled "Use a private Wikidot account"
- Enter your API key
- Enter the unix name of a site you use for testing
- Enter the page name that you want STE to use for the preview feature
- Apply the changes by clicking on the "Apply" button
The "CSS Theme" field is for advanced use and we recommend that you don't make any changes to it. If you have accidentally modified this URL, you may want to re-enter the default: http://editor.wdfiles.com/local--code/p/1
Discuss this page
 |
Add reply on "Preview" |