Issue#3 english docs

[samanthahamilton]

Continued Read of English Docs

Issue linked:

Issue #3

Pages addressed:

• README
• index.html
• doc/index.html
• Sections 1.1 to 1.4

Notes:

Hi Sascha,

I made a couple of little edits to the README and main index pages. Just small, grammatical issues I notice when opening the docs today.

I've read and adjusted Section 1.0 About (previously "Round About"). I will continue with Section 2 soon!

Two notes for things I would suggest changing:

• The file app.revision_update for the Revision History Appendix A needs some spacing between the words. When it displays the words come out like this, "Revision 1.0.0-0Fri Oct 16 2020Sascha Manns" I just don't know how to fix it, sorry!

• The slogan on the index page is "A job-application creator that uses LaTEX with one simple click" but the slogan on the documentation page is "A job-application creator with LaTEX". I would suggest making them both the same? And perhaps re-written as, "Use LaTEX to create job applications with one simple click" or "Create job applications using LaTEX with one simple click".

Talk soon, Sam.

[samanthahamilton]

Continued Read of English Docs

Pages addressed:

• installation.xml
• usage.xml
• database.xml
• credits.xml

Notes:

I had time to go through the final 4 files for grammar, clarity, English-usage, etc. I have a couple quick questions:

• In Section 4.1, there is no discussion about the user interface at the bottom right (the editing screen). When you press the "edit" button in the top half, does this section become activated? I thought perhaps a sentence or two explaining this section might be useful.

On the Installation page:

• In the "Important" notice (line 92), it says to "comment out" a portion of the file. I want to make sure my re-wording is correct: Is the user commenting out two code sections within the file curriculum_vitae.tex? And what type of "comment out" is the user to apply? That is adding the marker, <!-- or */ or other, might be a helpful visual.
• For the title, the original wording was, "Download, Installation & Configuration." Normally in English you want the verbs to be of the same tense, which would make it, "Downloading, Installation & Configuration" however I think in this section you could also use the header, "Download, Install & Configure" --- your choice!!! But I wanted to let you know the option is there.
• Line 69/70 says, "You can also type file path in the Windows Explorers address field" but I feel like that sentence is missing something? Perhaps it should be, "You can also type file path in the Windows Explorer address field to..... action here" but I wasn't 100% sure what the action would be.

I also created some added line breaks in the Installation section to highlight and emphasize some key information, and break up the text a little.

Let me know what you think, and any other changes that might be necessary.

Cheers, Sam.

[saigkill]

Hi @samanthahamilton : the xml code, and also the app.revision_update file will build by a docbook builder. That builder sets it in the right way. For the slogan i would propose to use "Create job applications using LaTEX with one simple click" and use that one in all places. About the Section 4.1: In general the edit range works in the same way as the other one. Maybe you would like to write some sentence about that? Important Notice on Line 92: You're right. Commenting out in LaTEX works with the marker "%". Would you like to add a sentence about that? About Download wording: I would propse to use "Download, Install & Configure". About file path: The procedure works so (see the second picture on https://saigkill.github.io/latex_curriculum_vitae-dotnet/doc/cha.installation.html). You see a field, where are "Roaming > latex_curriculum_vitae". If you click in this field, you can type any path in it (like C:\Users), and Windows Explorer opens that path. If you type "%appdata%/latex_curriculum_vitae", Windows Explorer opens "C:\User\Username\AppData\Roaming\latex_curriculum_vitae". Hope that helps.

Thank you very much for your help :-) I'll merge the Pull Requests now.