@TamerGester @El_Artista the Natron documentation is already hosted on Read The Docs. When you try and edit a page from there it actually redirects/links to Github
There is a tool called pandoc
Famous for doc framework conversion. Let me test if we can convert it from doc > rst
@magdesign
Okay got it. Here is the workflow:
-
install pandoc:
https://pandoc.org/ -
Download the docx file and put it into a new folder. Rename the file without any space. @hellocatfood please rename the doc without space or use ‘_’ undersocre. It will be easy for rst compile as well.
-
now extract the docx file in terminal:
cd ‘your docx director’
lnx/osx:
unzip natron_docu.docx
win:
unzip .\natron_docu.docx
-
You will get a “media” folder inside the word folder. This contains images. copy the media folder and paste it in the docx folder you are working on.
-
now in the terminal type:
win:
pandoc.exe -f docx natron_docu.docx -t rst -o natron.rst
linux/OSX
pandoc -f docx natron_docu.docx -t rst -o natron.rst
You can preview your rst file online by copy pasting the text:
http://rst.ninjs.org/#
or you can install vscode plugin to edit further:
Here is an example. Used VSCODE later to further edit after getting RST fro Pandoc:
nat rst.zip (81.8 KB)
Big thanks for your help.
He added me as a contributor on his fork, so we can avoid creating 1000 of forks.
then we solved the task via discord communication and the ReText tool.
However, just followed your recommendation about the visual studio plugin, this now looks like its the way we could work! I think we are getting into it, its just a massive steep learning curve…
@cgvirus this is great! me and @magdesign were getting setup using ReText and editing the .rst files directly but this is a good other option.
@devernay would it be worth adding these instructions on getting set up to Writing documentation — Natron 2.3.15 documentation or is that of the scope of that tutorial?
BTW.
If I want to link in the document to another site of the document, how would I do this?
Check the label at the top of the .rst file that you want to link to. It’ll be something like .. _documentlabel:
And then to create the link in the document you’re writing write :ref:
Link name ` (that should have a backtick on each end but I don’t know how to escape a backtick here)
@magdesign @hellocatfood
Folks I have talked with ffmpeg folks and had to change some doc codes. Please see the update. Usually we go straight for tiff. Seems PNG and Tiff have some different algorithm preference issue. Have changed all in the doc. Please update those.
Thanks and sorry for the hassle.
Do you have a source for this?
“Seems PNG and Tiff have some patent code issue.”
What does that mean, you have to include some copyright infos?
and btw. since we are now getting into .rst, what else is needed in the docs?
I saw the section “Producing digital intermediates (empty) — Natron 2.3.16 documentation” is emty, what are “digital intermediates” ? If someone can tell me, I might fill up this section too…
(Digital intermediate - Wikipedia) => ?
Last time I check, there are many empty sections that we could if help. Shall we start a new topic because this one if for the FFMPEG.
What does that mean, you have to include some copyright infos?
No, not the copyright. It’s the RGBbe/le codec mismatch. PNG loves to call it be RGB"be", TIFF loves RGB"le". Although they are same.
I think that if the documentation is going to be making recommendations of formats to use/not to use due to patent issues then there really needs to be information about the issues to link to.
@cgvirus Do the FFmpeg people you spoke to have any information about the patent issues published somewhere (URL)?
I have pushed a PR on the doc.
All formats here are open. No question on law rights. The patent is a different meaning for “coding style”.
I have changed the word as “patent” may create confusion. Nothing to worry.
@hellocatfood and @magdesign please PM me your names or add them directly to https://github.com/NatronGitHub/Natron/blob/RB-2.3/Documentation/source/index.rst
I’m trying to convert a MXF from a FS7 into a TIFF sequence but I’m having colorspace issues. The result have a hue shift compare to the original. Any ideas?