Rst handbook

You can override this if you wish:. For example, if the WordPress code starts like this:. The code directive has been included in docutils since version 0. To ease the transition, two aliases for code directive are provided: code-block and sourcecode :. Assuming you have a foo. Will include the source code from foo. Listings support the same options reST includes support including various options for controlling which parts of the file are included , and also a linenos option for Sphinx compatibility.

Formerly, start-at and end-at options were supported; however, they do not work anymore since v6. You can also use start-line and end-line. The small thumbnail will be placed in the page, and it will be linked to the bigger version of the image when clicked, using baguetteBox by default. All options supported by the reST image directive are supported except target. Providing alt is recommended, as this is the image caption. If a body element is provided, the thumbnail will mimic the behavior of the figure directive instead:.

This directive is a thin wrapper around Pygal and will produce charts as SVG files embedded directly in your pages.

For examples of what each kind of graph is, check here. You can use any option described in the pygal docs. Finally, the content of the directive is the actual data, in the form of a label and a list of values, one series per line. Take a look at my other post about theme creating. Take a look at Creating a Theme to know how to do it. The reference in angular brackets should be the slug for the target page. You can also use the title, and Nikola will slugify it for you, so Creating a theme is also supported.

Keep in mind that the important thing is the slug. No attempt is made to check if the fragment points to an existing location in the page, and references that don't match any page's slugs will cause warnings. Any post or page that uses this directive will be considered out of date, every time a post is added or deleted, causing maybe unnecessary rebuilds.

On the other hand, it will sometimes not be considered out of date if a post content changes, so it can sometimes be shown outdated, in those cases, use nikola build -a to force a total rebuild. This directive can be used to generate a list of posts.

You could use it, for example, to make a list of the latest 5 blog posts, or a list of all blog posts with the tag nikola :. The index of the first post to show. A negative value like -3 will show the last three posts in the post-list. Defaults to None. The index of the last post to show. A value negative value like -1 will show every post, but not the last in the post-list.

Sort post list by one of each post's attributes, usually title or a custom priority. Defaults to None chronological sorting. Filter posts to show only posts having at least one of the tags. Change tag filter behaviour to show only posts that have all specified tags. Defaults to False. Filter posts to show only posts having one of the categories. Filter posts to show only posts having at least one of the slugs. Show only posts , pages or all.

Replaces all. Defaults to posts. Defaults to show only posts. The name of an alternative template to render the post-list. A manual id for the post list. By default, this is an unordered list with dates and clickable post titles. See the template file in Nikola's base theme for an example of how this works.

The list may fail to update in some cases, please run nikola build -a with the appropriate path if this happens. If you are using this as a shortcode, flags reverse , all are meant to be used with a True argument, eg. ReStructured Text is "compiled" by docutils, which supports a number of configuration options.

It would be difficult to integrate them all into Nikola's configuration, so you can just put a docutils. More information in the docutils configuration reference. If you like Nikola, and want to start using it, but you have a WordPress blog, Nikola supports importing it.

Here are the steps to do it:. Get an XML dump of your site 1. It currently supports the following:. This will format the posts including supported shortcodes the same way as WordPress does.

Use the --transform-to-html option to convert your posts to HTML. If you use this option, you do not need to install the plugin permanently. You can ask Nikola to install the plugin into the subdirectory plugins of the current working directory by specifying the --install-wordpress-compiler option.

You can leave the posts the way they are and use the WordPress page compiler plugin to render them when building your new blog. This also allows you to create new posts using the WordPress syntax, or to manually add more shortcode plugins later. Use the --use-wordpress-compiler option to not touch your posts.

If you want to use this option, you have to install the plugin permanently. You can ask Nikola to install the plugin into your new site by specifying the --install-wordpress-compiler option. You can let Nikola convert your posts to Markdown. This is the default option and requires no plugins. Please note that the page compiler currently only supports the [code] shortcode, but other shortcodes can be supported via plugins. This feature is a work in progress, and the only way to improve it is to have it used for as many sites as possible and make it work better each time, so we are happy to get requests about it.

