Skip to content

Commit

Permalink
Add a Txt2tags test case
Browse files Browse the repository at this point in the history
  • Loading branch information
b4n committed Aug 19, 2014
1 parent e587038 commit a1466f6
Show file tree
Hide file tree
Showing 3 changed files with 240 additions and 0 deletions.
1 change: 1 addition & 0 deletions tests/ctags/Makefile.am
Expand Up @@ -216,6 +216,7 @@ test_sources = \
refcurs.sql \
regexp.js \
rules.t2t \
sample.t2t \
secondary_fcn_name.js \
semicolon.f90 \
shebang.js \
Expand Down
225 changes: 225 additions & 0 deletions tests/ctags/sample.t2t
@@ -0,0 +1,225 @@
TXT2TAGS SAMPLE
Aurelio Jargas
%%mtime(%m/%d/%Y)

%!encoding: UTF-8

This text is before the introduction.

But it's OK.

= Introduction =

Welcome to the txt2tags sample file.

Here you have examples and a brief explanation of all
marks.

The first 3 lines of this file are used as headers,
on the following format:
```
line1: document title
line2: author name, email
line3: date, version
```

Lines with balanced equal signs = around are titles.

% a secret comment!
%TODO link to program site http://txt2tags.org


= Fonts and Beautifiers =

We have two sets of fonts:

The NORMAL type that can be improved with beautifiers.

The TYPEWRITER type that uses monospaced font for
pre-formatted text.

We will now enter on a subtitle...


== Beautifiers ==

The text marks for beautifiers are simple, just as you
type on a plain text email message.

We use double *, /, - and _ to represent **bold**,
//italic//, --strike-- and __underline__.

The **//bold italic//** style is also supported as a
combination.


== Pre-Formatted Text ==

We can put a code sample or other pre-formatted text:
```
here is pre-formatted
//marks// are **not** ``interpreted``
```

And also, it's easy to put a one line pre-formatted
text:
``` prompt$ ls /etc

Or use ``pre-formatted`` inside sentences.


== More Cosmetics ==

Special entities like email (duh@somewhere.com) and
URL (http://www.duh.com) are detected automagically,
as long as the horizontal line:

--------------------------------------------------------
^ thin or large v
========================================================

You can also specify an [explicit link http://duh.org]
or an [explicit email duh@somewhere.com] with label.

And remember,
A TAB in front of the line does a quotation.
More TABs, more depth (if allowed).
Nice.


= Lists =

A list of items is natural, just putting a **dash** or
a **plus** at the beginning of the line.


== Plain List ==

The dash is the default list identifier. For sublists,
just add **spaces** at the beginning of the line. More
spaces, more sublists.

- Earth
- America
- South America
- Brazil
- How deep can I go?
- Europe
- Lots of countries
- Mars
- Who knows?


The list ends with **two** consecutive blank lines.


== Numbered List ==

The same rules as the plain list, just a different
identifier (plus).

+ one
+ two
+ three
- mixed lists!
- what a mess
+ counting again
+ ...
+ four


== Definition List ==

The definition list identifier is a colon, followed by
the term. The term contents is placed on the next line.

: orange
a yellow fruit
: apple
a green or red fruit
: other fruits
- wee!
- mixing lists
+ again!
+ and again!


= Tables =

Use pipes to compose table rows and cells.
Double pipe at the line beginning starts a heading row.
Natural spaces specify each cell alignment.

| cell 1.1 | cell 1.2 | cell 1.3 |
| cell 2.1 | cell 2.2 | cell 2.3 |
| cell 3.1 | cell 3.2 | cell 3.3 |

|| heading 1 | heading 2 | heading 3 |
| cell 1.1 | cell 1.2 | cell 1.3 |
| cell 2.1 | cell 2.2 | cell 2.3 |

|_ heading 1 | cell 1.1 | cell 1.2 |
| heading 2 | cell 2.1 | cell 2.2 |
| heading 3 | cell 3.1 | cell 3.2 |

|/ heading | heading 1 | heading 2 |
| heading 1 | cell 1.1 | cell 1.2 |
| heading 2 | cell 2.1 | cell 2.2 |

Without the last pipe, no border:

| cell 1.1 | cell 1.2 | cell 1.3
| cell 2.1 | cell 2.2 | cell 2.3
| cell 3.1 | cell 3.2 | cell 3.3

|| heading 1 | heading 2 | heading 3
| cell 1.1 | cell 1.2 | cell 1.3
| cell 2.1 | cell 2.2 | cell 2.3

|_ heading 1 | cell 1.1 | cell 1.2
| heading 2 | cell 2.1 | cell 2.2
| heading 3 | cell 3.1 | cell 3.2

|/ heading | heading 1 | heading 2
| heading 1 | cell 1.1 | cell 1.2
| heading 2 | cell 2.1 | cell 2.2

= Special Entities =

Because things were too simple.


== Images ==

The image mark is as simple as it can be: ``[filename]``.

[img/photo.jpg]

And with some targets the image is linkable :

[[img/photo.jpg] http://www.txt2tags.org]

- The filename must end in PNG, JPG, GIF, or similar.
- No spaces inside the brackets!


== Other ==
When the target needs, special chars like <, > and &
are escaped.

The handy ``%%date`` macro expands to the current date.

So today is %%date on the ISO ``YYYYMMDD`` format.

You can also specify the date format with the %? flags,
as ``%%date(%m-%d-%Y)`` which gives: %%date(%m-%d-%Y).

That's all for now.

-------------------------------------------------------
%%% TRANSLATOR: Uncomment and translate the next two lines
%Translated by John Smith.
%-------------------------------------------------------
[img/t2tpowered.png] ([%%infile %%infile])

% vim: tw=55
14 changes: 14 additions & 0 deletions tests/ctags/sample.t2t.tags
@@ -0,0 +1,14 @@
# format=tagmanager
Beautifiers�64�Fonts and Beautifiers�0
Definition List�64�Lists�0
Fonts and Beautifiers�64�0
Images�64�Special Entities�0
Introduction�64�0
Lists�64�0
More Cosmetics�64�Fonts and Beautifiers�0
Numbered List�64�Lists�0
Other�64�Special Entities�0
Plain List�64�Lists�0
Pre-Formatted Text�64�Fonts and Beautifiers�0
Special Entities�64�0
Tables�64�0

0 comments on commit a1466f6

Please sign in to comment.