Yamyam: 1版をインポートしました

2018-06-28T21:11:44Z

1版をインポートしました

wiki>Koilz: ...

2014-11-04T11:39:49Z

...

新規ページ

__NOINDEX__

= rst notes =

; These are some notes I wrote down when making some patches for the [http://www.blender.org/manual/ rst manual].
; Feel free to use them for any other pages.

; I use [http://rst.ninjs.org/ 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
<pre>
Index: <directory>
===================================================================
--- <directory>
+++ <directory>
</pre>

; svn example
<pre>
Index: manual/introduction/introduction.rst
===================================================================
--- manual/introduction/introduction.rst
+++ manual/introduction/introduction.rst
</pre>

; git template
<pre>
diff --git <a directory> <b directory>
--- <a directory>
+++ <b directory>
</pre>

; git example
<pre>
diff --git a/manual/introduction/introduction.rst b/manual/introduction/introduction.rst
--- a/manual/introduction/introduction.rst
+++ b/manual/introduction/introduction.rst
</pre>

; 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.
<pre>
:kbd:`shortcuts` are not supported, generates parsing errors, best to use `shortcut`.
</pre>

; 3.
;text with subtex is bold in doc.

; 4.
; tables work, though only show the bottom divider.

<pre>
text
sub text
sub text
</pre>

== common rst syntax ==

; 1.
; ..

; 2. headers
<pre>
1111
****

2222
====

3333
----

4444
^^^^

5555
""""

6666
****
</pre>

; 3. format text
<pre>
*Italic*
**Bold**
`Not sure, may be Italic`
``Highlight``
</pre>

; 4. sub text
<pre>
title
sub text
sub text

sub title
sub sub text
sub sub text
</pre>

; 5.
; picture
<pre>
.. figure:: /images/file.jpg
</pre>

; width
<pre>
.. figure:: /images/file.jpg
:width: 300px
:figwidth: 300px
</pre>

; 6. keyboard
<pre>
:kbd:`Keyboard Command`

:kbd:`Ctrl-Alt-K`
</pre>

; 7. doc link
<pre>
:doc:`Name </directory/directory>`
</pre>

; 8. code
<pre>
::

pre formatted
pre formatted

.. code-block:: python

code
code
</pre>

; 9. table
<pre>
+-----+-----+
+table+table+
+-----+-----+
+table +
+-----+-----+
</pre>

== style guide ==

; 1.
; Pictures dont support headers.
; To refer to a location, or blend file, or action, probably best to write under the picture.

<pre>
.. figure:: /images/file.jpg

text: sub tex.
</pre>

; 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

← 古い版	2018年6月28日 (木) 21:11時点における版
(相違点なし)

利用者:Koilz/rstn - 版の履歴

Yamyam: 1版 をインポートしました

wiki>Koilz: ...

Yamyam: 1版をインポートしました