Mall hjälptexter.md

section	title	order	date	tags
Main	Start	1	2018-10-17	mall

Mall vid skapande av hjälptexter

Sektionen (headern) ovan ska ingå i alla filer. Uppgifterna för section, title, order och tags ändras efter uppgifterna i Excelfilen. Datum (date) behöver uppdateras manuellt när texten uppdateras.

Mallen är under utveckling och uppdateras vid behov.

Innehållsförteckning:

Rubriker och textformatering
Exempel
Terminologi
Länkar

Innehållsförteckning tabell (Carins exempel):

Adminmetadata	Instans	Verk
Skapad av	Utgivningssätt	Verkets titel
Uppgraderad av	Titel	Språk
Katalogiserande instans	Upphovsuppgift	Medverkan och funktion
Poststatus	Identifikator	Klassifikation
Systemnummer	Upplageuppgift	Ämne
Katalogiseringsspråk	Utgivning	Genre
Katalogiseringsregler	Tillverkning	Innehållstyp
Beskrivningsnivå	Copyrightår
Bibliografikod	Omfång
Systemteknisk anmärkning	Illustrationer
	Mått
	Bilagor
	Medietyp
	Bärartyp
	Seriemedlemskap
	Anmärkning
	Innehållsanmärkning
	Målgrupp
	Annat bärarformat

Rubriker och textformatering

Se befintliga hjälptexter för att använda motsvarande rubriker.

Rubrik nivå 1: # före rubriken
Rubrik nivå 2: ## före rubriken
Rubrik nivå 3: ### före rubriken

Rubrik 1

Rubrik 2

Rubrik 3

Rubrik 4

Punktlista:

• Punkt 1 överordnad nivå

  • Punkt 1 underordnad nivå
  • Punkt 2 underordnad nivå
  • Punkt 3 underordnad nivå

• Punkt 2 överordnad nivå

  • Punkt 1 underordnad nivå
  • Punkt 2 underordnad nivå
  • Punkt 3 underordnad nivå

Fetstil:

** direkt före och ** direkt efter det/de ord som ska fetas. Används restriktivt och endast där något verkligen behöver framhävas.

Kursiv stil:

Asterisk * direkt före och efter det/de ord som ska kursiveras. Används restriktivt och företrädesvis för kommentarer om sådant som är under utveckling/ej ännu går att göra i katalogiseringsverktyget.

Brödtext:

Ingen formatering alls. Endast brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext brödtext.

Radbrytning

Teckenuppsättningen < br / > (ihopskrivet) används för radbrytning, vid behov.

Exempel

• Namnform Förklarande brödtext innan exemplet. Förklarande brödtext innan exemplet. Förklarande brödtext innan exemplet. Förklarande brödtext innan exemplet.
  Ett exempel skrivs på samma rad:
  Exempel: Lagerlöf

  
  Två eller fler exempel staplas under varandra (förslagsvis i en punktlista för läsbarhetens skull):
  Exempel:

  • Enkelt efternamn: Lagerlöf
  • Sammansatt släktnamn (dubbla efternamn): Lindmark Månsson
    Kompletterande/förklarande brödtext kan även läggas efter exemplet.

Terminologi

• Plustecknet ska benämnas just så - plustecknet. Förtydligande beskrivning om vilket plustecken i verktyget som avses får komplettera.

• Sidorutan (i version 1.1.0 en pop up) ska benämnas så - sidorutan. Använd föredragsvis sidorutans rubrik (Länka entitet ; Lägg till entitet ; Lägg till egenskap under) eller beskrivning för att förtydliga vilken sidoruta som avses.

• Egenskaper, klasser Sträva efter att använda BIBFRAME-terminologin egenskaper och klasser i stället för fält etc. Se BIBFRAME svensk terminologi för definitioner.

• Använd tecknet # för delfält i MARC21.

Länkar

• Ytterligare tips på markdownsyntax på Markdown Cheatsheet
• Besök Libris supportforum för frågor och svar.
• Rapportera fel i Felrapportering