Skip to content

Commit

Permalink
Batch update to improve readme descriptions (xamarin#486)
Browse files Browse the repository at this point in the history
* Batch update to improve readme descriptions

* Another pass to strip markdown images in the description

* Stripped everything after sentences starting with "For more info"
  • Loading branch information
profexorgeek authored and conceptdev committed Jul 11, 2019
1 parent 16d1c3c commit 99d864d
Show file tree
Hide file tree
Showing 172 changed files with 173 additions and 173 deletions.
2 changes: 1 addition & 1 deletion Advanced/DependencyResolution/DIContainerDemo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Dependency Resolution (Container)
description: This sample demonstrates how to inject a dependency resolution method into Xamarin.Forms, so that an app's dependency injection container has contr...
description: This sample demonstrates how to inject a dependency resolution method into Xamarin.Forms, so that an app's dependency injection container has control over the construction and lifetime of custom renderers, effects, and DependencyService implementations.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Advanced/DependencyResolution/FactoriesDemo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Dependency Resolution (Factory Methods)
description: This sample demonstrates how to inject a dependency resolution method into Xamarin.Forms, so that custom renderers, effects, and DependencyService ...
description: This sample demonstrates how to inject a dependency resolution method into Xamarin.Forms, so that custom renderers, effects, and DependencyService implementations are created using factory methods.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Behaviors/AttachedNumericValidationBehavior/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Attached Behaviors
description: A behavior that's attached to a control through attached properties is known as an attached behavior. This sample demonstrates creating and consumi...
description: A behavior that's attached to a control through attached properties is known as an attached behavior. This sample demonstrates creating and consuming an attached behavior.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Behaviors/EffectBehavior/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Effect Behavior
description: Behaviors are a useful approach for adding an effect to a control, removing boiler-plate effect handling code from code-behind files. This sample d...
description: Behaviors are a useful approach for adding an effect to a control, removing boiler-plate effect handling code from code-behind files. This sample demonstrates using a behavior to add an effect to a control.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Behaviors/EventToCommandBehavior/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Event to Command Behavior
description: In the context of commanding, behaviors are a useful approach for connecting a control to a command. In addition, they can also be used to associat...
description: In the context of commanding, behaviors are a useful approach for connecting a control to a command. In addition, they can also be used to associate commands with controls that were not designed to interact with commands. This sample demonstrates using a behavior to invoke a command when an event fires.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Behaviors/NumericValidationBehavior/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: NumericValidation Behavior
description: Xamarin.Forms behaviors are created in a class that derives from the Behavior, or Behavior<T> class. This sample demonstrates how to create a...
description: Xamarin.Forms behaviors are created in a class that derives from the Behavior, or Behavior<T> class. This sample demonstrates how to create and consume a Xamarin.Forms behavior.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Behaviors/NumericValidationBehaviorStyle/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: NumericValidation Behavior with Style
description: Xamarin.Forms behaviors can be consumed by an explicit or implicit style. This sample demonstrates how to consume a Xamarin.Forms behavior with an ...
description: Xamarin.Forms behaviors can be consumed by an explicit or implicit style. This sample demonstrates how to consume a Xamarin.Forms behavior with an explicit style.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/BasicBoxView/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Basic BoxView
description: Just a `BoxView` on the page, demonstrating the `Color`, `WidthRequest`, and `HeightRequest` properties. This sample is described in more detail i...
description: Just a BoxView on the page, demonstrating the Color, WidthRequest, and HeightRequest properties. This sample is described in more detail in the article on BoxView.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/BoxViewClock/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: BoxView Clock
description: A classic analog clock realized entirely with `BoxView`. Although Xamarin.Forms doesn't have a vector graphics programming interface, it does hav...
description: A classic analog clock realized entirely with BoxView. Although Xamarin.Forms doesn't have a vector graphics programming interface, it does have a BoxView. Although normally used for displaying rectangular blocks of color, BoxView can be sized, positioned, and rotated. This is enough to render a classic analog clock. This sample is described in more detail in the article on BoxView.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/DotMatrixClock/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Dot-Matrix Clock
description: The `BoxView` element is ideal for creating a simulation of a dot-matrix digital display. This sample is described in more detail in the article o...
description: The BoxView element is ideal for creating a simulation of a dot-matrix digital display. This sample is described in more detail in the article on BoxView.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/GameOfLife/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Game of Life
description: This is an implementation of the Game of Life for Xamarin.Forms. Life is a cellular automaton invented by mathematician John Conway in 1970 and po...
description: This is an implementation of the Game of Life for Xamarin.Forms. Life is a cellular automaton invented by mathematician John Conway in 1970 and popularized in Scientfic American. Tap cells to make them alive A clustered population of live cells works the best. Then press the Run! button. Rules are applied to the live cells to generate successive populations. A population might grow, or shrink, or stagnate, or disappear.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/ListViewColors/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ListView Colors
description: A `ListView` displaying the system colors, each of which is illustrated with a `BoxView`. This sample is described in more detail in the article o...
description: A ListView displaying the system colors, each of which is illustrated with a BoxView. This sample is described in more detail in the article on BoxView.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BoxView/TextDecoration/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Text Decoration
description: One simple application of the `BoxView` element is for adorning text with horizontal and vertical lines. This sample is described in more detail i...
description: One simple application of the BoxView element is for adorning text with horizontal and vertical lines. This sample is described in more detail in the article on BoxView.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion BugSweeper/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: BugSweeper
description: This is a familiar game with a new twist. Ten bugs are hidden in a 9-by-9 grid of tiles. To win, you must find and flag all ten bugs. Begin playin...
description: This is a familiar game with a new twist. Ten bugs are hidden in a 9-by-9 grid of tiles. To win, you must find and flag all ten bugs. Begin playing by double tapping any tile. That first double tap is always safe. Thereafter, numbers indicate the number of surrounding tiles with bugs. If you know that a tile has a bug, flag it (or unflag it) with a single tap. Avoid double-tapping a tile with a bug!
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CatClock/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Cat Clock
description: Cat Clock is a Xamarin.Forms application that demonstrates various features of SkiaSharp graphics. It runs on iOS, Android, and Universal Windows P...
description: Cat Clock is a Xamarin.Forms application that demonstrates various features of SkiaSharp graphics. It runs on iOS, Android, and Universal Windows Platform devices. This program was the focus of a webinar. To see the program built from the ground up, watch the video SkiaSharp Graphics for Xamarin Forms.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion ClassHierarchy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ClassHierarchy
description: This program uses .NET reflection to display a scrollable hierarchy of all Xamarin.Forms classes, structures, and enumerations. Non-instantiable cl...
description: This program uses .NET reflection to display a scrollable hierarchy of all Xamarin.Forms classes, structures, and enumerations. Non-instantiable classes are displayed in the system accent color. ClassHierarchy is a handy reference for Xamarin.Forms developers, as well as demonstrating using the StackLayout and ScrollView from code.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CocosSharpForms/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: CocosSharp and Xamarin Forms
description: This solution contains an iOS and Android project which combines CocosSharp with Xamarin Forms. All code (aside from initial template code) is cont...
description: This solution contains an iOS and Android project which combines CocosSharp with Xamarin Forms. All code (aside from initial template code) is contained in a .NET Standard Library. This demo is built against CocosSharp 1.7.1
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/ContentPage/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ContentPage Custom Renderer
description: This sample demonstrates a custom renderer for a `ContentPage`, enabling developers to override the default native rendering with their own platfor...
description: This sample demonstrates a custom renderer for a ContentPage, enabling developers to override the default native rendering with their own platform-specific customization.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/Entry/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Entry Custom Renderer
description: This sample demonstrates a custom renderer for the `Entry` control, enabling developers to override the default native rendering with their own pla...
description: This sample demonstrates a custom renderer for the Entry control, enabling developers to override the default native rendering with their own platform-specific customization.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/HybridWebView/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: HybridWebView Custom Renderer
description: This sample demonstrates a custom renderer for a `HybridWebView` custom control, that demonstrates how to enhance the platform-specific web control...
description: This sample demonstrates a custom renderer for a HybridWebView custom control, that demonstrates how to enhance the platform-specific web controls to allow C code to be invoked from JavaScript.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/ListView/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ListView Custom Renderer
description: This sample demonstrates a custom renderer that encapsulates platform-specific list controls and native cell layouts. For more information about ...
description: This sample demonstrates a custom renderer that encapsulates platform-specific list controls and native cell layouts.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/Map/Circle/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Circle Map Overlay
description: This sample demonstrates how to add a circular overlay to a map in order to highlight a circular area of the map. For more information about this ...
description: This sample demonstrates how to add a circular overlay to a map in order to highlight a circular area of the map.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/Map/Pin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Map Custom Renderer
description: This sample demonstrates how to create a custom renderer for the `Map` control, which displays a native map with a customized pin and a customized ...
description: This sample demonstrates how to create a custom renderer for the Map control, which displays a native map with a customized pin and a customized view of the pin data on each platform.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/Map/Polygon/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Polygon Map Overlay
description: This sample demonstrates how to add a polygon overlay to a map in order to highlight a region on the map. Polygons are a closed shape and have thei...
description: This sample demonstrates how to add a polygon overlay to a map in order to highlight a region on the map. Polygons are a closed shape and have their interiors filled in.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/Map/Polyline/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Polyline Map Overlay
description: This sample demonstrates how to add a polyline overlay to a map. A polyline overlay is a series of connected line segments that are typically used ...
description: This sample demonstrates how to add a polyline overlay to a map. A polyline overlay is a series of connected line segments that are typically used to show a route on a map, or form any shape that's required.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/VideoPlayerDemos/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Video Player Demos
description: This sample demonstrates renderers for a `VideoPlayer` custom control. For more information about this sample see [Implementing a Video Player](ht...
description: This sample demonstrates renderers for a VideoPlayer custom control.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/View/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: View Custom Renderer
description: This sample demonstrates a custom renderer for a Xamarin.Forms custom control that's used to display a preview video stream from the device's camer...
description: This sample demonstrates a custom renderer for a Xamarin.Forms custom control that's used to display a preview video stream from the device's camera.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion CustomRenderers/ViewCell/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ViewCell Custom Renderer
description: This sample demonstrates a custom renderer for a `ViewCell` that's hosted inside a Xamarin.Forms `ListView` control, enabling developers to overrid...
description: This sample demonstrates a custom renderer for a ViewCell that's hosted inside a Xamarin.Forms ListView control, enabling developers to override the default native rendering with their own platform-specific customization.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion DataBindingDemos/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Data Binding Demos
description: This sample demonstrates data binding in both code and XAML. For more information about this code, see the article [Data Binding](https://develope...
description: This sample demonstrates data binding in both code and XAML.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion DeepLinking/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Deep Linking
description: Application indexing allows applications that would otherwise be forgotten after a few uses to stay relevant by appearing in search results. Deep l...
description: 'Application indexing allows applications that would otherwise be forgotten after a few uses to stay relevant by appearing in search results. Deep linking allows applications to respond to a search result that contains application data, typically by navigating to a page referenced from a deep link. This sample demonstrates how to use application indexing and deep linking to make Xamarin.Forms application content searchable on iOS and Android devices. Note: to use this sample on Android, you must add your google-services.json (downloaded from the Firebase console) file to the Android project, and set the build action to GoogleServicesJson.'
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion DependencyService/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Dependency Service
description: This sample demonstrates how to use the `DependencyService` class, which is a service locator that enables Xamarin.Forms applications to invoke nat...
description: This sample demonstrates how to use the DependencyService class, which is a service locator that enables Xamarin.Forms applications to invoke native platform functionality from shared code.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Effects/BackgroundColorEffect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: BackgroundColor Effect
description: This sample demonstrates creating an effect for the `Entry` control, that changes the background color of the control. For more information about ...
description: This sample demonstrates creating an effect for the Entry control, that changes the background color of the control.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Effects/FocusEffect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Focus Effect
description: This sample demonstrates creating an effect for the `Entry` control, that changes the background color of the control when it gains focus. For mor...
description: This sample demonstrates creating an effect for the Entry control, that changes the background color of the control when it gains focus.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Effects/ShadowEffect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Shadow Effect
description: This sample demonstrates using CLR properties to pass parameters to an effect. For more information about the sample see [Creating an Effect](http...
description: This sample demonstrates using CLR properties to pass parameters to an effect.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Effects/ShadowEffectRuntimeChange/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Shadow Effect with Runtime Parameter Change
description: This sample demonstrates using attached properties to pass parameters to an effect, and changing a parameter at runtime. For more information abou...
description: This sample demonstrates using attached properties to pass parameters to an effect, and changing a parameter at runtime.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Effects/TouchTrackingEffect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Touch-Tracking Effect Demos
description: This sample demonstrates an effect that implements multi-touch finger tracking, and shows how to trigger events from an effect. For more informati...
description: This sample demonstrates an effect that implements multi-touch finger tracking, and shows how to trigger events from an effect.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion EmployeeDirectory/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Employee Directory
description: This contacts application is Xamarin.Forms port of the [existing pre-build app](http://xamarin.com/prebuilt/employeedirectory). With Xamarin.Forms...
description: 'This contacts application is Xamarin.Forms port of the existing pre-build app. With Xamarin.Forms you can use C or XAML to create layout and this sample app shows how to use both of them. To switch between user interface implementations open ~/EmployeeDirectory/EmployeeDirectoryUI/App.cs file and change uiImplementation variable. Switch to XAML: public static class App { //Change the following line to switch between XAML and C versions private static UIImplementation uiImplementation UIImplementation.Xaml; ... } Switch to C: public static class App { //Change the following line to switch between XAML and C versions private static UIImplementation uiImplementation UIImplementation.CSharp; ... } Nugets used in this solution: [PCLStorage][pclHref], [Xamarin.Forms][xFormsHref], [Microsoft.Bcl][mBclHref], [Microsoft.Bcl.Build][mBclBuildHref], [Microsoft.Net.Http][mNetHttpHref] Components used in this solution: [Xamarin.Social][xSocialHref]'
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion Forms2Native/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Forms2Native
description: This sample demonstrates how to add native views to a Xamarin.Forms page, and how they can interact with Xamarin.Forms views. For more samples, an...
description: This sample demonstrates how to add native views to a Xamarin.Forms page, and how they can interact with Xamarin.Forms views. For more samples, and more information about this sample see Native Views.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion FormsGallery/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: FormsGallery
description: 'This program displays all the views, cells, layouts, and pages available in Xamarin.Forms, one per page. '
description: This program displays all the views, cells, layouts, and pages available in Xamarin.Forms, one per page.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion FormsGridLayout/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: GridLayoutDemo
description: This sample demonstrates how to display various ui elements in a grid. GridLayoutDemo is based off of https://github.com/xamarin/monodroid-sampl...
description: This sample demonstrates how to display various ui elements in a grid. GridLayoutDemo is based off of https://github.com/xamarin/monodroid-samples/tree/master/GridLayoutDemo
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion GetStarted/FirstApp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 'Get Started: First app with Xamarin.Forms'
description: Sample code for the [get started page and video](https://docs.microsoft.com/xamarin/xamarin-forms/get-started/first-app/), that shows how to build ...
description: Sample code for the get started page and video, that shows how to build a basic Xamarin.Forms app from the File > New template in Visual Studio.
topic: sample
languages:
- csharp
Expand Down
2 changes: 1 addition & 1 deletion GetStarted/Notes/Database/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Notes (local database)
description: This sample demonstrates a multi-page Xamarin.Forms application that's capable of storing multiple notes in a local SQLite.NET database. For more ...
description: This sample demonstrates a multi-page Xamarin.Forms application that's capable of storing multiple notes in a local SQLite.NET database.
topic: sample
languages:
- csharp
Expand Down
Loading

0 comments on commit 99d864d

Please sign in to comment.