Forum

Welcome to ProjeQtOr new Forum. We migrated old forum to the new website.
You will find all your posts here, with your usual account.
Just one point : you’ll have to reinitialize your password. Use “Lost password” feature.

Updated User Manual...
 
Notifications
Clear all

Updated User Manual for 7.0.5 features and screens: I can help if needed

7 Posts
2 Users
0 Reactions
12.3 K Views
(@narayanaras)
Posts: 150
Active Member
Topic starter
 
[#5101]

Hi

After upgrading to 7.0.5, I downloaded the User Manual, and it turned out to be outdated (for v6.3).

I can help by writing the entire updated manual if some notes are provided (and if I can interact with the project leads here whenever I have a doubt).
Please let me know!


 
Posted : 26 Apr 2018 9H59
babynus
(@babynus)
Posts: 14966
Main Contributor Admin
 

Hi,

Thanks for your proposale.
Yes indeed, we are late in updating the user manual (shame on us :blush: )

You can of course contribute, but yu lust know that we use a very specific way to manage the user doc : sphinx-doc
Data is written is specific .rtf files, and then we generate the manual.
This is a bit weird to enter data, but great advantage is that with single description, we can generate several formats (the html online user manual and the pdf version)
You can find source at : https://sourceforge.net/p/projectorria/code/HEAD/tree/branches/V7.1/projeqtor/docs/user/


 
Posted : 26 Apr 2018 12H54
(@narayanaras)
Posts: 150
Active Member
Topic starter
 

Hi

I want to help in making of the User Manual.
I would prefer to-
1. download the current version of the manual,
2. open it in a GUI that offers WYSIWYG interface
3. edit the manual
4. save it (upload).

I have already installed Sphinx-doc, but it does not seem to have a GUI.
Can you recommend a WYSIWYG front-end GUI for it?

Also, can you please give a hint about how to do the four actions listed above?
(I should not be imposing on your time, so kindly point to any online documentation.)


 
Posted : 27 Apr 2018 10H39
babynus
(@babynus)
Posts: 14966
Main Contributor Admin
 

1. download the current version of the manual,

Here : https://sourceforge.net/p/projectorria/code/HEAD/tree/branches/V7.1/projeqtor/docs/user/
Then click "download snapshot"

2. open it in a GUI that offers WYSIWYG interface

Unfortunately it does not exist.
The best I could find is : http://rst.ninjs.org/
Not a WYSIWYG but helps with syntax and automatically displays result

3. edit the manual

You can copy .rst file in ninjs, edit it (and see result on right side), then copy back result

4. save it (upload).

Send us your work (at support@projeqtor.org)


 
Posted : 27 Apr 2018 11H00
(@narayanaras)
Posts: 150
Active Member
Topic starter
 

I tried that online editor, and copied the text of one of the rst files into the left pane.
In the right pane, it shows several orange boxes with "xxx is missing..." type errors.
This may be happening because it can load only one page at a time; and not the entire manual at a time.
So all hyperlinks and inserted images are reported as missing.

I have a suggestion: I am much much faster with LibreOffice writer.
I can also take large numbers of screenshots rapidly, with annotations.

So can I create a separate article in rtf, doc or odt format?
Although this won't be in the desired rst format, the text+images can be easily copied and pasted into rst format.

what do you think?


 
Posted : 27 Apr 2018 15H17
babynus
(@babynus)
Posts: 14966
Main Contributor Admin
 

It could be a workaround, even if this will require much formating from us afterwards (copy into rst files is not so easy...)


 
Posted : 27 Apr 2018 16H57
(@narayanaras)
Posts: 150
Active Member
Topic starter
 

OK, so I will start revising the manual page-by-page, and send you rtf files as they get ready.


 
Posted : 27 Apr 2018 17H31
Share:

Scroll to Top