Home
Restitutio manualul-radioamatorului wiki!
Proiectul își propune reconstrucția (cu un pic de imaginație putem citi "construcția generică") unui manual tehnic. Toate uneltele de lucru, pe care le propunem, sunt exclusiv open source și pot fi utilizate fără restricții în contextul acestui proiect care este, de asemenea, open source.
Din punct de vedere structural, un manual tehnic este un ansamblu compus din următoarele elemente:
- Cuprinsul
- Conținutul tehnic
Conținutul este organizat în:
- Text formatat în paragrafe cu diferite stiluri
- Tabele
- Expresii matematice (formule, ecuații)
- Reprezentări 2D (grafice, diagrame, scheme etc.)
- Reprezentări 3D (ansambluri, subansambluri, repere etc.)
- Imagini foto sau desene cu conținut non-vectorizabil
Pentru input se vor accepta unul sau mai multe documente în format electronic non-vectorizat (scanare primară). În acest fel avem garanția că există niște copii de referință pentru revizuire modificări. E posibil ca un singur document să nu conțină toată informația (cauze: erori scanare, eroare umana, erori generare document post-scanare).
Pentru simplitate, outputul proiectului va fi text în format Markdown (GitHub Flavored Markdown). Pentru mai multe detalii referitoare la sintaxa Markdown vezi Sintaxa-Markdown.
Cuprinsul, într-o abordare top-to-bottom va fi primul element care va fi generat. Într-o formulă general aplicabilă, vom considera conținutul unui document tehnic ca fiind format din următoarele elemente:
- introducere
- parte
- capitol
- subcapitol
- secțiune
Ierarhic, elementele de mai sus, pot fi reprezentate în felul următor:
cuprins
|
+-- introducere
|
+-- partea P{NN} [întâi, a doua, a treia ...]
| |
| +-- capitol C{XX} [Capitolul I, II, III, IV ...]
| |
| +-- subcapitol S{AA} [A, B, C, D ...]
| |
| +-- secțiune T{nn} [1, 2, 3 ...]
|
+--
În cazul în care un element, la același nivel ierarhic, nu are alte elemente de același rang, notația acestuia se va face cu <!-- X. -->, unde X este indexul elementului, conform exemplului de mai jos:
## Capitolul V
### <!-- A. -->Aparate electroacustice
#### 1. Aparate pentru transformarea undelor sonore în curenți de audiofrecvență
#### 2. Aparate pentru convertirea curenților de audiofrecvență în unde sonore
## Capitolul VIConținutul oricărui manual tehnic este compus din:
- text simplu
- tabele
- expresii matematice (ecuații și formule)
- elemente grafice 2D (grafice, scheme, desene)
- elemente grafice 3D
- imagini foto sau capturi raster (bitmap)
Formatarea Markdown este suficient de flexibilă pentru a satisface cerințele de tehnoredactare primară.
Permite redactarea rapidă a listelor:
- simple
- numerotate
- unu
- doi
Formatarea **Markdown** este suficient de *flexibilă* pentru a satisface cerințele de tehnoredactare primară.
----
Permite redactarea rapidă a listelor:
- simple
- numerotate
1. unu
2. doi
#### Exemplu Formatarea Markdown permite editarea rapidă a unui tabel.
Vezi și https://help.github.com/articles/organizing-information-with-tables/
Sintaxa
|Denumirea materialului| Constanta dielectrică (ɛ) |
|---|---:|
|Hârtie bachelizată | 5,5 |
| Bachelită presată | 5,5 |
| Cuarț topit | 4,2 | Afișare
| Denumirea materialului | Constanta dielectrică (ɛ) |
|---|---|
| Hârtie bachelizată | 5,5 |
| Bachelită presată | 5,5 |
| Cuarț topit | 4,2 |
Pentru ecuații, formule, expresii matematice în general, vom utiliza limbajul LaTeX. Nu în mod direct, deoarece GitHub nu are (încă) suport direct pentru sintaxa LaTeX. Ecuațiile și formulele vor fi în format svg. Generarea acestora se va realiza cu ajutorul https://www.codecogs.com/latex/eqneditor.php. Se salveaza în format svg și se plasează în folderul equations (referit relativ față de locația documentului)
Pentru mai multe detalii referitoare la sintaxa LaTeX vezi 1.b Ce este LaTeX.
[MILIAMPERUL(mA)=\frac{1}{1000}A](equations/partea_01/capitolul_01/equ_6c0c896837fa4f2bb4e69acc0e427c22.svg)
<p align="center">
<img src="equations/partea_01/capitolul_01/equ_2a4b775f09a3415289fb5a1acf511126.svg" alt="Z=\sqrt{R^{2}+\left ( L_{\omega}-\frac{1}{C_{\omega}} \right )^{2}}" />
</p>
Vezi și 3.-Cum-fac#expresii-matematice
Schemele sau diagramele vor fi, în final, în format vectorial svg. Fișierele se plasează în directorul drawings (referit relativ față de locația documentului). În funcție de tipul elementelor grafice, se pot folosi:
- Inkskape - desenare generală https://inkscape.org/.
- Fritzing - prototipuri electronice http://fritzing.org/home/
- LibreCAD - desen tehnic 2D https://librecad.org/
Vezi și 3.-Cum-fac#reprezentări-2d-grafice-diagrame-scheme-etc
<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>
Fig. 1
Imaginile cu echipamente 3D vor fi desenate în FreeCAD, o aplicație CAD open source (https://www.freecadweb.org/). Se va exporta o proiecție izometrică (care va respecta regulile de formatare ale reprezentărilor 2D) în format svg. Sursele 3D, în cazul în care au dimensiuni peste 10MB, pot fi publicate pe https://grabcad.com.
Vezi și 3.-Cum-fac#reprezentări-3d-ansambluri-subansambluri-repere-etc
<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>
Fig. 4
Toate imaginile non-vectorizabile vor fi în format png. Acestea vor fi referite logic cu tag img, iar plasarea fizică va fi în folderul images (referit relativ față de locația documentului)
Vezi și 3.-Cum-fac#imagini-foto-sau-desene-cu-conținut-non-vectorizabil
<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>
Fig. 4
Dacă vrei să ne ajuți, vezi mai departe: