Search Results

Search found 22 results on 1 pages for 'restructuredtext'.

Page 1/1 | 1 

  • reStructuredText tool support

    - by Chen Levy
    I love reStructuredText, however the tools that support it are scattered all over the Internet. The official tool list is incomplete and/or outdated, and can be updated only via commit privileges. For some time there was a comprehensive list at the Wikipedia reStructuredText page, but this apparently "may not meet the notability guideline for web content" and is scheduled for removal. So to put it in a question form: What tool support can one expect to find when working with reStructuredText, e.g. text editors, Wiki software, converters to and from reStructuredText etc.?

    Read the article

  • How to reformat reStructuredText?

    - by wal-o-mat
    I'm writing reST in vim, which handles line breaks for me (after 80 chars). However, since I frequently go back and edit the text before, lines get ugly again. For example, in tables, it's sometimes annoying to re-format a complete table just because you need a line break in some place. So I wish I had a program that reads my ugly-but-correct reStructuredText and outputs it nicely formatted and wrapped. I found that pandoc in.rst -w rst mostly works, but it has some drawbacks. For example :author: John Doe becomes author John Doe and title formatting is changed as well. Sadly, there seems to be no rst2rst or something similar. Does anyone have some advice?

    Read the article

  • Sphinx, reStructuredText show\hide code snippets

    - by Adam Matan
    Hi, I've been documenting a software package using Sphinx and reStructuredText. Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little "Show\Hide" button that would expand them (Example). Is there a standard way to do that? If not, I think I will suggest this feature to the developers. Thanks, Adam

    Read the article

  • reStructuredText for SQL?

    - by Chris
    I am trying to use DocUtils and reStructuredText to comment SQL code. I can get this to work when I include the markup inside multi-line comments. I then use --Some text:: to introduce each block of code. I cannot get internal hyperlinks to work. I would like to write -- .. Step1_: but the parser ignores this because of the leading comment. Using a multi-line style also fails. Is there a way to get this to work? Here's an example: /* ========== this query ========== :Author: Me Outline ========== - Create table 1 - Create table 2 - Output the result */ -- _Step1: build the table:: create table table1 -- _Step2: use Step1_ to build table 2:: create table table2

    Read the article

  • How can I change from docbook to restructuredText?

    - by Paul Biggar
    I have a 30-ish page manual in docbook. However, working with docbook is so painful that I don't really update it. I want to switch to restructedText instead. I can't find any direct translator (the best I could find is ezComponents, but it fails on the docbook sgml). Maybe there is an indirect route through RTF or some other format, but I can't figure it out. Any ideas? PS The current conversion process is: docbook -> jade -> html docbook -> jade -> tex -> pdflatex -> pdf

    Read the article

  • Sphinx: cross-reference indexed item

    - by Unbeknown
    How can I cross-reference an indexed item inside a reStructuredText document? For example, how can I cross-reference SectionB: .. index:: pair: SectionA; SectionB SectionB -------- SectionB description. I tried using :ref:'SectionB' and :index:'SectionB' but they don't work. Thanks.

    Read the article

  • Extending rst container to output extra div attributes

    - by Manwe
    I'm starting to use pelican with reStructuredText rst page format. I have custom javascript (jQuery) things that I'd like to control with div attributes like data-default-tpl="basename" with nested content. What to extend and what. I've looked at Directives and nodes, but I just can't wrap my head around how to do it. .. rstdiv:: class1 class2 :name: namessid :extra: thisIsMyextra .. rstdiv:: nested class3 :name: nestedid :extra: data-default-tpl="basename" some text .. container:: This is normal rst container :name: contid text From rst to html with pelican. <div id="nameisid" class="class1 class2" thisIsMyextra> <div id="nestedid" class="nested class3" data-default-tpl="basename"> some text </div> </div> <div id="contid" class="container This is normal rst container"> text </div>

    Read the article

  • reStructured Text - Escape a headline?

    - by Rory
    I have a reStructuredText document. rST uses =====, etc. as a heading format. However I need to include some lines that have this text in it, e.g.: some of my text ===== stuff ===== some more of my text And I don't want the ==== to be interpreted as a heading, i.e. I don't want stuff to be a heading. I would rather that those equal signs are just displayed as is. Is this possible in rST?

    Read the article

  • Using the RST3 plugin in the Leo Outliner

    - by T-Boy
    I'm currently trying out the Leo Outliner, and I've heard quite a bit about the RST3 plugin that it has. I'm not planning to use Leo to program just yet -- at this point I'm wondering if it might be useful for generating HTML and PDF documents, as I'm quite currently enamored with RST and how it works. I'm using my Ubuntu Netbook Remix netbook (running 9.10, I believe). I think I've got it down pat, more or less -- I've installed docutils using the Synaptics Package Manager, and I think I've gotten SilverCity installed, as per the requirements -- I've downloaded the archive, and then run "sudo python setup.py install" with no errors. The thing is, I'm not exactly sure how to invoke the rst3 plugin itself. It doesn't appear in the Plugins menu for Leo right now, and the documentation I've managed to source doesn't seem to clearly explain how to use the plugin. Has anyone had any experience in using the rst3 plugin in Leo? It's a little confusing right now, and searches on Google doesn't seem to be helping much any more. I'm using the latest 4.7.1 final version of Leo from the Synaptics Package Manager (was informed that this would have offered the best integration with UNR, so I figured, what the heck). Have I missed out on any steps here, and are there any useful tutorials on how to use the rst3 plugin?

    Read the article

  • Is there a wysiwyg editor for restructured text?

    - by dar
    Is there a wysiwyg editor for the web, like tinymce or wmd, which can produce restructured text? I'm looking for something which can be integrated with django. I would like to use rst instead of markdown because I need to convert the content entered to pdf and do some layout specific things which make rst look like a better choice.

    Read the article

  • Visualizing rst diffs with rst2pdf

    - by Karol
    Is there an easy way to visualize the differences between rst files using rst2pdf? I know I could use rst2latex instead and then latexdiff to generate PDF files (and that is the effect I am after), but I would like to have the same style in the original and diff files.

    Read the article

  • Need advice - Developing a flexible documentation system, heavily focused on localization

    - by inkedmn
    I've been charged with building a documentation system/platform. Here's a short list of the major requirements: Easily localized : This will need to support a dozen or so languages out of the gate. (the ability for non-technical personnel to add/update translations would be a big plus, though not 100% required) Flexibility in output formats : At the bare minimum, I need to output the documents (either as a whole or in selected chunks) as PDF and HTML. Bonus points for native formats like Windows Help Files. Managed and deployed via an intuitive user interface (web, ideally). I'm wondering if you folks know of any systems out there that support this type of thing already? I'm not averse to writing this from scratch, but I'd rather not reinvent the wheel if I can help it. The two major candidates I've come across thus far are DocBook and reST. The former seems to have garnered a reputation for, well, sucking. I'm unfamiliar with either, but I'm told that reST would get me a good portion of the way there. Any other suggestions? Would I be better off building this from scratch?

    Read the article

  • Restructured Text - adding title attributes to links

    - by Ant
    Hi all, I am trying to use a jquery lightbox implementation on my website that is generated from Restructured Text. The lightbox takes the title of the link around the images as the caption of the image in the lightbox display. However, I can't seem to find a way in Restructured Text of providing a title attribute on a link - does anyone know of a way of doing so. My Images are defined like so: .. image:: image001.thumb.jpg :alt: Some alt text here :target: image001.jpg So I can add an alt attribute, but not a title. A possible alternative may be to use a target as the reference like so: .. image:: image001.thumb.jpg :alt: Some alt text here :target: image1_ .. _image1: image001.jpg In this latter case, I am not sure how to add attributes to the link defined at the bottom (if it is possible at all)

    Read the article

  • Programmatically convert *.odt file to MS Word *.doc file using an OpenOffice.org basic macro

    - by Chen Levy
    I am trying to build a reStructuredText to MS Word document tool-chain, so I will be able to save only the rst sources in version control. So far I -- Have rst2odt.py to convert reStructuredText to OpenOffice.org Writer format. Next I want to use the most recent OpenOffice.org (currently 3.1) that do a pretty decent work of generating a Word 97/2000/XP document, so I wrote the macro: sub ConvertToWord(file as string) rem ---------------------------------------------------------------------- rem define variables dim document as object dim dispatcher as object rem ---------------------------------------------------------------------- rem get access to the document document = ThisComponent.CurrentController.Frame dispatcher = createUnoService("com.sun.star.frame.DispatchHelper") rem ---------------------------------------------------------------------- dim odf(1) as new com.sun.star.beans.PropertyValue odf(0).Name = "URL" odf(0).Value = "file://" + file + ".odt" odf(1).Name = "FilterName" odf(1).Value = "MS Word 97" dispatcher.executeDispatch(document, ".uno:Open", "", 0, odf()) rem ---------------------------------------------------------------------- dim doc(1) as new com.sun.star.beans.PropertyValue doc(0).Name = "URL" doc(0).Value = "file://" + file + ".doc" doc(1).Name = "FilterName" doc(1).Value = "MS Word 97" dispatcher.executeDispatch(document, ".uno:SaveAs", "", 0, doc()) end sub But when I executing it: soffice "macro:///Standard.Module1.ConvertToWord(/path/to/odt_file_wo_ext)" I get a: "BASIC runtime error. Property or method not found." message On the line: document = ThisComponent.CurrentController.Frame And when I comment that line, the above invocation complete without error, but do nothing. I guess I need to somehow set the value of document to a newly created instance, but I don't know how to do it. Or am I going at it at a completely backward way? P.S. I will consider JODConverter as a fallback, because I try to minimize my dependencies.

    Read the article

  • WYSIWYG editor for structured text (suitable for SVN versioning)

    - by chris_l
    I'm looking for an open source cross platform WYSIWYG editor that I can use to write documentation. I'm not looking for a web based solution - i.e. it should work without a web server, and I want to save my files directly to disk. The result could be any structured format, like Wiki markup, ReStructuredText, DocBook, or a small subset of HTML, ... But it's important, that Subversion diff can be used to see differences between the versions easily (this wouldn't work with .odt or .rtf files for example) I'm currently thinking about using Open Office, and saving the files as HTML, but is there a better solution?

    Read the article

  • How to make flyspell bypass some words by context?

    - by manu
    Hi, I use Emacs for writing most of my writings. I write using reStructuredText, and then transform them to LaTeX after some preprocessing since I write my citations á-la LaTeX. This is an excerpt of one of my texts (in Spanish): En \cite[pp.~XXVIII--XXIX]{Crnkovic2002} se brindan algunos riesgos que se pueden asumir con el desarrollo basado en componentes, los This text is processed by some custom scripts that deals with the \cite part so rst2latex can do its job. When I activate flyspell-mode it signals most of the citation keys as spelling errors. How can I tell flyspell not to spellcheck things within \cite commands. Furthermore, how can I combine rst-mode and flyspell, so that rst-mode would keep flyspell from spellchecking the following? reST comments reST code literal reST directive parameters and arguments reST raw directive contents Any ideas?

    Read the article

1