Skip to content
Get started
Write
Reuse
Translate
Nexus
Paligo Docs
Paligo Documentation
Paligo API
Docs
Documentation
API
Paligo Glossary
/
Coder view
English
en
Deutsch
English
→
Get started
Paligo API
document
Paligo API
1 min read
document
Paligo has two types of documents:
Publications
and
Topics
.
In this chapter
01
Create document
02
List documents
03
Show document
04
Update document
05
Delete document
← Prev
Fair use
Next →
Create document
Paligo Documentation
What's New in Paligo?
Quick Start
Benefits of structured content
Topics as structured content
Elements as structured content
Components as structured content
Publications for building documents
Basic Workflow
Paligo Interfaces
Content Manager
Contributor Editor
Dashboard
Editor
Next-Gen Editor
Layout Editor
Planner
Nexus
About Nexus
Create a new project
Portal
Manage a portal
Portal authentication
Custom domains
Nexus Analytics
Nexus Search
Nexus project history
Nexus Answers
Turn Nexus Answers on or off
Set the response style for Nexus Answers
Set the source URL for Nexus Answers
Keep content out of Nexus Answers
Turn the Nexus Answers widget on or off
Customize the Nexus Answers widget
Connect Slack to Nexus Answers
AI Analytics
Nexus themes
Create a theme layout
Choose the theme for a layout
Set theme options
Upload a custom theme
Download a theme
Build a custom theme
Paligo Theme Studio
Publish with Nexus
Your Account
Sign in to Paligo
Set Up 2FA
Sign In using 2FA
Use your Backup Code to Reset 2FA
Lost Backup Code
Reset Password
Reset 2FA
Sign in using SSO
Administer Your Account
Display System Settings
Editor Settings
Display Editor Settings
Enable or Disable Automatic Check-In
Enable or Disable Correction of Element Structures
Enable or Disable Link Tools
Enable or Disable Autosave
Enable or Disable Restore Feature
Set Topic Names to Match Topic Titles
Use Guillemets instead of Quotes
Enable or Disable Keyboard Shortcut for Warnings
Set Preview Layouts
Enable Whitespace Removal
Enable or Disable Highlights
Switch to Distraction-Free Mode
Validation
Password Policy
Permissions
How Permissions Work
Set Up Permissions
Change Component Owner
Change Folder Owner
Lock Icon on Folder or Component
Message "Access Restricted"
Remove Permissions
Restrict Component Access
Restrict Folder Access
Recommended Settings
Choose your Filtering Strategy
Control the Custom CSS Filename
Set Up SEO-Friendly and Reader-Friendly URLs
Manage Consecutive Branching
Control the Image Filenames
Set the Automatic Logout
Control Source Language Translation Import
Allow Users to Delete or Force them to Send to Trash
Set the Default Filename for PDF and ZIP Files
Storage Space
System Requirements and Recommendations
Browser Recommendations
Internet Connection
Set Up Your Paligo Instance
Performance Issues
User Accounts
User Types
Add Users
Bulk Import Users
Edit Users
Remove Users
My Profile
User Groups
Create a User Group
Add Users to a User Group
Remove Users from a User Group
Delete a User Group
WebDAV Access to your Paligo Instance Folders
Import or Export
About Importing and Exporting
Well-structured Legacy Content
Smart Import
Import Types
Import from Confluence
Multi-file Import
Single File Import
Import from DITA
Import Conkeyrefs as Variables
Import from DocBook
Prepare the DocBook Content
Import from Help and Manual
Import HTML (Multi File)
Prepare HTML Multi-File for Import
Troubleshooting HTML Imports
Import HTML (Single File)
Prepare HTML File for Import
Troubleshooting HTML Imports
Import from MadCap Flare
Import Markdown
Markdown import properties
Import from Microsoft Word
Prepare MS Word Document for Import
Import Paligo Export File (PEF)
Import from RoboHelp 2020
What does the RoboHelp 2020 Import Support?
Prepare your Adobe RoboHelp Content
Troubleshooting RoboHelp Import
Import Swagger OpenAPI
Prepare Swagger OpenAPI for Import
Import from Zendesk
Map your Imported Content to your Zendesk Content
Import from Other Formats
Use the Import Wizard
View Information about an Import
Revert an Import
Find a Variable Set ID
Export and Backup to XML
Export Paligo Export File (PEF)
Author
About Authoring
Favorites
Publications
Create a Publication
Add Content to a Publication
Duplicate Publications
Exclude Content from Publication TOC
Forks
Organize a Publication
Preview a Publication
Publication Structure Menus
Publication Topic
Remove Content from a Publication
Revert a Publication to a Different Revision
Topics
The Basics of Topic Editing
Check-in and Check-out
Create a Topic
Headings and Subheadings
Open a Topic
Duplicate Topics
Preview a Topic
Topic File Names
Exclude a Topic from Search
Make Topics Non-clickable Labels (HTML5)
Appendix Component
Bibliography Topic
Glossary Topic
Index Topic
Revision History Topic
Admonitions
Admonition Types
Add Admonitions
Convert Admonitions
Admonition Titles
Admonition Styling (PDF)
Elements and Attributes
Add Elements
Add a Sequence of UI Options
Add Labels
Attributes
Author Remarks
Copy Elements
Emphasis
Symbols and Special Characters
Footnotes
Move Elements
Remove Elements
Cross-References and Links
Types of Cross-References and Links
Add Cross-Reference to a Topic
Add a Cross-Reference to a Fork
Add Cross-Reference Within the Topic
Add a Cross-Reference to a Branch
Add Downloadable Files
Add External Links
Add Link to Email Address
Add Link to List Item or Step
Add Link to Local File
Add Link to Phone Number
Auto-Text for Cross-References
Automatic Links to Related Topics ("See also" sections)
Change Default Link Behavior
Add a Cross-Reference to an Element in Another Topic
Edit a Cross-Reference
Embed Google Doc or OneDrive Documents
Embed a Webpage
IDs for Cross-References
Add a Cross-Reference to an Element in a Specific Fork
Reference an Info Element in a Regular Topic
Search for Cross-References
Turn Images and Other Elements into Links
Update Individual Link Behavior
How Cross-References Resolve when Published
Troubleshooting Cross-References
Delete Content
Delete Topics, Folders or Other Components
Rules for Deleting Reused Content
Find and Remove Dependencies
Restore Deleted Content
Move to Trash
Restore from Trash
Empty the Trash
Rules for Emptying the Trash
eLearning
eLearning Workflow
Set a Minimum Passing Score
Add Information Topics for eLearning
Quiz Topic
Organize the eLearning Publication
Lists and Procedures
Create a List or Procedure
Types of Lists
Procedures
Ordered Lists
Unordered Lists
Callout Lists
Simple Lists
Sublists
Tasks
Checklists
Question and Answer Lists
Variable List (Description List)
Reuse Content in Lists
Add Content Inside a List Item or Step
Optional and Required Steps in Procedures
Set Starting Number
Select Numeration Type
Move a List Item or Step
Split a List
Merge Two Lists
Convert a List
Convert a List into Paragraphs
Convert a Group of Paragraphs into a List
Style a List
Mathematics
Choose a Math Editor
Use the Built-In Math Editor
Use the MathType Editor
Media
Images
Add Videos
Add Audio
Insert 3D Models
Embed a Lucidchart Viewer
Software and Code Documentation
General Software Elements
Code Blocks in Your Content
Code in a Paragraph (Inline Code)
Embed Code from an External Source
Syntax Highlighting
Embed Swagger OpenAPI
Copy Code to Clipboard
API Documentation Layout
Subsections
Create Subsections
Accordions (Collapsible Sections)
Convert Subsections into Separate Topics
Reader-Friendly URLs for Subsections
Section Subtitle Styling (PDF)
Section Title and Heading Styling (PDF)
Tables
Tables and Informal Tables
Add Row or Column
Add Table Footer
Create a Table
Display Table Settings
Change Cell Alignment
Change Column Alignment
Change Column Width
Change Row Alignment
Change Table Width
Change the Table Type
Copy Row or Column
Delete Parts of a Table
Merge or Split Cells
Move Row or Column
Rotate a Table (PDF)
Set Up Table Headers
Select Multiple Columns or Rows
Set the Last Line Alignment for Tables (PDF)
Sort a Table
Taxonomies in Paligo
The Benefits of Taxonomies
Taxonomies Workflow
Categorize Content with Taxonomies
Working in Taxonomy Manager
Taxonomies in the Content Manager
Create Taxonomy Tags
Apply Taxonomy Tags to Content
Set Colors for Taxonomy Tags
Move Taxonomy Tags
Search with Taxonomy Tags
Use Taxonomies as HTML Classes
Remove Taxonomy Tags
Templates
Publication Templates
Topic Templates
Templates and Translation
Paligo Metadata
SEO Best Practice
Collaborate
About Collaboration
Workflow Status
View the Status
Change the Status
Automatic Status Change
Working with Assignments
Assignment Types
Assignment Workflow and States
Assignment Settings
Create Assignments
Comments in the Main Editor
Different Ways to Open Assignments
Favorite Profiles
Open an Assignment that "Needs Work"
Respond to Feedback Comments
Reassign an Assignment
Refresh an Assignment
Track the Assignment Progress
Review Assignment Instructions
Author Instructions for Review Assignments
Reviewer Instructions
Working in Review View
Review View Features
Display the Review View
Choose Profile Settings
Chapter Numbering in Review View
Compare Reviews
Feedback in Review View
View Content in Context
Contribution Assignment Instructions
Author Instructions for Contribution Assignments
Contributor Instructions
Working in Edit View
Display the Edit View
Edit View Features
Chapter Numbering in Edit View
Copy Content from other Applications
Compare Contributions
Edit Content in Edit View
Feedback in Edit View
Highlighted Content in Edit View
Share Content (without assignments)
Author Sharing Content
Contributor Sharing Content
Reviewer Sharing Content
Work on Shared Content
Timeline
Timeline Toolbar
Display the Timeline
Compare Snapshots
Download the Comparison as PDF
Reuse
About Reusing Content
Content Reuse vs Copying
Types of Content Reuse
Create an Informal Topic
Content Reuse for Front Matter
Convert to Informal Topic from Structure View
Convert to Reusable Component
Filtering / Profiling
Set Up Filtering - Workflow
Types of Filter
Filters on Hierarchical Structures
Add the Filter Values
Taxonomy Filters
Filter Attributes and Filter Values
Choose Which Filters to Apply When Publishing
Scoped Filtering
Remove Filters
Edit or Delete a Filter Value
Troubleshooting Filtering
Filter by Language
Find Reusable Content
Insert Reusable Text Fragment
Find Topics and Publications to Reuse
Find Where Content is Reused
Find Where Topics and Publications are Reused
Find Where Text Fragments are Reused
Insert Component
Lock and Unlock Content
Remove Inserted Component
Reuse Admonitions
Create a Reusable Admonition
Insert a Reusable Admonition
Make Admonitions Reusable
Reuse Forks
Reuse Forks in Different Publications
Reuse Forks in the Same Publication
Reuse List Items
Reuse a Single Item in a List
Reuse a Sequence of List Items
Reuse Multiple Times in the Same Publication
Reuse Text Fragments
Insert Reusable Text Fragment
Reuse Topics
Title Styling for Informal Topics (PDF)
Variables in Paligo
Types of Variables
Variables Workflow
Superscript Text in Variables
Use XML Variables for Links
Use Variables
Variable Sets
Dynamic Text Variables
Search
About Searching
Advanced Search
Display Advanced Search
Perform an Advanced Search
Define the Advanced Search Criteria
Search and Open in Editor
Search and Rename
Search for the UUID
Search for Attributes
Search for Elements
Search for Topics that Contain Videos
Search for Topics that use a Variable Set
Search for Topics that Contain Variables
Global Search and Replace
Global Replace Text with a Variable
Quick Search
Use Quick Search
Search Using ID
Find Element XML ID
Enable Wildcard Search
Exact or Close Match Search
Filter Search in the Content Manager
Navigate through the Publication Structure
Search and Replace with Source Code Editor
Search for a Topic in a Publication
Help Center Search
Publish
About Publishing
What Happens during Publish?
Integrations
Nexus integration
Algolia Search Engine Integration
Amazon S3 Integration
Azure Repos Integration
Bitbucket Integration
Coveo Integration
Fluid Topics Integration
Freshdesk Integration
FTP Integration
GitHub Integration
Gitlab Integration
HTML5 Search Engines
Intercom Integration
Netlify Integration
Mixpanel Integration
MS Teams Integration
Paligo REST API
Salesforce Knowledge Integration
ServiceNow Integration
SFTP Integration
Single Sign On (SSO) and SAML Integration
Slack Integration
Swiftype Search
Webhooks
Zendesk Integration
Zoomin Integration
Style and Customize your Outputs
Styling Workflow
Layouts
Layout Relationships - Base, New, Duplicate
Create a Layout
Edit a Layout
Copy a Layout (Duplicate)
Delete a Layout
Change the Base Layout
eLearning Styling
Style the Progress Indicator
Always Show Progress Indicator
eLearning Layout Editor Options
SCORM Layout Editor Options
Publish to LMS
HTML and HTML5 Styling
Style with CSS
Style with JavaScript
Base Layout Types for HTML and HTML5
HTML5 Help Center Styling
HTML and XHTML Styling
HTML Metadata
MS Word Styling
MS Word Layout Options
Style your MS Word Documents
Manage Taxonomy Filtering for MS Word
Manage Scoped Filtering for MS Word
Publish to MS Word
PDF Styling
PDF Styling Workflow
PDF Layout Editor Options
Booklet
Bookmarks (PDF)
Bridgehead Styling (PDF)
Cover Pages and Front Matter
Default Fonts (PDF)
Footers (PDF)
Headers (PDF)
Inline Element Styling (PDF)
Section Title and Heading Styling (PDF)
Section Subtitle Styling (PDF)
List Styling (PDF)
Multi-Language PDF
Numbering (PDF)
Page Preferences (PDF)
PDF Document Properties and Metadata
Prepress
Publish to PDF
Quote Styling (PDF)
Table of Contents (PDF)
Table Styling (PDF)
Admonition Styling (PDF)
Style the Related Topics Section (PDF)
XML Styling
Include Link Text for XML
Image Size for XML Output
Output Taxonomies for XML
Use xml:lang as profiling attribute
Scoped filtering for XML outputs
Publish as DocBook XML
Markdown Styling
Output table of contents
Taxonomy filtering for Markdown output
Scoped filtering for Markdown outputs
XML elements in Markdown
Publishing Settings
Save Publishing Settings
Apply Saved Publishing Settings
Copy Publishing Settings
Reuse Publishing Settings
Publish Content
Batch Publishing
Broken Links Report
Customize Output Filename
Multi-Language PDF
Publish Multiple Versions of Content
Topic Report
Upload Directly to a Web Server or Portal
Upload Manually to Your Web Server
Translate
About Translating
Language Management
Activate Languages
Create Additional Languages
Add a Language to a Publication or Topic
Remove a Language from a Publication or Topic
Source Language
Prepare Content for Translation
Exclude Content from Translation
Translate Images
Translate Filters
Translate Variables
Check and Approve the Translation
Find Incomplete Translations
Re-Index Translations
Update Content when Translation is Not Finished
Discuss Project with Translators
Add Languages
Prepare for Translation
Send Content to Translators
Create Branches during Translation
Update and Publish the Branches
Create More Branches for Further Updates
Import the Translation of the Original Version
Review the Imported Translation
Publish the Translations for the Original Version
Merge and Translate the Updates
Publish the Translated Updates
Work with Internal Translators
Workflow for Internal Translation
Translation Assignments
Translation Review Assignments
Working in Translation View
Translation Reviewer Instructions
Work with a Translation Service
Workflow for Translation Services
Start Working with a Translation Service
Translation Software Settings
Import a Translation Package
Review or Edit the Translation
Translate with Crowdin
Translate with LanguageWire
Translate with Phrase
Translate with TransPerfect
Translate with AI
Versioning
About Versioning
Release Process
Release Content
Create a New Version
Change Workflow for Reused Content
Create Snapshot in Resource View
Restore a Previous Version
View Snapshot Information
Branching
What is Branching?
Select Branching Mode
Choose the Appropriate Branching Method
Create a Publication Branch
Create a Topic Branch from a Fork
Create a Topic Branch
Create a Publication Branch from a Fork
Create an Informal Topic Branch
Edit a Topic Branch
Branch Icons and Numbers
Add or Edit Branch Labels
Merge a Topic Branch
Merge a Publication Branch
Convert Branch to Main Branch
Delete a Branch
Replace a Branch
Replace an Informal Topic Branch
Revision Control
View Revision History
Compare Revisions
Download Revisions
Delete Revisions
New Topics Based on Revisions
Revert to Earlier Revisions
Image revisions
Paligo Glossary
Paligo API
Paligo API
Authentication
Pagination
Rate limiting
Fair use
document
Create document
Parameters
Response Headers
List documents
Parameters
Response Schema
Response Headers
Show document
Parameters
Response Headers
Update document
Parameters
Response Headers
Delete document
Parameters
Response Headers
fork
List forks
Parameters
Response Schema
Response Headers
Show fork
Parameters
Response Schema
Response Headers
Delete fork
Parameters
Response Headers
Create fork
Parameters
Response Headers
folder
List folders
Parameters
Response Schema
Response Headers
Show folder
Parameters
Response Headers
Create folder
Parameters
Response Headers
image
List images
Parameters
Response Schema
Response Headers
Show image
Parameters
Response Headers
Update image
Parameters
Response Headers
Create image
Parameters
Response Headers
search (beta)
Beta status
Search operators
Search Paligo content & resources
Parameters
Response Headers
import
List imports
Parameters
Response Schema
Response Headers
Create import
Parameters
Response Headers
Show import
Parameters
Response Headers
output
Get output
Parameters
Response Headers
production
List productions
Parameters
Response Schema
Response Headers
Create production
Parameters
Response Headers
Show production
Parameters
Response Headers
publishsetting
List publish settings
Parameters
Response Schema
Response Headers
Show publish setting
Parameters
Response Headers
translationexport
List translation exports
Parameters
Response Schema
Response Headers
Create translation export
Parameters
Response Headers
Show translation export
Parameters
Response Headers
translationimport
List translation imports
Parameters
Response Schema
Response Headers
Create translation import
Parameters
Response Headers
Show translation import
Parameters
Response Headers
taxonomies
List taxonomies
Parameters
Response Schema
Response Headers
Create a taxonomy
Parameters
Response Headers
Show a taxonomy
Parameters
Response Headers
Updates taxonomy
Parameters
Response Headers
Deletes a taxonomy
Parameters
variables
List variable set
Parameters
Response Schema
Response Headers
Create variable set
Parameters
Response Headers
Show variable set
Parameters
Response Headers
Update variable set
Parameters
Response Headers
Delete variable set
Parameters
Response Headers
List variable variants
Parameters
Response Schema
Response Headers
Create variable variant
Parameters
Response Headers
Show variable variant
Parameters
Response Headers
Update variable variant
Parameters
Response Headers
Delete variable variant
Parameters
Response Headers
List variables
Parameters
Response Schema
Response Headers
Create variable
Parameters
Response Headers
Show variable
Parameters
Response Headers
Update variable
Parameters
Response Headers
Delete variable
Parameters
Response Headers
List variable values
Parameters
Response Schema
Response Headers
Create variable value
Parameters
Response Headers
Show variable value
Parameters
Response Headers
Update variable value
Parameters
Response Headers
Schemas
Document
DocumentRequestPutPayload
Fork
ForkRequestPostPayload
Search
SearchRequestPostPayload
SearchRequestWhereHas
SearchRequestWhereEquals
SearchRequestWhereAfter
SearchRequestWhereBefore
SearchRequestWhereBetween
SearchRequestWhereContainsBlockElement
Folder
FolderRequestPostPayload
Image
ImageRequestPostPayload
ImageRequestPutPayload
Import
ImportRequestPostPayload
Production
ProductionRequestPostPayload
Publishsetting
Translationexport
Translationimport
TranslationexportRequestPostPayload
TranslationimportRequestPostPayload
Taxonomy
CustomAttribute
TaxonomyRequestPostPutPayload
VariableSetRequestPostPutPayload
VariableRequestPostPutPayload
VariantRequestPostPutPayload
VariantRequestPutPayload
VariableValueText
VariableValueImage
VariableValueTranslationLanguage
VariableValueTranslation
VariableValueRequestPutPayload
VariableValueRequestPostPayload
VariableSet
Variable
Variant
VariableValue
DocumentRequestPostPayload
DocumentByTypeRequestPostPayload
DocumentByTemplateRequestPostPayload