jinyuzu99 / formatting-protocol

[developing] formatting protocol for 'dorxmi' project.

dorjmi formatting protocol

dorjmi formatting protocol (dfp) is a formatting protocol designed for 'dorjmi' project.

to-do

• emoji
• verb and noun

table of content

• dorjmi formatting protocol
  • table of content
  • text
    • name
    • user name
    • keyboard key
    • input instruction
    • quotation + text block
    • abbreviation
    • tag
    • extra information
  • number
    • date
    • unit
    • array
  • symble
    • step
    • punctuation
    • tab
    • quote name

text

name

with ' ', use ' '

sayo naming protocol

alex zeitlin

usage: title name, local file name

without ' ', use '-'

sayo-formatting-protocol

alex-zeitlin

usage: variable name, online file name, link name, code file name.

without ' ' or '-', use '_'

sayo_formatting_protocol

alex_zeitlin

not recommand: '_' is usually as subscript

name in setence

my name is 'alex zeitlin' this protocol is 'sayo formatting protocol'

attention:

1. use noun, do not use verb.
2. no 's' after noun.
3. file must have extension name.

user name

with '-'

user-name

without '-'

user_name

name is duplicated

user-name-[Identification Number: 99]

keyboard key

single key

[space]

multiple key

[command | ctrl] + [shift] + [C]

explaination: '+' for press at the same time.

input instruction

instruction

[input instruction]

[blog url]

instruction with example

[input instruction: example]

[cirst name: alex]

optional instruction

([optional instruction: answer])

2019.05.14-01:32:25([Time Zone: +08:00])

quotation + text block

'This is a quote.'

This is a 'Text Block'

'这是一段引用'

这是一个 '文字块'

中文输入法为什么会有全角和半角的区别?

abbreviation

dorjmi formatting protocol -> dfp

tag

[tag1, tag2] other text

extra information

Sentence (Extra information).

usage: adding extra information to paragraph.

number

date

[year].[month].[day].[hour]:[minute]:[second] ([Time Zone])

2019.05.14-01:32:25

2019.05.14-01:32:25+08:00

usage: time, version number.

explanation: no ' ', '+08:00' is optional.

unit

byte

• 1b = 2 ^ 10 byte = kilo binary byte
• 2b = 2 ^ 20 byte = mega binary byte
• 3b = 2 ^ 30 byte = giga binary byte
• 4b = 2 ^ 40 byte = tera binary byte
• 5b = 2 ^ 50 byte = peta binary byte

bit

• 1bi = 2 ^ 10 bit = kilo binary bit

• ...

• $, €, ¥ ...: 11$ (not $11)

• %, ºC, ...: 100%

array

array

[first item, Second Item, Third Item, ...]

[9, 7, 2]

[Jobs, Gates, Page]

Array with Value

[First Item: First Value, Second Item: Second Value, ...]

[First Name: Alex, Last Name: Zeitlin]

dimensional Array

[9, 7, 2; 3, 5, 1; 4, 9, 3]

[9, 7, 2
 3, 5, 1
 4, 9, 3]

multi-dimensional Array

[1, 2:
 9, 7, 2
 3, 5, 1
 4, 9, 3]

[1, 3:
 9, 7, 2;
 3, 5, 1;
 4, 9, 3]

[1, 2: 9, 7, 2; 3, 5, 1; 4, 9, 3]

symble

step

first -> second -> third

'<-' in rtl (right to left)

اول -> ثان -> ثالث

punctuation

' + ': and

'[space] + [a]'

' | ': or

He | She

' . ': belonging

[big].[small]

Father.Son, 2019.05.14, system.right

' : ': explanation + example

Explanation: This is an explanation

SFP: Sayo Formatting Protocol

Example: This is an example

First Name: Alex

' ... ': Et cetera

[first item, second item, third item, ...]

tab

use 2 space as a tab.

quote name

brand name, product name, human name, artical name...

'dorjmi formatting protocol' is developed by 'dorjmi'

use original language name. jobs not 乔布斯.