Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #2 addressed, semantic linefeeds, added guidelines for hyperlinking and sourcing #5

Merged
merged 3 commits into from
Jan 31, 2019
Merged

Issue #2 addressed, semantic linefeeds, added guidelines for hyperlinking and sourcing #5

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5c7e8e
Issue #2 fixed, added guidelines for hyperlinking and sourcing
Jan 30, 2019
9e6849e
Add semantic linefeeds to overview docs and CONTRIBUTING.md
Jan 31, 2019
c7a9fde
Formatting nuances and fixes
Jan 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ for guidelines on visual formatting.

### Semantic Linefeeds (!)

Always use [Semantic Linefeeds][] when editing code.
Always use [Semantic Linefeeds][] when editing text.
They are used
to break lines into logical units
rather than after a certain line length threshold is reached!
Expand Down Expand Up @@ -190,8 +190,9 @@ The indent size is **two spaces**.

Unordered list lines should be indented **once**,
while ordered lists are indented **twice**.
The text of an unordered item should have one space after the `-`
while the text of an ordered item should have two spaces after the `#.`
The text of an unordered item should have one space after the `-`,
while the text of an ordered item
should start four columns after the number.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's still kind of ambiguous for multi-digit numbers, but we specifically have an example for that below, so ┐(°ヮ°)┌.


```md
- This is an unordered list
Expand All @@ -203,7 +204,7 @@ while the text of an ordered item should have two spaces after the `#.`
1. This is an ordered list.
Consecutive lines are indented with four spaces.
2. Another list item
...
…
10. Now only one space after the item number.
```

Expand All @@ -215,7 +216,7 @@ should be separated from text
with a blank line on each side.
The same applies to code blocks.

Separate headings from text with **two** blank lines before the heading
Separate headings from text with **two** blank lines before the heading,
and **one** after.
Headings immediately following their parent heading
only need one blank line in-between.
Expand Down Expand Up @@ -251,13 +252,13 @@ you will want multiple lines at the end of the header section.
```md
[short1]: https://guide.encode.moe/
[short2]: https://guide.encode.moe/CONTRIBUTING.HTML
...
…
```

If you are linking to a section on the same page,
`[section name](#header)` is allowed in-line.
An example of this is ["the hyperlink section you are reading"](#Hyperlinking).
In code, this is simply `["the hyperlink section you are reading"](#Hyperlinking)`.
An example of this is [the hyperlink section you are reading](#Hyperlinking).
In markdown, this is simply `[the hyperlink section you are reading](#Hyperlinking)`.

For relative links (links to other pages,
images,
Expand Down
28 changes: 16 additions & 12 deletions overview/roles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ and video.
They will generally be provided with one or more video sources
and are expected to produce the best video possible within reason.

This is done with a **frame-by-frame video processor** such as AviSynth
and VapourSynth<sup name="a1">[1](#fn1)</sup>,
a **video encoder** such as x264 or x265<sup name="a2">[2](#fn2)</sup>,
and **audio tools** such as eac3to, qaac,
and FLAC<sup name="a3">[3](#fn3)</sup>.
This is done with a **frame-by-frame video processor** such as AviSynth
and VapourSynth[^1],
a **video encoder** such as x264 or x265[^2],
and **audio tools** such as eac3to,
qaac,
and FLAC[^3].
This is not a comprehensive list,
but it does represent the broad categories of tools required.

Expand Down Expand Up @@ -89,7 +90,7 @@ presentation of translated text on-screen. These generally are called *signs*.

For example, given this scene and a translation of "Adachi Fourth Public
High
School"...
School"…

![\[DameDesuYo\] Eromanga-sensei - 01 (1920x1080 10bit AAC) \[05CB518E\].mkv\_snapshot\_03.11\_\[2017.08.18\_21.14.55\].jpg](images/cnvimage100.png)

Expand Down Expand Up @@ -215,11 +216,14 @@ and can be highly programming-oriented.

***

<b name="fn1">1</b>: *TODO - sources for AviSynth and VapourSynth builds
relevant to fansubbing.* [↩](#a1)
[^1]: *TODO - sources for AviSynth and VapourSynth builds
relevant to fansubbing.*

<b name="fn2">2</b>: Further reading on the x264 and x265 libraries can be
found [here](https://www.reddit.com/r/anime/comments/8ktmvu/nerdpost_how_fansubbers_make_your_anime_look/). [↩](#a2)
[^2]: Further reading on the x264 and x265 libraries can be found
[here][reddit-x264-x265].

<b name="fn3">3</b>: Comparisons of various audio codecs can be found
[here](https://en.wikipedia.org/wiki/Comparison_of_audio_coding_formats). [↩](#a3)
[^3]: Comparisons of various audio codecs can be found
[here][wikipedia-audio].

[reddit-x264-x265]: https://www.reddit.com/r/anime/comments/8ktmvu/nerdpost_how_fansubbers_make_your_anime_look/
[wikipedia-audio]: https://en.wikipedia.org/wiki/Comparison_of_audio_coding_formats