Documentation

Contributing to the Documentation

All the language data are stored in /public/data/, in the form of /public/data/category/subcategory/language/.

In each language directory, there are two files, code.ext and desc.md.

code.ext

Extension ext is same as the name of its parent language directory.

It contains the source code which appears on ACE editor on the application.

For the sake of exact matching among languages, code parts should be wrapped with #(no){[ and ]}.

Correspondent code parts among languages share the same (no) in the wrapper.

It starts from 0 and increases by 1, but does not have to be in order.

NOTE that any change of wrapper may result in modifying wrappers in every single language.

The wrapper is the key to show the difference among languages.

Also, NOTE that there should be no case that any (no) of the wrapper is omitted.

Even if a wrapper wraps around nothing, the wrapper should be on the line corresponding to that in other languages.

To meet our goals, minimize the number of wrappers.

DuoCoder may only notify the changes that are related to their category.

Check out the difference between C++ and Python sample codes below.

C++

#0{[int]} integer = #1{[3]};
#2{[float]} decimal = #3{[0.8f]};
#4{[double]} pi = #5{[3.1415926535]};
#6{[long long int]} long_number = #7{[4294967296L]};

Python

#0{[]}integer = #1{[3]}
#2{[]}decimal = #3{[0.8]}
#4{[]}pi = #5{[3.1415926535]}
#6{[]}long_number = #7{[4294967296L]}

desc.md

It shows the description on bottom right panel on the application.

It is in Markdown format, which is well explained in adam-p/markdown-here.

To meet our goals, write the description as simple as possible.

You may put some links to other detailed related documentations.

Check out a sample markdown below.

## Numeric Type Variables

1. Integers
    * Positive value: `(value)` or `+(value)` 
    * Negative value: `-(value)`

2. Long Integers: `(value)L`
    
3. Decimals: `(integer_part).(fraction_part)`
    `(integer_part)` is not necessary if 0.

### What it looks like?
`(name) = (number)`