The dump needs to be in 1. If it says 1. It is possible to either import into a location you desire or into an already existing Nikola site.

To do so you can specify a location after the dump:. If the folder already exists Nikola will not overwrite an existing conf. Instead a new file with a timestamp at the end of the filename will be created. Twitter Cards enable you to show additional information in Tweets that link to your content. Nikola supports Twitter Cards. They are implemented to use Open Graph tags whenever possible. To enable and configure your use of Twitter Cards, please modify the corresponding lines in your conf.

If you want extra plugins, there is also the Plugins Index. Similarly to themes, there is a nice, built-in command to manage them — plugin :. You can also share plugins you created with the community! Visit the GitHub repository to find out more. For pdb debugging in Nikola, you should use doit.

By default, doit and thus Nikola redirects stdout and stderr. Thus, you must use the different call.

Alternatively, you could run with nikola build -v 2 , which disables the redirections. Since Nikola is a command line tool, and this is the 21st century, it's handy to have smart tab-completion so that you don't have to type the full commands.

To enable this, you can use the nikola tabcompletion command like this, depending on your shell:. The --hardcode-tasks adds tasks to the completion and may need updating periodically.

Nikola is released under the MIT license , which is a free software license. Some components shipped along with Nikola, or required by it are released under other licenses. If you are not familiar with free software licensing, here is a brief explanation this is NOT legal advice : In general, you can do pretty much anything you want — including modifying Nikola, using and redistributing the original version or the your modified version.

However, if you redistribute Nikola to someone else, either a modified version or the original version, the full copyright notice and license text must be included in your distribution.

Read the full license text for details. Themes Plugins Shortcodes. Version 8. Getting Help Why Static? Build the site: nikola build Start the test server and open a browser: nikola serve -b That should get you going. If you want to know more, this manual will always be here for you.

Nikola can do: A blog example Your company's site Your personal site A software project's site example A book's site Since Nikola-based sites don't run any code on the server, there is no way to process user input in forms. Why Static? So, let's see some reasons for using static sites: Security Dynamic sites are prone to experience security issues.

A smaller software stack implies less security risk. Obsolescence If you create a site using for example WordPress, what happens when WordPress releases a new version? Also, static sites are easily handled by the Internet Archive.

Cost and Performance On dynamic sites, every time a reader wants a page, a whole lot of database queries are made. Lock-in On server-side blog platforms, sometimes you can't export your own data, or it's in strange formats you can't use in other services.

With Nikola, you own your files, and you can do anything with them. May be displayed by some themes. Translated posts can have different values for this field, and the correct one will be used. The currently supported metadata formats are: reST-style comments.. They look like the beginning of our reST files Note Keys are converted to lowercase automatically. Finally, note that destination can be translated, i.

Warning Removing the. Use date-based path when creating posts? In reStructuredText If you want to change that text, you can use a custom teaser Out of the box, we have compilers available for: reStructuredText default and pre-configured Markdown pre-configured since v7. For those options, two types of values can be provided: a string, which will be used for all languages a dict of language-value pairs, to have different values in each language Note As of version 8.

Example: conf. Template tweaking and creating themes If you really want to change the pages radically, you will want to do a custom theme. Only one level of submenus is supported.

Requires JavaScript. Initialize a git repository in your Nikola source directory by running: git init. We recommend adding at least the following entries: cache. Moot Support Moot doesn't support comment counts on index pages, and it requires adding this to your conf.

Thumbnail images will be created there as well. The most common ones are: 0th Information about the image itself Exif Information about the camera and the image 1st Information about embedded thumbnails usually nothing thumbnail An embedded thumbnail, in JPEG format usually nothing GPS Geolocation information about the image Interop Not too interesting at this point. The currently available filters are: Creating your own filters You can use any program name that works in place as a filter, like sed -i and you can use arbitrary Python functions as filters, too.

