1NESTED(1)                   General Commands Manual                  NESTED(1)
2
3
4

NAME

6       nested - specialized editor for structured documents
7
8

SYNOPSIS

10       nested [FILE]
11
12

DESCRIPTION

14       Nested is a specialized editor focused on creating structured documents
15       such  as  reports,  publications,  presentations,  books,  etc.  It  is
16       designed  to  help the user concentrate on writing content without been
17       distracted by format or markup.  It offers  a  rich  WYSIWYM  interface
18       where  the  user  writes  plain text with a lightweight markup language
19       known as txt2tags.
20
21
22       Basic users are assisted with extensive examples, formatting buttons, a
23       simple  image  gallery  per  document,  assisted  internal and external
24       links, section based layout and easy publishing options in HTML,  LaTeX
25       or PDF. Power users will like the advanced pre-processing and post-pro‐
26       cessing options, advanced theming, version control systems  compatibil‐
27       ity,  LaTeX  formulas  support,  a  complete set of keyboard shortcuts,
28       among others.
29
30
31       Nested separates content from presentation and  publishing  option,  so
32       same  content can be presented as a HTML web page, a rich standard-com‐
33       pliant HTML presentation, a IEEE journal publication, a  beautiful  PDF
34       book,  etc. Nested files are plain text so they can be used with common
35       version control systems.
36
37
38       Please visit the program site at http://nestededitor.sourceforge.net/.
39
40

MARKUP

42       Comment           % comments
43       Bold              **words**
44       Italic            //words//
45       Underline         __words__
46       Strike            --words--
47       Superscript       ^^words^^
48       Subscript         ,,words,,
49       Monospaced        ``words``
50       Tagged            ''words''
51       Separator line    -----------------------...
52       Strong line       =======================...
53
54       Image             [filename.jpg]
55                         [300-filename.jpg]
56       External link     [label url]
57       Internal link     [label #section_name]
58
59       Paragraph         words
60       Quote             <TAB>words
61       List              - words
62       Numbered list     + words
63       Definition list   : words
64       Table             | cell1 | cell2 | cell3...
65
66       Verbatim line     ``` words
67       Tagged line       ''' words
68
69       Verbatim block    ```
70                         lines
71                         ```
72       Raw block         """
73                         lines
74                         """
75       Tagged block      '''
76                         lines
77                         '''
78       Math block        <<<
79                         lines
80                         >>>
81       Code block        {{{ code
82                         lines
83                         }}}
84
85
86
87       A more complete example can be found in File > Examples > Markup
88
89

DOCUMENT FILE

91       The document files are  identified  by  the  .t2t  extension  (such  as
92       myfile.t2t).  You have three areas inside your sources:
93
94
95       Header The  first  three  lines  of  the file. Used for document title,
96              author, version and date information.
97
98
99       Settings
100              Begins right after the  Header  and  ends  when  the  Body  area
101              starts.   Used  for  settings  (configurations)  in  the  %!key‐
102              word:value format.
103
104
105       Body   Begins after the settings and goes until the end  of  the  docu‐
106              ment. Used for the document contents.
107
108

SETTINGS

110       These  are  the  settings or properties of the document that are loaded
111       into the GUI.
112
113
114       %!target
115              Set the publishing option, it can be xhtmls, tex or txt
116              %!target: xhtmls
117
118
119
120
121       %!options(target)
122              Set common options to each target. Example:
123              %!options(xhtmls): --toc --toc-level 3
124
125
126
127
128       %!nested(target)
129              Set special options to each target. Example:
130              %!nested(xhtmls): --base64 --libs syntaxhighlighter,jquery
131
132
133
134
135       %!style
136              Set a style for the document. Right now it can only be  used  to
137              select the theme on HTML target:
138              %!style(xhtmls): media/theme/Base/style.css
139
140
141
142
143       %!preproc
144              Input  search/replace  filter  used  to  change  the Body of the
145              source document BEFORE conversion to target. It can  be  general
146              or  specific  to target. Search uses Python regular expressions.
147              Example:
148              %!preproc(xhtmls):  "AUTHOR"  "Carlos Jenkins"
149
150
151
152
153       %!postproc
154              Output search/replace filter used to change the generated  docu‐
155              ment  AFTER  the  conversion is done. Search uses Python regular
156              expressions. It can be general or specific to target. Example:
157              %!postproc(xhtmls):  "<b>"  "<strong>"
158
159
160
161

MACROS

163       Macros are handy shortcuts to insert dynamic contents in your document.
164       The  time macros can be customized with special directives, like %Y and
165       %f, see http://docs.python.org/library/time.html for more information.
166
167
168       %%date Insert the current date. The default format  is  %%date(%Y%m%d),
169              which gives YYYYMMDD.
170
171
172       %%toc  Specifies  where  the  Table of Contents will be placed. You can
173              even use it multiple times. Note that  you  must  also  use  the
174              --toc option.
175
176

TARGET COMMENTS

178       Target  comments  are special tokens that will be removed for some spe‐
179       cific target, making the content of the line avalaible.
180
181
182       %target%<space>
183              Avalaible targets are xhtmls (or its alias html),  tex  (or  its
184              aliases  latex  or  pdf) or txt (or its alias text). Please note
185              the leading space.
186
187
188       For example, you can insert in your document:
189
190       %html% You can download the PDF version of this document from [my website http://www.somedomain.com/myfile.pdf]
191       %pdf% You can view the HTML version of this document in [my website http://www.somedomain.com/myfile.html]
192
193
194

EXAMPLES

196       All examples can be found on File > Examples
197
198

FILES AND FOLDERS

200       ~/.nested/config.ini
201              Default user configuration file.
202
203
204       ~/.nested/recent.txt
205              Recently opened files.
206
207
208       ~/.nested/examples/
209              User custom examples.
210
211
212       ~/.nested/libraries/
213              User Javascript libraries.
214
215
216       ~/.nested/templates/
217              User content and structural templates.
218
219
220       ~/.nested/themes/
221              User HTML presentation themes.
222
223

AUTHOR

225       Carlos Jenkins <cjenkins@softwarelibrecr.org>
226           http://carlos.jenkins.co.cr/
227
228
229       Nested uses txt2tags by Aurelio Jargas <verde@aurelio.net>
230           http://txt2tags.org/
231
232

BUGS

234       http://sourceforge.net/p/nestededitor/tickets/
235
236
238       Copyright (C) 2018 Carlos Jenkins, GNU GPL v2
239
240
241
242
243                                   Nov, 2011                         NESTED(1)
Impressum