./README.md in runeblog-0.2.57 vs ./README.md in runeblog-0.2.58
- old
+ new
@@ -1,24 +1,21 @@
-<div float="left" align="left">
-<p>
-
-<p>
-
-<img src="raido.png" width="196" height="275" align="left"></img>
+<div style="float: left; align: left; vertical-align: bottom">
+<img src="raido4.png" width="210" height="295" align="left"></img>
</div>
+<h1>runeblog</h1><b>Runeblog</b> is a blogging tool written in Ruby. It has these basic characteristics:
+<ul>
+ <li>It is usable entirely in text mode from the terminal</li>
+ <li>It publishes web pages as static HTML</li>
+ <li>So far, yes, like Jekyll</li>
+ <li>It's based on Livetext (highly extensible Ruby-based markup)</li>
+ <li>It has the concept of multiple "views" for a blog</li>
+ <li>The multiple views are in effect multiple blogs managed with the same backend.</li>
+</ul>
<p>
-# runeblog
-Runeblog is a blogging tool written in Ruby. It has these basic characteristics:
<p>
- * It is usable entirely from the command line
- * It publishes web pages as static HTML
- * So far, yes, like Jekyll
- * It's based on Livetext (highly extensible Ruby-based markup)
- * It has the concept of multiple "views" for a blog
-The multiple views are in effect multiple blogs managed with the same backend.
<p>
## What is Livetext?
Livetext is a markup format that is a throwback to the old, old days of text
formatters such as <font size=+1><tt>roff</tt></font> It's very flexible, and it is extensible <i>in Ruby</i>.
@@ -38,125 +35,239 @@
would go into another. There might be a view that only old friends or close friends
can see. There might be a view purely for reviews of music, books, and movies.
<p>
But the important points are these:
- * _All the views will be managed the same way in the same place, and they will all share common data.
+<p>
+
+ * <i>All</i> the views will be managed the same way in the same place, and they will all share common data.
* Any post can easily be included in a single view, in more than one, or in all of them.
* Each view can have its own look and feel, and it can be linked/published separately from the others.
* Each view can be hosted in a different location and/or a different server and domain
* Any post can be in more than one view
-## The `[blog] environment
+## The <tt>blog</tt> environment
There is a command-line tool called <font size=+1><tt>blog</tt></font> which is a REPL (read-eval-print loop).
Note that this tool is a curses-based environment (mainly so it can display menus
and such to the user).
<p>
The help message looks like this:
<p>
<pre>
- Commands:
+ <b>Basics:</b> <b>Views:</b>
+ ------------------------------------------- -------------------------------------------
+ <b>h, help</b> This message <b>change view VIEW</b> Change current view
+ <b>q, quit</b> Exit the program <b>cv VIEW</b> Change current view
+ <b>v, version</b> Print version information <b>new view</b> Create a new view
+ <b>clear</b> Clear screen <b>list views</b> List all views available
+ <b>lsv</b> Same as: list views
+<br>
+ <b>Posts:</b> <b>Advanced:</b>
+ ------------------------------------------- -------------------------------------------
+ <b>p, post</b> Create a new post <b>config</b> Edit various system files
+ <b>new post</b> Same as p, post <b>customize</b> (BUGGY) Change set of tags, extra views
+ <b>lsp, list posts</b> List posts in current view <b>preview</b> Look at current (local) view in browser
+ <b>lsd, list drafts</b> List all drafts (all views) <b>browse</b> Look at current (published) view in browser
+ <b>delete ID [ID...]</b> Remove multiple posts <b>rebuild</b> Regenerate all posts and relink
+ <b>undelete ID</b> Undelete a post <b>publish</b> Publish (current view)
+ <b>edit ID</b> Edit a post <b>ssh</b> Login to remote server
+ <b>import ASSETS</b> Import assets (images, etc.) <b>manage WIDGET</b> Manage content/layout of a widget
+</pre>
+## Getting started
+But when you first run the REPL, it checks for an existing blog repository under
+the <font size=+1><tt>.blogs</tt></font> directory. If it doesn't find one, it asks whether you want to create
+a new blog repo. Enter <font size=+1><tt>y</tt></font> for yes.
+<p>
- h, help This message
- q, quit Exit the program
+You'll then enter the editor (vim for now) to add configuration info to the <font size=+1><tt>global.lt3</tt></font> file.
+<p>
- change view _view Change current view
- new view Create a new view
- list views List all views available
- lsv Same as: list views
+<pre><b>FIXME add menu screenshot here</b></pre>
+<pre><b>FIXME add vim screenshot here</b></pre>
+<p>
- p, post Create a new post
- new post Same as post (create a post)
- lsp, list posts List posts in current view
- lsd, list drafts List all posts regardless of view
+The next thing you should do is to create at least one view of your own. Use the
+`[new view] command for this. Note that the current view is displayed as part of the prompt.
+<p>
- rm _id Remove a post
- edit _id Edit a post
+<pre>
+<b>[no view]</b> new view mystuff<br>
+<b>[mystuff]</b>
+</pre>
+<p>
- preview Look at current (local) view in browser
- browse Look at current (deployed) view in browser
+To create a new post, use the <font size=+1><tt>new post</tt></font> command (also abbreviated <font size=+1><tt>post</tt></font> or simply <font size=+1><tt>p</tt></font>). You will be
+prompted for a title:
+<p>
- relink Regenerate index for all views (MAY CHANGE)
- rebuild Regenerate all posts and relink (MAY CHANGE)
- deploy Deploy (current view)
+<pre>
+<b>[around_austin]</b> new post<br>
+<b>Title:</b> This is my first post
</pre>
-## Getting started
-But when you first run the REPL, it checks for an existing blog repository under
-the <font size=+1><tt>.blog</tt></font> directory. If it doesn't find one, it asks whether you want to create
-a new blog repo. If you enter <font size=+1><tt>y</tt></font> for yes, it creates a sort of "skeleton" with a
-single view called <font size=+1><tt>test_view</tt></font>.
<p>
-The next thing you should do is to create at least one view of your own. Use the
-<font size=+1><tt>new view</tt></font> command for this.
+Then you'll be sent into the editor (currently vim but can be others):
<p>
-(new view)
+<pre><b>FIXME add example here</b></pre>
<p>
-(new post)
+<pre>
+<b>FIXME wizard?</b>
+(publishing one-time setup - server, ssh keys, etc.)
+preview...
+publish...
+browse...
+(and so on)
+</pre>
<p>
-(preview)
+<b>To be continued</b>
<p>
-(publishing one-time setup - server, ssh keys, etc.)
+## Customizing the default templates and configuration
+You can use the <font size=+1><tt>config</tt></font> command to choose a file to edit.
<p>
-(publish)
+<pre><b>FIXME add screenshot here</b></pre>
<p>
-(browse)
+The meaning and interaction of these files will be explained later. <b>FIXME</b>
<p>
-(and so on...)
+When you make changes, <font size=+1><tt>rebuild</tt></font> will detect these and regenerate whatever files
+are needed.
<p>
-*[To be continued]
+## The directory structure for a view
+<pre><b>FIXME add details here</b></pre>
<p>
-## Changing the default templates
-*TBD
<p>
## Basics of Livetext
-*TBD
+<b>TBD</b>
<p>
-(bold, italics, etc.)
+<b>Bold, italics, etc.</b>
+ single, double, bracketed
<p>
-(common dot commands)
+<b>Common dot commands)
+<pre>
+ .debug
+ .say
+ .nopara
+ .quit
+ indented dot-commands
+</pre>
<p>
-(predefined functions and variables)
+<b>Using external files</b>
+<pre>
+ .mixin
+ .include
+ .copy
+ .seek
+</pre>
<p>
-## Runeblog-specific features (Liveblog)
-*TBD
+<b>Predefined functions and variables</b>
+<pre>
+ $File
+ $\[date is undefined]
+ etc.
+</pre>
<p>
-(dot commands)
+## Runeblog-specific features (Liveblog</b>
+<b>TBD</b>
<p>
-(variables and functions)
+<b>Dot commands - the basics</b>
+<pre>
+ .mixin liveblog
+ .post
+ .title
+ .views
+ .tags
+ .teaser
+</pre>
<p>
+<b>Dot commands - more advanced</b>
+<pre>
+ .image
+ .inset
+ .dropcap
+ .pin
+</pre>
+<p>
+
+<b>Variables and functions</b>
+<pre>
+ $view, etc.
+ $\[date is undefined], $\[link is undefined], etc.
+</pre>
+<p>
+
+<p>
+
## Defining your own features
-(dot commands)
+<b>Dot commands, variables, functions</b>
+<pre>
+ .def/.end
+ .set
+ .variables
+ .heredoc
+ .func
+</pre>
<p>
-(variables and functions)
+<b>Defining these in Ruby</b>
<p>
-*TBD
<p>
-##
-*TBD
+## More topics
+<b>Meta tags, etc.</b>
+<b>CSS</b>
<p>
+<b>Widgets</b>
+<pre>
+ pages
+ links
+ pinned
+ faq
+ sitemap
+ news
+ etc.
+</pre>
+<p>
+
+<b>Banner and navbar</b>
+<p>
+
+<b>Creating your own widgets</b>
+<p>
+
+<b>Special tags coming "soon"</b>
+<pre>
+ github, gitlab, gist
+ wikipedia
+ youtube, vimeo
+ twitter, instagram
+ etc.
+</pre>
+<p>
+
+<p>
+
+<b>TBD</b>
+<p>
+
## More later...
-*TBD
+<b>TBD</b>
<p>