As a silly example, this would make everything uppercase and totally break your website: import string from nikola. For example here are two random videos You can override this if you wish To ease the transition, two aliases for code directive are provided: code-block and sourcecode Note Formerly, start-at and end-at options were supported; however, they do not work anymore since v6. If a body element is provided, the thumbnail will mimic the behavior of the figure directive instead Here's an example of how it works You can use any option described in the pygal docs Finally, the content of the directive is the actual data, in the form of a label and a list of values, one series per line.

In this case we are giving the portion of text we want to link. So, the result will be: Take a look at my other post about theme creating. Docutils Configuration ReStructured Text is "compiled" by docutils, which supports a number of configuration options. Allows you to export your comments with each post Exports information on attachments per post There are different methods to transfer the content of your posts: You can convert them to HTML with the WordPress page compiler plugin for Nikola.

There are elements, however, that don't inherit from bodytext, for example headings and the styles used in the table of contents. Those are elements that are not real paragraphs, so they should not follow the indentation and spacing you use for your document's main content. The heading style is inherited by all sorts of titles: section titles, topic titles, admonition titles, etc.

Yes, these are table styles, because they are implemented as tables. Remember that this is only used between items and not before the first or after the last items. Rst2pdf adds a non-standard directive, called code-block, which produces syntax highlighted for many languages using Pygments. Notice that you need to declare the language of the fragment. Here's a list of the currently supported. You can use any of them instead of the default by adding, for example, a -s murphy to the command line.

The overal look of a code box is controlled by the "code" style or by a class you apply to it using the.. Aditionally, if you want to change some properties when using different languages, you can define styles with the name of the language.

For example, a python style will be applied to code blocks created with.. Rst2pdf has a very limited mechanism to pass commands to reportlab, the PDF generation library. You can use the raw directive to insert pagebreaks and spacers other reportlab flowables may be added if there's interest , and set page transitions.

The unit used by the spacer by default is points, and using a space or a comma is the same thing in all cases. For example, if the first pages are a coverpage and a table of contents, you want page 1 to be where your first section starts. This sets the counter to 0, and makes it display in lower roman characters i, ii, iii, etc which is a style often used for the pages before the document proper for example, TOCs and abstracts. When used with two arguments, the first argument must be a number, it sets the page counter to that number.

If you want to jump to the next frame in the page or the next page if the current frame is the last , you can use the FrameBreak command. It takes an optional height in points, and then it only breaks the frame if there is less than that vertical space available. For example, if you don't want a paragraph to begin if it's less than 50 points from the bottom of the frame:. Page transitions are effects used when you change pages in Presentation or Full Screen mode depends on the viewer.

You can use it when creating a presentation using PDF files. Keep in mind that Transition sets the transition from this page to the next so the natural thing is to use it before a PageBreak:.

To enable this, use the --raw-html command line option. This is a nonstandard interpreted text role, which means it will only work with rst2pdf. It implements an unlimited number of counters you can use in your text.

For example, you could use it to have numbered figures, or numbered tables. This is a nonstandard directive, which means it will only work with rst2pdf, and not with rst2html or any other docutils tool. The contents of oddeven should consist of exactly two things in this case, two paragraphs. The first will be used on odd pages, and the second one on even pages.

If you want to use more complex content, you should wrap it with containers, like in this example:. If you have Matplotlib installed, rst2pdf supports a math role and a math directive.

You can use them to insert formulae and mathematical notation in your documents using a subset of LaTeX syntax, but doesn't require you have LaTeX installed. Currently, the math role is slightly buggy, and in some cases will produce misaligned and generally broken output.

Also, while the math directive embeds fonts and draws your formula as text, the math role embeds an image.

