Below is a screenshot of each tab of the RoadRunner application which a detailed explanation of its purpose and how it works.
|
* [Start Sync\- details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-StartSync%5Cdetailsbelow]
|
* [Progress Dashboad\- details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-ProgressDashboad%5Cdetailsbelow]
|
* [Confluence Servers \-more details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-ConfluenceServersmoredetailsbelow]
|
* [Spaces\- details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-Spaces%5Cdetailsbelow]
|
* [Page Copy \-more details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-PageCopymoredetailsbelow]
|
* [Export HTML \-more details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-ExportHTMLmoredetailsbelow]
|
* [History(not yet implemented) - details below|http://confluence.atlassian.com/display/CONFEXT/RoadRunner+Documentation+by+screenshot#RoadRunnerDocumentationbyscreenshot-History%28notyetimplemented%29detailsbelow]
|
... h2. *Start Sync* \- details below
*Start Sync:*
This is the first screen you'll see when you launch RoadRunner. If you have definied a synchronization and click either button it will start the synchronization.
The 'Start Sync' button will only download content (pages and attachments) which has been updated since your last sync.
|
The 'Refresh Sync' button will do a complete synchronization of all the server spaces you have defined on the 'Spaces' tab.
|
!start-sync.jpg!
|
----
h2. *Progress Dashboad* \- details below
|
...
*Progress Dashboard:*
The Progress Dashboard will pop up any time you start a synchronization.
It gives you real time graphical and text feedback about the progress of your sync.
_Coming soon:_
_\* More details about the attachments being copied._
\* _A list of any conflicts._
|
\* _Summary information about that sync such as total number of pages, total bytes transfered, how long it took, etc._
|
!sync-in-prog.png!
|
----
h2. *Confluence Servers -* more details below
|
...
*Confluence Servers:*
Here you can define multiple Confluence Servers. You should define a minimum of two servers - a local server and a remote server from which you wish to pull content.
The server alias field can be anything that helps you remember the purpose of this server.
Once you have filled in the information it is a good idea to click 'Test Connection' to verify you have entered the correct credentials to access the server.
|
_Coming soon:_
* _Support for https / SSL._\---\-*Spaces -* more details below
|
----
|
!servers-list.jpg!
* ----
|
h2. *Spaces* \- details below
|
... *Spaces:*
Here you define which spaces you wish to pull down from one or multiple Confluence servers to your local Confluence.
Steps (basically follow left to right of the screen):
# Click on a server in the 'Remote Server'.
# Click on the 'Refresh' button to bring up the list of spaces for that server
# Select one or more spaces to 'synchronize'. To select multiple spaces hold down the <ctrl> key while clicking on the list.
# select the correct 'local' server in the drop down list under 'local server'
# Click on the 'Save Sync' button. You'll see the synchronization(s) you've defined added to the list below.
You can remove 'syncs' by clicking on them in the bottom window and hitting the delete key.
|
Once you have defined spaces to synchronize on this screen you can flip back to the 'Start Sync' tab to run them.
|
!spaces.jpg!
|
----
h2. *Page Copy -* more details below
|
...
*Page Copy:*
Use the 'page copy' to send select content from your local Confluence up to another Confluence server. The idea here is that typically you're working on a small set of known pages on your local Confluence server before you make the public or update them on your company's Confleunce server.
Steps:
# select a local server from the drop down
# select a remote server from the drop down
# click the 'Refresh Tree' button to build the tree of all Confluence pages
# check off the individual pages you which to send up to the Confluence server
# Click either 'Send Pages' (this button does not send attachments) or 'Send Pages and their Attachments' button
The 'Clear All' button and 'Expand All' buttons are convenience buttons which will be replaced in the future with other tree navigation and selection features.
_Coming soon:_
_\* Intelligent determination of whether to send attachments._
\* _Right click pop up menu options to do things such as automatically select an entire subtree of nodes, fully expand a subtree, etc._
|
\* _The option to remember these selections between when you close and start RoadRunner_
|
!rr-pages-1.jpg!
|
----
h2. *Export HTML -* more details below
|
...
You can export hte HTML of pages by checking off all the pages you which to export and then right clicking on a parent page. The HTML files will be exported to a directory called 'html-export' where ever you ran RoadRunner from.
----
h2. *History* (not yet implemented) - details below
*History:*
The History screen will log all your previous synchronzations and allow you to check which pages and other content were syncrhonized.
This feature is not yet implemented. The existing data is just a sample along the lines of what the screen will look like in its first functional iteration.
|