Skip to content

Commit ff44e98

Browse files
committed
fix md
1 parent f13a607 commit ff44e98

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ https://github.com/swipe-org/swipe
99

1010

1111

12-
##What is Swipe?
12+
## What is Swipe?
1313

1414
Swipe is a **domain-specific, declarative language** for non-developers (such as designers, animators, illustrators, musicians, videographers and comic writers) to create **media-rich/animated documents** that contain photos, videos, images, vector graphics, animations, voices, musics and sound effects, which will be consumed on touch-enabled devices such as smartphones, tablets and touch-enabled set-top-boxes (such as **iPhone and Apple TV**).
1515

16-
##What is Swipe Engine?
16+
## What is Swipe Engine?
1717

1818
Swipe Engine is the **viewer** of documents described in Swipe. Since it supports hyperlinking and allows you to browse from one Swipe document to another, you could even call it a **domain-specific browser**. At this moment (October 2015), Swipe Engine is available for **iOS and tvOS**, but will be ported to other platforms such as Android, Windows and even HTML5 (and we are looking for volunteers to do so).
1919

20-
##Why do we need Swipe?
20+
## Why do we need Swipe?
2121

2222
Because existing platforms (such as HTML5, ePub, Flash and iBooks) require some form of programming to create media-rich/animated documents, which is expensive and error-prone.
2323

@@ -27,15 +27,15 @@ Because existing platforms (such as HTML5, ePub, Flash and iBooks) require some
2727

2828
That's why I came to the conclusion that it's time to design a new platform, which is powerful enough to describe media-rich documents that allow us to take full advantage of modern devices, but is also **strictly declarative** (no API, no script), easy to read, easy to write and easy to auto-generate.
2929

30-
##Why is it open?
30+
## Why is it open?
3131

3232
Because I want to make it an industry standard so that everybody can benefit from it. I was lucky enough to work on several successful products, such as Windows 95, which were used by hundreds of millions of people. I'd like to see such a success again.
3333

34-
##Is it really free?
34+
## Is it really free?
3535

3636
Yes, I still maintain the copyright, but it's **absolutely free**. You can use it for non-commercial and commercial applications, modify it as needed, port it to other platforms (I'd really appreciate if you open source it as well), re-distribute it with your applications, as long as you explicitly mention that your application uses Swipe and recognize me (Satoshi Nakajima) as the copyright holder.
3737

38-
##Target Applications
38+
## Target Applications
3939

4040
* Interactive Comics
4141
* Sound Novels
@@ -44,7 +44,7 @@ Yes, I still maintain the copyright, but it's **absolutely free**. You can use i
4444
* Media-rich Tutorials and Presentations
4545
* Interactive Arts
4646

47-
##Primary Audiences
47+
## Primary Audiences
4848

4949
* Designers/Illustrators
5050
* Animators
@@ -54,7 +54,7 @@ Yes, I still maintain the copyright, but it's **absolutely free**. You can use i
5454
* Teachers/Educators
5555
* Weekend Programmers
5656

57-
##Design Principles
57+
## Design Principles
5858

5959
* Optimized for touch-enabled devices
6060
* 100% declarative (no programming)
@@ -64,11 +64,11 @@ Yes, I still maintain the copyright, but it's **absolutely free**. You can use i
6464
* Designer friendly
6565
* Lightweight & portable
6666

67-
##Is there an authoring tool?
67+
## Is there an authoring tool?
6868

6969
I'm working on it. Stay tuned.
7070

71-
##Specification
71+
## Specification
7272

7373
The specification is available [here](SPECIFICATION.md).
7474

SPECIFICATION.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
#Swipe Language Specification
1+
# Swipe Language Specification
22

3-
##Abstract
3+
## Abstract
44

55
This specification defines the features and syntax of Swipe, a mark-up language for non-developers to create media-rich and animated documents for touch-enabled devices.
66

7-
##Status of this document
7+
## Status of this document
88

