Skip to content

Home

Jump to bottom
Mircea MATEI edited this page Feb 7, 2019 · 32 revisions

Restitutio manualul-radioamatorului wiki!

Introducere

Proiectul își propune reconstrucția unui manual tehnic. Din punct de vedere structural un manual tehnic este un ansamblu compus din următoarele elemente:

  1. Cuprins
  2. Text formatat în paragrafe cu diferite stiluri
  3. Ecuații (formule)
  4. Reprezentări 2D (grafice, diagrame, scheme etc.)
  5. Reprezentări 3D (ansambluri, subansambluri, repere etc.)
  6. Imagini foto sau desene cu conținut non-vectorizabil

Input

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).

Output

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

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 ...]
|
+--

Notarea elementelor care sunt singulare

Î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 VI

Ecuații și formule

Ecuațiile și formulele vor fi în format svg. Generarea acestora se poate realiza cu ajutorul https://www.codecogs.com/latex/eqneditor.php. Se salveaza în format svg și se plasează în folderul equations

Exemple

Sintaxa Markdown

[MILIAMPERUL(mA)=\frac{1}{1000}A](https://github.com/matei-tm/manualul-radioamatorului/blob/master/output/equations/partea_01/capitolul_01/equation_0002.svg)

MILIAMPERUL(mA)=\frac{1}{1000}A

Sintaxa Markdown + HTML

<p align="center">
 <img src="https://github.com/matei-tm/manualul-radioamatorului/blob/master/output/equations/partea_01/capitolul_01/equation_0001.svg" alt="x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}" />
</p>

x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}

Reprezentări 2D

Schemele sau diagramele vor fi în final în format vectorial svg. Un bun editor este Inkskape https://inkscape.org/.

Exemple

<p align="center">
 <img src="https://github.com/matei-tm/manualul-radioamatorului/blob/master/src/final/capitol1_fig1.svg" alt="capitol 1 figura 1" />
</p>
<p align="center">
 <i>Fig. 1</i>
</p>

capitol 1 figura 1

Fig. 1

Reprezentări 3D

Imaginile cu echipamente 3D pot fi desenate într-o aplicație CAD (Ex. Autodesk Inventor, AutoCAD etc). Se va exporta o proiecție izometrică în format svg. Sursele 3D, în cazul în care au dimensiuni peste 10MB, pot fi publicate pe https://grabcad.com.

Imagini foto sau desene cu conținut non-vectorizabil

Toate imaginile non-vectorizabile vor fi în format png. Acestea vor fi referite logic cu tag img, iar plasarea fizică va fi în folderul output/images

Exemple

<p align="center">
 <img src="https://github.com/matei-tm/manualul-radioamatorului/blob/master/output/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

Manualul radiomatorului

Clone this wiki locally