With the introduction of DocC for generating documentation from source code, is it possible to take the output of DocC and use it as the source of truth for an Apple Help Book (for use inside of a macOS App)?
Running Apple DocC as a Apple Help Book file
162 Views Asked by Chris At
2
There are 2 best solutions below
0
matt
On
Probably not. They are completely different animals. A help book is a complete web site with some help for certain kinds of anchors. A DocC is a highly restricted, formalized representation of a very specific type of information. Indeed, even if you meld the two things, you would not want to; a help book helps users, whereas DocC displays a programming API to a programmer.
Just as an example, here is a help book I wrote:
http://www.apeth.com/sd5help/index.html
You couldn't possibly express that using DocC. If the problem is that you're looking for a tool to help you write help books, DocC is not it.
Related Questions in SWIFT
- Navigate after logged in with webservice
- URLSession requesting JSON array from server not working
- When using onDrag in SwiftUI on Mac how can I detect when the dragged object has been released anywhere?
- Protect OpenAI key using Firebase function
- How to correct error: "Cannot convert value of type 'MyType.Type' to expected argument type 'Binding<MyType>'"?
- How to share metadata of an audio url file to a WhatsApp conversation with friends
- Using @Bindable with a Observable type in SwiftUI
- How to make a scroll view of 9 images in a forEach loop open on image 6 if image 6 is clicked on from a grid?
- Using MTLPixelFormat.rgba16Float results in random round-off errors
- Search and highlight text of current text in PDFKit Swift
- How is passing a function as a parameter related to escaping autoclosure?
- Actionable notification api call not working in background
- Custom layout occupies all horizontal space
- Is it possible to fix slow CKAsset loading on Cloudkit?
- Thread 1: Fatal error: Unexpectedly found nil while implicitly unwrapping an Optional value - MapView.isMyLocationEnabled
Related Questions in MACOS
- Error installing Nativescript on Mac M2 Sonoma 14.4.1
- macOS - Most secure way of a GUI SUDO_ASKPASS
- When using onDrag in SwiftUI on Mac how can I detect when the dragged object has been released anywhere?
- Why does Hugo generate different taxonomy-related HTML on different OS's?
- ZSH function parameters conundrum
- how to make read only file/directory in Mac writable
- macOS BigSur - Unable to run bundled php version or brew php 8
- 9 Digit Addresses in Hexadecimal System in MacOS
- MacOS Bash-Script: while read p and echo
- How to make a range for tail rows on a categorized table in Numbers with JXA scripts?
- Cannot build a basic project with curl on Mac (M2) for Raspberry Pi Pico
- How to recover deleted files from create vite react project
- Can't run built SFML project from Xcode template
- React Native - RealmJS - Linker command failed with exit code 1
- How can I manually add a keyboard shortcut to a Shortcut Action Service directly via the system files, without going through the System Prefs GUI?
Related Questions in DOCUMENTATION-GENERATION
- Sphinx warning: Failed to import test.test_adder from module `pythontemplate`
- Documentation generation via python docstrings
- how can i Automate documentation in my CI/CD pipeline or through my project workflow (java) ? documentation generator for the whole process?
- Take docs files from multiple folders to build Docusaurus
- Is there a way to generate asciidocs from application.properties in Quarkus?
- how can i hide certain parts of a function signature from doxygen?
- is it possible to generate documentation for anonymous classes in rdoc
- how to document function templates with `requires` clauses and `static_assert`s?
- I can't put text like [static] on the right side of the page for a certain function in doxygen
- Sphinx still generating documentation for test folders despite exclusion in conf.py
- deploy project documentation to gitlab wiki using CI/CD pipeline
- Automate Process Documentation for Boomi
- Templating based on Nunjucks with live preview and export capabilities for non coders - Open source solutions?
- code documentation with calls traceback (python)
- Jazzy: zsh: no matches found: --documentation=./*.md
Related Questions in DOCC
- DocC fails to generate parameters in SwiftUI
- How to exclude files and paths for Swift-DocC compilation process?
- Is there a way to host multiple Apple DocC Archives on one GitHub repository?
- Documenting a framework with DocC
- Swift Doc-C - Selective data for documentation
- Unable to build documentaion using docc preview FILE.docc
- How can I include Swift documentation in a Private CocoaPod .xcframework?
- Is it possible to distribute the documentation along with XCFramework?
- DocC (Apple documentation compiler) resize image
- Can DocC interactive tutorials be hosted?
- Host a DocC documentation in a Next.js app
- Apple DocC "BUILD DOCUMENTATION FAILED"
- Using DocC for an Objective-C project
- Package documentation using DocC failing to recognise catalogue
- Xcode 13 build an interactive tutorial
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular # Hahtags
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?
@matt mentioned:
However I disagree with it. You can create article pages with DocC: Getting Started with Sloths
The problems with using DocC to create Apple Help Book:
DocC documentation only support basic markdown syntax, so your formatting option is limited.
DocC exports the documentation as a single page web app, where Apple Help Book expect individual html files for each help pages. So you would need to automatically generate static html files.
DocC documentation doesn't let you add custom meta tags for indexing or keywords and name for anchors. (Maybe you can use comments in markdown, then automatically generate them from comments. However I'm not sure if comments in markdown would remain in DocC generated file)
You would still need to use Help Indexer to index them.
@matt mentioned:
You can definitely meld the two and use DocC generated files as your source of truth, but I would rather do it with other html editors, or a better markdown editor if you prefer the markdown syntax.