99
This specification describes the current snapshot of the Swipe 0.1, which is still under development and may change drastically.
1010

11-
##1. Introduction
11+
## 1. Introduction
1212

1313
Swipe is a domain-specific, declarative language for non-developers (such as designers, animators, illustrators, musicians, videographers and comic writers) to create media-rich documents (books and presentations) that contains photos, videos, vector graphics, animations, voices, music and sound effects, which will be consumed on touch-enabled devices (such as smartphones, tablets and touch-enabled set-top-boxes).
1414

@@ -63,7 +63,7 @@ Swipe is NOT
6363
- **StringId**: Regular string used as an identifier
6464
- **LangId**: Language identifier, such as "\*", "en", "ja", "de", etc., where "\*" represents the default
6565

66-
##2. Document
66+
## 2. Document
6767

6868
A **Document** is a UTF8 JSON file, which consists of a collection of **Pages**. The order of **Pages** in the collection is significant, and they will be presented to the user in the specified order.
6969

@@ -108,7 +108,7 @@ When the user opens this document with a Swipe viewer, the user will see only th
108108
- **languages** ({"id":LangId, "title":String},...): Languages to display via the "Lang." button in the Swipe viewer.
109109

110110

111-
##3. Page
111+
## 3. Page
112112

113113
**Page** consists of a collection of **Elements**. The order of **Elements** in the collection is significant, those elements will be rendered in the specified order (from bottom to top).
114114

@@ -144,7 +144,7 @@ Here is a **Document** with a **Page**, which has two **Elements**.
144144
- **eyePosition** (Float): Eye position (z-height) for the perspective relative to width, default is 1.0 (not supported)
145145
- **strings** ([StringId:[LangId:String]]): String resources
146146

147-
##4. Paging direction, inter-page transition and animation
147+
## 4. Paging direction, inter-page transition and animation
148148

149149
The paging direction is defined by the "paging" property of the **Document**. It must be either *vertical*, *leftToRight* or *rightToLeft*, and the default is *vertical*.
150150

@@ -165,7 +165,7 @@ The "play" property defines the timing of play/animation defined on the **Page**
165165
- *always*: The animation on the **Page** will be played after scrolling to this page
166166
- *scroll*: The animation on the **Page** will be performed while the user scrolls the page
167167

168-
##5. Page Template
168+
## 5. Page Template
169169

170170
A **PageTemplate** defines a set of properties and **Elements** to be shared among multiple **Pages**. It also defines a background music to be played when one of those **Pages** is active.
171171

@@ -230,7 +230,7 @@ The following example uses the "id" to identify a particular **Element** in the
230230
### PageTemplate specific properties
231231
- bgm (URL): Specifies the background music to play.
232232

233-
##6. Element
233+
## 6. Element
234234

235235
An **Element** is a visible entity on a **Page**. It occupies a specified rectangle area within a **Page**. An **Element** may contain child **Elements**.
236236

@@ -346,7 +346,7 @@ The following example shows how to use a **ElementTemplate** with child **Elemen
346346
}
347347
```
348348

349-
##7. Transition Animation
349+
## 7. Transition Animation
350350

351351
The **Transition Animation** specifies a set of animations to play right after or during the page transition (depending on the "transition" property of the page).
352352

@@ -394,7 +394,7 @@ If the "play" property of the page is "scroll" like the example below, the anima
394394
}
395395
```
396396

397-
##8. Loop Animation
397+
## 8. Loop Animation
398398

399399
The "loop" property of the element specifies the **Loop Animation** associated with the element. Unlike **Transition Animation**, it repeats the same animation multiple times specified by the *count* property (the default is 1).
400400

@@ -427,7 +427,7 @@ Following example wiggles the text "I'm wiggling!" three times when the second p
427427
}
428428
```
429429

430-
##9. Multilingual Strings
430+
## 9. Multilingual Strings
431431

432432
The "strings" property of the page specifies strings in multiple languages. The format is:
433433

0 commit comments

Comments
 (0)