Dokumentation/Hjælp

From The Document Foundation Wiki
Jump to navigation Jump to search
This page is a translated version of the page Documentation/Help and the translation is 100% complete.
Other languages:
English • ‎dansk • ‎español • ‎italiano • ‎русский • ‎فارسی


LibreOffices Hjælp undergik en radikal ændring med version 6.1 og vises nu i systemets browser.

Warning.svg

Warning:
Udvidelsen HelpAuthoring anses nu som FORÆLDET. Undgå at bruge den til at redigere hjælpesider, da den kan ødelægge Hjælp XML.


Introduktion til redigering af LibreOffice Hjælp

LibreOffice Hjælp-sider er tekstsider i XML (Extensive Markup Language). Her er der et sammendrag, der hjælper dig med at bidrage til Hjælp-projektet:

Mine aktuelle færdigheder Enkle opgaver (slåfejl, grammatik, lingvistik) Mellemsvære opgaver (opdatering i henseende til aktuel version, omordning af menuer, bedre formatering) Stort omfang (nye sider om funktionaliteter, tilføj billeder og multimedier, mange berørte filer...)
Jeg har en Gerrit-konto, jeg kan XHP Rediger XHP-filen direkte i Gerrit Det kan være svært at redigere i Gerrit, undgå det. Endnu hårdere, undgå det.
Jeg har klonet undermodulet Hjælp, jeg kan teste lokalt, jeg har udviklingsfærdigheder og kan XHP Rediger XHP-filen lokalt, konstruere, teste og indsende en rettelse Det samme som enkle opgaver Det samme som enkle opgaver
Ingen af ovennævnte, jeg har ingen færdigheder i udvikling eller XML, men jeg er god til at dokumentere. Send en email til dokumentationslisten. Giv så mange oplysninger som muligt, eller endnu bedre tilføj den side, du vil ordne. Åbn en fejlrapport i Bugzilla for at rapportere manglen, det er endnu bedre, hvis du tilføjer den side, der skal ordnes. Åbn en fejlrapport i Bugzilla for at rapportere manglen/forbedringen. Vedhæft filer med foreslået indhold. Tilføj så meget som muligt, det er endnu bedre, hvis du tilføjer den side, der skal ordnes.

Dokumentation til Hjælp-redigering

Et minimalt kendskab til XML eller endda HTML er nødvendigt. The XML til LibreOffices Hjælp (også kendt som XHP) er ikke svært at fatte, hvis du kender de grundliggende ideer i XML. Det vil være nyttigt til små ændringer, indtil du bliver mere fortrolig med, hvad du må og ikke må i LibreOffice Hjælp-filer.

Dokumentation til forståelse, affattelse og redigering af LibreOffice Hjælp kan findes i online version. Disse wiki-sider er under revision og forbedring og vil følge udviklingen i LibreOffice Hjælp-ressourcer.

Den vigtigste wiki-side til XHP er side 2: XHP Referencer.

Den originale PDF-bog er tilgængelig: Forstå, affat og rediger OpenOffice.org HELP (PDF). Bemærk, at denne bog nu er forældet.

Rediger LibreOffice Hjælp-filer direkte i gerrit

En fyldestgørende side om emnet er tilgængelig her

Rediger LibreOffice Hjælp-filer på din lokale computer

Kilder til LibreOffice Hjælp med git

Kilderne til LibreOffice Hjælp findes i git. Den letteste måde at sætte alting op på er simpelthen af at tilføje denne linje i din autogen.input-fil i din kerne LibreOffice-mappe:

--with-help=html

Den næste gang, du nu kører make, bliver undermodulet Hjælp klonet ins i helpcontent2 og konfigureret automatisk. Den eneste manuelle konfiguration, du har brug for for at gøre, er at tilføje pushurl-en:

cd helpcontent2 && git remote set-url --push origin ssh://logerrit/help

Derefter kan du arbejde med git-depotet på sædvanlig vis:

Læs Hvordan sættes gerrit op første gang og Hvordan sendes en rettelse til korrektur. Hvis du har problemer med opsætningen, kontakt venligst udvidklerne på #libreoffice-dev IRC://-kanalen. De vil være glade for at hjælpe dig!

Kilder til Hjælp som pakket arkiv

Indrømmet, git er den sikreste måde at få den seneste kildekode til hjælp. Men hvis git ikke er en løsning for dig, kan du downloade Hjælp-kildefilen som en tarball og dekomprimere den til din arbejdsmappe.

For at downloade den seneste kildekode til Hjælp ser du efter den seneste version på denne side

http://download.documentfoundation.org/libreoffice/src/X.Y.Z/ hvor X, Y and Z skal erstattes af den seneste version. For eksempel (24. maj 2017) er X.Y.Z 5.4.0 .

Rediger Hjælp

Der findes en kort manual, der beskriver, hvordan Hjælp-indholdet skal affattes here.

Sådan findes den fil, der skal arbejdes på

