*sub_qc.txt*	Subtitle QC filetype plugin
		Author: lys
		Version: 0.2.0

							*sub_qc*
Sub QC provides syntax and mappings for subtitle quality check reports. It has
rudimentary syntax highlighting for Advanced Substation Alpha (.ass) files and
QC report files. In addition, it includes mappings to allow QC reports to be
written efficiently.

This plugin imposes a prescribed format for QC report files. An example is
included in the next section (|sub_qc-example|). Furthermore, these files must
use the '.qc.txt' file extension in order be recognized by this plugin.


							*sub_qc-example*
Example format: >
    #########################
    Dialogue: 30,0:00:40.54,0:00:42.64,Dialogue,,0,0,0,,Line being reported

    Remarks

    >>>
    Suggestion

    #########################
    Dialogue: 30,0:02:02.47,0:02:03.95,Dialogue,,0,0,0,,Another line being reported

    Remarks

    #########################
    Dialogue: 30,0:04:15.06,0:04:17.94,Dialogue,,0,0,0,,Line with multiple suggestions

    Remarks

    >>>
    Suggestion
    >>>
    Another suggestion

    #########################
<

A few notes:
  - Entries are separated by a line containing 25 '#' characters
  - Suggestions are preceded by a line containing 3 '>' characters


==============================================================================
1. Mappings						*sub_qc-mappings*

							*sub_qc-<Plug>SubQCNewRegister*
<Plug>SubQCNewRegister		Creates a new QC entry from the contents of
				the unnamed register.
				Default: <leader>e

							*sub_qc-<Plug>SubQCNewPasteboard*

<Plug>SubQCNewPasteboard	Creates a new QC entry from the contents of
				the OS X pasteboard.
				Default: <leader>w

							*sub_qc-<Plug>SubQCNewLine*
<Plug>SubQCNewLine		Creates a new QC entry for a numbered subtitle
				line.
				Default: <leader>l

							*sub_qc-]]*
]]				[count] sections forward to the next line of
				dialogue reported.

							*sub_qc-[[*
[[				[count] sections backward to the previous line
				of dialogue reported.

							*sub_qc-][*
][				[count] sections forward to the next QC
				suggestion.

							*sub_qc-[]*
[]				[count] sections backward to the previous QC
				suggestion.

							*sub_qc-]e*
]e				[count] sections forward to the next '#'
				separator line.

							*sub_qc-[e*
[e				[count] sections backward to the previous '#'
				separator line.

							*sub_qc-<Plug>SubQCSaveNewVersion*
<Plug>SubQCSaveNewVersion	Save a new version of the current QC file and
				increment a version number in its filename.

							*sub_qc-<Plug>SubQCAppendASSEntryToEnd*
<Plug>SubQCAppendASSEntryToEnd	In .ass buffers, append the current line of
				dialogue as a new QC entry to another buffer
				open in a second split window.
				Default: <leader>e

							*sub_qc-<Plug>SubQCAppendASSEntryToCurrentLine*
<Plug>SubQCAppendASSEntryToCurrentLine
				In .ass buffers, append the current line of
				dialogue as a new QC entry to the current line
				of another buffer open in a second split.
				Default: <leader>w

							*sub_qc-<Plug>SubQCInitializeQCFileBoilerplate*
<Plug>SubQCInitializeQCFileBoilerplate
				In .ass buffers, append QC report metadata to
				the top of another buffer open in a second
				split window.
				Default: <leader>n


==============================================================================
2. License						*sub_qc-license*

Sub QC is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Sub QC is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Sub QC. If not, see <http://www.gnu.org/licenses/>.