This project is read-only.

The Main Window

When you start EdgeSync you will see the main window, which provides you with an entry point to all synchronisation and view features:

EdgeSyncInterface.png

Main View

The main view of the GUI is dominated by a list of (known) Edge Journals (left: "Edge Journals") and an overview over the OneNote structure (right: "OneNote Notebooks"). The buttons in the middle allow you to start the synchronisation (red & green arrow), and to create / destroy partnerships (chain button). Note that the arrow buttons are currently not in use.

EDGE JOURNALS
The Edge Journal view lists all the journals that (a) are in a partnership and (b) are in any of the folders that you specified for watching. The entries reflect the current status of the respective journal:
Apply.png "uptodate": indicates a journal that is in a partnership and is uptodate
Modify.png "modified": shows that the paired journal has been modified since the last synchronisation.
Question 2.png "unknown": indicates that the respective journal is in a partnership but currently not available (status unknown)
broken-link.gif "unpaired": finally shows that the according journal is not in a partnership - it will not be synchronised
By hovering the mouse over the according icon you get detailed information about the current status of the file.

The entry name is not necessarily identical to the file name, as you can change the assigned name to partnerships at any time (see below). If you hover the mouse over the entry, you will get the file details as a tooltip.

You can select entries for viewing their partnership or for additional capabilities. If you double click an entry, you get a preview of the journal's content and additional options for converting them directly to OneNote (see ...). Notice that when you select an entry that is in a partnership, it's counterpart in the OneNote section will highlight in yellow. If the counterpart is hidden in the tree structure, the higher nodes will be highlighted in a very faint yellow. As will be detailed below, this also works vice versa.
Note that your active selection is highlighted in blue. Any changes and actions you perform (besides for full synchronisation) will affect the selected file and not necessarily the paired one (highlighted in yellow).

CONTEXT MENU
By right clicking on the "Edge Journals" you get additional options for handling the journals:
  • refresh: allows you to update the view, e.g. if you changed any files. Note that EdgeSync will automatically detect if you insert / remove a device on USB - in particular if you insert the Edge.
  • show content: has the same effect as double-clicking the entry and brings you to a preview of the journal (see Viewing)
  • rename (only for paired files): allows you to enter a meaningful name for the partnership, thus hiding the filename (see Synchronisation)
  • sync now (only for paired files): allows you to directly synchronise the selected journal with OneNote - note that this ONLY synchronises this file and not all partnerships (see Synchronisation)

ONENOTE NOTEBOOKS
The OneNote Notebooks view gives you an overview over the content and structure of all your OneNote notebooks. Currently, it does not tell you whether the respective node is a notebook, a section or a page. You can generally assume though that highest level nodes are notebooks and the lowest one are pages. If the name of a node is slightly indented, it refers to a subpage.

When selecting an entry in this view, the associated EdgeJournal will be highlighted in yellow, if the respective OneNote entry is part of a partnership (see also above). Note that your actual selection is highlighted in blue and actions such as creating a partnership etc. act on the selected nodes, not on the partnered ones (unless they are selected).

CONTEXT MENU
By right clicking on a "OneNote entry" you get additional options for handling the journals:
  • refresh: allows you to update the view, e.g. if you added or removed pages, notebooks or sections
  • go to OneNote: opens OneNote and moves to the selected notebook and section. Note though that it cannot jump to the right page.
  • show XML: shows the serialised content of the selected entry - this is mostly for debugging purposes, but may be interesting for some users (see Viewing)

SYNCHRONISATION
sync32.png
In order to execute the synchronisation between all paired and out-of-date entries, just click the main button in the middle of the window. A pop-up window will inform you of the progress (you can also watch it live in OneNote ;)

At the moment, all synchronisation is uni-directional, i.e. only from Edge to OneNote. The synchronisation tries to overwrite former entries (i.e. changes) to keep the OneNote content consistent. However, it may thereby delete any additional entries that you made on a destination page, or it may forget to delete tabs, when you deleted them on your Edge - this is work in progress. As a general advice, try to familiarize yourself with the synchronisation process, before risking loss of data through wrong usage. Please check out the "Usage Recommendation" section in Synchronisation

CREATE / DESTROY PARTNERSHIPS
Partnerships describe the relationship between an Edge Journal file and a OneNote entry. At the moment, synchronisation is uni-directional only, that means that only updated on the Edge Journals will be synchronized with OneNote, not the other way round.

Create a Partnership
chain6.png
In order to create a partnership, simply select the Edge Journal and the OneNote entry you want to pair. Notably, EdgeSync allows you to pair a Journal with any type of OneNote entry, be it a notebook, a section, a section group or a page. Please refer to Synchronisation for more details. Once you have selected the according entries, click the "Create Partnership" button (see image) to pair the two entries. The status next to the selected Journal entry will change from "unpaired" to "modified" (see "Edge Journals" above).

Notably, if the selected Journal file was already in a partnership, the existing partnership will be reorganised to your selection. A dialog box will make you aware of this circumstance, so you can still stop the process at this point.

Each Edge journal can only be partnered with a single OneNote entry, but a OneNote entry can take the input from multiple Edge journals - this allows you to merge files. However, it is expected that this feature will be discontinued with the introduction of two-way snychronisation.

Destroy a Partnership
unchain2.png
Partnerships can be destroyed at any time if you don't want to synchronise your Journal file any longer. In order to do so, just select the paired entries, i.e. both the Edge Journal and the OneNote entry - the partnership button will change to a broken chain (see image) to denote "Destroy Partnership". By clicking the button, the partnership will be removed and the state of the Journal file be changed to "unpaired" again.

Note that by pairing a broken partnership again, the status will return to "modified", as EdgeSync does not keep track of former partnerhsips.

Menu

The menu gives you access to the following additional capabilities:
  • Partnerships: this provides you with an overview over all partnerships currently registered, the file details and their last synchronistaion time. You can also add and remove partnerships directly from here. Please see Synchronisation for more details.
  • Preferences: here you can change the synchronisation behaviour and the display options of EdgeSync. Please refer to Preferences for details.
  • About: displays a version splash screen. This will automatically check for existing updates, see Checking for updates
  • Help: opens these pages in your browser (sorry, no offline help)

Last edited Apr 5, 2011 at 1:10 PM by LutzS, version 12

Comments

No comments yet.