Når du har kilderne til Hjælpen og strengen, du vil ændre (som at ændre den "brede vifte af muligheder" på https://help.libreoffice.org/Writer/Writer_Features#Designing_and_Structuring), gør du:

cd helpcontent2
git grep "wide variety of options"

Dette returnerer dette til dig:

source/text/swriter/main0503.xhp:<paragraph role="paragraph" id="par_id3147239" xml-lang="en-US" l10n="U" oldref="10">$[officename] offers ...

hvis betyder, at denne findes i source/text/swriter/main0503.xhp

Hvordan ændres det

Warning.svg

Warning:
Udvidelsen HelpAuthoring er FORÆLDET.


Med tekst-baseret redigering

Praktisk talt enhver tekstbehandler kan åbne filen .xhp (det er fx Kate i KDE, gedit i Gnome eller Notepad2 i Windows. Måske vil du bruge vim eller en anden professionel xml-redigering).

Note pin.svg

Note:
Den tekstbaserede redigering skal understøtte filer i UTF-8.

  1. Åbn en Hjælp-fil i menuen Filer ▸ Åbn eller med funktionen Åbn med... fra en filhåndtering (fx i KDE, højreklik på filen og vælg Åbn med... ▸ Kate på kontekstmenuen).
  2. Fordi filerne kan være meget store og have et stort antal xml-mærker, du bruge funktionen Find (sædvanligvis Rediger ▸ Find... eller Ctrl + F).
  3. Lav de nødvendige ændringer (hvis du ikke er fortrolig med xml-mærker i Hjælp-filer, skal du sikre dig, at du ikke har rørt dem).
  4. Gem filen.

Den metode er god, når vi har brug for at lave mindre rettelser uden at røre XML-mærkernene, fx for at rette en slåfejl.

Med XHP-redigeringsassistenten

XHP-dokumentationsredigeringen giver nogen hjælp med at tjekke gengivelsen af .xhp-filerne. Den understøtter ikke alle xhp-mærker, men dækker et rimeligt udvalg. XHP-redigeringen giver ikke DTD-overenstemmelse, hvilket betyder, at stadig omhu er nødvendig under redigering af en .xhp-fil.

Forstå strukturen i LibreOffice Hjælp-filer

LibreOffice Hjælp-filen er sammensat af flere obligatoriske dele. Se på dette guidede eksempel.

Hvordan verificeres ændringer

Hvis du laver ændringer eller opretter en ny side i Hjælp, er det en god ide at tjekke, hvordan den vil se ud i brugerfladen. Du skal konstruere LibreOffices Hjælp.

Den første gang har du brug for at konstruere LibreOffice. For fremtiden kan det gøres ved at opdatere versionen fra tid til anden. Flere oplysninger om konstruktionen af LibreOffice kan findes på disse sider: til Linux, til Windows og til macOS.

Den lokale Hjælp

Brug indstillingen --with-help=html til autogen.sh, når du konstruerer LibreOffice

Den resulterende konstruktion er placeret i instdir/help/ sammen med mange ledsage-filer, der er nødvendige til at styre siderne. Åbn filen instdir/help/index.html fra din browser eller tryk på F1 i din LibreOffice-konstruktion for at få adgang til Hjælp-elementets side.

Online-Hjælpen

Brug indstillingen --with-help=online til autogen.sh, når du bygger LibreOffice

Den resulterende konstruktion er placeret i instdir/help/X.Y sammen med mange ledsage-filer, der nødvendige til at styre filerne. For at navigere lokalt i Online-hjælp-konstruktionen, indstiller du en webserver i din computer og får den til at åbne siden https://localhost/<path-to-instdir>/instdir/help/X.Y/index.html.

Note pin.svg

Note:
En LibreOffice-konstruktion tager 3 til 8 timer, afhængigt af din computers kapacitet. En Hjælp-konstruktion tager omkring 5 minuter pr. sprog.

Hvordan sendes den tilbage til godkendelse (via gerrit)

Gerrit er et vsuærktøj, som tillader en let korrektur på ændringer, som går ind i LibreOffice. Hjælp bruger den samme arbejdsgang, som er beskrevet i wikiartiklen Hvordan sendes en rettelse til korrektur. Den detaljerede dokumentation om at arbejde i undermoduler findes i en særskilt artikel.

Hvis du vil oprette en ny ændring, opretter du en ny gren:

cd <submodule>
git checkout -b my_branch

Rediger filerne i helpcontent2 og indsend dine ændringer i mappen. Mens du er i mappen helpcontent2, sender du til Gerrit med denne kommando:

git push origin my_branch:refs/for/master

Så snart din undermodullapning er flettet ind, kan du slette 'my_branch':

./g checkout master
cd <submodule>
git branch -D my_branch

Ved at bruge scriptet ./g behøver du ikke at bekymre dig om opdatering af undermodulet git.

Hvis du får en gerrit-fejl om ikke at have et Ændrings-ID, kører du denne kommando i kernemappen:

./g -z

Hvis denne kommando ikke hjælper, følger du rådet i fejlen "Vink: for automatisk at indsætte Ændrings-ID installerer du krogen".

Se også