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)?
DocC Introduction: https://developer.apple.com/videos/play/wwdc2021/10166/
Apple Help Book for Mac Apps: https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html#//apple_ref/doc/uid/TP30000903-CH206-CIHEHEAC
Is it possible to take the output of DocC and use it as the source of truth for an Apple Help Book?
Yes, but likely not worth it.
#matt mentioned:
A DocC is a highly restricted, formalized representation of a very specific type of information.
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:
A help book helps users, whereas DocC displays a programming API to a programmer.
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.
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
Can someone supply an example or a link to an example that signs an existing pdf using itextsharp 5.4.4? Ideally keeping pdf/a conformity of the pdf? Thank you.
Edit: I understand the question looks as if I did not use google etc. BUT, new versions of itextsharp contain completely rewritten code for signing as well as other functions, making the existing examples non-functional. Also, itextsharp started using different names for methods eg. instead of createSignature one has CreateSignature, instead of getSignatureAppearance one seems to have SignatureAppearance etc. making the port from java examples a real nightmare. Also the samples in the source code itself are in java not c#. There is really nowhere else I can go.
Please read http://itextpdf.com/book/digitalsignatures
The examples are in Java, but they were also ported to C#. You can find the C# examples here. I didn't vote your question down, but... the first place to go when you have a question about iText should probably be http://itextpdf.com
The book I refer to (I'm the author) as well as the new examples are on the learn page.
I've recently started studying OpenEars speech recognition and it's great! But I also need to support speech recognition and dictation in other languages such as Russian, French and German.I've found that here are available various acoustic and language models.
But I cannot really understand - is that enough what I need to integrate extra language support in application?
Question is - what steps should I take in order to successfully integrate, for example russian, in Open Ears?
As far as I understood - all acoustic and language models for english language in Open Ears demo is located in folder hub4wsj_sc_8k . Same files can be found in voxforge language archives. So I just replaced them in demo. One thing is different - in demo English language, there also was a sendump 2MB large file, which is not located in voxforge language archives.There are two other files used in Open Ears demo:
OpenEars1.languagemodel
OpenEars1.dic
These I replaced with:
msu_ru_nsh.lm.dmp
msu_ru_nsh.dic
as .dmp is similar to .languagemodel. But application is crashing without any error.
What am I doing wrong? Thank You.
From my comments, reposted as an answer:
[....] Step 1 for issues like this is to turn on OpenEarsLogging and verbosePocketsphinx, which will give you very fine-grained info on what is going wrong (search your console output for the words error and warning to save time). Instructions on doing this can be found in the docs. Feel free to bring questions to the OpenEars forums [....]: http://politepix.com/forums/openears You might also want to check out this thread: http://politepix.com/forums/topic/other-languages
The solution:
To follow up for later readers, after turning on logging we got this working by using the mixture_weights file as a substitute for sendump and by making sure that the phonetic dictionary used the phonemes that were present in the acoustic model rather than the English-language phonemes.
The full discussion in which we accomplished this troubleshooting can be read here: http://www.politepix.com/forums/topic/using-russian-acoustic-model/
UPDATE: Since OpenEars 1.5 was released this week, it is possible to pass the path to any acoustic model as an argument to the main listening method, and there is a much more standardized method for packaging and referencing any acoustic model so you can have many acoustic models in the same app. The info in this forum post supersedes the info in the discussion I linked to in this answer: http://www.politepix.com/forums/topic/creating-an-acoustic-model-bundle-for-openears-1-5-and-up/ I left the rest of the answer for historical reasons and because there may be details in that discussion that are still useful, but it can be skipped in favor of the new link.
I want to build an iPhone app that is really a wrapper around a wiki. Specifically, I have some static reference content that can be represented by a hyperlinked set of pages and want to build an app that will provide a nice interface over this content, including search, bookmarking, and annotating. I'm wondering what the best approach is for building something like this.
(I'm spent a fair bit of time googling for answers but pretty much every combination of search terms I can think of returns links to wikis, not links about putting a wiki into an app).
Are there libraries out there for handling wiki content (rendering, navigating links etc.)? I imagine I could just represent my content as a set of local HTML pages and point the web browser control at these but that doesn't seem right. Any ideas on how best to approach this in the iOS world?
Thanks in advance!
Try looking at TWedit, it is a wrapper for the excellent TiddlyWiki which is a single file WIKI built around JavaScript and HTML. TW is very powerful and well supported with many plugins available.
The problem? I look up stuff in the xcode documentation and find very useful lists of objects, methods, etc... But then I still have to go somewhere else to find useful example code of how to use that object. For example, I looked up NSNumber yesterday and found all of the neat stuff it can do, but I still had no clue how to use it. That's just an example. I'm sure I could read the objective c pdf front to back and learn something there (which I plan on doing) but what about later? When I'm looking up some UIKit object? Do I have to go find a tutorial each time (or lately, I just ask StackOverflow and you guys take care of me).
Is there a part of the apple website / xcode documentation that shows the example code I'm looking for?
Is there a wiki site out there or something that has what I'm looking for? (I just tried a simple google search "iphone sdk wiki". this site could be good. iphone sdk wiki . I'll check it out. Anyone else have one they like? )
This is also sort of a mild complaint to Apple. Why not a section on each code definition page that shows usage?
I've found the sample code section on Apple's iPhone Developer Connection be extremely useful not only for samples of complete applications but also a best practices source. Going through the code of The Elements, for example, will expose you to how to use particular classes as well as how to structure your code. It is a wonderful example of how to create a non-trivial iPhone app.
Look in developer.apple.com/iphone they have pretty good documentation (you can use the search bar there) on all the classes and have a lot of good sample code..
I really would emphasize the "Related sample code" section on many, if not most, of the documented classes.
But, IMHO, there isn't any easy way of acquiring the knowledge to develop in Cocoa/Cocoa Touch. The API's are so numerous that it simply takes a lot of time and experience. You just have to work on it, look at a lot of books and study the sample source code where available.
I've tried to take a purposeful approach by carving out some time every week to learning a new API/class irrespective of whether my current project needs it or not.
Alternatively, search Joe Hewitt. He's the developer for iPhone facebook. He has a project you can download that demonstrates all the features of facebook. It's an awesome open source project!
When you look something up in Xcode Developer Documentation, you sometimes get a Related Sample Code: text that tells you what Sample the method or property is used in. Too bad you can't click on it to see the code, but if you do click it takes you to the page to download the sample. – mahboudz 0 secs ago
Apple Developer site has all kinds of code examples. Try searching google for a UICatalog project, it will show you all the basic UI stuff you can do, like adding buttons and progressbars through using only code.
I use Codesmith to create our code generation templates and have had success in learning how to use the tool by looking at example templates and the built in documentation. However I was wondering if there are any other resources (books, articles, tutorials, etc.) for getting a better grasp of Codesmith?
Have you checked the codesmith community site
We also have a great new collection of video tutorials available. You may want to check those out as well.
There is also a Google Code Codesmith section where you can download the latest updates of some CSLA, nHibernate and Plinqo templates.
Here is an interesting tutorial for building a data access layer using CodeSmith.
Depending on the templates you are using, we might have a separate website with tons of useful information like nettiers.com and plinqo.com. Also check out the help section on our community site.
We have also recently created a new WIKI (http://docs.codesmithtools.com) for all of our documentation.
Thanks
-Blake Niemyjski