利用者:Koilz/rstn

rst notes

These are some notes I wrote down when making some patches for the rst manual.

Feel free to use them for any other pages.

I use rst.ninjs.org to write rst pages.

I did try make a local rst previewer using 'jquery' + 'markitup!'.

I couldnt get it to work for some reason.

notes

git diff commands

phabricator workflow

patches

ninjs differences

common rst syntax

style guideline (bold obs)

win carridge return byte

The text editors distributed with windows, save files with a different byte value.

I dont know if it matters, maybe git ignores, though it may be best to use a compatible text editor.

workflow

git diff commands

..

phab workflow

..

patch diff

svn template

Index: <directory>
===================================================================
--- <directory>
+++ <directory>

svn example

Index: manual/introduction/introduction.rst
===================================================================
--- manual/introduction/introduction.rst
+++ manual/introduction/introduction.rst

git template

diff --git <a directory> <b directory>
--- <a directory>
+++ <b directory>

git example

diff --git a/manual/introduction/introduction.rst b/manual/introduction/introduction.rst
--- a/manual/introduction/introduction.rst
+++ b/manual/introduction/introduction.rst

The diff part of the patch can be generated from two files using different tools.

diff

diff for windows

winmerge for windows

rst.ninjs. org

1.

pictures are not supported, doesnt generate errors.

2.

:kbd:`shortcuts` are not supported, generates parsing errors, best to use `shortcut`.

3.

text with subtex is bold in doc.

4.

tables work, though only show the bottom divider.

text
    sub text
    sub text

common rst syntax

1.

..

2. headers

1111
****

2222
====

3333
----

4444
^^^^

5555
""""

6666
****

3. format text

*Italic*
**Bold**
`Not sure, may be Italic`
``Highlight``

4. sub text

title
    sub text
    sub text

    sub title
        sub sub text
        sub sub text

5.

picture

.. figure:: /images/file.jpg

width

.. figure:: /images/file.jpg
   :width: 300px
   :figwidth: 300px

6. keyboard

:kbd:`Keyboard Command`

:kbd:`Ctrl-Alt-K`

7. doc link

:doc:`Name </directory/directory>`

8. code

::

    pre formatted
    pre formatted

.. code-block:: python

    code
    code

9. table

+-----+-----+
+table+table+
+-----+-----+
+table      +
+-----+-----+

style guide

1.

Pictures dont support headers.

To refer to a location, or blend file, or action, probably best to write under the picture.

.. figure:: /images/file.jpg

   text: sub tex.

Maybe tables could be used.

2.

I guess unique object id's can be bold.

Italic to refer to UI widgets.

Probably best not to over use.

3.

For key keyboard combo shortcuts, like Alt+C, best to use alt-c or Alt-C I guess.

Not sure which is prefered, lower or higher case.

x page

Notes.

Rewrite.

Check.

RST.

Patch.

bf-docboard.

...

Add patch to tracker. Add pictures. I guess.

tools

People are currently testing different workflows and tools.

bf-docboard