Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    Dan Allen
    @mojavelinux
    @scitechcs what you are showing (which looks good) is what will be added to the default UI. I just haven't had time to review and merge it yet. I'll do it shortly after the 2.3 release is ready.
    Mark
    @scitechcs
    I used the JavaScript version of the Zoom search engine. My site is installed as a help system along with software on a local computer, so I have to use a client side search engine. I think it's a good search engine. I like the Google style results page that uses the description attribute from the asciidoc pages.
    It will be great to have the on-page navigation included by default.
    Dan Allen
    @mojavelinux
    @scitechcs totally agree
    David Jencks
    @djencks_gitlab
    I'm wondering if there's a way or conceptual model to have a site (or component) with individually versioned pages. I'm thinking of something like Guillaume's "blog antora" https://github.com/yuzutech/blog.yuzutech.fr except where you can go to old versions of each post. Perhaps one starting point would be to spread out the git versions of a page into separate content catalog entries, or even to preprocess the git repo to duplicate page versions into separate files.
    Dan Allen
    @mojavelinux
    we specifically designed Antora to not address that case. We felt it would be overengineered if we did and too hard for anyone to understand. In theory, it could be done since the content catalog is all virtual. But that won't be our focus.
    Dan Allen
    @mojavelinux
    Happy Holidays everyone! Thank you all for your involvement in the project this past year. I'm excited about what's to come in the new year! We'll keep growing and growing, and continue to work hard to make documentation awesome. :tada:
    David Jencks
    @djencks_gitlab
    @mojavelinux Happy Holidays! I wasn't thinking Antora ought to support individually versioned files out of the box, but rather wondering if anyone had an idea how to get it to work as a modification.... it's a use case I'd find useful and there have been some other people seemingly wanting to try something similar. Although iso-git doesn't appear to support notes directly, I'm thinking writing the "page version" in a note attached to a file might work for the data model, and modifying the content aggregator to look in history for the notes might work for the implementation.
    Dan Allen
    @mojavelinux
    ...and we're back! Gitter seems to have been down most of the day.
    I realized today that one of the nice benefits of exposing the content catalog to the UI (via site.contentCatalog), is that you could, in theory, create a helper to autogenerate navigation based on your own system. (It's still possible to do it with a custom generator too, but the UI template / helper approach is a more of a soft handed approach.
    Matthew Setter
    @settermjd
    Hey folks, I’ve been reading through the include directive documentation, but don’t quite understand how to set attributes when using it. Can someone point me in the right direction?
    Matthew Setter
    @settermjd
    Sorry, wrong channel. Will ask in asciidoctor/asciidoctor
    Dan Allen
    @mojavelinux
    @settermjd you can't set document attributes using an include directive. You have to set them around the include directive.
    the attributes on the include directive pertain to configuring the include itself
    leveloffset is exception, and was only added because it is used so frequently. but all that does is set document attributes around the include (implicitly)
    Ulf Riehm
    @ukubauka
    Ok, first: Happy Christmas.
    2nd. We have a 1000 page asciidoc manual collection, which is humming around real world machines, in other words, not software primarily. Its in a repo on bitbucket. We currently use it to create pdf, but now would ALSO create a website from it which the machines can retrieve and display online on their HMI. While currently all the nice document settings are working ok, as every document does inlcude the corresponding partial, that doesnt seem to work the same way when antora creates a website. Yes, we could rearrange all the settings and make them global in the playbook, but then how would we keep creating flawless pdf? Is there a way we can create common settings valid for both outputs?
    Ulf Riehm
    @ukubauka
    3rd. Thanks for asciidoc and antora.
    David Jencks
    @djencks_gitlab
    @ukubauka Could you provide a simple example of what you mean? What do the partials contain? Others might understand your description but I need a lot of specifics :-)
    Dan Allen
    @mojavelinux
    deep PDF integration is not yet something Antora offers. so if you move common attributes to the component descriptor or playbook, you'll need an extra script to pass those attributes to Asciidoctor PDF (or whatever you use)
    Ulf Riehm
    @ukubauka

    @djencks_gitlab

    Ok, sorry. Let me explain that a little better.
    We have 1 repository, which holds

    /Manuals (What antora would call a "component")
    /Manuals/Extrusion (What antora would call a "module")
    /Manuals/Extrusion/Motor-Manual.adoc
    /Manuals/Extrusion/Screw-Manual.adoc
    /Manuals/Clamp/Timing-belt-Manual.adoc
    /Manuals/Clamp/Mold-interface.adoc

    but also
    /Automation (we would move that into another repository, actually, its another team...)
    /Automation/Classes/Motion-Control/Variables.adoc
    /Automation/Classes/Heating/Controls.adoc

    but also
    /Commons
    /Commons/Icons/...
    /Commons/Settings.adoc (what antora would call a "partial")

    All of the manuals and automation docs (what antora would call "pages") include the //commons/settings.adoc to control their appearance and behaviour when we transfer them to pdf's using asciidoctor-pdf. Also we refer to the iconsdir alike.
    Now, how do we get that to antor aso we can use the repository in BOTH ways, that is as source for pdf's and also as a website. Maybe I can't.

    David Jencks
    @djencks_gitlab
    @ukubauka ok, what is in the included partials you mentioned?
    I'm wondering if some of the problems are that plain asciidoctor and Antora syntax for reference targets is different.
    Setting an asciidoctor attribute in an included file or in the playbook or component descriptor should have the same effect in Antora.
    Ulf Riehm
    @ukubauka
    @djencks_gitlab the partials hold values for predefined attributes (such as toc, sectnums, etc ...) but also plenty of "shortcuts" e.g. using an attribute :1: to represent a unicode encircled "1". I can see how i would place them in a partial family in an antora module, but not how to create partials which are accessible for all modules AND at the same time the adocs work without running it through antora, e.g. in a firefox plugin.
    David Jencks
    @djencks_gitlab
    From that I think the main problem you have is the reference syntax difference.
    Ulf Riehm
    @ukubauka
    yes
    David Jencks
    @djencks_gitlab
    If you use antora style references, they aren't going to work in a browser plugin without a really major development effort.... you'd basically be writing a "live antora" system.
    I think there's a similar problem with asciidoctor-pdf, but I think it's much more tractable.
    Ulf Riehm
    @ukubauka
    Well, the plugin is king for reviewing what you write. You dont want to run it through antora to find out there is a typo in an include:: or image:: or a blank which kills the table or whatever... Also antora would be on a pipeline somewhere in a datacenter and I dont want every writer to work it through locally. So how would he check his result easily? We are a machine building company... you can not imagine the efforts it took us to understand the first 0,5% of git.
    David Jencks
    @djencks_gitlab
    I would like @mojavelinux's opinion on this, but I think it would be only a moderate amount of work to (1) have antora export some aspects of the content catalog and (2) provide an asciidoctor extension or plugin to interpret Antora style reference correctly.
    My experience is that the chrome Asciidoctor plugin gives a useful but incomplete preview, and that running Antora locally with an "author mode" playbook for the part you're actually working on is quick and easy for a complete view of what you'll get.
    I'm not sure how easy it is to add extensions/plugins to the asciidoctor browser plugins, but it wouldn't be hard to write something to syntax-check Antora references, even if they aren't resolved.
    Ulf Riehm
    @ukubauka

    Ok lets mull it over. Thanks for the response. Your suggestion would have allow (1) to have a single source for two different backends (2) enhance the referencing in asciidoctor.

    True, we could make "author playbooks"

    Dan Allen
    @mojavelinux

    but I think it would be only a moderate amount of work to (1) have antora export some aspects of the content catalog and (2) provide an asciidoctor extension or plugin to interpret Antora style reference correctly.

    exactly. And when parsing AsciiDoc, Antora works exclusively via Asciidoctor extensions, so all of it can be replicated outside of Antora (provided you have all the metadata you need).

    I'm not sure how easy it is to add extensions/plugins to the asciidoctor browser plugins

    it's not hard. there is a field in the configuration page for them

    You dont want to run it through antora to find out there is a typo in an include:: or image:: or a blank which kills the table or whatever.

    I think you do, because otherwise you won't be totally sure there isn't an error. but that's just my (strongly held) opinion.

    Dan Allen
    @mojavelinux

    I'm wondering if some of the problems are that plain asciidoctor and Antora syntax for reference targets is different.

    they are different, but what Antora does is not non-standard. it uses the standard extension mechanism in Asciidoctor to enhance the syntax (to make it more context aware). we are very careful not to modify AsciiDoc, but rather to channel everything through extensions.

    David Jencks
    @djencks_gitlab
    So, IIUC, for the browser scenario, a fairly easy although partial first step would be to write extensions for the asciidoctor.js browser plugin to (1) parse and verify antora reference syntax and (2) for references into the same component/version, translate to links into the antora source tree. This wouldn't completely work for distributed components, but would help otherwise.
    David Jencks
    @djencks_gitlab
    My impression is that asciidoctor-pdf is a pdf renderer for ruby asciidoctor... how plausible is it to run this renderer through Opal and then use it in Antora (presumably with something like a UI-free pipeline)?
    Dan Allen
    @mojavelinux

    how plausible is it to run this renderer through Opal and then use it in Antora

    not likely, and likely impossible. that's what asciidcotor-pdf.js is for. all node

    btw, the exporting of the content catalog is already something i've been exploring for sharded sites (like main and archive). we could continue to build on that for author mode tools
    danyill
    @danyill
    @ukubauka several users here do produce PDF as well and use Antora. The openSUSE documentation does that. See the website. This is done using asciidoctor-pdf and it would take some effort to fully understand it, but you could start with the Makefile
    I do think that asciidoctor-pdf.js has a bright future with Antora but for a really clean integration some architecture is required but there has already been some good discussion on an issue: antora/antora#349
    David Jencks
    @djencks_gitlab
    I've seen that issue for ages but had no idea about the https://github.com/Mogztter/asciidoctor-pdf.js project. I added a comment to the issue :-)
    Dan Allen
    @mojavelinux
    thanks @djencks_gitlab
    Dan Allen
    @mojavelinux
    :confetti_ball:
    David Jencks
    @djencks_gitlab
    After spending half an hour looking for the issue for antora/antora-ui-default!56 and realizing there wasn't one I opened a new one antora/antora-ui-default#107.
    Dan Allen
    @mojavelinux
    you're absolutely right. thank you for closing that gap
    (could be why we keep forgetting about it)