[go: up one dir, main page]

File: kate-category.doc

package info (click to toggle)
libkate 0.3.7-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 4,484 kB
  • ctags: 4,083
  • sloc: ansic: 10,002; sh: 8,853; yacc: 2,250; python: 721; lex: 362; makefile: 239
file content (51 lines) | stat: -rw-r--r-- 2,062 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/* Copyright (C) 2008, 2009 Vincent Penquerc'h.
   This file is part of the Kate codec library.
   Written by Vincent Penquerc'h.

   Use, distribution and reproduction of this library is governed
   by a BSD style source license included with this source in the
   file 'COPYING'. Please read these terms before distributing. */


/**

\page categories Kate categories

The category field in the Kate ID header is an ASCII string meant to be
recognizable automatically (eg, it is kept as non localized ASCII). This
page lists examples of categories to use for various purposes.
It is suggested that applications recognizing well known categories such
as the ones described below may display to the user a localized version
of them (eg, when a stream has a category of "SUB", an application set
up for the French locale might display the category as "sous-titres".
If a particular category is not recognized, it may still be displayed as
a string, albeit non localized.

If using custom categories for your own use, you may use category names
prefixed by "x-". These are reserved for private use. Category names not
starting with "x-" are reserved for future "standard" use.

\li \c SUB, or \c subtitles Movie (or other) subtitles, as text, possibly including
simple inline markup.

\li \c CC Movie (or other) closed captions, as text, possibly including
simple inline markup.

For instance, ffmpeg2theora can create such streams, which can be played
back by VLC, MPlayer (if patched), the Annodex browser plugin (if patched),
and any player using GStreamer (if patched).

\li \c K-SPU, or \c spu-subtitles Movie (or other) subtitles, as DVD style images, with
on screen positioning and size information.

For instance, Thoggen (if patched) can create such streams, which can be
played back by VLC, and MPlayer (if patched).

\li \c LRC, or \c lyrics Song lyrics (typically in the language they are sung in) as
plain text.

For instance, oggenc (if patched) can create such streams, which can be
played back by XMMS (if patched), or Audacious (if patched).

*/