From b0a34b4ec6755a6981cd53a28d8f7b6d8921832d Mon Sep 17 00:00:00 2001 From: Justin Johnson Date: Thu, 18 Jul 2019 17:17:50 -0600 Subject: [PATCH 1/2] batch updates adding yaml and transforming headings --- AnimatedClock/README.md | 20 +++++-- AnimatingViews/README.md | 15 ++++- AzureTodoMac/Readme.md | 23 +++++--- ButtonMadness/Readme.md | 15 ++++- CAQuartzComposition/README.md | 23 ++++++-- CFNetwork/Readme.md | 15 ++++- CircleView/Readme.md | 24 +++++--- Constraints/README.md | 26 ++++++--- CoreAnimationBook/README.md | 20 +++++-- CoreTextArcMonoMac/ReadMe.md | 29 ++++++---- CoreWLANWirelessManager/README.md | 20 +++++-- CustomFont/Readme.md | 15 ++++- DatePicker/README.md | 20 +++++-- DockAppIcon/README.md | 23 ++++++-- DocumentSample/README.md | 15 ++++- DragAndDropExample/Readme.md | 15 ++++- DrawerMadness/Readme.md | 15 ++++- ExtensionSamples/README.md | 29 ++++++---- FSEvents/README.md | 15 ++++- Fire/Readme.md | 15 ++++- GLFullScreen/README.md | 29 ++++++---- GLSLShader/README.md | 15 ++++- GlossyClock/README.md | 20 +++++-- HeartRateMonitor/README.md | 15 ++++- Hello_Mac/Readme.md | 15 ++++- HttpClient/README.md | 29 ++++++---- ImageKitDemoStep1/README.md | 23 ++++++-- ImageProtocolSample/README.md | 55 +++++++++++-------- MacCollectionNew/Readme.md | 15 ++++- MacControls/Readme.md | 15 ++++- MacCopyPaste/Readme.md | 21 ++++--- MacCustomControl/Readme.md | 15 ++++- MacDatabase/Readme.md | 15 ++++- MacDatabinding-Storyboard/Readme.md | 15 ++++- MacDatabinding-XIBs/Readme.md | 15 ++++- MacDialog/Readme.md | 15 ++++- MacImages/Readme.md | 15 ++++- MacInspector/Readme.md | 15 ++++- MacMenus/Readme.md | 15 ++++- MacOpenTK/Readme.md | 15 ++++- MacOutlines/Readme.md | 15 ++++- MacSourceLists/Readme.md | 15 ++++- MacTables/Readme.md | 15 ++++- MacToolbar/Readme.md | 15 ++++- MacWindows/Readme.md | 15 ++++- MacXibless/Readme.md | 15 ++++- MarkdownViewer/README.md | 21 +++++-- MonoMacGameWindow/Readme.md | 15 ++++- MouseTrackingExample/Readme.md | 15 ++++- NSAlert/Readme.md | 15 ++++- NSComboBoxTest/README.md | 15 ++++- NSCustomView/README.md | 15 ++++- NSImageName/README.md | 15 ++++- NSOutlineViewAndTableView/README.md | 15 ++++- NSPortExample/Readme.md | 23 +++++--- NSScrollExample/Readme.md | 15 ++++- NSTableViewBinding/README.md | 32 +++++++---- NSTextViewSample/README.md | 15 ++++- OpenGL-NeHe/README.md | 15 ++++- OpenGLLayer/readme.md | 18 ++++-- OpenGLViewSample/Readme.md | 15 ++++- OutlineView/README.md | 20 +++++-- PopupBindings/README.md | 23 ++++++-- PredicateEditorSample/README.md | 26 ++++++--- ProgressBarExample/Readme.md | 15 ++++- QTRecorder/README.md | 20 +++++-- ReactiveUIExample/Readme.md | 15 ++++- RoundedTransparentWindow/README.md | 15 ++++- Rulers/README.md | 18 ++++-- SCNetworkReachability/README.md | 15 ++++- SceneKitViewer/README.md | 24 +++++--- SearchField/README.md | 32 +++++++---- SkinnableApp/Readme.md | 15 ++++- SourceWriter/Readme.md | 15 ++++- StillMotion/README.md | 15 ++++- .../Readme.md | 15 ++++- UserNotificationExample/Readme.md | 15 ++++- VillainTracker/Readme.md | 15 ++++- WhereIsMyMac/README.md | 20 +++++-- XMBindingExample/Readme.md | 15 ++++- XMLocalizationSample/README.md | 29 ++++++---- guiunit-example/Readme.md | 15 ++++- yosemite/Bananas/README.md | 29 ++++++---- yosemite/Earthquakes/README.md | 29 ++++++---- yosemite/FileCards/README.md | 26 ++++++--- yosemite/SceneKitSessionWWDC2013/README.md | 29 ++++++---- yosemite/SceneKitSessionWWDC2014/README.md | 26 ++++++--- yosemite/VisualEffectPlayground/README.md | 29 ++++++---- 88 files changed, 1304 insertions(+), 384 deletions(-) diff --git a/AnimatedClock/README.md b/AnimatedClock/README.md index d136f2ea..b9330fd3 100644 --- a/AnimatedClock/README.md +++ b/AnimatedClock/README.md @@ -1,10 +1,22 @@ -AnimatedClock -============= +--- +name: Xamarin.Mac - AnimatedClock +description: Shows the use of custom property animations for CALayers in the CoreAnimation Layers API. This is based on the GlossyClock sample. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: animatedclock +--- +# AnimatedClock Shows the use of custom property animations for `CALayers` in the `CoreAnimation` Layers API. This is based on the GlossyClock sample. -Author ------- +![AnimatedClock application screenshot](Screenshots/0.png "AnimatedClock application screenshot") + +## Author Ported to Xamarin.Mac by Rolf Bjarne Kvinge. diff --git a/AnimatingViews/README.md b/AnimatingViews/README.md index bce40573..72dc96c4 100644 --- a/AnimatingViews/README.md +++ b/AnimatingViews/README.md @@ -1,4 +1,15 @@ -AnimatingViews -============== +--- +name: Xamarin.Mac - AnimatingViews +description: The Animating View sample shows how to use CoreAnimation to animate views. The code that does the animation lives in the... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: animatingviews +--- +# AnimatingViews The Animating View sample shows how to use `CoreAnimation` to animate views. The code that does the animation lives in the `AnimatingViewsWindowController.cs` file and shows how to animate either using the simple API (just assigning a value to the Frame property) or manually controlling the animation's properties. \ No newline at end of file diff --git a/AzureTodoMac/Readme.md b/AzureTodoMac/Readme.md index 1416c640..85b89860 100644 --- a/AzureTodoMac/Readme.md +++ b/AzureTodoMac/Readme.md @@ -1,16 +1,23 @@ -AzureToDoMac -============ +--- +name: Xamarin.Mac - AzureToDoMac +description: 'This sample covers using Azure Cloud Data in a Xamarin.Mac application by creating a simple ToDo list application. UPDATE: the most recent (Nov-16)...' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: azuretodomac +--- +# AzureToDoMac This sample covers using Azure Cloud Data in a Xamarin.Mac application by creating a simple ToDo list application. -UPDATE: the most recent (Nov-16) version of the [Azure Mobile Client NuGet](https://www.nuget.org/packages/Microsoft.Azure.Mobile.Client/) doesn't explicitly support the Xamarin.Mac platform, so the NET45 assemblies have been referenced directly in this sample. - ---- +## UPDATE: the most recent (Nov-16) version of the [Azure Mobile Client NuGet](https://www.nuget.org/packages/Microsoft.Azure.Mobile.Client/) doesn't explicitly support the Xamarin.Mac platform, so the NET45 assemblies have been referenced directly in this sample. **NOTE:** You'll need to edit the `Constants` class and provide your Azure Developer Credentials by setting the `ApplicationURL` values _before_ this sample can be successfully run. -The table configured in Azure should also have the same columns as the `TodoItem` class: `id`, `text`, `notes`, `complete`. - ---- +## The table configured in Azure should also have the same columns as the `TodoItem` class: `id`, `text`, `notes`, `complete`. ![](Screenshots/01.png) \ No newline at end of file diff --git a/ButtonMadness/Readme.md b/ButtonMadness/Readme.md index dcc99fd1..e12b2969 100644 --- a/ButtonMadness/Readme.md +++ b/ButtonMadness/Readme.md @@ -1,4 +1,15 @@ -ButtonMaddness -============== +--- +name: Xamarin.Mac - ButtonMaddness +description: This is a button sample for mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: buttonmadness +--- +# ButtonMaddness This is a button sample for mac. diff --git a/CAQuartzComposition/README.md b/CAQuartzComposition/README.md index f20c1866..bc252ed7 100644 --- a/CAQuartzComposition/README.md +++ b/CAQuartzComposition/README.md @@ -1,20 +1,31 @@ -CAQuartzComposition -=================== +--- +name: Xamarin.Mac - CAQuartzComposition +description: Shows the use of the CoreAnimation and QuartzComposition QCCompositionLayer. For a full description of the program and the original article point... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: caquartzcomposition +--- +# CAQuartzComposition Shows the use of the `CoreAnimation` and `QuartzComposition` `QCCompositionLayer`. For a full description of the program and the original article point your browser here: [Core Animation Tutorial] -Instructions ------------- +## Instructions There are two menu options you can access from the View menu item. * Switch View - which will switch between the to Quartz Compositions. * Use Filters - which toggles the use of filters being applied to the layer or not. -Author ------- +![CAQuartzComposition application screenshot](Screenshots/0.png "CAQuartzComposition application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/CFNetwork/Readme.md b/CFNetwork/Readme.md index 071f2675..f1457c5a 100644 --- a/CFNetwork/Readme.md +++ b/CFNetwork/Readme.md @@ -1,4 +1,15 @@ -CFNetwork -========= +--- +name: Xamarin.Mac - CFNetwork +description: CFNetwork Xamarin.Mac sample. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: cfnetwork +--- +# CFNetwork CFNetwork Xamarin.Mac sample. diff --git a/CircleView/Readme.md b/CircleView/Readme.md index 9bb93c68..2c106d35 100644 --- a/CircleView/Readme.md +++ b/CircleView/Readme.md @@ -1,19 +1,27 @@ -CircleView -============== +--- +name: Xamarin.Mac - CircleView +description: This is a sample ported from Swift which draws text on a custom view using NSLayoutManager. Runtime OS X 10.10+ Copyright Xamarin port changes are... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: circleview +--- +# CircleView This is a sample ported from Swift which draws text on a custom view using `NSLayoutManager`. -Runtime ------------------- +## Runtime OS X 10.10+ -Copyright --------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +## Author Ported to Xamarin.Mac by Chris Hamons diff --git a/Constraints/README.md b/Constraints/README.md index c3dcbf94..f1b3a80f 100644 --- a/Constraints/README.md +++ b/Constraints/README.md @@ -1,20 +1,30 @@ -Constraints -======== +--- +name: Xamarin.Mac - Constraints +description: This sample shows how to use UI constraints in Xamarin.Mac apps. Build Requirements OS X 10.12, Xcode 8.0 or later Runtime OS X 10.12 +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: constraints +--- +# Constraints This sample shows how to use UI constraints in Xamarin.Mac apps. -Build Requirements ------------------- +## Build Requirements OS X 10.12, Xcode 8.0 or later -Runtime ------------------- +## Runtime OS X 10.12 -Author ------- +![Constraints application screenshot](Screenshots/1.png "Constraints application screenshot") + +## Author Timothy Risi diff --git a/CoreAnimationBook/README.md b/CoreAnimationBook/README.md index 3163f287..86c2dbfe 100644 --- a/CoreAnimationBook/README.md +++ b/CoreAnimationBook/README.md @@ -1,9 +1,21 @@ -CoreAnimationBook -================= +--- +name: Xamarin.Mac - CoreAnimationBook +description: The samples in this directory are ports from the book Pragmatic's Core Animation for Mac OS X and show how to use CoreAnimation with Xamarin.Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: coreanimationbook +--- +# CoreAnimationBook The samples in this directory are ports from the book "Pragmatic's Core Animation for Mac OS X" and show how to use CoreAnimation with Xamarin.Mac. -Author ------- +![CoreAnimationBook application screenshot](Screenshots/1.png "CoreAnimationBook application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. \ No newline at end of file diff --git a/CoreTextArcMonoMac/ReadMe.md b/CoreTextArcMonoMac/ReadMe.md index 32430c29..d35545f0 100644 --- a/CoreTextArcMonoMac/ReadMe.md +++ b/CoreTextArcMonoMac/ReadMe.md @@ -1,5 +1,16 @@ -CoreTextArcMonoMac -================== +--- +name: Xamarin.Mac - CoreTextArcMonoMac +description: Illustrates how to use CoreText to draw text along an arc in a Xamarin.Mac application. The main drawing functionality demonstrated in this... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: coretextarcmonomac +--- +# CoreTextArcMonoMac Illustrates how to use `CoreText` to draw text along an arc in a Xamarin.Mac application. @@ -7,8 +18,7 @@ The main drawing functionality demonstrated in this application is implemented i All of the interresting functionality in that view is encapsulated in the -drawRect: method in the `CoreTextArcView.cs` file. There, `CoreText` is used to layout and draw glyphs along a curve. -NSFontPanel ------------ +## NSFontPanel This sample also makes use of the `NSFontPanel` to allow user configuration of the text being displayed in the custom view. This functionality can be found in the file `MyDocument.cs`. Key points to make note of in that file are: @@ -19,20 +29,19 @@ This functionality can be found in the file `MyDocument.cs`. Key points to make 3. The methods -toggleBold: and -toggleItalic: are called in response to user clicks in the italic and bold checkboxes. In these methods, the respective font attributes are changed and then the current settings are synchronized to the font pane and to the custom view. -Instructions ------------- +## Instructions * Build and run this sample. * When launched, the application will display a string drawn along an curve. * Click in the checkboxes in wthe window to change some font settings. * Choose the "Show Fonts" menu item from the "Format" menu to open the font panel so you can change additional font settings. -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![CoreTextArcMonoMac application screenshot](Screenshots/0.png "CoreTextArcMonoMac application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/CoreWLANWirelessManager/README.md b/CoreWLANWirelessManager/README.md index 568bde90..850e193d 100644 --- a/CoreWLANWirelessManager/README.md +++ b/CoreWLANWirelessManager/README.md @@ -1,5 +1,16 @@ -CoreWLANWirelessManager -======================= +--- +name: Xamarin.Mac - CoreWLANWirelessManager +description: 'Description: An example application which utilizes the CoreWLAN Framework. Interface Popup Button: The app supports a multiple interface scenario,...' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: corewlanwirelessmanager +--- +# CoreWLANWirelessManager * Description: An example application which utilizes the `CoreWLAN` Framework. @@ -24,7 +35,8 @@ And, there is a button in the bottom right corner of the Scan tab which allows t Also there is another one push button entitled "Create IBSS". A sheet will be presented upon clicking the Create IBSS button that will allow the user to provide the appropriate credentials for creating the computer-to-computer network. -Author ------- +![CoreWLANWirelessManager application screenshot](Screenshots/1.png "CoreWLANWirelessManager application screenshot") + +## Author Ported to Xamarin.Mac by Oleg Demchenko. diff --git a/CustomFont/Readme.md b/CustomFont/Readme.md index 0163e0c2..a2dcd96a 100644 --- a/CustomFont/Readme.md +++ b/CustomFont/Readme.md @@ -1,4 +1,15 @@ -Custom Fonts -============ +--- +name: Xamarin.Mac - Custom Fonts +description: This sample shows how to embed a custom font in a Xamarin.Mac application and how to use that font in a User Interface item. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: customfont +--- +# Custom Fonts This sample shows how to embed a custom font in a Xamarin.Mac application and how to use that font in a User Interface item. \ No newline at end of file diff --git a/DatePicker/README.md b/DatePicker/README.md index 8c4192da..29b52c60 100644 --- a/DatePicker/README.md +++ b/DatePicker/README.md @@ -1,9 +1,21 @@ -DatePicker -========== +--- +name: Xamarin.Mac - DatePicker +description: Shows the use of the NSDatePicker control with Xamarin.Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: datepicker +--- +# DatePicker Shows the use of the `NSDatePicker` control with Xamarin.Mac. -Author ------- +![DatePicker application screenshot](Screenshots/0.png "DatePicker application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth Pouncey. diff --git a/DockAppIcon/README.md b/DockAppIcon/README.md index be03d79d..df2cf0ce 100644 --- a/DockAppIcon/README.md +++ b/DockAppIcon/README.md @@ -1,5 +1,16 @@ -DockAppIcon -=========== +--- +name: Xamarin.Mac - DockAppIcon +description: Shows the use of the NSDockTile. Adding a badge to the icon in the Dock provides a setting to add a custom format. Manipulating the Application... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: dockappicon +--- +# DockAppIcon Shows the use of the `NSDockTile`. @@ -7,15 +18,15 @@ Shows the use of the `NSDockTile`. * Manipulating the Application Badge. * Getting the users attention: Informational and Critical. -Instructions ------------- +## Instructions To see the request for attention: * Use the Request Button. * Move away from this application by activating another application within 3 seconds. * The requests only work if the requesting application is not the active application. -Author ------- +![DockAppIcon application screenshot](Screenshots/0.png "DockAppIcon application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. \ No newline at end of file diff --git a/DocumentSample/README.md b/DocumentSample/README.md index b7d6c341..57242753 100644 --- a/DocumentSample/README.md +++ b/DocumentSample/README.md @@ -1,5 +1,16 @@ -DocumentSample -============== +--- +name: Xamarin.Mac - DocumentSample +description: Shows how to create a Document-based application. Document-based applications are supported by the NSDocument family of classes and take a lot of... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: documentsample +--- +# DocumentSample Shows how to create a Document-based application. diff --git a/DragAndDropExample/Readme.md b/DragAndDropExample/Readme.md index 68696527..8aad2442 100644 --- a/DragAndDropExample/Readme.md +++ b/DragAndDropExample/Readme.md @@ -1,5 +1,16 @@ -Drag and Drop Example -===================== +--- +name: Xamarin.Mac - Drag and Drop Example +description: This sample shows how to do a simple drag & drop between two views in a Xamarin.Mac application. When the application is run, the user can drag... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: draganddropexample +--- +# Drag and Drop Example This sample shows how to do a simple drag & drop between two views in a Xamarin.Mac application. When the application is run, the user can drag from the **Red View** and drop onto the **Green View**. diff --git a/DrawerMadness/Readme.md b/DrawerMadness/Readme.md index eb0ef2e0..932fd923 100644 --- a/DrawerMadness/Readme.md +++ b/DrawerMadness/Readme.md @@ -1,4 +1,15 @@ -DrawerMadness -============= +--- +name: Xamarin.Mac - DrawerMadness +description: DrawerMadness Xamarin.Mac sample. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: drawermadness +--- +# DrawerMadness DrawerMadness Xamarin.Mac sample. diff --git a/ExtensionSamples/README.md b/ExtensionSamples/README.md index bc5c81ea..43dd8c8f 100644 --- a/ExtensionSamples/README.md +++ b/ExtensionSamples/README.md @@ -1,5 +1,16 @@ -ExtensionSamples -============== +--- +name: Xamarin.Mac - ExtensionSamples +description: This sample demonstrates how to use app extensions in Xamarin.Mac. To register an extension on your machine you'll need run the host application,... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: extensionsamples +--- +# ExtensionSamples This sample demonstrates how to use app extensions in Xamarin.Mac. To register an extension on your machine you'll need run the host application, **ExtensionSamples** one time and then enable each plugin from the **System Preference** Extension panel. @@ -10,20 +21,18 @@ Sample extensions: * Finder extension * Today extension -Build Requirements ------------------- +## Build Requirements OS X 10.11, Xcode 7.0 or later -Runtime ------------------- +## Runtime OS X 10.11 -Copyright ---------- +## Copyright Xamarin samples released under the MIT license -Author ------- +![ExtensionSamples application screenshot](Screenshots/0.png "ExtensionSamples application screenshot") + +## Author Chris Hamons diff --git a/FSEvents/README.md b/FSEvents/README.md index 55ff76a3..54ec5abe 100644 --- a/FSEvents/README.md +++ b/FSEvents/README.md @@ -1,4 +1,15 @@ -FSEvent Watcher -=============== +--- +name: Xamarin.Mac - FSEvent Watcher +description: Directory monitoring sample app using FSEvents from CoreServices. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: fsevents +--- +# FSEvent Watcher Directory monitoring sample app using [FSEvents from CoreServices](https://developer.apple.com/library/mac/#documentation/Darwin/Conceptual/FSEvents_ProgGuide/TechnologyOverview/TechnologyOverview.html#//apple_ref/doc/uid/TP40005289-CH3-SW1). diff --git a/Fire/Readme.md b/Fire/Readme.md index 4fb6e627..4166af1e 100644 --- a/Fire/Readme.md +++ b/Fire/Readme.md @@ -1,4 +1,15 @@ -Fire -==== +--- +name: Xamarin.Mac - Fire +description: Fire sample for Xamarin.Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: fire +--- +# Fire Fire sample for Xamarin.Mac. diff --git a/GLFullScreen/README.md b/GLFullScreen/README.md index 7da2af36..c54c0300 100644 --- a/GLFullScreen/README.md +++ b/GLFullScreen/README.md @@ -1,18 +1,27 @@ -GLFullScreen -============ +--- +name: Xamarin.Mac - GLFullScreen +description: This sample code demonstrates OpenGL drawing to the entire screen. Files Description MainWindowController.cs - A controller object that handles... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: glfullscreen +--- +# GLFullScreen This sample code demonstrates `OpenGL` drawing to the entire screen. -Files Description ------------------ +## Files Description * `MainWindowController.cs` - A controller object that handles full-screen/window modes switching and user interactions. * `MyOpenGLView.m` - An `NSView` subclass that delegates to separate "scene" and "controller" objects for OpenGL rendering and input event handling. * `Scene.cs` - A delegate object used by `MyOpenGLView` and `MainWindowController` to render a simple scene. * `Texture.cs` - A helper class that loads an `OpenGL` texture from an image path. -Instructions ------------- +## Instructions * In the window mode, press the "Go FullScreen" button to switch to the full-screen mode. * In the full-screen mode, press [ESC] to switch to the window mode. @@ -20,12 +29,12 @@ Instructions * Press [w]/[W] to toggle wireframe rendering. * Hold and drag the mouse to change the roll angle and from which the light is coming. -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![GLFullScreen application screenshot](Screenshots/0.png "GLFullScreen application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/GLSLShader/README.md b/GLSLShader/README.md index 06d13535..acc02629 100644 --- a/GLSLShader/README.md +++ b/GLSLShader/README.md @@ -1,5 +1,16 @@ -GLSLShader -========== +--- +name: Xamarin.Mac - GLSLShader +description: Simple GLSL shader harness program. Does nothing more than draw a line on the screen. The color is controlled by the shader.vert GSL source.... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: glslshader +--- +# GLSLShader Simple GLSL shader harness program. Does nothing more than draw a line on the screen. The color is controlled by the shader.vert GSL source. diff --git a/GlossyClock/README.md b/GlossyClock/README.md index fedacbca..b5f3ab4f 100644 --- a/GlossyClock/README.md +++ b/GlossyClock/README.md @@ -1,12 +1,24 @@ -GlossyClock -=========== +--- +name: Xamarin.Mac - GlossyClock +description: Shows the use of the CoreAnimation Layers API and KVO bindings. For a full description of the program and the original article point your browser... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: glossyclock +--- +# GlossyClock Shows the use of the `CoreAnimation` Layers API and KVO bindings. For a full description of the program and the original article point your browser here: [Core Animation Layered Clock] -Author ------- +![GlossyClock application screenshot](Screenshots/0.png "GlossyClock application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/HeartRateMonitor/README.md b/HeartRateMonitor/README.md index fd3f7fcf..cdcaf59f 100644 --- a/HeartRateMonitor/README.md +++ b/HeartRateMonitor/README.md @@ -1,5 +1,16 @@ -HeartRateMonitor -================ +--- +name: Xamarin.Mac - HeartRateMonitor +description: The CoreBluetooth framework provides the classes needed for your iOS and Mac apps to communicate with devices that are equipped with Bluetooth low... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: heartratemonitor +--- +# HeartRateMonitor The `CoreBluetooth` framework provides the classes needed for your iOS and Mac apps to communicate with devices that are equipped with Bluetooth low energy wireless technology, such as heart rate monitors, cycling cadence sensors, and temperature monitors. diff --git a/Hello_Mac/Readme.md b/Hello_Mac/Readme.md index 71bc808c..7299424f 100644 --- a/Hello_Mac/Readme.md +++ b/Hello_Mac/Readme.md @@ -1,5 +1,16 @@ -Hello, Mac -========== +--- +name: Xamarin.Mac - Hello, Mac +description: Source code for the [Hello, Mac Getting Started Guide] on the [Xamarin Developer Center]. Uses [Xamarin.Mac]. Consists of a single window, button... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: hello-mac +--- +# Hello, Mac Source code for the [Hello, Mac Getting Started Guide] on the [Xamarin Developer Center]. diff --git a/HttpClient/README.md b/HttpClient/README.md index 707f2197..a2ec88ec 100644 --- a/HttpClient/README.md +++ b/HttpClient/README.md @@ -1,23 +1,32 @@ -HttpClient -====== +--- +name: Xamarin.Mac - HttpClient +description: This sample shows how to issue http/https web requests using .NET and Objective-C API. Main actions takes place in NetworkHandlers.cs file. There... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: httpclient +--- +# HttpClient This sample shows how to issue http/https web requests using .NET and Objective-C API. Main actions takes place in NetworkHandlers.cs file. There you will find Cocoa and DotNet classes. DotNet class uses standard WebRequest to create web-requests. On the other hand Cocoa utilizes NSUrlRequest native class. -Build Requirements ------------------- +## Build Requirements OS X 10.10, Xcode 6.0 or later -Runtime ------------------- +## Runtime OS X 10.10 -References ------------------- +## References Checkout how to issue http/https web requests in Xamarin.iOS [here](https://github.com/xamarin/monotouch-samples/tree/master/HttpClient) -Author ------- +![HttpClient application screenshot](Screenshots/0.png "HttpClient application screenshot") + +## Author Chris Hamons diff --git a/ImageKitDemoStep1/README.md b/ImageKitDemoStep1/README.md index 5de57894..7b2f1ba3 100644 --- a/ImageKitDemoStep1/README.md +++ b/ImageKitDemoStep1/README.md @@ -1,5 +1,16 @@ -ImageKit Demo -============= +--- +name: Xamarin.Mac - ImageKit Demo +description: Simple demo to exercise ImageKit's ImageBrowserView. While it is largely unrecognizable from the source, this code was inspired by and modeled... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: imagekitdemostep1 +--- +# ImageKit Demo Simple demo to exercise ImageKit's `ImageBrowserView`. @@ -12,8 +23,7 @@ This demo illustrates: * IKImageBrowserItem. * Drag and drop support. -Instructions ------------- +## Instructions * Drag images (or PDFs, etc) around the browser view to re-organize. * Enter search text to filter the images displayed. @@ -23,7 +33,8 @@ Instructions * Dragging a folder will add all files in that folder. * Events for double click, right click etc. are wired up, but only print notices to the console. -Author ------- +![ImageKit Demo application screenshot](Screenshots/0.png "ImageKit Demo application screenshot") + +## Author Ported to Xamarin.Mac by Regan Sarwas. diff --git a/ImageProtocolSample/README.md b/ImageProtocolSample/README.md index 5d4581ea..b46b41de 100644 --- a/ImageProtocolSample/README.md +++ b/ImageProtocolSample/README.md @@ -1,23 +1,32 @@ -ImageProtocol -============= - -This sample illustrates how to register a custom NSUrlProtocol in Xamarin.Mac. - -Build Requirements ------------------- - -OS X 10.11, Xcode 8.0 or later - -Runtime ------------------- -OS X 10.11 - -Copyright ---------- - -Released under the MIT license - -Author ------- - -Chris Hamons +--- +name: Xamarin.Mac - ImageProtocol +description: This sample illustrates how to register a custom NSUrlProtocol in Xamarin.Mac. Build Requirements OS X 10.11, Xcode 8.0 or later Runtime OS X 10.11... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: imageprotocolsample +--- +# ImageProtocol + +This sample illustrates how to register a custom NSUrlProtocol in Xamarin.Mac. + +## Build Requirements + +OS X 10.11, Xcode 8.0 or later + +## Runtime +OS X 10.11 + +## Copyright + +Released under the MIT license + +![ImageProtocol application screenshot](Screenshots/1.png "ImageProtocol application screenshot") + +## Author + +Chris Hamons diff --git a/MacCollectionNew/Readme.md b/MacCollectionNew/Readme.md index 5857b80e..18ddc760 100644 --- a/MacCollectionNew/Readme.md +++ b/MacCollectionNew/Readme.md @@ -1,5 +1,16 @@ -MacCollectionNew -============== +--- +name: Xamarin.Mac - MacCollectionNew +description: Source code for the Collection Views documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with Data Binding and... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: maccollectionnew +--- +# MacCollectionNew Source code for the [Collection Views](/guides/mac/user-interface/working-with-collection-views/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacControls/Readme.md b/MacControls/Readme.md index 6767f7a2..64201be6 100644 --- a/MacControls/Readme.md +++ b/MacControls/Readme.md @@ -1,5 +1,16 @@ -MacControls -========== +--- +name: Xamarin.Mac - MacControls +description: Source code for the Standard Controls documentation on Xamarin Developer Center Uses Xamarin.Mac. When working with C and .NET in a Xamarin.Mac... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: maccontrols +--- +# MacControls Source code for the [Standard Controls](/guides/mac/user-interface/standard-controls/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacCopyPaste/Readme.md b/MacCopyPaste/Readme.md index 5e460b26..47c0dcd9 100644 --- a/MacCopyPaste/Readme.md +++ b/MacCopyPaste/Readme.md @@ -1,9 +1,16 @@ -MacCopyPaste -============ - -This sample covers working with the Pasteboard (`NSPasteboard`) to provide **Cut**, **Copy** and **Paste** operationsin a Xamarin.Mac application. It shows how to work with standard data types that can be shared between multiple apps and how to support custom data within a give app. - --- -**Note:** This sample currently contains a workaround to [Bugzilla Defect #31760](https://bugzilla.xamarin.com/show_bug.cgi?id=31760). When the version of Xamarin.Mac is released that fixes this issue, this sample will be updated to the correct version. The correct source code has been included as a reference. +name: Xamarin.Mac - MacCopyPaste +description: This sample covers working with the Pasteboard (NSPasteboard) to provide Cut, Copy and Paste operationsin a Xamarin.Mac application. It shows how... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: maccopypaste +--- +# MacCopyPaste ---- \ No newline at end of file +## This sample covers working with the Pasteboard (`NSPasteboard`) to provide **Cut**, **Copy** and **Paste** operationsin a Xamarin.Mac application. It shows how to work with standard data types that can be shared between multiple apps and how to support custom data within a give app. +## **Note:** This sample currently contains a workaround to [Bugzilla Defect #31760](https://bugzilla.xamarin.com/show_bug.cgi?id=31760). When the version of Xamarin.Mac is released that fixes this issue, this sample will be updated to the correct version. The correct source code has been included as a reference. \ No newline at end of file diff --git a/MacCustomControl/Readme.md b/MacCustomControl/Readme.md index 9c064a0c..d05d0b1f 100644 --- a/MacCustomControl/Readme.md +++ b/MacCustomControl/Readme.md @@ -1,4 +1,15 @@ -MacCustomControl -=========== +--- +name: Xamarin.Mac - MacCustomControl +description: This sample shows how to create a reusable, Custom User Interface Control in a Xamarin.Mac app and add it to a storyboard in Xcode's Interface... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: maccustomcontrol +--- +# MacCustomControl This sample shows how to create a reusable, Custom User Interface Control in a Xamarin.Mac app and add it to a storyboard in Xcode's Interface Builder. \ No newline at end of file diff --git a/MacDatabase/Readme.md b/MacDatabase/Readme.md index ea7200ef..b78868d1 100644 --- a/MacDatabase/Readme.md +++ b/MacDatabase/Readme.md @@ -1,5 +1,16 @@ -MacDatabase -=========== +--- +name: Xamarin.Mac - MacDatabase +description: Source code for the Working with SQLite Databases documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macdatabase +--- +# MacDatabase Source code for the [Working with SQLite Databases](/guides/mac/application_fundamentals/databases/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacDatabinding-Storyboard/Readme.md b/MacDatabinding-Storyboard/Readme.md index 245bc285..b33d2924 100644 --- a/MacDatabinding-Storyboard/Readme.md +++ b/MacDatabinding-Storyboard/Readme.md @@ -1,5 +1,16 @@ -MacDatabinding Storyboard -============== +--- +name: Xamarin.Mac - MacDatabinding Storyboard +description: Source code for the Data Binding and Key-Value Coding documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macdatabinding-storyboard +--- +# MacDatabinding Storyboard Source code for the [Data Binding and Key-Value Coding](/guides/mac/application_fundamentals/databinding/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacDatabinding-XIBs/Readme.md b/MacDatabinding-XIBs/Readme.md index 3eb6a9af..109c2e8f 100644 --- a/MacDatabinding-XIBs/Readme.md +++ b/MacDatabinding-XIBs/Readme.md @@ -1,5 +1,16 @@ -MacDatabinding XIBs -============== +--- +name: Xamarin.Mac - MacDatabinding XIBs +description: '> ℹ️ NOTE: This method of working with controls and Data Binding has been deprecated, please see the MacDatabinding-Storyboard or MacCollectionNew...' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macdatabinding-xibs +--- +# MacDatabinding XIBs > ℹ️ **NOTE**: This method of working with controls and Data Binding has been deprecated, please see the **MacDatabinding-Storyboard** or **MacCollectionNew** samples instead. diff --git a/MacDialog/Readme.md b/MacDialog/Readme.md index 126c8260..f841a0f8 100644 --- a/MacDialog/Readme.md +++ b/MacDialog/Readme.md @@ -1,5 +1,16 @@ -MacDialog -========== +--- +name: Xamarin.Mac - MacDialog +description: This project covers working with Windows, Modal Windows, Panels, Sheets, Dialogs and Alerts in a Xamarin.Mac application and includes examples of... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macdialog +--- +# MacDialog This project covers working with Windows, Modal Windows, Panels, Sheets, Dialogs and Alerts in a Xamarin.Mac application and includes examples of every time of each items listed. diff --git a/MacImages/Readme.md b/MacImages/Readme.md index df996749..301c95d6 100644 --- a/MacImages/Readme.md +++ b/MacImages/Readme.md @@ -1,5 +1,16 @@ -MacImages -========== +--- +name: Xamarin.Mac - MacImages +description: Source code for the Working with Images documentation on Xamarin Developer Center Uses Xamarin.Mac. When working with C and .NET in a Xamarin.Mac... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macimages +--- +# MacImages Source code for the [Working with Images](/guides/mac/application_fundamentals/working-with-images) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacInspector/Readme.md b/MacInspector/Readme.md index 0bead708..a45b3b1f 100644 --- a/MacInspector/Readme.md +++ b/MacInspector/Readme.md @@ -1,5 +1,16 @@ -MacInspector -============ +--- +name: Xamarin.Mac - MacInspector +description: Most modern OS X applications present auxiliary controls and options that affect the active document or selection as Inspectors that are part of... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macinspector +--- +# MacInspector Most modern OS X applications present auxiliary controls and options that affect the active document or selection as **Inspectors** that are part of the Main Window (like Apple's Pages or Numbers apps), instead of using [Panel Windows](https://developer.xamarin.com/guides/mac/user-interface/working-with-windows/#Panels). diff --git a/MacMenus/Readme.md b/MacMenus/Readme.md index 269efcc5..f86f5644 100644 --- a/MacMenus/Readme.md +++ b/MacMenus/Readme.md @@ -1,5 +1,16 @@ -MacMenus -========== +--- +name: Xamarin.Mac - MacMenus +description: Source code for the Menus documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with Menus in a Xamarin.Mac... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macmenus +--- +# MacMenus Source code for the [Menus](/guides/mac/user-interface/working-with-menus/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacOpenTK/Readme.md b/MacOpenTK/Readme.md index 9ae8cfa8..ab19bc8e 100644 --- a/MacOpenTK/Readme.md +++ b/MacOpenTK/Readme.md @@ -1,5 +1,16 @@ -MacOpenTK -========= +--- +name: Xamarin.Mac - MacOpenTK +description: OpenTK (The Open Toolkit) is an advanced, low-level C library that makes working with OpenGL, OpenCL and OpenAL easier. OpenTK can be used for... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macopentk +--- +# MacOpenTK OpenTK (The Open Toolkit) is an advanced, low-level C# library that makes working with OpenGL, OpenCL and OpenAL easier. OpenTK can be used for games, scientific applications or other projects that require 3D graphics, audio or computational functionality. This example gives a brief introduction to using OpenTK in a Xamarin.Mac app. diff --git a/MacOutlines/Readme.md b/MacOutlines/Readme.md index a91ecd9e..ebfaf1b8 100644 --- a/MacOutlines/Readme.md +++ b/MacOutlines/Readme.md @@ -1,5 +1,16 @@ -MacOutlines -=========== +--- +name: Xamarin.Mac - MacOutlines +description: Source code for the Outline Views documentation on Xamarin Developer Center Uses Xamarin.Mac. This sample covers working with Outline Views in a... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macoutlines +--- +# MacOutlines Source code for the [Outline Views](/guides/mac/user-interface/working-with-outlineviews/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacSourceLists/Readme.md b/MacSourceLists/Readme.md index 9feeaa1b..de1793c4 100644 --- a/MacSourceLists/Readme.md +++ b/MacSourceLists/Readme.md @@ -1,5 +1,16 @@ -MacSourceLists -=========== +--- +name: Xamarin.Mac - MacSourceLists +description: Source code for the Source Lists documentation on Xamarin Developer Center Uses Xamarin.Mac. This sample covers working with Source Lists in a... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macsourcelists +--- +# MacSourceLists Source code for the [Source Lists](/guides/mac/user-interface/working-with-sourcelists/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacTables/Readme.md b/MacTables/Readme.md index 3f3b4590..9a751aad 100644 --- a/MacTables/Readme.md +++ b/MacTables/Readme.md @@ -1,5 +1,16 @@ -MacTables -========== +--- +name: Xamarin.Mac - MacTables +description: Source code for the Table Views documentation on Xamarin Developer Center Uses Xamarin.Mac. This sample covers working with Table Views in a... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: mactables +--- +# MacTables Source code for the [Table Views](/guides/mac/user-interface/working-with-tableviews/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacToolbar/Readme.md b/MacToolbar/Readme.md index d10f9b4e..da1e5dc5 100644 --- a/MacToolbar/Readme.md +++ b/MacToolbar/Readme.md @@ -1,5 +1,16 @@ -MacToolbar -========== +--- +name: Xamarin.Mac - MacToolbar +description: Source code for the Toolbars documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with Toolbars in a Xamarin.Mac... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: mactoolbar +--- +# MacToolbar Source code for the [Toolbars](/guides/mac/user-interface/working-with-toolbars/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacWindows/Readme.md b/MacWindows/Readme.md index d2bfab45..19f95a40 100644 --- a/MacWindows/Readme.md +++ b/MacWindows/Readme.md @@ -1,5 +1,16 @@ -MacWindows -========== +--- +name: Xamarin.Mac - MacWindows +description: Source code for the Windows, Dialogs and Alerts documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers working with... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macwindows +--- +# MacWindows Source code for the [Windows](/guides/mac/user-interface/working-with-windows/), [Dialogs](/guides/mac/user-interface/working-with-dialogs/) and [Alerts](/guides/mac/user-interface/working-with-alerts/) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MacXibless/Readme.md b/MacXibless/Readme.md index 5881545c..ca650771 100644 --- a/MacXibless/Readme.md +++ b/MacXibless/Readme.md @@ -1,5 +1,16 @@ -MacXibless -========== +--- +name: Xamarin.Mac - MacXibless +description: Source code for the .XIBless User Interface Design documentation on Xamarin Developer Center Uses Xamarin.Mac. This project covers creating a... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: macxibless +--- +# MacXibless Source code for the [.XIBless User Interface Design](/guides/mac/application_fundamentals/xibless-ui) documentation on [Xamarin Developer Center](http://docs.xamarin.com) diff --git a/MarkdownViewer/README.md b/MarkdownViewer/README.md index 9bed47d7..0d7eb1be 100644 --- a/MarkdownViewer/README.md +++ b/MarkdownViewer/README.md @@ -1,5 +1,16 @@ -MarkdownViewer -============== +--- +name: Xamarin.Mac - MarkdownViewer +description: This Mac sample is quite useful for authoring and viewing Markdown files, but also offers a little insight into building a hybrid web and native... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: markdownviewer +--- +# MarkdownViewer This Mac sample is quite useful for authoring and viewing __Markdown__ files, but also offers a little insight into building a hybrid web and native Mac @@ -12,15 +23,13 @@ application. * JavaScript is used to scroll the page, invoked from native code. * Navigation events are intercepted to open links in the system browser. -Under the hood --------------- +## Under the hood The [Sundown](https://github.com/vmg/sundown) C library is used to actually convert Markdown to HTML. In addition all the Github extensions are enabled. A small C# binding to Sundown is included. -Resources ---------- +## Resources * [Learn Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) * [Become familiar with classical Markdown](http://daringfireball.net/projects/markdown/syntax) diff --git a/MonoMacGameWindow/Readme.md b/MonoMacGameWindow/Readme.md index ac1b869e..2d8a1c24 100644 --- a/MonoMacGameWindow/Readme.md +++ b/MonoMacGameWindow/Readme.md @@ -1,4 +1,15 @@ -MonoMacGameView -=============== +--- +name: Xamarin.Mac - MonoMacGameView +description: MonoGame sample for mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: monomacgamewindow +--- +# MonoMacGameView MonoGame sample for mac. diff --git a/MouseTrackingExample/Readme.md b/MouseTrackingExample/Readme.md index fe551229..b5b1a09b 100644 --- a/MouseTrackingExample/Readme.md +++ b/MouseTrackingExample/Readme.md @@ -1,4 +1,15 @@ -MouseTrackingExample -==================== +--- +name: Xamarin.Mac - MouseTrackingExample +description: This sample covers working with the Mouse Tracking Areas (NSTrackingArea) to mouse tracking in a Xamarin.Mac application. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: mousetrackingexample +--- +# MouseTrackingExample This sample covers working with the Mouse Tracking Areas (`NSTrackingArea`) to mouse tracking in a Xamarin.Mac application. \ No newline at end of file diff --git a/NSAlert/Readme.md b/NSAlert/Readme.md index 52016cd9..b090d7be 100644 --- a/NSAlert/Readme.md +++ b/NSAlert/Readme.md @@ -1,4 +1,15 @@ -NSAlert -======= +--- +name: Xamarin.Mac - NSAlert +description: NSAlert sample for mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nsalert +--- +# NSAlert `NSAlert` sample for mac. diff --git a/NSComboBoxTest/README.md b/NSComboBoxTest/README.md index 785230d1..2421a5ca 100644 --- a/NSComboBoxTest/README.md +++ b/NSComboBoxTest/README.md @@ -1,4 +1,15 @@ -NSComboBoxTest -============== +--- +name: Xamarin.Mac - NSComboBoxTest +description: Demonstrates how to use an NSComboBox with an NSComboBoxData source to provide completion hints. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nscomboboxtest +--- +# NSComboBoxTest Demonstrates how to use an `NSComboBox` with an `NSComboBoxData` source to provide completion hints. \ No newline at end of file diff --git a/NSCustomView/README.md b/NSCustomView/README.md index 0a38f32a..08e5a82d 100644 --- a/NSCustomView/README.md +++ b/NSCustomView/README.md @@ -1,5 +1,16 @@ -NSCustomView -============ +--- +name: Xamarin.Mac - NSCustomView +description: This example shows the creation of two custom NSViews, which each paint themselves via different mechanisms. - One overrides the draw method and... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nscustomview +--- +# NSCustomView This example shows the creation of two custom `NSView`s, which each paint themselves via different mechanisms. diff --git a/NSImageName/README.md b/NSImageName/README.md index 15bbc4f5..70702476 100644 --- a/NSImageName/README.md +++ b/NSImageName/README.md @@ -1,5 +1,16 @@ -NSImageName Sample -================== +--- +name: Xamarin.Mac - NSImageName Sample +description: A simple sample application demoing the NSImageName enum for NSImage.ImageNamed. The sample cycles through all possible values and displays the... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nsimagename +--- +# NSImageName Sample A simple sample application demoing the `NSImageName` enum for `NSImage.ImageNamed`. The sample cycles through all possible values and displays the corresponding image. diff --git a/NSOutlineViewAndTableView/README.md b/NSOutlineViewAndTableView/README.md index 191e1c71..393671fe 100644 --- a/NSOutlineViewAndTableView/README.md +++ b/NSOutlineViewAndTableView/README.md @@ -1,5 +1,16 @@ -NSTableView / NSOutlineView -=========================== +--- +name: Xamarin.Mac - NSTableView / NSOutlineView +description: This quick start guide will walk you through the programmatic creation of and use of NSTableView/NSOutlineView with Xamarin.Mac. These views often... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nsoutlineviewandtableview +--- +# NSTableView / NSOutlineView This quick start guide will walk you through the programmatic creation of and use of `NSTableView`/`NSOutlineView` with Xamarin.Mac. diff --git a/NSPortExample/Readme.md b/NSPortExample/Readme.md index 68d2dadc..d057fb89 100644 --- a/NSPortExample/Readme.md +++ b/NSPortExample/Readme.md @@ -1,15 +1,22 @@ -NSPortExample -============= +--- +name: Xamarin.Mac - NSPortExample +description: The following is an example showing use of NSMessagePort & CFMessagePort to send information cross process, between applications. In the case of... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nsportexample +--- +# NSPortExample The following is an example showing use of `NSMessagePort` & `CFMessagePort` to send information cross process, between applications. In the case of this example, from a Xamarin.Mac C# program to a running Objective-C program. -The example is based off the [Inter-Process Communication](http://nshipster.com/inter-process-communication/) article by Mattt Thompson. - ---- - -**Note:** There are a few binding that are used in the article that are not currently available in Xamarin.Mac. These are being tracked by this [Bugzilla](https://bugzilla.xamarin.com/show_bug.cgi?id=30815) defect. +## The example is based off the [Inter-Process Communication](http://nshipster.com/inter-process-communication/) article by Mattt Thompson. ---- +## **Note:** There are a few binding that are used in the article that are not currently available in Xamarin.Mac. These are being tracked by this [Bugzilla](https://bugzilla.xamarin.com/show_bug.cgi?id=30815) defect. ## Running this Example diff --git a/NSScrollExample/Readme.md b/NSScrollExample/Readme.md index 83b93cc3..13945800 100644 --- a/NSScrollExample/Readme.md +++ b/NSScrollExample/Readme.md @@ -1,4 +1,15 @@ -NSScrollExample -========== +--- +name: Xamarin.Mac - NSScrollExample +description: This example show how to lay out a NSScrollView with a custom tree of child views. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nsscrollexample +--- +# NSScrollExample This example show how to lay out a NSScrollView with a custom tree of child views. diff --git a/NSTableViewBinding/README.md b/NSTableViewBinding/README.md index 68e2dcd6..12eb1ec6 100644 --- a/NSTableViewBinding/README.md +++ b/NSTableViewBinding/README.md @@ -1,5 +1,16 @@ -NSTableViewBinding -================== +--- +name: Xamarin.Mac - NSTableViewBinding +description: NSTableViewBinding is an application that demonstrates how to use Cocoa Bindings with a NSTableView. It demonstrates how to setup bindings in both... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nstableviewbinding +--- +# NSTableViewBinding NSTableViewBinding is an application that demonstrates how to use Cocoa Bindings with a `NSTableView`. @@ -16,8 +27,7 @@ Of course, to set this flag will mean that these bindings setup in Interface Bui * `NSArrayController` drives the content of several `NSTextFields` based on the controller's selection. * Provides notification of table selection changes through the use of `observeValueForKeyPath`. -Steps for setting the Compiler Directive "USE BINDINGS BY CODE" ---------------------------------------------------------------- +## Steps for setting the Compiler Directive "USE BINDINGS BY CODE" Running example with code binding: @@ -26,8 +36,7 @@ Running example with code binding: 3. Under the category Build -> Compiler look for the field labeled Define Symbols half way down the panel page. 4. Add the symbol "USE BINDINGS BY CODE" -Steps for un-setting the Compiler Directive "USE BINDINGS BY CODE" ------------------------------------------------------------------- +## Steps for un-setting the Compiler Directive "USE BINDINGS BY CODE" Running example without code binding where the bindings are established in Interface Builder: @@ -36,19 +45,18 @@ Running example without code binding where the bindings are established in Inter 3. Under the category Build -> Compiler look for the field labeled Define Symbols half way down the panel page. 4. Make sure the symbol "USE BINDINGS BY CODE" is not in this field. -Instructions ------------- +## Instructions * Use the Add and Remove buttons (small square buttons marked with "+" and "-") to add and remove people from the table. * You can edit each person's info by changing the first, last, and phone text fields. * By double-clicking a row in the table can also alternately edit a given person through the use of a sheet window. -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![NSTableViewBinding application screenshot](Screenshots/0.png "NSTableViewBinding application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/NSTextViewSample/README.md b/NSTextViewSample/README.md index 9d2b785f..dff84cf5 100644 --- a/NSTextViewSample/README.md +++ b/NSTextViewSample/README.md @@ -1,5 +1,16 @@ -NSTextAttachmentCell -==================== +--- +name: Xamarin.Mac - NSTextAttachmentCell +description: This sample demonstrates how to use the default NSTextAttachmentCell with an NSImage and how to subclass NSTextAttachmentCell to perform custom... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: nstextviewsample +--- +# NSTextAttachmentCell This sample demonstrates how to use the default `NSTextAttachmentCell` with an NSImage and how to subclass `NSTextAttachmentCell` to perform custom diff --git a/OpenGL-NeHe/README.md b/OpenGL-NeHe/README.md index 1acc983c..3634f2f0 100644 --- a/OpenGL-NeHe/README.md +++ b/OpenGL-NeHe/README.md @@ -1,5 +1,16 @@ -OpenGL-NeHe -=========== +--- +name: Xamarin.Mac - OpenGL-NeHe +description: 'This directory contains ports of the NeHe OpenGL tutorials from: [Nehe Gamedev] [Nehe Gamedev]:http://nehe.gamedev.net' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: opengl-nehe +--- +# OpenGL-NeHe This directory contains ports of the NeHe OpenGL tutorials from: [Nehe Gamedev] diff --git a/OpenGLLayer/readme.md b/OpenGLLayer/readme.md index 7838661e..96a8e0bb 100644 --- a/OpenGLLayer/readme.md +++ b/OpenGLLayer/readme.md @@ -1,11 +1,21 @@ -OpenGLLayer -=========== +--- +name: Xamarin.Mac - OpenGLLayer +description: 'For a full description of the program you will have to buy the book: [Core Animation for Mac OS X and the iPhone] - Creating Compelling Dynamic...' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: opengllayer +--- +# OpenGLLayer For a full description of the program you will have to buy the book: [Core Animation for Mac OS X and the iPhone] - Creating Compelling Dynamic User Interfaces by Bill Dudney. -Author ------- +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/OpenGLViewSample/Readme.md b/OpenGLViewSample/Readme.md index 8ac95b80..192d01cc 100644 --- a/OpenGLViewSample/Readme.md +++ b/OpenGLViewSample/Readme.md @@ -1,4 +1,15 @@ -OpenGLViewSample -================ +--- +name: Xamarin.Mac - OpenGLViewSample +description: OpenGLView sample for Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: openglviewsample +--- +# OpenGLViewSample OpenGLView sample for Mac. diff --git a/OutlineView/README.md b/OutlineView/README.md index 4f4737af..500f8c02 100644 --- a/OutlineView/README.md +++ b/OutlineView/README.md @@ -1,10 +1,22 @@ -OutlineView -=========== +--- +name: Xamarin.Mac - OutlineView +description: Illustrates how to populate a simple OutlineView using an NSViewOutlineDataSource that in turn, uses an object tree of animal classes. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: outlineview +--- +# OutlineView Illustrates how to populate a simple `OutlineView` using an `NSViewOutlineDataSource` that in turn, uses an object tree of animal classes. -Author ------- +![OutlineView application screenshot](Screenshots/01.png "OutlineView application screenshot") + +## Author Ported to Xamarin.Mac by Bryan Costanich. \ No newline at end of file diff --git a/PopupBindings/README.md b/PopupBindings/README.md index 07d7641c..3de82484 100644 --- a/PopupBindings/README.md +++ b/PopupBindings/README.md @@ -1,5 +1,16 @@ -PopupBindings -============= +--- +name: Xamarin.Mac - PopupBindings +description: PopupBindings is a Xamarin.Mac sample application that demonstrates how to use the bindings to manage the contents and selection of the... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: popupbindings +--- +# PopupBindings "PopupBindings" is a Xamarin.Mac sample application that demonstrates how to use the bindings to manage the contents and selection of the `NSPopupButton` class. It uses the `NSArrayController` class to hold the data and track the selection. @@ -29,12 +40,12 @@ All four Form Cells describing the person's address is bound to the array contro Controller Key: selection Model Key Path: addressStreet -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![PopupBindings application screenshot](Screenshots/0.png "PopupBindings application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/PredicateEditorSample/README.md b/PredicateEditorSample/README.md index a96851bd..8e059706 100644 --- a/PredicateEditorSample/README.md +++ b/PredicateEditorSample/README.md @@ -1,5 +1,16 @@ -PredicateEditorSample -===================== +--- +name: Xamarin.Mac - PredicateEditorSample +description: PredicateEditorSample is a Xamarin.Mac sample application that shows how to use the NSPredicateEditor. The NSPredicateEditor class is a subclass of... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: predicateeditorsample +--- +# PredicateEditorSample "PredicateEditorSample" is a Xamarin.Mac sample application that shows how to use the `NSPredicateEditor`. @@ -11,8 +22,7 @@ It shows how to: * Build Spotlight friendly queries based on `NSPredicate` and `NSCompountPredicate`. * Build search results based on `NSMetadataQuery` object. -Instructions ------------- +## Instructions Simply build and run the sample using MonoDevelop with the Xamarin.Mac plugin. Enter query information pertaining to your Address Book. The application will display matches in its table view. @@ -29,12 +39,12 @@ address book data only. Together along with the other predicates from the `NSPre // and send it off for processing... query.StartQuery(); -Copyright --------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![PredicateEditorSample application screenshot](Screenshots/0.png "PredicateEditorSample application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/ProgressBarExample/Readme.md b/ProgressBarExample/Readme.md index 8b91ea00..fa88dc58 100644 --- a/ProgressBarExample/Readme.md +++ b/ProgressBarExample/Readme.md @@ -1,4 +1,15 @@ -ProgressBarExample -================== +--- +name: Xamarin.Mac - ProgressBarExample +description: This project covers working with Timers and a Progress Bars (NSProgressIndicator) in a Xamarin.Mac application. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: progressbarexample +--- +# ProgressBarExample This project covers working with Timers and a Progress Bars (`NSProgressIndicator`) in a Xamarin.Mac application. \ No newline at end of file diff --git a/QTRecorder/README.md b/QTRecorder/README.md index 4c4f9702..4c4850ac 100644 --- a/QTRecorder/README.md +++ b/QTRecorder/README.md @@ -1,5 +1,16 @@ -QTRecorder -========== +--- +name: Xamarin.Mac - QTRecorder +description: 'This applications shows how to use various QuickTime features: Capture video. Display a live video feed. Play the newly created video in the UI....' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: qtrecorder +--- +# QTRecorder This applications shows how to use various QuickTime features: @@ -8,10 +19,7 @@ This applications shows how to use various QuickTime features: * Play the newly created video in the UI. * Apply CoreImage effects to the video source. * Use Cocoa drawers. -* Use Cocoa Key/Value bindings to the UI and a document-based interface. - - ---- +## * Use Cocoa Key/Value bindings to the UI and a document-based interface. ###### Attention diff --git a/ReactiveUIExample/Readme.md b/ReactiveUIExample/Readme.md index b9b353fc..f446dc64 100644 --- a/ReactiveUIExample/Readme.md +++ b/ReactiveUIExample/Readme.md @@ -1,5 +1,16 @@ -ReactiveUIExample -================= +--- +name: Xamarin.Mac - ReactiveUIExample +description: ReactiveUI Use the Reactive Extensions for .NET to create elegant, testable User Interfaces that run on any mobile or desktop platform. Supports... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: reactiveuiexample +--- +# ReactiveUIExample ## [ReactiveUI](http://reactiveui.net) Use the [Reactive Extensions](https://rx.codeplex.com/) for .NET to create elegant, testable User Interfaces that run on any mobile or desktop platform. Supports Xamarin.iOS, Xamarin.Android, Xamarin.Mac, WPF, Windows Forms, Windows Phone 8 and Windows Store apps. diff --git a/RoundedTransparentWindow/README.md b/RoundedTransparentWindow/README.md index fc474627..bd39332a 100644 --- a/RoundedTransparentWindow/README.md +++ b/RoundedTransparentWindow/README.md @@ -1,5 +1,16 @@ -RoundedDisplayWindow Sample -=========================== +--- +name: Xamarin.Mac - RoundedDisplayWindow Sample +description: 'The [original sample] was slightly updated to avoid using deprecated APIs. There are the two classes needed: CustomWindow - Configures the Window....' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: roundedtransparentwindow +--- +# RoundedDisplayWindow Sample The [original sample] was slightly updated to avoid using deprecated APIs. diff --git a/Rulers/README.md b/Rulers/README.md index 22138f2d..c49fd492 100644 --- a/Rulers/README.md +++ b/Rulers/README.md @@ -1,5 +1,16 @@ -Rulers -====== +--- +name: Xamarin.Mac - Rulers +description: This project demonstrates many of the interactions between an NSRulerView and its client view. It should give you an idea how to go about this when... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: rulers +--- +# Rulers This project demonstrates many of the interactions between an `NSRulerView` and its client view. It should give you an idea how to go about this when creating a view subclass that really does something. @@ -9,8 +20,7 @@ The RectsView puts markers in the horizontal and vertical rulers showing the pla `RectsView.m` defines a lot of methods, but these are the ones primarily related to working with `NSRulerViews`: -Methods Description -------------------- +## Methods Description * `rulerView: shouldMoveMarker:` - Denies move if no selection or if selection is locked. * `rulerView: willMoveMarker:` toLocation: - Limits minimum rectangle size and updates display; try changing this to snap markers to whole units. diff --git a/SCNetworkReachability/README.md b/SCNetworkReachability/README.md index 3ca1d3f2..9a007355 100644 --- a/SCNetworkReachability/README.md +++ b/SCNetworkReachability/README.md @@ -1,5 +1,16 @@ -SCNetworkReachability -===================== +--- +name: Xamarin.Mac - SCNetworkReachability +description: The NetworkReachability programming interface allows an application to determine the status of a system's current network configuration and the... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: scnetworkreachability +--- +# SCNetworkReachability The `NetworkReachability` programming interface allows an application to determine the status of a system's current network configuration and the reachability of a target host. A remote host is considered reachable when a data packet, sent by an application into the network stack, can leave the local device. Reachability does not guarantee that the data packet will actually be received by the host. diff --git a/SceneKitViewer/README.md b/SceneKitViewer/README.md index 1ebda538..1cc5e714 100644 --- a/SceneKitViewer/README.md +++ b/SceneKitViewer/README.md @@ -1,20 +1,28 @@ -SceneKitViewer -============== +--- +name: Xamarin.Mac - SceneKitViewer +description: Demonstrates how to use Scene Kit to load and play a 3D scene with animations. It also shows how to pick objects and change their materials. Build... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: scenekitviewer +--- +# SceneKitViewer Demonstrates how to use Scene Kit to load and play a 3D scene with animations. It also shows how to pick objects and change their materials. -Build Requirements -------- +## Build Requirements Xcode 4.4 or later, OS X v10.8 or later -Refs -------- +## Refs - [Original sample](https://developer.apple.com/library/content/samplecode/SceneKitDocumentViewer/Introduction/Intro.html#//apple_ref/doc/uid/DTS40012309) - [Documentation](https://developer.apple.com/scenekit/) -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license \ No newline at end of file diff --git a/SearchField/README.md b/SearchField/README.md index ed9c8b1a..73be7cba 100644 --- a/SearchField/README.md +++ b/SearchField/README.md @@ -1,12 +1,22 @@ -SearchField -================== +--- +name: Xamarin.Mac - SearchField +description: SearchField is a Xamarin.Mac sample application that shows how to use a special text control called NSSearchField. This is the control that is used... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: searchfield +--- +# SearchField SearchField is a Xamarin.Mac sample application that shows how to use a special text control called `NSSearchField`. This is the control that is used in the popular Apple applications like Safari, iTunes, Mail, etc. -Summary -------- +## Summary An `NSSearchField` object implements a text field control that is optimized for performing text-based searches. The control provides a customized text field for entering search data, a search button, a cancel button, @@ -21,8 +31,7 @@ This sample shows you how to override the text-based searching by providing your With regards to the popup icon to show the recents menu listing recent search strings, this sample shows how to further customize this menu by building the menu completely from scratch. You can do this using InterfaceBuilder, but the code gives you a better illustration. -Keyword Searching ------------------ +## Keyword Searching Basically we want to override the `NSSearchField` type completion feature by providing our own list of keywords to match. Therefore its up to us to call the `NSTextView Complete()` method at the right time. @@ -30,17 +39,16 @@ Therefore its up to us to call the `NSTextView Complete()` method at the right t Each time a character is typed, a lookup occurs every time the Changed delegate is called. If you don't want the drop down list to show on each character typed, then you need to call `Complete()` less frequently. Each lookup forces the drop down list to update itself causing the menu to disappear and reappear again with the new matches. So calling `Complete()` from within the Changed delegate can flood the run loop by repeatedly generating "Changed" calls. So we need to be a little smarter not to post Complete() when it's not necessary. -Enhancements ------------- +## Enhancements Hence, by implementing the `GetCompletions` delegate you now have complete control on the contents on which text-based searching is based. -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![SearchField application screenshot](Screenshots/0.png "SearchField application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/SkinnableApp/Readme.md b/SkinnableApp/Readme.md index 6c442847..c78a7f5e 100644 --- a/SkinnableApp/Readme.md +++ b/SkinnableApp/Readme.md @@ -1,4 +1,15 @@ -SkinnableApp -============ +--- +name: Xamarin.Mac - SkinnableApp +description: Skinnable App sample for Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: skinnableapp +--- +# SkinnableApp Skinnable App sample for Mac. diff --git a/SourceWriter/Readme.md b/SourceWriter/Readme.md index 79067908..94d2bd6f 100644 --- a/SourceWriter/Readme.md +++ b/SourceWriter/Readme.md @@ -1,5 +1,16 @@ -SourceWriter -============ +--- +name: Xamarin.Mac - SourceWriter +description: The SourceWriter Xamarin.Mac app is a simple source code editor that provides support for code completion and simple syntax highlighting. It is... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: sourcewriter +--- +# SourceWriter The SourceWriter Xamarin.Mac app is a simple source code editor that provides support for code completion and simple syntax highlighting. It is presented as an example of a complete Xamarin.Mac app that includes many of the features a user would expect to find in a typical Mac application. diff --git a/StillMotion/README.md b/StillMotion/README.md index 64b0f153..fbe40cbd 100644 --- a/StillMotion/README.md +++ b/StillMotion/README.md @@ -1,4 +1,15 @@ -StillMotion -=========== +--- +name: Xamarin.Mac - StillMotion +description: This sample shows how to capture live video from the system camera, and recording individual frames to create a new movie file that can then be... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: stillmotion +--- +# StillMotion This sample shows how to capture live video from the system camera, and recording individual frames to create a new movie file that can then be played back. diff --git a/UseMSBuildToCopyFilesToBundleExample/Readme.md b/UseMSBuildToCopyFilesToBundleExample/Readme.md index 6af78855..722e4792 100644 --- a/UseMSBuildToCopyFilesToBundleExample/Readme.md +++ b/UseMSBuildToCopyFilesToBundleExample/Readme.md @@ -1,5 +1,16 @@ -UseMSBuildToCopyFilesToBundleExample -========== +--- +name: Xamarin.Mac - UseMSBuildToCopyFilesToBundleExample +description: This sample shows you how to extend your build with msbuild to copy arbitrary files into your bundle. This is better the custom commands in your... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: usemsbuildtocopyfilestobundleexample +--- +# UseMSBuildToCopyFilesToBundleExample This sample shows you how to extend your build with msbuild to copy arbitrary files into your bundle. diff --git a/UserNotificationExample/Readme.md b/UserNotificationExample/Readme.md index ae79a40c..8c3c03ab 100644 --- a/UserNotificationExample/Readme.md +++ b/UserNotificationExample/Readme.md @@ -1,4 +1,15 @@ -UserNotificationExample -======================= +--- +name: Xamarin.Mac - UserNotificationExample +description: User notification example for Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: usernotificationexample +--- +# UserNotificationExample User notification example for Mac. diff --git a/VillainTracker/Readme.md b/VillainTracker/Readme.md index 3f69760b..a22a5cfe 100644 --- a/VillainTracker/Readme.md +++ b/VillainTracker/Readme.md @@ -1,4 +1,15 @@ -VillainTracker -============== +--- +name: Xamarin.Mac - VillainTracker +description: Villain tracker for Mac. +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: villaintracker +--- +# VillainTracker Villain tracker for Mac. diff --git a/WhereIsMyMac/README.md b/WhereIsMyMac/README.md index bb3bdde5..6f38330c 100644 --- a/WhereIsMyMac/README.md +++ b/WhereIsMyMac/README.md @@ -1,13 +1,25 @@ -WhereIsMyMac -============ +--- +name: Xamarin.Mac - WhereIsMyMac +description: 'Shows the use of the CoreLocation API. For a full description of the program and the original article point your browser here: [WhereIsMyMac]' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: whereismymac +--- +# WhereIsMyMac Shows the use of the CoreLocation API. For a full description of the program and the original article point your browser here: [WhereIsMyMac] -Author ------- +![WhereIsMyMac application screenshot](Screenshots/0.png "WhereIsMyMac application screenshot") + +## Author Ported to Xamarin.Mac by Kenneth J. Pouncey. diff --git a/XMBindingExample/Readme.md b/XMBindingExample/Readme.md index 50f1165e..280c02ab 100644 --- a/XMBindingExample/Readme.md +++ b/XMBindingExample/Readme.md @@ -1,5 +1,16 @@ -XMBindingExample -================ +--- +name: Xamarin.Mac - XMBindingExample +description: This example uses a Xamarin.Mac binding project to bind a simple Objective-C library. The native library is built in CustomBuildActions.targets as... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: xmbindingexample +--- +# XMBindingExample This example uses a Xamarin.Mac binding project to bind a simple Objective-C library. diff --git a/XMLocalizationSample/README.md b/XMLocalizationSample/README.md index a117096a..8000d412 100644 --- a/XMLocalizationSample/README.md +++ b/XMLocalizationSample/README.md @@ -1,5 +1,16 @@ -XMLocalizationSample -============== +--- +name: Xamarin.Mac - XMLocalizationSample +description: 'This sample shows two methods for localization your Xamarin.Mac application: - .resx files - Storyboard string files. Due to bug...' +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: xmlocalizationsample +--- +# XMLocalizationSample This sample shows two methods for localization your Xamarin.Mac application: - .resx files @@ -31,21 +42,19 @@ To add storyboard localization in Xcode:

