Skip to content

3. Cum fac

Mircea MATEI edited this page Feb 19, 2019 · 10 revisions

Cum fac

Dacă nu ai citit despre organizarea proiectului, vezi 1.d-Organizarea-proiectului. După ce te-ai lămurit cu organizarea proiectului poți să te întorci aici
Editorii vor genera conținut doar în directorul src.

Unelte de editare

Pentru informații detaliate referitoare la instalarea uneltelor de editare vezi 1.c-Ce-unelte-folosesc

Editare/Formatare text

Recomandăm Visual Studio Code cu plugin-uri:

  • Markdown All in One
  • GitLens
  • Insert GUID

Editare expresii matematice

Pentru uniformitate recomandăm editorul https://www.codecogs.com/latex/eqneditor.php.

Editare reprezentări 2D

Inkskape https://inkscape.org/. Este un editor svg open source.

Indicații de editare

Textul

Textul se modifică în [output/DOCUMENT-PARTEA_xx-CAPITOLUL_yy.md] unde:

  • xx - partea X
  • yy - capitol YY

Utilizarea unui serviciu OCR

Puteți utiliza un serviciu de recunoaștere optică a textului. Sunt nenumărate variante free online. Un exemplu poate fi https://newocr.com. Dacă doriți să folosiți acest serviciu, am creat un scurt tutorial (68s) fără pretenții ultra academice:

IMAGE ALT TEXT HERE

Formatare exponenți

Pentru inserții de text care reprezintă cazuri izolate cu exponenți, puteri, indici superiori sau alte situații asemănătoare, în care nu este necesară o ecuație distinctă, se va folosi marcatorul <sup>.

Exemplu:

Energia sistemului este E = mc2

Energia sistemului este E = mc<sup>2</sup>

Formatare indici inferiori

Pentru inserții de text care reprezintă cazuri izolate cu indici inferiori sau alte situații asemănătoare, în care nu este necesară o ecuație distinctă, se va folosi marcatorul <sub>.

Exemplu:

Dioxidul de carbon se notează CO2

Dioxidul de carbon se notează CO<sub>2</sub>

Expresii matematice

Expresiile matematice complexe (formule, ecuații) vor fi definite în format svg. Fișierele svg se vor plasa in directorul equations, referit relativ față de locația documentului. Pentru generarea acestora se va folosi serviciul online https://www.codecogs.com/latex/eqneditor.php. Un scurt tutorial (58s) este prezentat mai jos:

IMAGE ALT TEXT HERE

La inserarea ecuațiilor formatul Markdown este următorul:

![MICROMPERUL(\mu A)=\frac{1}{1000000}A](equations/partea_01/capitolul_01/equ_5d0dd87858e2438ca508a7364f7e24bd.svg)

MICROMPERUL(\mu A)=\frac{1}{1000000}A

Formatare

Ecuațiile vor conține în eticheta Markdown (între parantezele pătrate []), sintaxa LaTeX.

Reprezentări 2D (grafice, diagrame, scheme etc.)

Schemele sau diagramele vor fi, în final, în format vectorial svg. Fișierul cu elementele grafice se salvează în directorul de lucru /src/contribution/drawings/partea_xx/capitolul_yy, conform cerințelor din 1.d-Organizarea-proiectului.
În funcție de tipul elementelor grafice, se pot folosi:

În document fișierele vor fi referite relativ, conform exemplelor următoare.

Exemple

<p align="center">
 <img src="drawings/partea_01/capitolul_01/fig_0001.svg" alt="capitol 1 figura 1" />
</p>
<p align="center">
 <i>Fig. 1</i>
</p>

capitol 1 figura 1

Fig. 1

[todo] https://github.com/fsmMLK/inkscapeMadeEasy, https://github.com/fsmMLK/inkscapeCircuitSymbols

Reprezentări 3D (ansambluri, subansambluri, repere etc.)

Reprezentările 3D se realizează cu ajutorul FreeCad. Proiectele se plasează în directorul src/contribution/freecad.
Sursele 3D, în cazul în care au dimensiuni peste 10MB, pot fi publicate pe https://grabcad.com.
Se va exporta o proiecție izometrică (care va respecta regulile de formatare ale reprezentărilor 2D) în format svg. Fișierul cu proiecția izometrică se salvează în directorul de lucru /src/contribution/drawings/partea_xx/capitolul_yy, conform cerințelor din 1.d-Organizarea-proiectului.

Exemple

<p align="center">
 <img src="drawings/partea_01/capitolul_01/fig_0004.svg" alt="capitol 1 figura 4" />
</p>
<p align="center">
 <i>Fig. 4</i>
</p>

capitol 1 figura 4

Fig. 4

Imagini foto sau desene cu conținut non-vectorizabil

Fișierul cu proiecția izometrică se salvează în directorul de lucru

Toate imaginile non-vectorizabile vor fi în format png. Acestea vor fi referite logic cu tag img, iar plasarea fizică va fi în folderul /src/contribution/images/partea_xx/capitolul_yy (referit relativ față de locația documentului), conform cerințelor din 1.d-Organizarea-proiectului.

Exemple

<p align="center">
 <img src="images/partea_01/capitolul_01/fig_0004.png" alt="capitol 1 figura 1" />
</p>
<p align="center">
 <i>Fig. 4</i>
</p>

capitol 1 figura 1

Fig. 4

Evoluție proiect

Conținutul subcapitolelor se poate dezvolta simultan.

Redesenare diagrame/scheme

Pentru început vom prelua imaginile în format bitmap din scanări. În final imaginile bitmap vor fi refăcute în format vectorial svg.