That means:. You can also use an inline substitution of the math directive for things you use often, which is the same as using the math role:. You don't need to worry about fonts, the correct math fonts will be used and embedded in your PDF automatically they are included with matplotlib. To do it, you need to install Wordaxe [2]. For more information, see this issue in rst2pdf's bug tracker. Also, you may need to set hyphenation to true in one or more styles, and the language for hyphenation via the command line or paragraph styles.

If you are not an english speaker, you need to change the language using the -l or --language option. Since Wordaxe version 0. PyHyphen can use any OpenOffice dictionary, and can even download them automatically. If you are creating a multilingual document, you can declare styles with specific languages. For example, you could inherit bodytext for spanish:. If you explicitly configure a language in a paragraph style and also pass a language in the command line, the style has priority, so remember:.

If you configure the bodytext style to have a language, your document is supposed to be in that language, regardless of what the command line says. By default, your document will have a single column of text covering the space between the margins. You can change that, though, in fact you can do so even in the middle of your document! To do it, you need to define Page Templates in your stylesheet. The default stylesheet already has 3 of them:.

A page template has a name oneColumn, twoColumn , some options, and a list of frames. A frame is a list containing this:. For example, this defines a frame "at the very left", "at the very bottom", "a bit less than half a page wide" and "as tall as possible":.

Since we can have more than one template, there is a way to specify which one we want to use, and a way to change from one to another. To specify the first template, do it in your stylesheet, in pageSetup oneColumn is the default :. Then, to change to another template, in your document use this syntax will change soon, though :. The background should be an image, which will be centered in your page or stretched to match your page size, depending on the --fit-background-mode option, so use with caution.

Quoted from the smartypants documentation:. You can enable this by passing the --smart-quotes option in the command line.

By default, it's disabled. Here are the different values you can use again, from the smartypants docs :. Currently, even if you enable it, this transformation will only take place in regular paragraphs, titles, headers, footers and block quotes. Kerning is the process of adjusting letter spacing. It is usually accepted that kerning makes your text look better.

For convenience, a stylesheet that uses DejaVu fonts with kerning is provided as kerning. Sphinx is a very popular tool. This is the description from its website:. Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created to translate the new Python documentation, and it has excellent support for the documentation of Python projects, but other documents can be written with it too.

Then you can run make pdf or sphinx-build -b pdf Rst2pdf can get new features from extensions. Extensions are python modules that can be enabled with the -e option. The design goal of "base rst2pdf" is to be completely compatible with docutils, such that a file which works as a PDF can also work as HTML, etc.

Unfortunately, base docutils is a slow-moving target, and does not make this easy. So, while it would be nice to have documents that render perfectly with any backend, this goal is hard to achieve for some documents, and once you are restricted to a particular transformation type, then you might as well have a slightly nicer syntax for your source document. The preprocessor generates a file that has the same name as the source file, with.

This file is left on the disk after operation, because any error messages from docutils will refer to line numbers in it, rather than in the original source, so debugging could be difficult if the file were automatically removed. The initial version is a proof of concept; uses subprocess in a naive way, and doesn't check return from inkscape for errors.

All I did was take the wrap method from the stock reportlab TOC generator, and make the minimal changes to make it work on MY documents in rst2pdf. The reportlab TOC generator adds nice dots between the text and the page number.

To build BIRD, run:. You may need to execute these and any following commands in this handbook as sudo. Before any validations with BIRD can be done, it must be configured accordingly. At the top of this file write:. The function itself checks for three entries in the ROA table and prints the corresponding validity status.

The BIRD socket must now be opened. In order to do that type the following command:. With the option -d BIRD runs in the foreground. It is required by the bird-rtrlib-cli which we will install next.

Open another new terminal. If everything was build correctly, there now should be an executable called bird-rtrlib-cli. Size Category Education. Compatibility iPhone Requires iOS Mac Requires macOS Languages English. Price Free. Family Sharing With Family Sharing set up, up to six family members can use this app. You Might Also Like. Boeing NG Normal Procedures. A Cockpit Systems. Boeing LoadSheet. CPaT Mobile 4. B MRG.