- Close Xcode and delete Main.storyboard from your project, as it now is copied into specific Resources/ folder. -Build Requirements ------------------- +## Build Requirements OS X 10.11, Xcode 8.0 or later -Runtime ------------------- +## Runtime OS X 10.11 -Copyright ---------- +## Copyright Released under the MIT license -Author ------- +![XMLocalizationSample application screenshot](Screenshots/1.png "XMLocalizationSample application screenshot") + +## Author Chris Hamons diff --git a/guiunit-example/Readme.md b/guiunit-example/Readme.md index a7cff9d4..7ecc4d75 100644 --- a/guiunit-example/Readme.md +++ b/guiunit-example/Readme.md @@ -1,5 +1,16 @@ -GUIUnit Example -=============== +--- +name: Xamarin.Mac - GUIUnit Example +description: This is a quick example showing how to package up a nunit test that requires Xamarin.Mac into a bundle and invoke it using GUIUnit. About GUIUnit... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: guiunit-example +--- +# GUIUnit Example This is a quick example showing how to package up a `nunit` test that requires Xamarin.Mac into a bundle and invoke it using [GUIUnit](https://github.com/mono/guiunit). diff --git a/yosemite/Bananas/README.md b/yosemite/Bananas/README.md index 19a13f29..75956169 100644 --- a/yosemite/Bananas/README.md +++ b/yosemite/Bananas/README.md @@ -1,24 +1,33 @@ -Bananas -======== +--- +name: Xamarin.Mac - Bananas +description: This sample shows how to build a basic game using Scene Kit, demonstrating physics, rendering techniques, lighting, actions and animation. Build... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-bananas +--- +# Bananas This sample shows how to build a basic game using Scene Kit, demonstrating physics, rendering techniques, lighting, actions and animation. -Build Requirements ------------------- +## Build Requirements OS X 10.10, Xcode 6.0 or later -Runtime ------------------- +## Runtime OS X 10.10 -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![Bananas application screenshot](Screenshots/1.png "Bananas application screenshot") + +## Author Ported to Xamarin.Mac by Oleg Demchenko diff --git a/yosemite/Earthquakes/README.md b/yosemite/Earthquakes/README.md index d91a6f4d..f543f568 100644 --- a/yosemite/Earthquakes/README.md +++ b/yosemite/Earthquakes/README.md @@ -1,5 +1,16 @@ -Earthquakes -=========== +--- +name: Xamarin.Mac - Earthquakes +description: Most applications that use Core Data employ a single persistent store coordinator to mediate access to a given persistent store. Earthquakes shows... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-earthquakes +--- +# Earthquakes Most applications that use Core Data employ a single persistent store coordinator to mediate access to a given persistent store. Earthquakes shows how to use an additional "private" persistent store coordinator when creating managed objects using data retrieved from a remote server. @@ -9,21 +20,19 @@ The main persistent store coordinator is vended by a singleton "stack controller Current version of Xamarin Studio have no support for xcdatamodeld. If you want to use them in your applications use Xcode to create data model files and momc utility to compile xcdatamodeld to mom. Read Apple's doc for more info: https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CoreData/Articles/cdUsingMOM.html -Build Requirements ------------------- +## Build Requirements OS X 10.10, Xcode 6.0 or later -Runtime ------------------- +## Runtime OS X 10.10 -Copyright --------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![Earthquakes application screenshot](Screenshots/1.png "Earthquakes application screenshot") + +## Author Ported to Xamarin.Mac by Oleg Demchenko diff --git a/yosemite/FileCards/README.md b/yosemite/FileCards/README.md index 55771902..80e82aaf 100644 --- a/yosemite/FileCards/README.md +++ b/yosemite/FileCards/README.md @@ -1,5 +1,16 @@ -FileCards -============== +--- +name: Xamarin.Mac - FileCards +description: Demonstrates the use of NSPageController. App are displayed for the contents of the user's Documents folder. You can swipe, click the arrow buttons... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-filecards +--- +# FileCards Demonstrates the use of `NSPageController`. App are displayed for the contents of the user's `Documents` folder. @@ -17,18 +28,17 @@ Simple wrapper around NSUrl to make binding to file properties in IB easier. `CardBackgroundView`: Draws the rounded edge background of the file cards. -Build Requirements ------------------- +## Build Requirements Xcode 6.0, OS X 10.10 -Runtime Requirements --------------------- +## Runtime Requirements OS X 10.8 or later -Author ------- +![FileCards application screenshot](Screenshots/Screen.png "FileCards application screenshot") + +## Author Copyright (C) 2014 Apple Inc. All rights reserved. Ported to Xamarin.Mac by Rustam Zaitov \ No newline at end of file diff --git a/yosemite/SceneKitSessionWWDC2013/README.md b/yosemite/SceneKitSessionWWDC2013/README.md index 50531302..2df6b2d0 100644 --- a/yosemite/SceneKitSessionWWDC2013/README.md +++ b/yosemite/SceneKitSessionWWDC2013/README.md @@ -1,26 +1,35 @@ -Scene Kit Session WWDC 2013 -=========================== +--- +name: Xamarin.Mac - Scene Kit Session WWDC 2013 +description: This application render a 3D environment and presents a series of slides with Scene Kit objects. Each slide presents a different feature of Scene... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-scenekitsessionwwdc2013 +--- +# Scene Kit Session WWDC 2013 This application render a 3D environment and presents a series of slides with Scene Kit objects. Each slide presents a different feature of Scene Kit. The code for each example is in a separate file and is independent from the other slides. -Instructions ------------- +## Instructions * To navigate between the slides you can use the left and right arrows. * You can access all the slides from the Go menu item. -Build Requirements ------------------- +## Build Requirements * Xcode 5.0 and OS X v10.9 or later. * Xamarin.Mac v1.11.3 or later. -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![Scene Kit Session WWDC 2013 application screenshot](Screenshots/0.png "Scene Kit Session WWDC 2013 application screenshot") + +## Author Ported to Xamarin.Mac by Vincent Dondain. diff --git a/yosemite/SceneKitSessionWWDC2014/README.md b/yosemite/SceneKitSessionWWDC2014/README.md index c588014c..40f6d9ff 100644 --- a/yosemite/SceneKitSessionWWDC2014/README.md +++ b/yosemite/SceneKitSessionWWDC2014/README.md @@ -1,22 +1,32 @@ -Scene Kit Session WWDC 2014 -=========================== +--- +name: Xamarin.Mac - Scene Kit Session WWDC 2014 +description: This application render a 3D environment and presents a series of slides with Scene Kit objects. Each slide presents a different feature of Scene... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-scenekitsessionwwdc2014 +--- +# Scene Kit Session WWDC 2014 This application render a 3D environment and presents a series of slides with Scene Kit objects. Each slide presents a different feature of Scene Kit. The code for each example is in a separate file and is independent from the other slides. -Instructions ------------- +## Instructions * To navigate between the slides you can use the left and right arrows. * You can access all the slides from the Go menu item. -Build Requirements ------------------- +## Build Requirements * Xcode 6.0 and OS X v10.10. * Xamarin.Mac v1.11.3 or later. -Author ------- +![Scene Kit Session WWDC 2014 application screenshot](Screenshots/0.png "Scene Kit Session WWDC 2014 application screenshot") + +## Author Copyright (C) 2014 Apple Inc. All rights reserved. Ported to Xamarin.Mac by Vincent Dondain. diff --git a/yosemite/VisualEffectPlayground/README.md b/yosemite/VisualEffectPlayground/README.md index 7f9ad6ef..6eb87d63 100644 --- a/yosemite/VisualEffectPlayground/README.md +++ b/yosemite/VisualEffectPlayground/README.md @@ -1,23 +1,32 @@ -Blurs, translucency and vibrancy on OS X -=========== +--- +name: Xamarin.Mac - Blurs, translucency and vibrancy on OS X +description: This sample shows how to use various options of NSVisualEffectView to do blurs, translucency and vibrancy on OS X. It demonstrates in window... +page_type: sample +languages: +- csharp +products: +- xamarin +technologies: +- xamarin-mac +urlFragment: yosemite-visualeffectplayground +--- +# Blurs, translucency and vibrancy on OS X This sample shows how to use various options of NSVisualEffectView to do blurs, translucency and vibrancy on OS X. It demonstrates in window blending, behind window blending, creating masks, using state, and custom vibrant controls. -Build Requirements ------------------- +## Build Requirements OS X 10.10, Xcode 6.0 or later -Runtime ------------------- +## Runtime OS X 10.10 -Copyright ---------- +## Copyright Xamarin port changes are released under the MIT license -Author ------- +![Blurs, translucency and vibrancy on OS X application screenshot](Screenshots/1.png "Blurs, translucency and vibrancy on OS X application screenshot") + +## Author Ported to Xamarin.Mac by Oleg Demchenko From 0d14a89afccc66386d6896871cda713eb32e4c4f Mon Sep 17 00:00:00 2001 From: Justin Johnson Date: Thu, 18 Jul 2019 17:36:22 -0600 Subject: [PATCH 2/2] Fixes to parser errors --- AzureTodoMac/Readme.md | 6 +++--- MacCopyPaste/Readme.md | 5 +++-- NSPortExample/Readme.md | 6 +++--- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/AzureTodoMac/Readme.md b/AzureTodoMac/Readme.md index 85b89860..2ee8dead 100644 --- a/AzureTodoMac/Readme.md +++ b/AzureTodoMac/Readme.md @@ -14,10 +14,10 @@ urlFragment: azuretodomac This sample covers using Azure Cloud Data in a Xamarin.Mac application by creating a simple ToDo list application. -## UPDATE: the most recent (Nov-16) version of the [Azure Mobile Client NuGet](https://www.nuget.org/packages/Microsoft.Azure.Mobile.Client/) doesn't explicitly support the Xamarin.Mac platform, so the NET45 assemblies have been referenced directly in this sample. +UPDATE: the most recent (Nov-16) version of the [Azure Mobile Client NuGet](https://www.nuget.org/packages/Microsoft.Azure.Mobile.Client/) doesn't explicitly support the Xamarin.Mac platform, so the NET45 assemblies have been referenced directly in this sample. **NOTE:** You'll need to edit the `Constants` class and provide your Azure Developer Credentials by setting the `ApplicationURL` values _before_ this sample can be successfully run. -## The table configured in Azure should also have the same columns as the `TodoItem` class: `id`, `text`, `notes`, `complete`. +The table configured in Azure should also have the same columns as the `TodoItem` class: `id`, `text`, `notes`, `complete`. -![](Screenshots/01.png) \ No newline at end of file +![AzureToDoMac sample screenshot](Screenshots/01.png) diff --git a/MacCopyPaste/Readme.md b/MacCopyPaste/Readme.md index 47c0dcd9..ad45b788 100644 --- a/MacCopyPaste/Readme.md +++ b/MacCopyPaste/Readme.md @@ -12,5 +12,6 @@ urlFragment: maccopypaste --- # MacCopyPaste -## This sample covers working with the Pasteboard (`NSPasteboard`) to provide **Cut**, **Copy** and **Paste** operationsin a Xamarin.Mac application. It shows how to work with standard data types that can be shared between multiple apps and how to support custom data within a give app. -## **Note:** This sample currently contains a workaround to [Bugzilla Defect #31760](https://bugzilla.xamarin.com/show_bug.cgi?id=31760). When the version of Xamarin.Mac is released that fixes this issue, this sample will be updated to the correct version. The correct source code has been included as a reference. \ No newline at end of file +This sample covers working with the Pasteboard (`NSPasteboard`) to provide **Cut**, **Copy** and **Paste** operationsin a Xamarin.Mac application. It shows how to work with standard data types that can be shared between multiple apps and how to support custom data within a give app. + +**Note:** This sample currently contains a workaround to [Bugzilla Defect #31760](https://bugzilla.xamarin.com/show_bug.cgi?id=31760). When the version of Xamarin.Mac is released that fixes this issue, this sample will be updated to the correct version. The correct source code has been included as a reference. diff --git a/NSPortExample/Readme.md b/NSPortExample/Readme.md index d057fb89..9cbb1449 100644 --- a/NSPortExample/Readme.md +++ b/NSPortExample/Readme.md @@ -14,13 +14,13 @@ urlFragment: nsportexample The following is an example showing use of `NSMessagePort` & `CFMessagePort` to send information cross process, between applications. In the case of this example, from a Xamarin.Mac C# program to a running Objective-C program. -## The example is based off the [Inter-Process Communication](http://nshipster.com/inter-process-communication/) article by Mattt Thompson. +The example is based off the [Inter-Process Communication](http://nshipster.com/inter-process-communication/) article by Mattt Thompson. -## **Note:** There are a few binding that are used in the article that are not currently available in Xamarin.Mac. These are being tracked by this [Bugzilla](https://bugzilla.xamarin.com/show_bug.cgi?id=30815) defect. +**Note:** There are a few binding that are used in the article that are not currently available in Xamarin.Mac. These are being tracked by this [Bugzilla](https://bugzilla.xamarin.com/show_bug.cgi?id=30815) defect. ## Running this Example -Follow these instructions to run this sample: +Follow these instructions to run this sample: 1. Build and launch MessageReceiver first (via XCode) 2. Build and launch MessageSender (via Xamarin Studio)