-
Notifications
You must be signed in to change notification settings - Fork 3
1.d. Organizarea proiectului
Pentru început, să ne lămurim cu organizarea proiectului. Pentru o urmărire facilă și, eventual, pentru a putea ușor separa efortul în subproiecte, propunem ca fiecare capitol să fie un agregat format dintr-un document cu ecuații, desene vectoriale și imagini. În acest scop, la adăugarea unui issue cu denumirea Reconstrucție Partea XX - Capitol YY pentru capitol YY din partea XX, se vor genera (TODO: generare automată din denumire issue+label) în folderul output, următoarele:
- un document cu denumirea DOCUMENT-PARTEA_XX-CAPITOLUL_YY.md
- un director drawings/partea_XX/capitolul_YY
- un director equations/partea_XX/capitolul_YY
- un folder images/partea_XX/capitolul_YY
Proiectul conține trei directoare:
- input - pentru fișierele de start (scan-uri, cerințe tehnice, rastere, etc...)
- output - pentru agregarea fișierelor, rezultate din procesul de tehnoredactare, din folderul src
- src - pentru sursele fișierelor de lucru (secțiuni subcapitole, proiecte 3D FreeCAD, desene Inkscape)
Ierarhic, structura directoarelor se prezintă după cum urmează:
project
| README.md
| ...
|
+-- input
+-- output
| | DOCUMENT.md
| | DOCUMENT-PARTEA_01-CAPITOLUL_01.md
| | DOCUMENT-PARTEA_01-CAPITOLUL_02.md
| | ...
| |
| +-- drawings
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0001.svg
| | | ...
| |
| +-- equations
| | +-- partea_01
| | +-- capitolul_01
| | | equ_fcc9cae001c848c1a15056663a58dc40.svg
| | | equ_f35a681a1e694a89bcd236e4dc1dc128.svg
| | | ...
| |
| +-- images
| +-- partea_01
| +-- capitolul_01
| | fig_0f17db4471b24b46a6610469d797da38.png
| | ...
|
|
+-- src
| |
| +-- draft
| | +-- freecad
| | | +-- fig004
| | | | Ansamblu.FCStd
| | | | Pompa.FCStd
| | | | ...
| | |
| | +-- inkskape
| | +-- fig002
| | | capitol1_fig2_sursa.svg
| | | ...
| +-- contribution
| +-- drawings
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0001.svg
| | | ...
| |
| +-- equations
| | +-- partea_01
| | +-- capitolul_01
| | | equ_fcc9cae001c848c1a15056663a58dc40.svg
| | | equ_f35a681a1e694a89bcd236e4dc1dc128.svg
| | | ...
| |
| +-- images
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0f17db4471b24b46a6610469d797da38.png
| | | ...
| |
| | P_01-C_01-S_A-T_1.md
| | P_01-C_01-S_A-T_2.md
| | ...
| ...
Distingem două cazuri:
- figuri cu numerotare preexistentă (fig. 1, fig. 2, etc...)
- elemente grafice sau ecuații fără numerotare preexistentă
Fișierele se vor denumi:
- fig_nnnn.svg - elemente grafice vectoriale pentru figura numărul nnn
- fig_yyyy.png - figura cu numărul yyyy, în format non-vectorial png.
Numerotarea va respecta valoarea din documentul original
Numerotarea va utiliza identificatori de tip GUID. În cazul în care sunt mai mulți editori care generează conținut în același capitol, e imposibil să apară conflicte de sincronizare a unor resurse cu aceeași denumire (fișiere denumite identic dar cu conținut diferit). Fiecare editor va utiliza un generator de identificatori de tip GUID în formatul
Toate referințele din document, vor fi denumite cu ajutorul unui GUID în formatul:
- fig_GUID.svg - elementele grafice vectoriale pentru figuri
- fig_GUID.png - elementele grafice non-vectoriale (raster/bitmap) pentru figuri
- equ_GUID.svg - ecuații
unde GUID este în formatul 1234567890abcdef1234567890abcdef
Editorii vor lucra exclusiv în folderul src. Fiecare editor (sau un grup colaborativ) va genera conținut în următoarele:
- directorul draft
- folderul freecad - proiecte 3D
- folderul inkscape - reprezentări grafice svg
- directorul contribution
- fișierul P_xx-C_yy-S_aa-T_nn.md - documentul tehnic pentru Partea xx, Capitolul yy, Subcapitolul aa, secTiunea nn
- folderul drawings/partea_xx/capitolul_yy - pentru reprezentări 2D
- folderul equations/partea_xx/capitolul_yy - pentru expresii matematice în format svg
- folderul images/partea_xx/capitolul_yy - pentru imagini raster
project
|
+-- src
| |
| +-- draft
| | +-- freecad
| | | +-- fig004
| | | | Ansamblu.FCStd
| | | | Pompa.FCStd
| | | | ...
| | |
| | +-- inkskape
| | +-- fig002
| | | capitol1_fig2_sursa.svg
| | | ...
| +-- contribution
| +-- drawings
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0001.svg
| | | ...
| |
| +-- equations
| | +-- partea_01
| | +-- capitolul_01
| | | equ_fcc9cae001c848c1a15056663a58dc40.svg
| | | equ_f35a681a1e694a89bcd236e4dc1dc128.svg
| | | ...
| |
| +-- images
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0f17db4471b24b46a6610469d797da38.png
| | | ...
| |
| | P_01-C_01-S_A-T_1.md
| | P_01-C_01-S_A-T_2.md
| | ...
| ...
Documentul final e într-o stare de continuă schimbare. Acesta este o însumare a documentelor parțiale ale capitolelor. Varianta curentă se găsește în folderul output/DOCUMENT.md
Fiecare tip de conținut (text/2d/3d/foto) din parte/capitol este "plasat" automat în folderul output în containerul aferent. Informațiile sunt preluate din directorul de lucru src/contribution
De exemplu
project
| README.md
| ...
|
+-- input
+-- output
| | DOCUMENT.md
| | DOCUMENT-PARTEA_01-CAPITOLUL_01.md
| | DOCUMENT-PARTEA_01-CAPITOLUL_02.md
| | ...
| |
| +-- drawings
| | +-- partea_01
| | +-- capitolul_01
| | | fig_0001.svg
| | | ...
| |
| +-- equations
| | +-- partea_01
| | +-- capitolul_01
| | | equ_fcc9cae001c848c1a15056663a58dc40.svg
| | | equ_f35a681a1e694a89bcd236e4dc1dc128.svg
| | | ...
| |
| +-- images
| +-- partea_01
| +-- capitolul_01
| | fig_0f17db4471b24b46a6610469d797da38.png
| | ...
|
Manualul radiomatorului