DOC(More standardised documents)

mmarquee · mmarquee · commit 59b79eee7bb9 · 2017-10-07T21:07:53.000+01:00
diff --git a/README.md b/README.md
@@ -30,6 +30,6 @@ See LICENCE.txt for details.
 * [UIAutomation for Powershell](http://uiautomation.codeplex.com/documentation)
 * [TestStack.White](https://github.com/TestStack/White)
 * [UI Automation - A wrapper around Microsoft's UI Automation libraries.](https://github.com/vijayakumarsuraj/UIAutomation)
-
+* [Automation Spy Blog entry](http://www.automationspy.com/post-25_12_2014.html)
 * [Functional GUI Testing Automation Patterns](https://www.infoq.com/articles/gui-automation-patterns)
 
diff --git a/docs/button.md b/docs/button.md
@@ -1,9 +1,9 @@
-#Discovery 
+# Discovery 
 * See [Element Discovery](element-discovery.md)
 
-:Methods
+# Methods
 
-:Name
-:Value
-:Click
-:Focus
+## Name
+## Value
+## Click
+##Focus
diff --git a/docs/checkbox.md b/docs/checkbox.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
 AutomationCheckBox check = window.getCheckBox(0);
 check.toggle();
@@ -10,9 +13,9 @@ try {
 }
 ```
 
-: Methods
+# Methods
 
-:Name
-:Value
-:Toggle
-:ToggleState
+## Name
+## Value
+## Toggle
+## ToggleState
diff --git a/docs/combobox.md b/docs/combobox.md
@@ -1,6 +1,11 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
 AutomationComboBox cb1 = window.getCombobox("AutomatedCombobox1");
 String oldTxt = cb1.text();
 cb1.setText("Replacements");
 String txt = cb1.text();
-```
+```
+
+# Methods
diff --git a/docs/custom.md b/docs/custom.md
@@ -1 +1,7 @@
-The Custom control type covers a multitude of non-standard controls. Mostly these have been wrapped up in a single type - Custom, but where specific implementations are known, then sub-classes of Custom have been created - for example [Word](Word) has a AutomationDocumentPage, which is different enough from a standard Custom control to have a specific implementation. 
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
+The Custom control type covers a multitude of non-standard controls. Mostly these have been wrapped up in a single 
+type - Custom, but where specific implementations are known, then sub-classes of Custom have been created - for 
+example [Word](Word) has a AutomationDocumentPage, which is different enough from a standard Custom 
+control to have a specific implementation. 
diff --git a/docs/developer.md b/docs/developer.md
@@ -134,4 +134,4 @@ The controls that have been implemented reflect the requirements for automating
 * [Events](events.md)
 
 ## Other languages
-* [Scala](scala.md)
+* [Scala](scala.md)
diff --git a/docs/document.md b/docs/document.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationDocument document = applicationWindow.getDocument(0);
 
diff --git a/docs/editbox.md b/docs/editbox.md
@@ -1,11 +1,2 @@
-Edit boxes can be located by index, or by name.
-
-```
-  AutomationEditBox user = window.getEditBox(0);
-  user.setText("USER1");
-```
-
-```
-  AutomationEditBox user = window.getEditBox("edtBox1");
-  user.setText("USER1");
-```
+# Discovery 
+* See [Element Discovery](element-discovery.md)
diff --git a/docs/grids.md b/docs/grids.md
@@ -1,13 +1,14 @@
-## DataGrid
+# Discovery 
+* See [Element Discovery](element-discovery.md)
 
-### WFP
+## WFP
 ```
   AutomationDataGrid grid = window.getDataGrid(0);
   AutomationDataGridCell cell = grid.getItem(0,0);
   String itemName = item.name();
 ```
 
-### Delphi
+## Delphi
 
 The [DelphiUIAutomation](https://github.com/markhumphreysjhc/DelphiUIAutomation) project introduced some Delphi controls that implement IUIAutomation providers, allowing them to be accessed by automation. The TAutomatedStringGrid is one of these, as the base Delphi (as of XE5 at least) control does not implement the Grid or Table interfaces and so is opaque to automation. In order to get the element associated with the specific TAutomationStringGrid, then this is done in the following manner.
 
diff --git a/docs/hyperlink.md b/docs/hyperlink.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationHyperlink link = window.getHyperlink(0);
   link.click();
diff --git a/docs/maskedit.md b/docs/maskedit.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 The [DelphiUIAutomation](https://github.com/markhumphreysjhc/DelphiUIAutomation) project introduced some Delphi controls that implement IUIAutomation providers, allowing them to be accessed by automation. The Delphi implementation of a masked edit is another of these.
 
 There does not seem to be an equivalent WPF control.
diff --git a/docs/panel.md b/docs/panel.md
@@ -1,11 +1,4 @@
-Panels (or Panes) are generic containers for other controls.
-
-They can be found using an index, or by the name, as shown in this example.
+# Discovery 
+* See [Element Discovery](element-discovery.md)
 
-```
-  AutomationPanel pane = window.getPanel("Document1");
-  logger.info(pane.name());
-  logger.info(pane.getClassName());
-  AutomationPanel pane1 = pane.getPanel(0);
-  logger.info(pane1.name());
-```
+Panels (or Panes) are generic containers for other controls.
diff --git a/docs/progressbar.md b/docs/progressbar.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationProgressBar progress = applicationWindow.getProgressBar(0);
   logger.info("Progress = " + progress.getRangeValue());
diff --git a/docs/radiobutton.md b/docs/radiobutton.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationRadioButton radio = window.getRadioButton(1);
   radio.selectItem();
diff --git a/docs/ribbon.md b/docs/ribbon.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 The ribbon control is a complex structure, but the tree of controls is navigable, as the snippet below shows (automating the Windows Explorer), finding the button associated with the Preview Pane and clicking on it to turn it on/off.
 
 ```
diff --git a/docs/slider.md b/docs/slider.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationSlider slider = applicationWindow.getSlider(0);
   logger.info("Slider value = " + slider.getRangeValue());
diff --git a/docs/splitbutton.md b/docs/splitbutton.md
@@ -1,3 +1,6 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
 ```
   AutomationSplitButton split = panes.getSplitButton("Navigation pane");
   split.click();
diff --git a/docs/statusbar.md b/docs/statusbar.md
@@ -1,3 +1,8 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
+# Example
+
 ```
   AutomationStatusBar statusBar = window.getStatusBar();
   AutomationTextBox tb1 = statusBar.getTextBox(1);
diff --git a/docs/tab.md b/docs/tab.md
@@ -1,3 +1,8 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
+# Example
+
 ```
   AutomationTab tab = applicationWindow.getTab(0);
   tab.selectTabPage("Details");
diff --git a/docs/textbox.md b/docs/textbox.md
@@ -1,2 +1,4 @@
-#Discovery 
+# Discovery 
 * See [Element Discovery](element-discovery.md)
+
+# Example
diff --git a/docs/toolbar.md b/docs/toolbar.md
@@ -1,3 +1,8 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
+# Example
+
 ```
   AutomationToolBar toolbar = applicationWindow.getToolBar(0);
   logger.info("Toolbar name is " + toolbar.name()); // Blank in default WPF
diff --git a/docs/treeview.md b/docs/treeview.md
@@ -1,3 +1,7 @@
+# Discovery 
+* See [Element Discovery](element-discovery.md)
+
+# Example
 ```
   AutomationTreeView tree = window.getTreeView(0);
 
diff --git a/docs/treewalker.md b/docs/treewalker.md
@@ -1,4 +1 @@
-This uses the ContentViewWalker to get elements marked as being content elements.
-
-## See also
-* [Automation Spy Blog entry](http://www.automationspy.com/post-25_12_2014.html)
+This uses the ContentViewWalker to get elements marked as being content elements.
