diff options
Diffstat (limited to 'ui/text/README.md')
| -rw-r--r-- | ui/text/README.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/ui/text/README.md b/ui/text/README.md new file mode 100644 index 00000000..003caf78 --- /dev/null +++ b/ui/text/README.md @@ -0,0 +1,73 @@ +Text Styling +============ +This sample shows how to style text on Android using spans. + +Introduction +------------ +## Features +Parse some hardcoded text and do the following: +* Paragraphs starting with “> ” are transformed into quotes. +* Text enclosed in “```” will be transformed into inline code block. +* Lines starting with “+ ” or “* ” will be transformed into bullet points. +To update the text, modify the value of `R.string.display_text`. +This project is not meant to fully cover the markdown capabilities and has several limitations; for example, quotes do not support nesting other elements. + +## Implementation +The text is parsed in the `Parser.parse` method and the spans are created in the `MarkdownBuilder.markdownToSpans` method. +To see how to apply a span, check out `MarkdownBuilder.buildCodeBlockSpan`. To see how to apply multiple spans on the same string, see `MarkdownBuilder.buildQuoteSpan”. For examples of creating custom spans, see `BulletPointSpan`, `CodeBlockSpan` or `FontSpan`. + +## Testing +Parsing of the text is tested with JUnit tests in `ParserTest`. Span building is tested via Android JUnit tests, in `MarkdownBuilderTest`. + + +Getting Started +--------------- + +Clone this repository, enter the top level directory and run `./gradlew tasks` +to get an overview of all the tasks available for this project. + +Some important tasks are: + +``` +assembleDebug - Assembles all Debug builds. +installDebug - Installs the Debug build. +connectedAndroidTest - Installs and runs the tests for Debug build on connected +devices. +test - Run all unit tests. +``` + +Screenshots +----------- +<img src="screenshots/main_activity.png" width="30%" /> + +Support +------- +- Stack Overflow: http://stackoverflow.com/questions/tagged/android-text + +If you've found an error in this sample, please file an issue: +https://github.com/googlesamples/android-text/issues + +Patches are encouraged, and may be submitted by forking this project and +submitting a pull request through GitHub. + +License +-------- +``` +Copyright 2018 The Android Open Source Project + +Licensed to the Apache Software Foundation (ASF) under one or more contributor +license agreements. See the NOTICE file distributed with this work for +additional information regarding copyright ownership. The ASF licenses this +file to you under the Apache License, Version 2.0 (the "License"); you may not +use this file except in compliance with the License. You may obtain a copy of +the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and limitations under +the License. +``` + |