Стиль написания протоколов: Оформление протоколов | Администрация Губернатора Астраханской области

Содержание

Рекомендации по проектированию веб-API — Azure Architecture Center

  • Статья
  • Чтение занимает 24 мин
Были ли сведения на этой странице полезными?

Были ли сведения на этой странице полезными?

Да Нет

Хотите оставить дополнительный отзыв?

Отзывы будут отправляться в корпорацию Майкрософт. Нажав кнопку «Отправить», вы разрешаете использовать свой отзыв для улучшения продуктов и служб Майкрософт. Политика конфиденциальности.

Отправить

В этой статье

Большинство современных веб-приложений предоставляют API, которые клиенты могут использовать для взаимодействия с приложением. Качественно спроектированный API должен поддерживать следующее:

  • Независимость от платформы. Любой клиент должен иметь возможность вызывать API, независимо от того, как API реализован внутренне. Для этого требуется использование стандартных протоколов, а также наличие механизма, при котором клиент и веб-службы могут согласовать формат данных для обмена.

  • Развитие службы. Веб-API должен иметь возможность развиваться и расширять набор функций независимо от клиентских приложений.

    По мере развития API имеющиеся клиентские приложения должны продолжать работать без изменений. Все функции должны быть доступными, чтобы клиентские приложения могли полноценно их использовать.

В этом руководстве описываются проблемы, которые следует учитывать при разработке веб-API.

Что такое REST?

В 2000 году Рой Филдинг предложил архитектурный подход к разработке веб-служб — передачу репрезентативного состояния (REST). REST — это архитектурная концепция создания распределенных систем на основе гиперсред. Модель REST не зависит от каких-либо базовых протоколов и не требует привязки к HTTP. Однако наиболее распространенные реализации REST API используют протокол HTTP в качестве протокола приложения, и в этом руководством основное внимание уделяется проектированию интерфейсов API RESTFUL для HTTP.

Основное преимущество при использовании REST с протоколом HTTP заключается в применении открытых стандартов и отсутствии необходимости в определенной реализации API или клиентских приложений.

Например, веб-службу REST можно написать в ASP.NET, а клиентские приложения могут использовать любой язык или набор инструментов, позволяющие создавать HTTP-запросы и анализировать HTTP-ответы.

Ниже приведены некоторые основные принципы проектирования интерфейсов RESTful API, использующих протокол HTTP:

  • REST API разрабатываются на основе ресурса, который может быть любым типом объекта, данных или службы, к которому может получить доступ клиент.

  • У ресурса есть идентификатор (универсальный код ресурса (URI)), который уникально идентифицирует этот ресурс. Например, URI для определенного клиентского заказа может быть таким:

    https://adventure-works.com/orders/1
    
  • Клиенты взаимодействуют со службой путем обмена представлениями ресурсов. Многие веб-API используют JSON в качества формата для обмена. Например, в результате запроса GET к приведенному выше URI может вернуться такой текст ответа:

    {"orderId":1,"orderValue":99. 90,"productId":1,"quantity":1}
    
  • Интерфейсы REST API используют единый интерфейс, который позволяет отделить реализации клиента и службы. Для REST API, созданных на основе протокола HTTP, единый интерфейс будет использовать стандартные HTTP-команды для выполнения операций с ресурсами. Наиболее часто выполняемые операции: GET, POST, PUT, PATCH и DELETE.

  • REST API использует модель запросов без отслеживания состояния. HTTP-запросы должны быть независимыми и могут создаваться в любом порядке, поэтому сохранение сведений о переходном состоянии между запросами не представляется возможным. Сведения хранятся только в самих ресурсах, и каждый запрос должен быть атомарной операцией. Благодаря этому ограничению веб-службы имеют высокую масштабируемость, так как нет необходимости сохранять сходство между клиентами и конкретными серверами. Каждый сервер может обрабатывать любой запрос от любого клиента. Тем не менее, другие факторы могут ограничить масштабируемость.

    Например, многие веб-службы записывают данные в серверное хранилище данных, что может быть трудно масштабировать. Дополнительные сведения о стратегиях масштабирования хранилища данных см. в разделе горизонтальное, вертикальное и функциональное секционирование данных.

  • Интерфейсами REST API управляют ссылки на гиперсреды, которые содержатся в представлении. Например, ниже показано JSON-представление заказа. Оно содержит ссылки для получения или обновления клиента, связанного с заказом.

    {
        "orderID":3,
        "productID":2,
        "quantity":4,
        "orderValue":16.60,
        "links": [
            {"rel":"product","href":"https://adventure-works.com/customers/3", "action":"GET" },
            {"rel":"product","href":"https://adventure-works.com/customers/3", "action":"PUT" }
        ]
    }
    

В 2008 году Леонард Ричардсон предложил следующую модель зрелости для веб-API:

  • Уровень 0. Определение одного URI, и все операции будут POST-запросами к этому URI.
  • Уровень 1. Создание отдельных URI для отдельных ресурсов.
  • Уровень 2. Использование методов HTTP для определения операций с ресурсами.
  • Уровень 3. Использование гиперсред (HATEOAS, описан ниже).

Уровень 3 соответствует настоящему RESTful API, согласно определению Филдинга. На практике многие опубликованные веб-API находятся где-то около уровня 2.

Организация разработки API вокруг ресурсов

Сосредоточьтесь на бизнес-сущностях, предоставляемых веб-API. Например, в системе электронной коммерции основными сущностями могут быть клиенты и заказы. Создание заказа может осуществляться путем отправки HTTP-запроса POST, содержащего сведения о заказе. HTTP-ответ указывает на успешность размещения заказа. Когда это возможно, универсальные коды ресурсов должны основываться на существительных (ресурсе), а не на глаголах (операциях c ресурсом).

https://adventure-works.com/orders // Good

https://adventure-works.com/create-order // Avoid

Ресурс не должен основываться на одном физическом элементе данных. Например, ресурс заказа может быть реализован внутри системы с использованием нескольких таблиц в реляционной базе данных, однако представлен в клиентском приложении как единая сущность. Избегайте создания API, которые просто отражают внутреннюю структуру базы данных. Цель REST — моделировать сущности и операции, которые приложение может выполнять в этих сущностях. Внутренняя реализация должна быть скрыта от клиента.

Сущности часто группируются в коллекции (заказов, клиентов). Коллекция — это отдельный ресурс из элемента в коллекции и должен иметь свой собственный URI. Например, следующий URI может представлять коллекцию заказов:

https://adventure-works.com/orders

В результате отправки HTTP-запроса GET на URI коллекции возвращается список элементов в коллекции. Каждый элемент в коллекции также имеет свой собственный универсальный код ресурса (URI). HTTP-запрос GET к URI элемента возвращает подробные сведения об этом элементе.

Используйте единое соглашение об именовании в универсальных кодах ресурсов. В целом это помогает использовать существительные во множественном числе для URI, ссылающихся на коллекции. Рекомендуется упорядочивать универсальные коды ресурсов для коллекций и элементов в иерархии. Например,

/customers — это путь к коллекции клиентов, а /customers/5 — путь к клиенту с идентификатором равным 5. Этот подход позволяет обеспечивать простоту веб-API. Кроме того, множество платформ веб-API могут направлять запросы на основании параметризованных путей URI, поэтому можно определить маршрут для пути /customers/{id}.

Также следует продумать связи между разными типами ресурсов и способы предоставления этих связей. Например, /customers/5/orders может представлять все заказы для клиента 5. Вы также можете пойти в другом направлении и представить связь между заказом и конкретным клиентом посредством универсального кода ресурса, например /orders/99/customer. Однако чрезмерное расширение этой модели может вызвать трудности. Более рациональное решение — предоставить ссылки с возможностью перехода на связанные ресурсы в тексте HTTP-ответа. Этот механизм более подробно описан в разделе Использование HATEOAS для включения навигации к связанным ресурсам.

В более сложных системах очевидным решением может показаться предоставление URI, позволяющих клиенту переходить между несколькими уровнями связей, например /customers/1/orders/99/products. Однако такой уровень сложности трудно обслуживать и адаптировать в случае дальнейшего изменения связей между ресурсами. Вместо этого постарайтесь сделать URI максимально простыми. Как только у приложения появляется ссылка на ресурс, оно может использовать эту ссылку для поиска элементов, связанных с указанным ресурсом. Предыдущий запрос можно заменить на URI /customers/1/orders, чтобы найти все заказы для клиента 1, а затем — на /orders/99/products, чтобы найти продукты в этом заказе.

Совет

Старайтесь использовать универсальные коды ресурсов не сложнее

collection/item/collection.

Кроме того, следует учесть, что все веб-запросы увеличивают нагрузку на веб-сервер, которая растет вместе с числом запросов. Поэтому старайтесь избегать создания веб-API с множественными операциями ввода-вывода, которые предоставляют большое количество небольших ресурсов. Такой API может потребовать от клиентского приложения отправки нескольких запросов для поиска всех необходимых данных. Вместо этого можно выполнить денормализацию данных и объединить соответствующую информацию в более крупные ресурсы, которые можно получить с помощью одного запроса. Однако следует сохранять равновесие в этом подходе, чтобы избежать получения чрезмерного объема данных, которые не нужны клиенту. Получение больших объектов может увеличить задержку запроса и привести к дополнительным расходам на пропускную способность. Дополнительные сведения об этих антишаблонах производительности см. в статье Антишаблон отправки множественных операций ввода-вывода и Антишаблон лишней выборки.

Избегайте зависимостей между веб-API и базовыми источниками данных. Например, если данные хранятся в реляционной базе данных, веб-API не требуется предоставлять каждую таблицу в виде коллекции ресурсов. Это, вероятно, будет неэффективная архитектура. Вместо этого представьте веб-API в виде абстракции базы данных. При необходимости создайте уровень сопоставления между базой данных и веб-API. Таким образом клиентские приложения изолированы от изменений в базовой схеме базы данных.

Наконец, сопоставление каждой операции, реализованной веб-API, с конкретным источником не всегда возможно. Такие безресурсные сценарии можно обрабатывать с помощью HTTP-запросов, вызывающих определенную функцию и возвращающих результаты в виде ответного HTTP-сообщения. Например, веб-API, реализующий простые расчетные операции, такие как добавление и вычитание, может предоставить универсальные коды ресурсов (URI), представляющие эти операции в виде псевдоресурсов, и использовать строку запроса для указания требуемых параметров. Например, запрос GET к URI /Add? операнд1 = 99 операнд2 = 1 возвратит ответное сообщение с текстом, содержащим значение 100. Однако следует использовать эти формы универсальных кодов ресурсов (URI) с осторожностью.

Определение операций API с точки зрения методов HTTP

Протокол HTTP определяет несколько методов, назначающих запросу семантическое значение. Ниже приведены наиболее распространенные методы HTTP, используемые большинством веб-API RESTful:

  • GET. Возвращает представление ресурса по указанному универсальному коду ресурса (URI). Текст ответного сообщения содержит сведения о запрашиваемом ресурсе.
  • POST. Создает новый ресурс по указанному URI. Текст запроса содержит сведения о новом ресурсе. Обратите внимание, что метод POST также можно использовать для запуска операций, не относящихся непосредственно к созданию ресурсов.
  • PUT. Создает или заменяет ресурсы по указанному URI. В тексте сообщения запроса указан создаваемый или обновляемый ресурс.
  • PATCH. Выполняет частичное обновление ресурса. Текст запроса определяет набор изменений, применяемых к ресурсу.
  • DELETE. Удаляет ресурс по указанному URI.

Результат конкретного запроса должен зависеть от того, является ли целевой ресурс коллекцией или отдельным элементом. В следующей таблице приведены общие соглашения, принятые большинством реализаций RESTFUL с помощью примера электронной коммерции. Не все эти запросы могут быть реализованы — они зависят от конкретного сценария.

РесурсPOSTGETPUTDELETE
/customersСоздание нового клиентаПолучение всех клиентовМассовое обновление клиентовУдаление всех клиентов
/customers/1ОшибкаПолучение сведений для клиента 1Обновление сведения о клиенте 1, если он существуетУдаление клиента 1
/customers/1/ordersСоздание нового заказа для клиента 1Получение всех заказов для клиента 1Массовое обновление заказов для клиента 1Удаление всех заказов для клиента 1

Различия между POST, PUT и PATCH могут запутать новичков.

  • Запрос POST создает ресурс. Сервер назначает URI для нового ресурса и возвращает этот URI клиенту. В модели REST запросы POST постоянно применяются к коллекциям. При этом новый ресурс добавляется в коллекцию. Запрос POST также может использоваться для отправки данных для обработки в имеющийся ресурс без создания нового ресурса.

  • Запрос PUT создает ресурс или обновляет имеющийся ресурс. Клиент указывает универсальный код ресурса. Текст запроса содержит полное представление ресурса. Если ресурс с таким URI уже существует, он заменяется. В противном случае создается новый ресурс, если сервер поддерживает это. Запросы PUT чаще всего применяются к ресурсам, которые являются отдельными элементами, например конкретные клиенты, а не к коллекциям. Сервер может поддерживать обновления, но не создание через PUT. Требуется ли поддерживать создание через PUT зависит от того, может ли клиент назначать информативный URI ресурсу до его существования. Если нет, используйте POST для создания ресурсов, а PUT или PATCH для обновления.

  • Запрос PATCH выполняет частичное обновление имеющегося ресурса. Клиент указывает универсальный код ресурса. Текст запроса определяет набор изменений, применяемых к ресурсу. Это может быть более эффективно, чем использование PUT, так как клиент отправляет только изменения, а не все представление ресурса. С технической точки зрения PATCH также может создать новый ресурс (указав набор обновлений для ресурса «null»), если это поддерживается сервером.

Запросы PUT должны быть идемпотентными. Если клиент отправляет тот же запрос PUT несколько раз, результаты всегда должны быть одинаковыми (тот же ресурс будет изменяться с теми же значениями). Запросы POST и PATCH не будут гарантированно идемпотентными.

Соответствие семантике HTTP

В этом разделе описываются некоторые распространенные вопросы по проектированию API, соответствующего спецификации HTTP. Однако он не охватывает все возможные детали или сценарии. Если вы сомневаетесь, обратитесь к спецификациям HTTP.

Типы мультимедиа

Как упоминалось ранее, клиенты и серверы обмениваются представлениями ресурсов. Например, в тексте запроса POST содержится представление создаваемого ресурса. В тексте запроса GET содержится представление получаемого ресурса.

В протоколе HTTP форматы задаются с помощью типов мультимедиа, также называемых типами MIME. Для недвоичных данных большинство веб-API поддерживают формат JSON (тип мультимедиа — application/json) и возможно XML (тип мультимедиа — application/xml).

Заголовок Content-Type в запросе или ответе определяет формат представления. Ниже приведен пример запроса POST, который включает в себя данные JSON:

POST https://adventure-works.com/orders HTTP/1.1
Content-Type: application/json; charset=utf-8
Content-Length: 57

{"Id":1,"Name":"Gizmo","Category":"Widgets","Price":1.99}

Если сервер не поддерживает данный тип мультимедиа, он возвращает код состояния HTTP 415 (неподдерживаемый тип носителя).

Запрос клиента может включать заголовок Accept, содержащий список типов мультимедиа, которые клиент будет принимать от сервера в ответном сообщении. Пример:

GET https://adventure-works.com/orders/2 HTTP/1.1
Accept: application/json

Если сервер не может соответствовать ни одному из указанных типов мультимедиа, он должен вернуть код состояния HTTP 406 (неприемлемо).

Методы GET

Успешное выполнение метода GET обычно возвращает код состояния HTTP 200 (ОК). Если ресурс не найден, метод должен вернуть код 404 (не найдено).

Методы POST

Если метод POST создает новый ресурс, он возвращает код состояния HTTP 201 (создано). URI нового ресурса содержится в заголовке Location ответа. Текст ответа содержит представление ресурса.

Если метод выполняет определенную обработку, но не создает новый ресурс, он может вернуть код состояния HTTP 200 и содержать результат операции в тексте ответа. Кроме того, при отсутствии результатов для возврата метод может вернуть код состояния HTTP 204 (нет содержимого) без текста ответа.

Если клиент помещает недопустимые данные в запрос, сервер должен вернуть код состояния HTTP 400 (неверный запрос). Текст ответа может содержать дополнительные сведения об ошибке или ссылку на универсальный код ресурса (URI), по которому можно получить более подробную информацию.

Методы PUT

Если метод PUT создает новый ресурс, он возвращает код состояния HTTP 201 (создано), как и метод POST. Если метод обновляет имеющийся ресурс, он возвращает коды состояния 200 (ОК) или 204 (нет содержимого). В некоторых случаях обновить имеющийся ресурс невозможно. В этом случае рассмотрите возможность возврата кода состояния HTTP 409 (конфликт).

Рассмотрите возможность реализации массовых HTTP-операций PUT, поддерживающих пакетные обновления нескольких ресурсов в коллекции. В запросе PUT должен быть указан универсальный код ресурса (URI) коллекции, а текст запроса должен содержать сведения о ресурсах, которые требуется изменить. Такой подход помогает сократить избыточность и повысить производительность.

Методы PATCH

С помощью запроса PATCH клиент отправляет набор обновлений в имеющийся ресурс в виде документа с исправлениями. Сервер обрабатывает документ с исправлениями, чтобы выполнить обновление. Документ с исправлениями не описывает весь ресурс, а только набор применяемых изменений. Спецификация метода PATCH (RFC 5789) не определяет конкретный формат документов с исправлениями. Формат необходимо определить на основе типа мультимедиа в запросе.

Вероятно, наиболее распространенный формат данных для веб-API — JSON. Есть два основных формата исправлений на основе JSON, называемые исправлением JSON и исправлением со слиянием JSON.

Исправление со слиянием JSON несколько проще. Документ с исправлениями имеет ту же структуру, что и исходный ресурс JSON, однако включает только подмножество полей, которые необходимо изменить или добавить. Кроме того, поле можно удалить, указав null для значения поля в документе с исправлениями. (Это означает, что исправление со слиянием не подходит, если исходный ресурс может иметь явные значения null.)

Предположим, что исходный ресурс имеет следующее представление JSON:

{
    "name":"gizmo",
    "category":"widgets",
    "color":"blue",
    "price":10
}

Вот возможное исправление со слиянием JSON для этого ресурса:

{
    "price":12,
    "color":null,
    "size":"small"
}

Это означает, что сервер должен обновляться, price удаляться color и добавляться size , пока name и category не изменяются. Точные сведения об исправлении со слиянием JSON см. в документе RFC 7396. Тип носителя для исправления со слиянием JSON — application/merge-patch+json.

Исправление со слиянием не подходит, если исходный ресурс может содержать явные значения null, из-за смысла значения null в документе с исправлениями. Кроме того, в документе с исправлениями не указывается порядок, в котором сервер должен применять обновления. Это может иметь значение, в зависимости от данных и предметной области. Исправление JSON, определенное в RFC 6902, — более гибкое. Оно определяет изменения как последовательность выполняемых операций, в частности добавление, удаление, замена, копирование и тестирование (для проверки значений). Тип носителя для исправления JSON — application/json-patch+json.

Ниже приведены некоторые типичные ошибки, которые могут возникнуть при обработке запроса PATCH, вместе с соответствующим кодом состояния HTTP.

Условие ошибкиКод состояния HTTP
Формат документа с исправлениями не поддерживается.415 (неподдерживаемый тип носителя)
Неправильный формат документа с исправлениями.400 (недопустимый запрос)
Документ с исправлениями действителен, но изменения нельзя применить к ресурсу в его текущем состоянии.409 (конфликт)

Методы DELETE

Если операция удаления выполнена успешно, веб-сервер должен отправить ответ с кодом состояния HTTP 204 (нет содержимого), указывая, что процесс успешно обработан, но текст ответа не содержит дополнительных сведений. Если ресурс не существует, веб-сервер может вернуть код HTTP 404 (не найдено).

Асинхронные операции

Иногда для завершения операции POST, помещения, исправления или удаления может потребоваться обработка, которая занимает некоторое время. Если дожидаться завершения до отправки ответа клиенту, это может привести к неприемлемой задержке. В этом случае рассмотрите возможность создания асинхронной операции. Верните код состояния HTTP 202, указывающий, что запрос был принят в обработку, но не завершен.

Следует предоставить конечную точку, которая возвращает состояние асинхронного запроса, чтобы клиент мог отслеживать состояние, опрашивая конечную точку состояния. Включите URI конечной точки состояния в заголовок Location ответа 202. Пример:

HTTP/1.1 202 Accepted
Location: /api/status/12345

Если клиент отправляет запрос GET к этой конечной точке, ответ должен содержать текущее состояние запроса. Кроме того, он также может включать предполагаемое время выполнения или ссылку для отмены операции.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status":"In progress",
    "link": { "rel":"cancel", "method":"delete", "href":"/api/status/12345" }
}

Если асинхронная операция создает новый ресурс, конечная точка состояния должна вернуть код состояния 303 (см. другие) после завершения операции. В ответе 303 включите заголовок Location, который предоставляет URI нового ресурса:

HTTP/1.1 303 See Other
Location: /api/orders/12345

Дополнительные сведения см. в разделе шаблон асинхронного Request-Reply.

Фильтрация и разбитие данных на страницы

Предоставление коллекции ресурсов через один универсальный код ресурса (URI) может привести к тому, что приложения будут получать крупные объемы данных, когда нужно лишь подмножество информации. Предположим, клиентскому приложению необходимо найти все заказы с суммой выше заданного значения. Он может получить все заказы через универсальный код ресурса (URI) /orders, а затем отфильтровать эти заказы на стороне клиента. Очевидно, что этот процесс крайне неэффективен. Он впустую использует пропускную способность сети и вычислительные ресурсы сервера, на котором размещен веб-API.

Вместо этого API может разрешить передачу фильтра в строке запроса URI, например /orders?minCost=n. Веб-API отвечает за синтаксический анализ и обработку параметра minCost в строке запроса и возврат отфильтрованных результатов на стороне сервера.

Запросы GET по ресурсам коллекций потенциально могут возвращать большое число элементов. При проектировании веб-API следует ввести ограничение на объем данных, возвращаемый одним запросом. Рассмотрите возможность использования строк запроса, определяющих максимальное количество элементов для получения и начальное смещение в коллекции. Пример:

/orders?limit=25&offset=50

Также рассмотрите возможность наложения верхнего предела на количество возвращаемых элементов, чтобы предотвратить атаки типа «отказ в обслуживании». Для поддержки клиентских приложений запросы GET, возвращающие разбитые по страницам данные, должны также включать какие-либо метаданные, указывающие общее число ресурсов, доступных в коллекции.

Аналогичную стратегию для сортировки данных можно также применить при их получении. Вы можете указать параметр сортировки, использующий имя поля в качестве значения, например /orders?sort=ProductID. Однако такой подход может негативно отразиться на кэшировании (так как параметры строки запроса составляют часть идентификатора ресурса, используемого многими реализациями кэша в качестве ключа к кэшированным данным).

Вы можете расширить этот подход и ограничить возвращаемые поля для каждого элемента, если каждый элемент содержит большой объем данных. Например, используйте параметр строки запроса, принимающий разделенный запятыми список полей, например /orders?fields=ProductID,Quantity.

Присвойте содержательные значения по умолчанию всем необязательным параметрам в строках запроса. Например, установите параметру limit значение 10, а параметру offset — 0, если вы реализуете разбиение по страницам, параметру сортировки в качестве значения задайте ключ ресурса, если вы реализуете упорядочение, а в параметре fields укажите все поля в ресурсе при поддержке проекций.

Поддержка частичных ответов для больших двоичных ресурсов

Ресурс может содержать большие двоичные поля, такие как файлы или изображения. Чтобы преодолеть проблемы, вызванные ненадежными и прерывистыми соединениями, а также улучшить время отклика, можно реализовать получение таких ресурсов пофрагментно. Для этого веб-API должен поддерживать заголовок Accept-Ranges для запросов GET по большим ресурсам. Этот заголовок указывает, что операция GET поддерживает частичные запросы. Клиентское приложение может отправлять запросы GET, которые возвращают подмножество ресурса, указанное в виде диапазона байтов.

Кроме того, рассмотрите возможность применения HTTP-запросов HEAD для этих ресурсов. Запрос HEAD аналогичен запросу GET с тем исключением, что он возвращает только заголовок HTTP, описывающий ресурс, и пустое сообщение. Клиентское приложение может отправить запрос HEAD, чтобы определить необходимость получения ресурса с помощью частичных запросов GET. Пример:

HEAD https://adventure-works.com/products/10?fields=productImage HTTP/1.1

Вот пример сообщения ответа:

HTTP/1.1 200 OK

Accept-Ranges: bytes
Content-Type: image/jpeg
Content-Length: 4580

Заголовок Content-Length содержит общий размер ресурса, а заголовок Accept-Ranges указывает, что соответствующая операция GET поддерживает частичные результаты. Клиентское приложение может использовать эту информацию для получения изображения небольшими фрагментами. Первый запрос возвращает первые 2500 байт с помощью заголовка «Range»:

GET https://adventure-works.com/products/10?fields=productImage HTTP/1.1
Range: bytes=0-2499

Ответное сообщение указывает, что это частичный ответ, возвращая код состояния HTTP 206. Заголовок «Content-Length» указывает фактическое число возвращаемых байтов в тексте сообщения (не размер ресурса), а заголовок «Content-Range» указывает, какая это часть ресурса (байты 0–2499 из 4580):

HTTP/1.1 206 Partial Content

Accept-Ranges: bytes
Content-Type: image/jpeg
Content-Length: 2500
Content-Range: bytes 0-2499/4580

[...]

Последующий запрос от клиентского приложения может получить оставшуюся часть ресурса.

Одна из основных целей реализации модели REST — получение возможности перемещаться внутри всего набора ресурсов без предварительного знания схемы универсальных кодов ресурсов (URI). Каждый HTTP-запрос GET должен возвращать сведения, необходимые для поиска ресурсов, напрямую связанных с запрашиваемым объектом, посредством гиперссылок, включенных в ответ. Запросу GET также необходимо предоставить сведения, описывающие операции, доступные в каждом из этих ресурсов. Этот принцип называется HATEOAS (гипертекст как обработчик состояния приложения). Система фактически представляет собой конечный автомат. Ответ по каждому запросу содержит сведения, необходимые для перемещения между состояниями. Другие сведения не требуются.

Примечание

В настоящее время отсутствуют стандарты общего назначения, определяющие, как моделировать принцип HATEOAS. В примерах, приведенных в этом разделе, показано одно из возможных собственных решений.

Например, чтобы обрабатывать связь между заказом и клиентом, представление заказа может включать ссылки, которые идентифицируют доступные операции для отправителя заказа. Вот возможное представление:

{
  "orderID":3,
  "productID":2,
  "quantity":4,
  "orderValue":16.60,
  "links":[
    {
      "rel":"customer",
      "href":"https://adventure-works.com/customers/3",
      "action":"GET",
      "types":["text/xml","application/json"]
    },
    {
      "rel":"customer",
      "href":"https://adventure-works.com/customers/3",
      "action":"PUT",
      "types":["application/x-www-form-urlencoded"]
    },
    {
      "rel":"customer",
      "href":"https://adventure-works. com/customers/3",
      "action":"DELETE",
      "types":[]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"GET",
      "types":["text/xml","application/json"]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"PUT",
      "types":["application/x-www-form-urlencoded"]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"DELETE",
      "types":[]
    }]
}

В этом примере в массиве links есть набор ссылок. Каждая ссылка представляет операцию в связанной сущности. Данные для каждой ссылки включают связь («customer»), URI (https://adventure-works.com/customers/3), метод HTTP и поддерживаемые типы MIME. Это все данные, необходимые клиентскому приложению, чтобы иметь возможность вызова операции.

Массив links также включает автореферентные сведения, относящиеся к полученному ресурсу. Они имеют отношение self.

Набор возвращаемых ссылок может изменяться в зависимости от состояния ресурса. Вот почему гипертекст является «обработчиком состояния приложения».

Управление версиями веб-API RESTful

Маловероятно, что веб-API останется статичным. По мере изменения бизнес-требований добавляются новые коллекции ресурсов, изменяются связи между ресурсами и структура данных в ресурсах. Несмотря на то что обновление веб-API для соответствия новым или измененным требованиям — довольно простой процесс, вам необходимо учесть, какое воздействие эти изменения окажут на клиентские приложения, использующие веб-API. Причина в том, что хотя разработка и реализация веб-API имеет полный контроль над этим API, разработчик не имеет такой же уровень контроля над клиентскими приложениями, который может быть создан сторонними организациями, работающими удаленно. В первую очередь необходимо позволить существующим клиентским приложениям продолжать работу без изменений, при этом предоставляя новым клиентским приложениям доступ к новым функциям и ресурсам.

Управление версиями позволяет веб-API указывать предоставляемые функции и ресурсы, за счет чего клиентское приложение может отправлять запросы для определенной версии функции или ресурса. В следующих разделах описано несколько различных подходов со своими преимуществами и недостатками.

Отсутствие управления версиями

Эта простейший подход, приемлемый для некоторых внутренних API. Значительные изменения можно представить в виде новых ресурсов или новых ссылок. Добавление содержимого в существующие ресурсы может не представлять критические изменения, так как клиентские приложения, не ожидающие просмотра этого содержимого, будут игнорировать его.

Например, запрос на универсальный код ресурса (URI) https://adventure-works.com/customers/3 должен вернуть сведения одного клиента с полями id, name и address, которые ожидает клиентское приложение.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Примечание

Для простоты примеры ответов в этом разделе не содержат ссылок HATEOAS.

Если поле DateCreated добавить в схему ресурса клиента, ответ будет выглядеть следующим образом:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":"1 Microsoft Way Redmond WA 98053"}

Существующие клиентские приложения могут продолжить работать без ошибок, если они могут пропускать нераспознанные поля, в то время как при проектировании новых клиентских приложений можно обеспечить поддержку новых полей. Однако внесение более серьезных изменений в схему ресурсов (таких как удаление или переименование полей) или изменение связей между ресурсами могут быть значительными изменениями, мешающими корректной работе существующих клиентских приложений. В таких ситуациях следует рассмотреть один из следующих подходов.

управление версиями с помощью URI;

При каждом изменении веб-API или схемы ресурсов вы добавляете номер версии в универсальный код (URI) каждого ресурса. Уже существующие универсальные коды ресурсов (URI) должны продолжить функционировать без изменений, возвращая ресурсы, соответствующие их исходной схеме.

Расширение предыдущего примера, если address поле переструктурировано в подполя, содержащие каждую составляющую часть адреса (например,,, streetAddresscitystate и zipCode ), эта версия ресурса может быть предоставлена с помощью URI, содержащего номер версии, например https://adventure-works.com/v2/customers/3 :

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":{"streetAddress":"1 Microsoft Way","city":"Redmond","state":"WA","zipCode":98053}}

Этот механизм управления версиями очень прост, но для него требуется, чтобы сервер направлял запрос к соответствующей конечной точке. Однако этот подход может стать чрезмерно сложным по мере прохождения веб-API через несколько итераций и необходимости поддержки сервером нескольких различных версий. Кроме того, с точки зрения пуриста во всех случаях клиентские приложения получают одни и те же данные (клиент 3), поэтому универсальный код ресурса (URI) не должен отличаться в зависимости от версии. Эта схема также усложняет реализацию HATEOAS, поскольку потребуется включать номер версии в универсальные коды ресурсов (URI) всех ссылок.

управление версиями с помощью строки запроса;

Чтобы не указывать множество кодов URI, вы можете указать версию ресурса с помощью параметра в строке запроса, добавленного к HTTP-запросу, например https://adventure-works.com/customers/3?version=2. Значение по умолчанию параметра версии должно быть содержательным, например 1, если оно опускается клиентскими приложениями прежних версий.

Этот подход обладает семантическим преимуществом в том плане, что один и тот же ресурс всегда возвращается по одинаковому универсальному коду ресурса (URI). Однако он зависит от кода, обрабатывающего запрос для анализа строки запроса и возврата соответствующего HTTP-ответа. Кроме того, этот подход также усложняет реализацию HATEOAS, как и механизм управления версиями через универсальные коды ресурсов (URI).

Примечание

Некоторые браузеры прежних версий и веб-прокси не могут кэшировать ответы по запросам, содержащим строку запроса в URL-адресе. Это может привести к снижению производительности веб-приложений, использующих веб-API и запускаемых из такого веб-браузера.

управление версиями с помощью заголовка.

Вместо того чтобы добавлять номер версии в виде параметра строки запроса, вы можете реализовать пользовательский заголовок, указывающий версию ресурса. Этот подход требует от клиентского приложения добавления соответствующего заголовка во все запросы. При этом в коде, обрабатывающем запрос клиентского приложения, можно использовать значение по умолчанию (версия 1), если заголовок с номером версии опускается. В следующих примерах используется пользовательский заголовок с именем Custom-Header. Значение этого заголовка указывает версию веб-API.

Версия 1:

GET https://adventure-works.com/customers/3 HTTP/1.1
Custom-Header: api-version=1
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Версия 2:

GET https://adventure-works.com/customers/3 HTTP/1.1
Custom-Header: api-version=2
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":{"streetAddress":"1 Microsoft Way","city":"Redmond","state":"WA","zipCode":98053}}

Как и в предыдущих двух подходах, реализация HATEOAS требует включения соответствующего пользовательского заголовка в любые ссылки.

Управление версиями через тип носителя

При отправке HTTP-запроса GET на веб-сервер клиентское приложение должно указывать поддерживаемый формат содержимого с помощью заголовка «Accept», как описано ранее в этом руководстве. Нередко заголовок Accept используется для того, чтобы позволить клиентскому приложению указать требуемый формат текста ответа: XML, JSON или другой формат, который клиентское приложение может анализировать. Однако можно определить пользовательские типы носителей, которые содержат сведения, позволяющие клиентскому приложению указывать предпочтительную версию ресурса.

В следующем примере показан запрос, в котором используется заголовок Accept со значением application/vnd.adventure-works.v1+json. Элемент vnd.adventure-works.v1 указывает веб-серверу на необходимость возврата ресурса версии 1, в то время как элемент json указывает JSON в качестве предпочтительного формата текста ответа.

GET https://adventure-works.com/customers/3 HTTP/1.1
Accept: application/vnd.adventure-works.v1+json

Код, обрабатывающий запрос, отвечает за обработку заголовка Accept и максимальное выполнение содержащихся в нем требований (клиентское приложение может указать в заголовке Accept несколько форматов, в случае чего веб-сервер может выбрать наиболее подходящий формат текста ответа). Веб-сервер подтверждает формат данных в тексте ответа с помощью заголовка «Content-Type»:

HTTP/1.1 200 OK
Content-Type: application/vnd.adventure-works.v1+json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Если в заголовке «Accept» не указан ни один из известных типов носителя, веб-сервер может отправить ответное сообщение с кодом HTTP 406 (неприемлемо) или вернуть сообщение с типом носителя по умолчанию.

Вероятно, это самый полноценный механизм управления версиями, беспрепятственно поддерживающий принцип HATEOAS, который может включать MIME-тип связанных данных в ссылках ресурсов.

Примечание

При выборе стратегии управления версиями вам также следует учесть воздействие на производительность, особенно при кэшировании на веб-сервере. Управление версиями через универсальные коды ресурсов (URI) и строку запроса поддерживает кэширование, поскольку одинаковое сочетание универсального кода ресурса (URI) и строки запроса каждый раз соотносится с одними и теми же данными.

Механизмы управления версиями через заголовок и тип носителя, как правило, требуют дополнительной логики для проверки значений в пользовательском заголовке или заголовке «Accept». Использование многочисленными клиентами разных версий веб-API в крупномасштабной среде может привести к образованию большого объема повторяющихся данных в кэше на стороне сервера. Эта проблема может усложниться, если клиентское приложение обменивается данными с веб-сервером через прокси-сервер, реализующий кэширование, который перенаправляет запрос на веб-сервер лишь в том случае, если в его кэше на текущий момент не содержится копия запрашиваемых данных.

Open API Initiative

Организация Open API Initiative создана отраслевым консорциумом для стандартизации описаний REST API разных поставщиков. В рамках этой инициативы спецификация Swagger 2.0 была переименована в OpenAPI Specification (OAS) и перенесена в проект Open API Initiative.

Возможно, вам потребуется применить OpenAPI для вашего веб-API. Учитывайте следующие факторы.

  • Спецификация OpenAPI поставляется с набором заключений и рекомендаций по разработке REST API. Она дает ряд преимуществ для взаимодействия, но требует дополнительного внимания при разработке API для соблюдения спецификации.

  • В OpenAPI рекомендуется начинать работу с создания контракта, а не реализации. Это означает, что при разработке API вы сначала создаете контракт (интерфейс) и лишь после этого пишете код для его реализации.

  • При помощи Swagger и других средства можно создавать клиентские библиотеки и документацию на основе контрактов API. например, см. веб-API ASP.NET страниц справки с помощью Swagger.

Дополнительные сведения

Магистр — Master Протокол и этикет

Международный Университет Бирчам — Образование взрослых — дистанционно.

 

Магистр — Master — Бизнес и СМИ

Протокол и этикет — заочное обучение

 

Данный курс раскрывает секреты делового протокола и этикета: как справиться с любой ситуацией не потеряв лицо, существующие каноны приветствий и поведения на деловых встречах и в офисе. Умение владеть собой и управлять ситуацией с уверенностью является лучшим конкурентным преимуществом. Слушатели изучат, как успешно проводить встречи и обеспечить достижение результатов при внедрении деловых протоколов. Хорошо организованные деловые встречи предоставляют ценные возможности для обмена опытом, информацией и знаниями.

 

Научный руководитель : Rubén Alberto Gavaldá y Castro
Подробная информация об этом руководителе и других преподавателях Международного Университета Бирчам доступна на сайте Bircham University Human Network. Далее…

 

Диплом высшего дистанционного образования по уровню Магистра предоставляет узко-специализированную подготовку по выбранной специальности. Студенты магистратуры должны продемонстрировать полное владение как теоретической, так и практической стороной материи. Далее…

* 36 — 54 академических кредитов (А.К.) после уровня бакалавра.
* Продолжительность от 9 до 12 месяцев.
* Структура программы: 70% на основе учебников + 30% дипломная работа.
* Свободный прием абитуриентов старше 25 лет.
* Общие требования: диплом высшего образования, Бакалавр или эквивалент трехлетнего или четырехлетнего образования.

 

Окончательная стоимость обучения включает в себя все: программу обучения, учебные материалы, руководство для студентов, наставничество преподавателей, аттестацию работ, диплом и сертификат полученных оценок.
Стоимость 1 А.К. последипломного образования: 130 Евро ($170 US)
Стоимость 1 трансферного балла (Т.Б.): 20 евро ($25 US)

 

36 … 54 А.К. (академических кредитов)
Стоимость :Мин. 4.680 Euros (6.120 US$) … Макс. 7.020 Euros (9.180 US$).

 

BIU предлагает рассрочку платежей до 36 месяцев без задатка. Далее…

 

 

Факультет — Бизнес и СМИ — заочное обучение

 

 

 

Магистр — Master

Протокол и этикет — заочное обучение

 

36 .
.. 54 А.К. (академических кредитов) необходимы для завершения данной программы
Структура:

+ 21 А.К. (академических кредитов) — Протокол и этикет — дистанционно
+ Дополнительные курсы
+ 13 А.К. (академических кредитов) — дипломная работа или диссертация.

 

 

+ 21 А.К. (академических кредитов): Протокол и этикет — дистанционно

 

Зачетные единицы BIU
Зачетными единицами BIU являются академические кредиты (А.К.), которые начисляются студенту в результате выполнения предписанной академической работы (рефератов, дипломной работы и/или диссертации).

 

1 академический кредит (А.К.) BIU = 1 семестральный А.К. США (15 часов обучения) = 2 А.К. ECTS (30 часов обучения).

Список учебных дисциплин (каждый предмет составляет 3 A.K.):
Вы можете изучать любой предмет как отдельный онлайн курс непрерывного образования. Далее…

 

Дистанционное обучение взрослых.
Рекомендуется наличие академической базы в этой области для реализации данного курса.

 

501ETI Interpersonal Communication
502ETI Public Speaking
503ETI Business Communications
504ETI Business Protocol & Etiquette
505ETI Multicultural Diversity
506ETI Cross Cultural Social Perspectives
507ETI International Protocol & Etiquette
Далее…

 

Библиография: Протокол и этикет — заочное обучение
Приобретение и пересылка предписанной учебной литературы включена в стоимость обучения. После проведения оплаты и завершения регистрации, Bircham International University (BIU) закажет соответствующие учебные материалы. Процесс получения студентами на руки высланных нами книг может занять от двух до пяти недель. Сотрудники офиса Международного Университета Бирчам всегда смогут предоставить Вам подробную информацию о процессе заказа и пересылки ваших учебных материалов. Если предписанная книга на английском языке, то реферат должен быть представлен также на английском, за исключением тех случаев, когда студент запросил выполнение письменных работ на другом языке и получил подтверждение BIU. Далее…
Ссылка на существующую библиографию на русском языке.

 

 

+ Вы можете выбрать несколько дополнительных предметов из других модулей данного факультета. Любое предложение, связанное с изменением программы обучения, должно быть одобрено Учебной Комиссией Международного Университета Бирчам. Например: Межинституциональные связи.

 

Дополнительные курсы — Например: Курсы — Маркетинг
Рекламные кампании
Корпоративная социальная ответственность
Исследование рынка
PR-кампании
Менеджмент продаж

 

 

+ 13 А.К. (академических кредитов) (дипломная работа или диссертация. Далее…).

 

 

Требования к абитуриентам: Магистр — Протокол и этикет

Критерии приема варьируются в зависимости от факультета и специальности. Не существует никакой дискриминации по признаку пола, расы или религии. Для поступления на выбранный уровень (Бакалавр, Магистр, Ph.D.) не менее 30% от общего количества зачетный единиц должны быть зачтены из предыдущего образования и/или профессионального опыта. Максимум 20% могут быть зачтены из профессионального опыта. Далее…

 

Нажмите, чтобы скачать… Официальное заявление о приёме

 

 

Цели обучения: Магистр — Протокол и этикет

 

Нижеприведенные цели обучения соответствуют руководящим принципам Европейской системы квалификаций (ЕСК) непрерывного образования (European Qualification Framework for lifelong learning and continuing education- EQF). Руководящие принципы данной системы облегчают зачисление зачетных единиц этого курса другими учебными учреждениями. Цели обучения считаются достигнутыми после завершения курса с удовлетворительным проходным баллом. Высокая оценка будет свидетельствовать о более глубоких аналитических способностях, самостоятельной точке зрения и критическом мышлении по данному предмету. Далее…

 

УРОВЕНЬ 5 ЕСК. Практические знания и решение задач.
Достигнутый уровень является результатом анализа и практического приложения полученной информации, что отражается в окончательном варианте реферата.

Студент должен будет аргументировать в письменной форме взаимосвязь между ключевыми идеями курса Протокол и этикет. А также от него потребуется проиллюстрировать работу примерами, отражающими практическое применение полученных знаний, и/или тематическими исследованиями. Обучаемый должен будет проверить и корректировать содержание реферата для выполнения заданного объема (от 20 до 35 страниц). Успешное окончание данной работы подтвердит наличие узко специализированных знаний по курсу Протокол и этикет и их корректное применение к решению проблем в профессиональной сфере Бизнес и СМИ. Далее…

 

УРОВЕНЬ 6 ЕСК. Углубленные знания и критический анализ информации.
Достигнутый уровень является результатом оценки полученных знаний и их практического применения в решении поставленных задач.

Способность студента объединить информацию из различных разделов учебного текста для создания последовательного, гармоничного и целостного изложения определит его потенциал критического понимания предмета и углубленное знание концепций курса Протокол и этикет. Стиль написания реферата, представленного студентом, его содержание и структура играют важную роль в оценке и применении знаний курса Протокол и этикет, в выявлении проблем и принятии решений в профессиональной области Бизнес и СМИ. Далее…

 

 

Международный Университет Бирчам разрабатывает программы обучения индивидуально для каждого соискателя, основываясь на его/ее предыдущем образовании, опыте работы и предпочтениях. Далее…

 

 

Магистр — Master — Бизнес и СМИ

Протокол и этикет — дистанционно

 

Признание — Дистанционное обучение — Далее…
Аккредитация — Университет дистанционного образования — Далее…
Легализация диплома — Услуги для выпускников — Далее…

Признание Диплома дистанционного образования и зачисление академических кредитов (А.К.) другими учебными заведениями, организациями и предприятиями является прерогативой принимающей стороны. Критерии данного процесса отличаются в каждом университете и зависят от их внутренней политики и законодательства страны, в которой они находятся.

 

 

Магистр — Master Протокол и этикет

 

 

Стиль написания кода на Swift

Имена

Наша цель — сделать код коротким, читабельным и простым.

Используйте наглядные имена с использованием заглавных букв, для обозначения нового слова: в именах классов, переменных, методов и т. д. Имена классов и констант на уровне модуля должны начинаться с большой буквы, в то время как, имена методов и переменных должны начинаться с маленькой.

Предпочтительно


private let maximumWidgetCount = 100

class WidgetContainer {
  var widgetButton: UIButton
  let widgetHeightPercentage = 0.85
}

Не предпочтительно


let MAX_WIDGET_COUNT = 100

class app_widgetContainer {
  var wBut: UIButton
  let wHeightPct = 0.85
}

Для функций и методов инициализации, предпочитают именованные параметры, для всех аргументов, если контекст не очень ясный. Также, хорошо использовать включение имен внешних параметров, если это делает вызов функции более читабельным.


func dateFromString(dateString: String) -> NSDate
func convertPointAt(#column: Int, #row: Int) -> CGPoint
func timedAction(#delay: NSTimeInterval, perform action: SKAction) -> SKAction!

// would be called like this:
dateFromString("2014-03-14")
convertPointAt(column: 42, row: 13)
timedAction(delay: 1. 0, perform: someOtherAction)

Касательно метода, хорошо работает стандартное соглашение об использовании первого параметра, в качестве ссылки имени самого метода:


class Guideline {
  func combineWithString(incoming: String, options: Dictionary?) { ... }
  func upvoteBy(amount: Int) { ... }
}

Перечисления

Используйте Горбатую нотацию Верхнего регистра для элементов перечислений


enum Shape {
  case rectangle
  case square
  case triangle
  case circle
}

Проза

Когда вы ссылаетесь на функцию, как внутри текста (статьи, книги, комментарии), включайте необходимые имена параметров, а не вырывайте только название функции. Это придаст вашему коду большей ясности. То есть, к примеру, вы можете написать про метод tableView, но лучше, в развернутом виде tableView(_:cellForRowAtIndexPath:).

Если сомневаетесь, то вы всегда можете посмотреть как Xcode перечисляет свои методы в выпадающей панели. Наш стиль соответствует его стилю.

Префиксы класса

Типы в Swift автоматически обретают пространство имени в том модуле, в котором они содержатся. И как результат, для того, чтобы свести к минимуму конфликты имен, префиксы не требуются. Если два имени из разных модулей сталкиваются, вы можете разделить их, используя префикс имени типа с именем модуля:


import SomeModule

let myClass = MyModule.UsefulClass()

Вам не следует добавлять префиксы к вашим типам Swift.

Если вам нужно работать с типом Swift в языке Objective-C, то вы можете использовать подходящий префикс, как например:


@objc (RWTChicken) class Chicken {
   ...
}

Расстановка пробелов

  • Для обозначения отступа используйте два пробела, а не один tab (нажатие кнопки табуляции), что сэкономит вам место и предотвратит перенос строки. Убедитесь, что вы используете такие настройки Xcode как показано ниже:
  • Открывайте фигурные скобки на той же строке, что и (if/else/switch/while и т. д.), но закрывайте на новой.
  • Совет: вы можете повторно выровнять код (⌘A для его выделения), затем нажмите Control-I(или в меню Editor\Structure\Re-Indent). 

Предпочитительно


if user.isHappy {
  // Do something
} else {
  // Do something else
}

Не предпочтительно


if user.isHappy
{
    // Do something
}
else {
    // Do something else
}
  • Должна быть ровно одна пустая строка между методами для визуальной четкости и организованности. Пробелами внутри методов следует разделять функциональность, но наличие слишком большого числа разделов часто означает, что вы должны реорганизовать их в несколько методов.

Комментарии

Используйте комментарии для объяснения почему конкретный кусок кода делает что-то. Комментарии должны быть актуальными или удаленными.

Избегайте блочных комментариев встроенных в код, по возможности весь код должен быть максимально понятным, чтобы не требовалось комментариев. Исключение: это правило не относится к тем комментариям, которые используются для генерации документации.

Классы и структуры

Что из них использовать?

Помните, что структуры имеют семантику значений. Используйте их в тех случаях, когда не наблюдается идентичности. Массив, который имеет элементы [a, b, c], на самом деле такой же, как и другой массив, имеющий те же [a, b, c] — эти массивы взаимозаменяемые. Нет никакой разницы, используете вы первый массив или второй, потому что они представляют из себя одно и то же. Вот поэтому, массивы являются структурами.

Классы имеют ссылочную семантику. Используйте классы в случаях, когда есть место идентичности или специфичный жизненный цикл. Вы смоделируете человека как класс, потому что два объекта человека — это два разных элемента. Если два человека имеют одинаковое имя и у них дни рождения в один день, еще не значит, что они оба одна и та же личность. Но день рождения будет структурой, так как 3 марта 1950 то же самое, что и любая другая дата объекта для 3 марта 1950. У даты, самой по себе, нет идентичности.

Иногда, что-то должно быть структурой, но должно соответствовать AnyObject или исторически так сложилось, что это уже является классом (NSDate, NSSet). Попробуйте следовать инструкциям настолько, насколько это возможно:

Пример объявления

Пример отлично стилизованного объявления класса:


class Circle: Shape {
  var x: Int, y: Int
  var radius: Double
  var diameter: Double {
    get {
      return radius * 2
    }
    set {
      radius = newValue / 2
    }
  }

  init(x: Int, y: Int, radius: Double) {
    self.x = x
    self.y = y
    self.radius = radius
  }

  convenience init(x: Int, y: Int, diameter: Double) {
    self.init(x: x, y: y, radius: diameter / 2)
  }

  func describe() -> String {
    return "I am a circle at \(centerString()) with an area of \(computeArea())"
  }

  override func computeArea() -> Double {
    return M_PI * radius * radius
  }

  private func centerString() -> String {
    return "(\(x),\(y))"
  }
}

Пример выше демонстрирует следующие стилистические установки:

  • Укажите типы для свойств, переменных, констант, определения аргументов и другие выражения с пробелом после двоеточия, но не до (x: Int и Circle: Shape).
  • Определите несколько переменных и структур в одной строке, если они имеют общую цель/контекст.
  • Отступ определения геттера, сеттера и наблюдателей свойств.
  • Не добавляйте модификатора типа internal, так как они уже идут по умолчанию. Аналогично, не повторяйте модификатор доступа, когда переписываете метод.

Использование Self

Для сокращения кода избегайте использования self, так как Swift не требует его для доступа к свойствам объектов или вызовам методов.

Используйте self, когда требуется разграничить между собой имена свойства и инициализаторы аргументов, или когда ссылаетесь на свойства в выражениях замыкания (как требует компилятор):


class BoardLocation {
  let row: Int, column: Int

  init(row: Int, column: Int) {
    self.row = row
    self.column = column

    let closure = {
      println(self.row)
    }
  }
}

Соответствие протоколу

Когда добавляете соответствие протоколу классу, то лучше добавить отдельное расширение класса, для методов протокола. Это оставляет связанные методы, сгруппированные вместе с протоколом, и упрощает действия по его добавлению.

Не забывайте: // ОТМЕТКА — оставляйте комментарии для организации кода

Предпочтительно


class MyViewcontroller: UIViewController {
  // class stuff here
}

// MARK: - UITableViewDataSource
extension MyViewcontroller: UITableViewDataSource {
  // table view data source methods
}

// MARK: - UIScrollViewDelegate
extension MyViewcontroller: UIScrollViewDelegate {
  // scroll view delegate methods
}

Не предпочтительно

class MyViewcontroller: UIViewController, UITableViewDataSource, UIScrollViewDelegate { // all methods }

Объявление функций

Не растягивайте объявление функций более чем на одну строку, включая фигурную скобку:

func reticulateSplines(spline: [Double]) -> Bool { // reticulate code goes here }

Для функций с длинными названиями или списками аргументов, добавляйте переносы строк на необходимых местах и не забудьте добавить дополнительный отступ, на последующих строках объявления:


func reticulateSplines(spline: [Double], adjustmentFactor: Double,
    translateConstant: Int, comment: String) -> Bool {
  // reticulate code goes here
}

Замыкающие выражения

Используйте синтаксис последующих замыканий всегда, когда это возможно. Во всех случаях, давайте именам параметров описывающие их имена:

Предпочтительно


UIView.animateWithDuration(1.0) {
  self.myView.alpha = 0
}

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  },
  completion: { finished in
    self.myView.removeFromSuperview()
  }
)

Не предпочтительно


UIView.animateWithDuration(1.0, animations: {
  self.myView.alpha = 0
})

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  }) { f in
    self.myView.removeFromSuperview()
}

Для однострочных замыканий, где контекст понятен, используйте неявный возврат значения:


attendeeList.sort { a, b in
  a > b
}

Типы

По возможности используйте родные типы Swift. Swift предлагает мост в Objective-C, так что вы можете использовать все методы оттуда, если вам нужно.

Предпочитительно


let width = 120.0                                    // Double
let widthString = (width as NSNumber).stringValue    // String

Не предпочтительно


let width: NSNumber = 120.0                          // NSNumber
let widthString: NSString = width.stringValue        // NSString

В коде Sprite Kit используйте CGFloat, если это сделает ваш код сжатым и позволит избежать большого количества конвертирования.

Константы

Константы объявляются с использованием ключевого слова let, переменные — var. Каждое значение, которое не меняется, должно быть объявлено как константа, с использованием let. В результате, вы вероятнее всего заметите, насколько чаще вы используете let, чем var.

Совет: попробуйте все объявлять как константа, и менять на переменную, когда компилятор ругается!

Опционалы

Объявляйте переменные и функциональные возвращаемые типы как опционалы с ?, где значение nil — допустимо как величина.

Используйте неявно извлеченные типы, объявленные с !, только для переменных экземпляров, которые вы знаете и что будут инициализированы позже. Но это должно быть сделано до использования, например, как некоторые элементы в viewDidLoad.

При обращении к опциональному значению, используйте опциональную последовательность или цепочку, если вы обращаетесь к значению только один раз, или у вас несколько опционалов:


self.textContainer?.textLabel?.setNeedsDisplay()

Используйте привязку опционала, когда более удобно извлечь значение и провести несколько операции сразу:


if let textContainer = self.textContainer {
  // do many things with textContainer
}

Когда вы даете имена опциональным переменным и свойствам, избегайте таких имен как optionalString или maybeView, так как их «опциональность» указана уже в типе.

Для связки опционала лучше следовать первоначальному имени, чем использовать такое как unrappedView или actualLabel

Предпочитительно


var subview: UIView?
var volume: Double?

// later on. ..
if let subview = subview, volume = volume {
  // do something with unwrapped subview and volume
}

Не предпочтительно


var optionalSubview: UIView?
var volume: Double?

if let unwrappedSubview = optionalSubview {
  if let realVolume = volume {
    // do something with unwrappedSubview and realVolume
  }
}

Инициализаторы структуры

Лучше используйте родные инициализаторы Swift, а не наследие конструкторов CGGeometry:

Предпочитительно


let bounds = CGRect(x: 40, y: 20, width: 120, height: 80)
let centerPoint = CGPoint(x: 96, y: 42)

Не предпочтительно


let bounds = CGRectMake(40, 20, 120, 80)
let centerPoint = CGPointMake(96, 42)

Предпочитайте константы уровня структуры CGRect.infiniteRect, CGRect.nullRect и другие, глобальным константам CGRectInfinite, CGRectNull. Для существующих переменных вы можете использовать сокращенный вариант .zeroRect.

Вывод типа

Компилятор Swift может вывести тип переменной или константы. Вы можете явно указать тип через через алиас типа, но в большинстве случаев в этом нет необходимости.

Предпочтите в данном случае компактный вариант, пусть компилятор сам выведет тип для переменной или константы.

Предпочитительно


let message = "Click the button"
let currentBounds = computeViewBounds()
var names = [String]()
let maximumWidth: CGFloat = 106.5

Не предпочтительно


let message: String = "Click the button"
let currentBounds: CGRect = computeViewBounds()
var names: [String] = []

Синтаксический сахар

Предпочитайте сокращенные версии объявления типов:

Предпочитительно


var deviceModels: [String]
var employees: [Int: String]
var faxNumber: Int?

Не предпочтительно


var deviceModels: Array<String>
var employees: Dictionary<Int, String>
var faxNumber: Optional<Int>

Управление потоком

Лучше использовать цикл for-in, но не классический for:

Предпочитительно


for _ in 0. .<3 {
  println("Hello three times")
}

for (index, person) in enumerate(attendeeList) {
  println("\(person) is at position #\(index)")
}

Не предпочтительно


for var i = 0; i < 3; i++ {
  println("Hello three times")
}

for var i = 0; i < attendeeList.count; i++ {
  let person = attendeeList[i]
  println("\(person) is at position #\(i)")
}

Точка с запятой

Точка с запятой после каждого выражения больше не обязательна. Они нужны только для тех случаев, когда вы хотите записать несколько выражений в одну строку.

Не пишите несколько выражений в одну строку, разделяя их точкой с запятой!

Единственное исключение из этого правила — классический цикл for, который требует такого синтаксиса. Однако, используйте for-in вместо for, где только это возможно:

Предпочитительно


let swift = "not a scripting language"

Не предпочтительно


let swift = "not a scripting language";

Заметка: Swift совершенно другой язык, не похожий на JavaScript, где отсутствие запятых считается небезопасным.

Язык

Используйте правописание анлийского языка США, так как оно соответствует Apple’s API.

Предпочитительно


let color = "red"

Не предпочтительно


let colour = "red"

Улыбающееся лицо

Улыбающиеся лица являются очень характерной чертой программирования на Swift! Это очень важно иметь правильную улыбку, означающую, огромное количество счастья и волнения в этой среде кодирования. Закрывающая квадратная скобка «]» используется потому, что она представляет собой большую улыбку и способна быть захваченной с помощью ASCII Art. В то время как закрывающая скобка «)» создает половинчатую улыбку, и, таким образом, не является предпочтительной.

Предпочитительно


:]

Не предпочтительно


:)

Что дальше?

Дальше, вы можете продолжить изучать наши туториалы по мере их появления, а также, параллельно читать перевод официальной книги по языку программирования Swift. И, для более подробного изучения языка, вы можете пройти наши курсы!

Урок подготовил: Иван Акулов

Источник урока: https://github.com/raywenderlich/swift-style-guide

Секретный протокол к пакту Молотова — Риббентропа: почему сенсации не случилось | Культура и стиль жизни в Германии и Европе | DW

Само существование этого секретного дополнительного протокола к Договору о ненападении между СССР и Германией, известному как пакт Молотова — Риббентропа, в Москве многие десятилетия отрицали. Этот договор обговаривал территориальные и организационные детали раздела Восточной Европы: к Советскому Союзу отходили часть Польши, прибалтийские страны и Бессарабия, а Гитлер, получив, что называется, «карт-бланш», спустя всего неделю после его подписания напал на Польшу. Так началась Вторая мировая война.

Фальсификаторы истории

Надо сказать, что секретным этот протокол, о котором не сообщили даже Верховному Совету СССР, который ратифицировал Договор о ненападении, в сущности, никогда не был. Уже на следующий день после его написания один из немецких дипломатов, которого ужасала мысль о войне, сообщил о нем своему американскому коллеге.

В 1946 году на Нюрнбергском процессе о существовании секретного дополнительного протокола между СССР и Германией рассказал бывший статс-секретарь германского МИДа Эрнст фон Вайцзеккер (Ernst von Weizsäcker). Это подтвердили другие обвиняемые, а один из адвокатов даже хотел огласить текст этого протокола, но ему не разрешили: представители обвинения со стороны СССР категорически отрицали существование секретного протокола, назвав его фальшивкой.

Двумя годами позже этот документ был опубликован Госдепартаментом США — вместе с обнаруженной в архивах «третьего рейха» перепиской между нацистскими и советскими дипломатами, которая содержала ссылки на секретные договоренности. Но в Советском Союзе продолжали утверждать, что это фальсификация, что никакого дополнительного секретного приложения к соглашениям 1939 года («О ненападении» и «О дружбе и границе») между СССР и Германией не существовало. Более того: в ответ на публикацию Госдепартамента в Москве выпустили свой сборник под названием «Фальсификаторы истории». Но что характерно: в нем не было ни одного полного архивного документа, лишь несколько фрагментов.

«Миролюбивый« Сталин и раздел Европы

Молотов, подписавший пакт о ненападении и секретный протокол к нему, до самой своей смерти в 1986 году отрицал его существование. Его аргументацию перенял после него и другой министр иностранных дел СССР — Громыко: это фальшивка, так как документ официально не опубликован. Аргумент, что называется, неубиенный: одной официальной стороны, его подписавшей (гитлеровской Германии), уже не существовало, а другая (Советский Союз) вообще отрицала, что он есть, и, разумеется, публиковать не собиралась.

Правда, в архивах германского МИДа сохранилась немецкая версия протокола, но бумажный оригинал как будто сгорел во время бомбежки Берлина в 1944 году, и осталась только фотокопия. На самом деле в архиве есть и бумажный вариант. Правда, происхождение этого экземпляра с подписями министров иностранных дел «третьего рейха» Риббентропа (Joachim von Ribbentrop) и СССР Молотова точно не запротоколировано.

Но почему так важно было доказать наличие этого секретного документа и почему в Москве с таким упорством отказывались признать его существование? Дело в том, что наличие договоренностей о разделе Восточной Европы между двумя диктаторами начисто перечеркивало официальную советскую версию о стремившемся оттянуть войну «миролюбивом» Сталине. Он уже, что называется, задокументированно представал агрессором, который вместе с Гитлером развязал Вторую мировую войну, аннексировав страны Балтии, часть Польши, Бессарабию и Северную Буковину. Об этом писали не только западные историки, но и, например, известный советский историк и публицистЛев Безыменский, чьи публикации — как в советской, так и в западной печати — сыграли важную роль в том, что о секретном протоколе заговорила советская общественность.

Секретный протокол в «Особой папке«

В 1989 году на Съезде народных депутатов представители Эстонии, Латвии и Литвы потребовали от Горбачева обнародовать этот документ. Михаил Горбачев отказался: мол, в архивах Кремля его нет. На самом деле пакет № 34 «Особой папки» с этим секретным приложением, когда-то пребывавший в сейфе Сталина, хранился в Общем отделе ЦК КПСС, и Горбачев, как подчеркивал Безыменский, знал о нем еще с 1987 года. Это подтверждает в своих мемуарах и управделами Горбачева, позже путчист Болдин. По его словам, между ними шел даже разговор об уничтожении этих документов.

Как бы то ни было, но время брало свое, и в декабре 1989 года специальная комиссия во главе с Александром Яковлевым, а вслед за ней и Съезд народных депутатов СССР признали существование секретного протокола к договору между Советским Союзом и нацистской Германией. Был опубликован и текст, — правда, не советский оригинал, а немецкий вариант. Только в октябре 1992 года уже другой историк — Дмитрий Волкогонов — добрался до папки № 34. Он представил секретный протокол вместе с другими документами на пресс-конференции. Последовала волна публикаций в газетах и исторических журналах. То есть уже тогда существование секретного дополнительного договора к пакту Молотова — Риббентропа стало общеизвестным и достоверно признанным фактом не только на Западе, не только в странах Балтии, Молдавии и Украине, но и в России. Так что нынешняя публикация факсимиле советского оригинала ничего принципиально не меняет, и сенсацией ее никак нельзя назвать.

Смотрите также:

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Подписание

    Иоахим фон Риббентроп (слева), Иосиф Сталин (второй слева) и Вячеслав Молотов (ставит подпись, сидит справа). Со стороны СССР договор был подписан наркомом по иностранным делам Молотовым, со стороны Германии — ее министром иностранных дел Риббентропом. Договор часто называют «пактом Молотова-Риббентропа».

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Молотов и Гитлер

    Стороны соглашения обязывались воздерживаться от нападения друг на друга и соблюдать нейтралитет в случае, если одна из них становилась объектом военных действий третьей стороны. К договору прилагался секретный дополнительный протокол о разграничении сфер обоюдных интересов в Восточной Европе. С ответным визитом в Берлине был Молотов. На снимке он слева с Гитлером и переводчиком.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Гитлер о пакте и позиции Сталина

    «Наши враги рассчитывали на то, что Россия станет нашим противником после завоевания Польши… Я был убежден, что Сталин никогда не примет предложения англичан. Только безоглядные оптимисты могли думать, что Сталин настолько глуп, что не распознает их истинной цели. Россия не заинтересована в сохранении Польши… Теперь… путь солдатам открыт», — Адольф Гитлер (1939 год).

  • Сталин и Гитлер: как началась и чем кончилась дружба

    «Вероломный изверг» по фамилии Гитлер

    «. ..как могло случиться, что советское правительство пошло на заключение пакта о ненападении с такими вероломными людьми и извергами, как Гитлер и Риббентроп? Не была ли здесь допущена со стороны советского правительства ошибка? Конечно, нет! Пакт о ненападении есть пакт о мире между двумя государствами», — из выступления Сталина (1941 год, после нападения Гитлера на СССР).

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Предыстория

    Договор был подписан после периода очень серьезного охлаждения советско-германских отношений, вызванного приходом Гитлера к власти, и вооруженных конфликтов, в которых СССР противостоял гитлеровской коалиции: Германии и Италии в Испании, Японии на Дальнем Востоке. Договор стал неожиданностью не только для третьих стран, но и для населения СССР и Германии.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Результаты

    1 сентября 1939 года Германия начала вторжение в Польшу, а 17 сентября 1939 года на территорию Польши вошли советские войска. Территориальный раздел страны был завершен 28 сентября 1939 года подписанием договора о дружбе и границе между Советским Союзом и Германией. Позже к СССР были присоединены страны Прибалтики, Бессарабия и Северная Буковина, а также часть Финляндии.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Начало Второй мировой

    Польская кампания вермахта — военная операция, в результате которой территория Польши была полностью оккупирована, а ее части аннексированы «третьим рейхом» и СССР. В ответ на агрессию Гитлера Великобритания и Франция объявили войну Германии, что ознаменовало начало Второй мировой войны. Датой ее начала ринято считать 1 сентября 1939 года — день вторжения в Польшу.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Раздел Польши

    Германские войска нанесли поражение вооруженным силам Польши. 17 сентября на территорию Польши вошли советские войска — как сообщалось официально, с целью присоединения к СССР Западной Белоруссии и Западной Украины. Территория Польши была поделена между Германией и Советским Союзом в соответствии с секретными протоколами к договорам о ненападении и о дружбе и границе, а также Литвой и Словакией.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Совместный парад в Бресте

    14 сентября 1939 года немецкий 19-й моторизованный корпус атаковал Брест-на-Буге (тогда польский город) и занял его. 22 сентября Брест был передан 29-й танковой бригаде Красной армии во время импровизированного парада. Парад принимают: в центре — генерал Гудериан (командующий 19-й моторизованным корпусом), справа — командир 29-й легкотанковой бригады РККА, комбриг Семен Кривошеин.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Город-символ

    Город Брест вошел в состав СССР как центр новообразованной Брестской области Белорусской ССР. По реке Западный Буг пролегла советско-германская демаркационная линия. И именно этот город 22 июня 1941 года одним из первых подвергся атаке германских войск. Оборона Брестской крепости стала символом стойкости, мужества и воинской доблести. На фото — парад при передаче города Красной армии в 1939 году.

  • Сталин и Гитлер: как началась и чем кончилась дружба

    Чем кончилась дружба

    После нападения Германии на Советский Союз 22 июня 1941 года «пакт Молотова-Риббентропа», так же как и все остальные советско-германские договоры, утратил силу. В 1989 году Съезд народных депутатов СССР осудил секретный дополнительный протокол к договору и признал его недействительным с момента подписания. Сегодня 23 августа — День памяти жертв сталинизма и нацизма.

    Автор: Дарья Брянцева


 

______________

Хотите читать нас регулярно? Подписывайтесь на наши VK-сообщества «DW на русском» и «DW Учеба и работа» и на Telegram-канал «Что там у немцев?» или читайте нас в WhatsApp

 

5.3. Проектирование протоколов прикладного уровня

Читайте также

2.

2. Обзор протоколов TCP/IP

2.2. Обзор протоколов TCP/IP Хотя набор протоколов и называется «TCP/IP», это семейство состоит не только из собственно протоколов TCP и IP. На рис. 2.1 представлен обзор этих протоколов. Рис. 2.1. Обзор протоколов семейства TCP/IPНа этом рисунке представлены и IPv4, и IPv6. Если рассматривать

Поддержка протоколов высокого уровня

Поддержка протоколов высокого уровня В ядре Linux предусмотрена поддержка нескольких протоколов высокого уровня. Благодаря этому коды, отвечающие за работу с этими протоколами, выполняются намного быстрее, чем соответствующие коды обычных пользовательских программ.

3.3 Обзор протоколов

3.3 Обзор протоколов На рис. 3.5 представлено соотношение между отдельными компонентами набора протоколов TCP/IP. Рис. 3.5. Соотношение между компонентами набора протоколов TCP/IPХотя текстовые пользовательские интерфейсы для пересылки файлов, доступа с терминала, работы с

Глава 4 Технологии физического уровня и уровня связи данных

Глава 4 Технологии физического уровня и уровня связи данных 4.1 Введение За последние несколько лет было предложено беспрецедентное количество новых технологий для локальных и региональных сетей, быстро утвердившихся на компьютерном рынке. Произошел огромный скачок от

Стек протоколов TCP/IP

Стек протоколов TCP/IP Стек протоколов TCP/IP является основным и единственным способом взаимодействия конечного компьютера с глобальной сетью Интернет, а также основным стеком взаимодействия с другими компьютерами сети. Именно поэтому было решено рассказать в этой главе и

5.

3. Проектирование протоколов прикладного уровня

5.3. Проектирование протоколов прикладного уровня В главе 7 рассматриваются преимущества разбиения сложных приложений на взаимодействующие процессы, которые обмениваются друг с другом данными посредством специфичного для них набора команд или протокола. Преимущества

5.4. Метаформаты протоколов прикладного уровня

5.4. Метаформаты протоколов прикладного уровня Подобно тому, как были усовершенствованы метаформаты файлов данных, чтобы упростить сериализацию для хранения этих данных, метаформаты протоколов прикладного уровня были усовершенствованы, чтобы упростить сериализацию

5.4.2. HTTP как универсальный протокол прикладного уровня

5.4.2. HTTP как универсальный протокол прикладного уровня С тех пор как приблизительно в 1993 году World Wide Web достигла критической массы, проектировщики прикладных протоколов демонстрируют усиливающуюся тенденцию к размещению специализированных протоколов над HTTP, используя

8.

3.5. Язык или протокол прикладного уровня

8.3.5. Язык или протокол прикладного уровня Не менее важно определить, будут ли другие программы интерактивно вызывать ядро мини-языка в качестве подчиненного процесса. Если это так, то конструкция, вероятно, должна меньше походить на диалоговый язык для взаимодействия с

Правило 19: Рассматривайте проектирование класса как проектирование типа

Правило 19: Рассматривайте проектирование класса как проектирование типа В C++, как и в других объектно-ориентированных языках программирования, при определении нового класса определяется новый тип. Потому большую часть времени вы как разработчик C++ будете тратить на

5.4. Метаформаты протоколов прикладного уровня

5.4. Метаформаты протоколов прикладного уровня Подобно тому, как были усовершенствованы метаформаты файлов данных, чтобы упростить сериализацию для хранения этих данных, метаформаты протоколов прикладного уровня были усовершенствованы, чтобы упростить сериализацию

5.

4.1. Классический метапротокол прикладного уровня в Internet

5.4.1. Классический метапротокол прикладного уровня в Internet RFC 3117 Маршала Роуза (Marshall Rose), «On the Design of Application Protocols»[54] представляет исключительный обзор вопросов проектирования протоколов прикладного уровня в Internet. В данном документе проясняются несколько черт классических

5.4.2. HTTP как универсальный протокол прикладного уровня

5.4.2. HTTP как универсальный протокол прикладного уровня С тех пор как приблизительно в 1993 году World Wide Web достигла критической массы, проектировщики прикладных протоколов демонстрируют усиливающуюся тенденцию к размещению специализированных протоколов над HTTP, используя

8.3.5. Язык или протокол прикладного уровня

8.3.5. Язык или протокол прикладного уровня Не менее важно определить, будут ли другие программы интерактивно вызывать ядро мини-языка в качестве подчиненного процесса. Если это так, то конструкция, вероятно, должна меньше походить на диалоговый язык для взаимодействия с

Атрибуты уровня компоновочного блока (и уровня модуля)

Атрибуты уровня компоновочного блока (и уровня модуля) Можно также задать применение атрибутов ко всем типам в рамках данного модуля или всех модулей в рамках данного компоновочного блока, если, соответственно, использовать признаки [module:] или [assembly:]. Предположим, что нам

систематических обзоров | Протокол

Все рукописи должны содержать следующие разделы под заголовком «Декларации»:

  • Одобрение этических норм и согласие на участие
  • Согласие на публикацию
  • Доступность данных и материалов
  • Конкурирующие интересы авторов
  • Финансирование 900 905
  • 9000 Благодарности
  • Информация об авторах (необязательно)

Подробная информация, которая должна быть включена в эти разделы, приведена ниже.

Если какой-либо из разделов не имеет отношения к вашей рукописи, включите заголовок и напишите «Неприменимо» для этого раздела.

Этическое одобрение и согласие на участие

Рукописи, сообщающие об исследованиях с участием людей, человеческих данных или человеческих тканей, должны:

  • содержать заявление об этическом одобрении и согласии (даже если от утверждения не требовалось одобрение)
  • включать имя комитета по этике, утвердившего исследование, и регистрационный номер комитета, если применимо

Исследования с участием животных должны включать заявление об одобрении этических норм, а для экспериментальных исследований с участием животных, принадлежащих клиенту, авторы также должны включать заявление об информированном согласии клиента или владелец.

Дополнительную информацию см. в нашей редакционной политике.

Если в вашей рукописи не сообщается о каких-либо данных или тканях животных или человека или не используется, укажите в этом разделе «Неприменимо».

Согласие на публикацию

Если ваша рукопись содержит данные какого-либо лица в любой форме (включая любые индивидуальные данные, изображения или видео), согласие на публикацию должно быть получено от этого лица, а в случае детей — от их родителей или законных опекун.Все презентации историй болезни должны иметь согласие на публикацию.

Вы можете использовать форму согласия вашего учреждения или нашу форму согласия, если хотите. Вы не должны отправлять нам форму при отправке, но мы можем запросить копию на любом этапе (в том числе после публикации).

Дополнительную информацию о согласии на публикацию см. в нашей редакционной политике.

Если ваша рукопись не содержит данных о каком-либо отдельном лице, укажите «Неприменимо» в этом разделе.

Наличие данных и материалов

Все рукописи должны включать заявление «Наличие данных и материалов». Заявления о доступности данных должны включать информацию о том, где можно найти данные, подтверждающие результаты, изложенные в статье, включая, где это применимо, гиперссылки на общедоступные архивные наборы данных, проанализированные или созданные в ходе исследования. Под данными мы подразумеваем минимальный набор данных, который потребуется для интерпретации, воспроизведения и использования выводов, изложенных в статье.Мы понимаем, что не всегда возможно публиковать исследовательские данные, например, когда может быть нарушена личная конфиденциальность, и в таких случаях доступность данных должна быть указана в рукописи вместе с любыми условиями доступа.

Заявления о доступности данных могут иметь одну из следующих форм (или комбинацию нескольких, если требуется для нескольких наборов данных):

  • Наборы данных, сгенерированные и/или проанализированные в ходе текущего исследования, доступны в репозитории [ИМЯ], [ПОСТОЯННАЯ ВЕБ-ССЫЛКА НА НАБОРЫ ДАННЫХ]
  • Наборы данных, использованные и/или проанализированные в ходе текущего исследования, можно получить у соответствующего автора по обоснованному запросу.
  • Все данные, полученные или проанализированные в ходе этого исследования, включены в эту опубликованную статью [и ее дополнительные информационные файлы].
  • Наборы данных, сгенерированные и/или проанализированные в ходе текущего исследования, не являются общедоступными из-за [ПРИЧИНА, ПОЧЕМУ ДАННЫЕ НЕ ОБЩЕСТВЕННЫ], но доступны у соответствующего автора по обоснованному запросу.
  • Совместное использование данных неприменимо к этой статье, так как в ходе текущего исследования наборы данных не создавались и не анализировались.
  • Данные, подтверждающие результаты этого исследования, доступны от [название третьей стороны], но на доступность этих данных распространяются ограничения, которые использовались по лицензии для текущего исследования, и поэтому не являются общедоступными.Однако данные доступны от авторов по обоснованному запросу и с разрешения [имя третьей стороны].
  • Не применимо. Если ваша рукопись не содержит никаких данных, укажите в этом разделе «Неприменимо».

Дополнительные примеры шаблонов заявлений о доступности данных, которые включают примеры наборов данных с открытым доступом и ограниченным доступом, доступны здесь.

BioMed Central также требует, чтобы авторы цитировали в рукописи любые общедоступные данные, на которых основаны выводы статьи.Ссылки на данные должны включать постоянный идентификатор (например, DOI) и в идеале должны быть включены в список литературы. Ссылки на наборы данных, когда они появляются в списке литературы, должны включать минимум информации, рекомендованной DataCite, и соответствовать стилю журнала. Идентификаторы наборов данных, включая DOI, должны быть представлены в виде полных URL-адресов. Например:


Hao Z, AghaKouchak A, Nakhjiri N, Farahmand A. Наборы данных Глобальной интегрированной системы мониторинга и прогнозирования засухи (GIDMaPS).фиговая доля. 2014. http://dx.doi.org/10.6084/m9.figshare.853801

С соответствующим текстом в заявлении о доступности данных и материалов:

Доступны наборы данных, созданные в ходе и/или проанализированные в ходе текущего исследования. в репозитории [ИМЯ], [ПОСТОЯННАЯ ВЕБ-ССЫЛКА НА НАБОРЫ ДАННЫХ]. [Номер ссылки]  

Если вы хотите отправить примечание с данными, описывающее ваши данные, которые будут опубликованы в BMC Research Notes , вы можете сделать это, посетив наш портал отправки.Примечания к данным поддерживают открытые данные и помогают авторам соблюдать политику спонсоров в отношении обмена данными. Совместно опубликованные примечания к данным будут связаны с исследовательской статьей в поддержку данных (пример).

Конкурирующие интересы

Все финансовые и нефинансовые конкурирующие интересы должны быть указаны в этом разделе.

Подробное описание конкурирующих интересов см. в нашей редакционной политике. Если вы не уверены, есть ли у вас или у кого-либо из ваших соавторов конкурирующие интересы, свяжитесь с редакцией.

Пожалуйста, используйте инициалы авторов для обозначения конкурирующих интересов каждого автора в этом разделе.

Если у вас нет конкурирующих интересов, укажите в этом разделе «Авторы заявляют об отсутствии конкурирующих интересов».

Финансирование

Необходимо указать все источники финансирования исследования. Роль финансирующей организации в разработке исследования и сборе, анализе и интерпретации данных, а также в написании рукописи должна быть заявлена.

Вклад авторов

В этом разделе должен быть указан индивидуальный вклад авторов в рукопись. Руководство и критерии авторства можно найти в наших редакционных правилах.

Пожалуйста, используйте инициалы для обозначения вклада каждого автора в этот раздел, например: «FC проанализировал и интерпретировал данные пациентов относительно гематологического заболевания и трансплантата. RH провел гистологическое исследование почки и внес большой вклад в письменной форме. рукопись.Все авторы прочитали и утвердили окончательный вариант рукописи».

Благодарности

Пожалуйста, отметьте всех, кто внес свой вклад в подготовку статьи, но не соответствует критериям авторства, включая тех, кто предоставил профессиональные письменные услуги или материалы.

Авторы должны получить разрешение на признание от все упомянутые в разделе «Благодарности»

Полное объяснение критериев благодарности и авторства см. в наших редакционных правилах.

Если вам некого подтвердить, напишите в этом разделе «Неприменимо».

Групповое авторство (для рукописей с участием совместной группы): если вы хотите, чтобы имена отдельных членов совместной группы были доступны для поиска в их индивидуальных записях PubMed, убедитесь, что название совместной группы включено в название. странице и в системе отправки, а также включить имена сотрудничающих авторов в качестве последнего абзаца раздела «Благодарности».Пожалуйста, добавляйте авторов в формате Имя, Инициал(ы) отчества (необязательно), Фамилия. Вы можете добавить информацию об учреждении или стране для каждого автора, если хотите, но это должно быть одинаковым для всех авторов.

Обратите внимание, что отдельные имена могут отсутствовать в записи PubMed на момент первоначального включения опубликованной статьи в PubMed, поскольку PubMed требуется дополнительное время для кодирования этой информации.

Информация об авторах

Этот раздел является необязательным.

Вы можете использовать этот раздел для включения любой соответствующей информации об авторе (авторах), которая может помочь читателю в интерпретации статьи и понять точку зрения автора (авторов).Это может включать сведения о квалификации авторов, нынешних должностях, которые они занимают в учреждениях или обществах, или любую другую соответствующую справочную информацию. Пожалуйста, ссылайтесь на авторов, используя их инициалы. Обратите внимание, что этот раздел не следует использовать для описания каких-либо конкурирующих интересов.

Сноски

Сноски могут использоваться для предоставления дополнительной информации, которая может включать цитирование ссылки, включенной в список литературы. Они не должны состоять исключительно из ссылочной цитаты и никогда не должны включать библиографические детали ссылки.Они также не должны содержать никаких рисунков или таблиц.

Сноски к тексту нумеруются последовательно; те, что к таблицам, должны быть обозначены надстрочными буквами верхнего индекса (или звездочками для значений значимости и других статистических данных). В сносках к названию или авторам статьи условные обозначения не даются.

Всегда используйте сноски вместо концевых сносок.

Протокол отправки и проверки контента

Предоставление утвержденного, точного и исчерпывающего контента и соблюдение оптимизированного процесса проверки имеют решающее значение для эффективной коммуникации.Приведенный ниже обязательный протокол описывает, как работать с институциональными коммуникациями.


Протокол отправки контента

Контент состоит из текста, фотографий и логотипов/иллюстраций. Отправка контента, который следует протоколу отправки контента, позволяет Institutional Communications получить целостное понимание ваших целей, сообщений и видения, чтобы создать и предоставить эффективный продукт, адаптированный для вашей целевой аудитории.

Текст

Весь текст должен быть предоставлен отделу по связям с общественностью в виде документа Word.Если у вас есть комментарии или примечания для команды по связям с общественностью, такие как параметры форматирования, использование фотографий и т.  д., предоставьте эту информацию красным текстом по всему документу или воспользуйтесь функцией комментариев .

Советы по письму
  • Определите аудиторию(и). Вы пытаетесь связаться с нынешними или потенциальными студентами, родителями, преподавателями, сотрудниками, широкой публикой или любой их комбинацией? Сделайте свое сообщение ясным и понятным, чтобы оно нашло отклик у тех, кто предназначен для его чтения.
  • Создайте план, чтобы систематизировать свои мысли и убедиться, что содержимое соответствует вашим ключевым сообщениям.
  • Ознакомьтесь с Руководством по редакционному стилю UWF, чтобы убедиться, что ваш стиль письма соответствует рекомендациям университета.
  • При написании контента учитывайте предполагаемый срок хранения вашей публикации или рекламы. Чем дольше ваш контент остается актуальным, тем больше копий вы можете напечатать или тем больше раз вы можете показывать свою рекламу. Когда это уместно, рассмотрите возможность привлечения читателей на веб-сайт, где информация, которая часто меняется, может регулярно обновляться, вместо того, чтобы включать эти детали в свой контент.
  • Подтвердите свои факты:
    • Проверка написания имен.
    • Проверить должности людей, отделов, центров и т. д.
    • Убедитесь, что все URL-адреса работают и что вы используете самый короткий доступный URL-адрес.
    • Проверить адреса и номера телефонов.
  • Тщательно отредактируйте и откорректируйте свой проект и попросите других в вашем подразделении, отделе или подразделении проверить его перед завершением.

Фотография

Все фотографии должны быть предоставлены отделу по связям с общественностью в виде вложения по электронной почте или в виде zip-файла с разрешением не менее 300 пикселей на дюйм (пикселей на дюйм).Фотография не должна быть встроена в другие документы или презентации или загружена непосредственно с сайтов социальных сетей или при поиске изображений в Интернете.

Institutional Communications поддерживает обширную библиотеку фотографий в качестве ресурса для университетских подразделений, колледжей и отделов. Мы рекомендуем вам связаться с нами, чтобы узнать, есть ли у нас то, что вам нужно, если вы не можете предоставить свою собственную фотографию. Также посетите Портал брендов UWF, чтобы получить советы по фотографии, ресурсы для съемки собственных фотографий и информацию о политике публикации фото/видео UWF.

Логотипы и иллюстрации

Официальные логотипы, товарные знаки и таблички с именами являются основными идентификаторами Университета Западной Флориды. Институциональные коммуникации будут следовать всем стандартам логотипов, изложенным на портале бренда, для обеспечения согласованности. Если необходимо включить логотип партнера, предоставьте файл EPS. Файл EPS (Encapsulated PostScript) — это формат графического файла, используемый в векторных изображениях. Например, имена файлов EPS заканчиваются на .eps, а не на .jpg.Если возможно, также предоставьте логотипы партнеров с условиями использования и стандартами бренда.

Утверждение содержания и стратегии

Все материалы и стратегии должны быть одобрены главой соответствующего отдела или подразделения , прежде чем они будут представлены в отдел по связям с общественностью.

Протокол проверки

После того, как проект будет спроектирован/разработан, отдел по связям с общественностью предоставит одно доказательство для проверки и обратной связи.

Пожалуйста, следуйте приведенным ниже рекомендациям при внесении правок в пробу:

  • Все изменения должны быть предоставлены в письменной форме по одному электронному письму.
  • Редактирование PDF-файлов должно выполняться с помощью функции выделения/комментирования в Adobe Acrobat Pro. Пожалуйста, не вносите изменения в PDF, так как дизайнер не будет знать, какой текст был изменен.
  • Проконсультируйтесь со всеми участниками проекта, получившими окончательное утверждение, и соберите все изменения для отправки в одном электронном письме. Не отправляйте незавершенные правки или одноразовые электронные письма с правками. Каждое отдельное электронное письмо считается еще одним этапом проверки.

Если запрашивается дополнительное подтверждение или не соблюдаются вышеуказанные рекомендации, проект автоматически переместится в конец очереди команды, что приведет к задержке проекта (обычно от 72 часов до двух недель, в зависимости от нагрузка и приоритеты).

 

PLOS Medicine: рецензируемый журнал открытого доступа

О журнале

PLOS Medicine публикует оригинальные исследовательские статьи выдающегося медицинского значения. Мы рассмотрим рукописи любого объема; мы поощряем представление как существенных полных работ, так и более коротких рукописей, в которых сообщается о новых открытиях, которые могут быть основаны на более ограниченном диапазоне экспериментов.

Стиль письма должен быть кратким и доступным, без использования жаргона, чтобы статья была понятна для читателей, не являющихся специалистами по специальности, или для тех, чей родной язык не английский.Редакторы внесут предложения о том, как этого добиться, а также предложения об исключениях или добавлениях, которые можно было бы внести в статью для усиления аргументации. Наша цель — сделать редакционный процесс строгим и последовательным, но не навязчивым или властным. Авторам рекомендуется использовать собственный голос и решать, как лучше всего представить свои идеи, результаты и выводы.

О журнале

PLOS Medicine  придерживается самых высоких этических стандартов в медицинских исследованиях.Соответственно, мы просим авторов предоставить конкретную информацию об этическом обращении с участниками исследования, согласии пациентов, конфиденциальности пациентов, протоколах, авторстве и конкурирующих интересах. Мы также просим, ​​чтобы отчеты об определенных типах исследований соответствовали общепринятым стандартам. Наши требования основаны на Единых требованиях к рукописям, представляемым в биомедицинские журналы, изданных Международным комитетом редакторов медицинских журналов.

Дополнительная информация для авторов

О процессе отправки

Первоначальное представление без формата

В PLOS Medicine используется процесс первоначальной отправки, что позволяет авторам быстро отправить заявку в журнал и быстро получить обратную связь от редакторов. Если редакция решит, что работа подходит для рецензирования, авторов попросят предоставить полную заявку с дополнительной информацией.

Соответствующие типы изделий

Этот процесс применяется ко всем типам статей, представленным в PLOS Medicine .

Элементы представления
  • Соответствующая информация об авторе
  • Рукопись (с титульным листом, содержащим полный список авторов)
  • Сопроводительное письмо
  • Цифры
  • Вспомогательная информация 
Формат представления
  • Один PDF-файл, содержащий рукопись, рисунки и вспомогательные информационные файлы, с отдельным сопроводительным письмом (рекомендуется для упрощения первоначальной отправки)

      ИЛИ

  • При необходимости загрузите файлы рисунков вместе с файлом рукописи в формате PDF или Word с отдельным сопроводительным письмом

Создание исходного материала — самый эффективный способ получить обратную связь от журнала. Авторам, отправившим запрос по электронной почте, будет предложено представить рукопись в качестве исходной заявки.

Полная подача без формата

Если вы получите первоначальное решение журнала о проведении рецензирования, вас попросят заполнить полную заявку с дополнительной информацией, включая:

  • Полный список авторов и сведения об авторе
  • Подробная информация о наличии данных, полученных в ходе исследования
  • Подробная информация о любых этических утверждениях
  • Сведения о регистрации клинических испытаний, если применимо
Стиль и формат

Приведенные ниже критерии стиля и формата требуются только в том случае, если рукопись рассматривается для публикации с положительным решением после рецензирования.Авторам, приглашенным для внесения изменений, будет предложено отформатировать свою рукопись в соответствии с этими требованиями. Мы не требуем специального форматирования рукописей для полного представления.

Формат файла

Отправьте файл рукописи в формате DOC, DOCX, RTF или PDF. Ваш файл не должен быть заблокирован или защищен.

Если вы написали свою рукопись в LaTeX, отправьте ее в формате PDF. Прочтите руководство по LaTeX.

Длина

Рукописи могут быть любой длины. Нет никаких ограничений по количеству слов, количеству рисунков или объему вспомогательной информации.


Мы рекомендуем вам кратко представить и обсудить ваши выводы.

Шрифт

Используйте стандартный размер шрифта и любой стандартный шрифт, кроме шрифта «Symbol». Чтобы добавить символы в рукопись, используйте функцию «Вставить» → «Символ» в текстовом редакторе или вставьте соответствующий символ Юникода.

Заголовки

Ограничить разделы и подразделы рукописи до трех уровней заголовков. Убедитесь, что уровни заголовков четко указаны в тексте рукописи.

Расположение и интервалы

Текст рукописи должен быть напечатан через два интервала.

Не форматировать текст в нескольких столбцах.

Номера страниц и строк

Включите номера страниц и номеров строк в файл рукописи.Используйте непрерывную нумерацию строк (не повторяйте нумерацию на каждой странице заново).

Сноски

Сноски не допускаются. Если ваша рукопись содержит сноски, переместите информацию в основной текст или в список литературы, в зависимости от содержания.

Язык

Рукописи должны быть представлены на английском языке.

Вы можете представить переводы рукописи или реферата в качестве вспомогательной информации.Прочтите рекомендации по вспомогательной информации.

Сокращения

Определите сокращения при первом появлении в тексте.

Не используйте нестандартные сокращения, если они не встречаются в тексте не менее трех раз. Перечислите все нестандартные сокращения (с определениями) в алфавитном порядке в отдельном разделе в начале рукописи.

Сведите сокращения к минимуму.

Справочный стиль

PLOS использует стиль «Ванкувер», как указано в образцах ссылок ICMJE.

См. справочные примеры форматирования и дополнительные инструкции ниже.

Уравнения

Мы рекомендуем использовать MathType для отображения и встроенных уравнений, так как это обеспечит наиболее надежный результат. Если это невозможно, можно использовать Редактор формул или функцию Microsoft Вставка → Формула. Пожалуйста, не вставляйте формулы в виде изображений.

Избегайте использования MathType, Equation Editor или функции Insert→Equation для вставки отдельных переменных (например,например, «a² + b² = c²»), греческие или другие символы (например, β, Δ или ′ [простое число]) или математические операторы (например, x, ≥ или ±) в бегущем тексте. По возможности вставляйте отдельные символы как обычный текст с правильными значениями Юникода (шестнадцатеричными).

Не используйте MathType, Equation Editor или функцию Insert→Equation только для части уравнения. Вместо этого убедитесь, что все уравнение включено. Уравнения не должны содержать смесь различных инструментов уравнений. Избегайте «гибридных» встроенных или отображаемых уравнений, в которых часть – текст, а часть – MathType, или часть – MathType, а часть – редактор формул.

Номенклатура

 По возможности используйте правильную и устоявшуюся номенклатуру.

Единицы измерения Используйте единицы СИ. Если вы не используете их исключительно, укажите значение SI в скобках после каждого значения. Узнайте больше о единицах СИ.
Наркотики Укажите рекомендуемое международное непатентованное название (rINN).
Названия видов Напишите курсивом (например, Homo sapiens ). Выпишите полностью род и вид как в названии рукописи, так и при первом упоминании организма в статье. После первого упоминания можно использовать первую букву названия рода, за которой следует полное название вида (например, H. sapiens ).
Гены, мутации, генотипы и аллели Напишите курсивом.Используйте рекомендуемое имя, сверившись с соответствующей базой данных генетической номенклатуры (например, HGNC для генов человека; мы настоятельно рекомендуем использовать этот инструмент для проверки ранее одобренных имен). Иногда целесообразно указывать синонимы для гена при первом его появлении в тексте. Генные префиксы, такие как те, которые используются для онкогенов или клеточной локализации, должны отображаться прямым шрифтом (например, v-fes, c-MYC).
Аллергены

Для рукописей, включающих описание или использование аллергенных белков, следует использовать систематическую номенклатуру аллергенов Подкомитета по номенклатуре аллергенов Всемирной организации здравоохранения/Международного союза иммунологических обществ (ВОЗ/IUIS). Для рукописей, описывающих новые аллергены, систематическое название аллергена должно быть одобрено Подкомитетом по номенклатуре аллергенов ВОЗ/IUIS до публикации рукописи. Примеры систематической номенклатуры аллергенов можно найти на сайте номенклатуры аллергенов ВОЗ/IUIS.

Организация рукописей

Большинство рукописей должны быть организованы следующим образом. Инструкции для каждого элемента приведены ниже.

  • Титул
  • Авторы
  • Филиалы
  • Аннотация
  • Введение
  • Методы (или методы и материалы)
  • Результаты
  • Обсуждение
  • Благодарности
  • Ссылки
  • Вспомогательные информационные подписи
Прочие элементы

  Обратитесь к нашим загружаемым образцам файлов, чтобы убедиться, что ваша отправка соответствует нашим требованиям к форматированию:

Название

Включите полное название и краткое название рукописи.

Название Длина Указания Примеры
Полное название 200 символов Конкретный, описательный, краткий и понятный для читателей за пределами области

Воздействие сигаретного дыма на врожденный иммунитет: A  Caenorhabditis elegans  модель

Солнечная дезинфекция питьевой воды (SODIS) для снижения детской диареи в сельских районах Боливии: кластерное рандомизированное контролируемое исследование

Краткое название 70 символов Назовите тему исследования

Воздействие сигаретного дыма и врожденный иммунитет

SODIS и детская диарея

Названия должны быть написаны в регистре предложения (только первое слово текста, имена собственные и названия родов пишутся с большой буквы). По возможности избегайте специальных сокращений. Для клинических испытаний, систематических обзоров или метаанализов подзаголовок должен включать дизайн исследования.

Список авторов

Требования к авторству

Все авторы должны соответствовать критериям авторства, изложенным в политике авторства. Те, кто внес свой вклад в работу, но не соответствует критериям авторства, могут быть упомянуты в благодарностях. Подробнее о Благодарностях.

Соответствующий автор должен предоставить идентификатор ORCID во время отправки, введя его в профиль пользователя в системе отправки.Узнайте больше об ORCID.

Имена авторов и организации

При первоначальной подаче укажите имена авторов на титульном листе рукописи. Если ваша рукопись выбрана для рецензирования, вы также добавите информацию об авторе в систему отправки.

На титульном листе укажите имена авторов в следующем порядке:

  • Имя (или инициалы, если используются)
  • Отчество (или инициалы, если используются)
  • Фамилия (фамилия, фамилия)

Каждый автор в списке должен иметь членство. Принадлежность включает отдел, университет или организационную принадлежность и ее местонахождение, включая город, штат/область (если применимо) и страну. У авторов есть возможность указать текущий адрес в дополнение к адресу их принадлежности на момент исследования. Текущий адрес должен быть указан в подписи и четко помечен как «текущий адрес». Как минимум, адрес должен включать текущее учреждение автора, город и страну.

Если у автора несколько организаций, введите полный список организаций на титульном листе.В системе подачи введите только предпочитаемую или основную принадлежность. Принадлежности авторов будут перечислены в напечатанной статье в формате PDF в том же порядке, в котором авторы перечислены в заявке.

Имена авторов будут опубликованы точно так же, как они указаны в файле рукописи. Пожалуйста, внимательно перепроверьте информацию, чтобы убедиться, что она верна.

Автор, ответственный за переписку

Отправляющий автор автоматически назначается соответствующим автором в системе отправки. Соответствующий автор является основным контактным лицом для офиса журнала и единственным автором, имеющим право просматривать или изменять рукопись, пока она находится на рассмотрении редакции.

Соответствующая роль автора может быть передана другому соавтору. Однако обратите внимание, что передача соответствующей роли автора также передает доступ к рукописи. (Чтобы назначить нового соответствующего автора, пока рукопись находится на рассмотрении, посмотрите видеоруководство ниже.)

В системе подачи может быть указан только один соответствующий автор, но это не ограничивает количество соответствующих авторов, которые могут быть указаны в статье в случае публикации.Тот, кто указан в качестве соответствующего автора на титульном листе файла рукописи, будет указан как таковой после публикации. Включите адрес электронной почты для каждого соответствующего автора, указанного на титульном листе рукописи.

   Как выбрать нового соответствующего автора в Editorial Manager

Консорциумы и групповое авторство

Если рукопись представлена ​​от имени консорциума или группы, укажите ее название в подписи к рукописи.Не добавляйте его в список авторов в системе отправки. Вы можете включить полный список участников в раздел «Благодарности» или в файл со вспомогательной информацией.

PubMed индексирует только отдельных членов консорциума или группы авторов, перечисленных в подписи к статье. Если они включены, эти лица должны соответствовать критериям авторства в соответствии с нашими критериями.

Авторские вклады

Если ваша рукопись будет выбрана для рецензирования, вы введете все авторские материалы в систему подачи заявок.Предоставьте как минимум один вклад от каждого автора и используйте таксономию CRediT для описания каждого вклада. Ознакомьтесь с политикой и полным списком ролей.

Чтобы претендовать на авторство, все участники должны соответствовать хотя бы одному из семи основных вкладов (концептуализация, методология, программное обеспечение, проверка, формальный анализ, исследование, курирование данных), а также хотя бы одному из письменных вкладов (подготовка исходного проекта). , проверка и редактирование). Авторы также могут удовлетворить другие оставшиеся взносы; однако сами по себе они не могут претендовать на авторство.

Вклады будут опубликованы вместе с финальной статьей, и они должны точно отражать вклады в работу. Подающий автор несет ответственность за заполнение этой информации при полной подаче, и мы ожидаем, что все авторы просмотрят, обсудят и согласятся со своими индивидуальными вкладами до этого времени.

Со всеми авторами свяжутся по электронной почте после полной подачи, чтобы убедиться, что они знают и одобряют представление рукописи, ее содержание, авторство и порядок авторства.Статьи не будут опубликованы, если все авторы не дали свое согласие на публикацию.

Сопроводительное письмо

Загрузить сопроводительное письмо отдельным файлом в онлайн-систему.

Сопроводительное письмо должно содержать ответы на следующие вопросы:

  • Почему эта рукопись подходит для публикации в PLOS Medicine ?
  • Почему ваше исследование вдохновит исследователей или клиницистов и как оно улучшит уход за пациентами или общественное здравоохранение или продвинет понимание болезни?

Титульный лист

Название, авторы и организации должны быть указаны на титульном листе в качестве первой страницы файла рукописи.

Аннотация

Резюме идет после титульного листа в файле рукописи. Текст тезисов также вводится в отдельное поле в системе отправки.

Резюме исследовательской статьи разделено на следующие три раздела: «Предпосылки», «Методы и выводы» и «Выводы». Он должен содержать все следующие элементы (элементы в квадратных скобках необходимы только для некоторых типов исследований).

PLOS Medicine  предпочитает тезисы, не превышающие 300 слов, но не более 500 слов.

Фон
  • В этом разделе должно быть четко изложено обоснование исследования. Он должен заканчиваться заявлением о конкретной гипотезе исследования и/или целях исследования.
Методы и выводы
  • Опишите участников исследования или то, что было изучено (например, популяция пациентов, клеточные линии; будьте как можно более конкретными, включая количество исследованных лиц). Опишите дизайн исследования, вмешательство, если применимо, основные использованные методы, критерий(и) первичного результата и продолжительность последующего наблюдения, если применимо.
  • [Если применимо, укажите, сколько участников из зачисленных было оценено. Для исследования в форме опроса укажите процент ответивших.]
  • [Если это важно для понимания статьи, опишите, как анализировались результаты, т. е. какие конкретные статистические тесты использовались.]
  • Опишите основные исходы и дайте количественную оценку результатов, используя меру точности (например, 95% доверительный интервал). Опишите любые нежелательные явления.
  • Опишите основные ограничения исследования.
Выводы
  • Предоставьте общую интерпретацию результатов с любыми важными рекомендациями для будущих исследований.
  • [Для клинического исследования укажите любой идентификационный(ые) номер(а) исследования и название(я) (например, регистрационный номер исследования, номер протокола или аббревиатуру).]

Введение

Во введении следует рассматривать рукопись в более широком контексте. Составляя введение, думайте о читателях, которые не являются экспертами в этой области.Включите краткий обзор ключевой литературы. Если в этой области есть соответствующие противоречия или разногласия, о них следует упомянуть, чтобы читатель, не являющийся экспертом, мог глубже вникнуть в эти вопросы. Введение должно заканчиваться кратким изложением общей цели экспериментов и комментарием о том, была ли эта цель достигнута.

Методы

Методы должны содержать достаточно деталей для воспроизведения результатов. Должны быть включены протоколы для новых методов, но можно просто сослаться на хорошо зарекомендовавшие себя методологические процедуры.Полное описание методов должно быть включено в саму рукопись, а не в дополнительный файл.

Методы также должны включать раздел с описанием любых используемых статистических методов. Описание должно соответствовать критериям, изложенным в Единых требованиях, а именно: 

.

Опишите статистические методы достаточно подробно, чтобы знающий читатель, имеющий доступ к исходным данным, мог оценить их пригодность для исследования и проверить представленные результаты. Когда это возможно, дайте количественную оценку результатов и представьте их с соответствующими индикаторами ошибки измерения или неопределенности (такими как доверительные интервалы). Избегайте полагаться исключительно на статистическую проверку гипотез, таких как значения P, которые не могут предоставить важную информацию о величине эффекта и точности оценок. Ссылки на дизайн исследования и статистические методы должны быть, по возможности, на стандартные работы (с указанием страниц). Определение статистических терминов, сокращений и большинства символов. Укажите пакет(ы) статистического программного обеспечения и используемые версии.Отличие предварительно определенного от исследовательского анализа, включая анализ подгруппы.

Отправьте подробные протоколы для более новых или менее известных методов. На хорошо зарекомендовавшие себя протоколы можно просто ссылаться. Протокольные документы для клинических испытаний, обсервационных исследований и других нелабораторных исследований могут быть загружены в качестве вспомогательной информации.

Мы рекомендуем и рекомендуем вам депонировать лабораторные протоколы в протоколах.io, где протоколам могут быть назначены собственные постоянные идентификаторы цифровых объектов (DOI).

Чтобы включить ссылку на протокол в вашу статью:

  1. Опишите свой пошаговый протокол на protocols.io
  2. Выберите Получить DOI , чтобы присвоить вашему протоколу постоянный цифровой идентификатор объекта (DOI)
  3. Включите ссылку DOI в раздел «Методы» своей рукописи, используя следующий формат, предоставленный протоколами.io: http://dx.doi.org/10.17504/protocols.io.[DOI ПРОТОКОЛА]

На данном этапе ваш протокол виден только тем, у кого есть ссылка. Это позволяет редакторам и рецензентам сверяться с вашим протоколом при оценке рукописи. Вы можете сделать свои протоколы общедоступными в любое время, выбрав Опубликовать на сайте protocols.io. Любой упомянутый(е) протокол(ы) будет автоматически обнародован при публикации вашей статьи.

PLOS ONE предлагает возможность публикации рецензируемых статей Lab Protocol, в которых описываются протоколы, размещенные в протоколах.ио статьи. Дополнительные сведения см. в статьях о лабораторном протоколе.

Результаты

Раздел «Результаты» должен включать все проанализированные первичные и вторичные показатели результатов. Раздел может быть разделен на подразделы, каждый из которых имеет краткий подзаголовок. Таблицы и рисунки, занимающие центральное место в исследовании, должны быть включены в основной документ. Раздел «Результаты» должен быть написан в прошедшем времени.

Журналы PLOS требуют от авторов, чтобы все данные, лежащие в основе выводов, описанных в их рукописи, были полностью доступны без ограничений, за редким исключением.

Большие наборы данных, включая необработанные данные, могут храниться в соответствующем общедоступном репозитории. См. наш список рекомендуемых репозиториев.

Для небольших наборов данных и определенных типов данных авторы могут предоставлять свои данные в файлах вспомогательной информации, сопровождающих рукопись. Авторы должны позаботиться о максимальной доступности и возможности повторного использования данных, выбрав формат файла, из которого данные могут быть эффективно извлечены (например, при предоставлении табличных данных следует предоставлять электронные таблицы или плоские файлы, а не PDF-файлы).

Для получения дополнительной информации о том, как лучше предоставлять данные, ознакомьтесь с нашей политикой доступности данных. PLOS не принимает ссылки на «данные не показаны».

Как указано в Единых требованиях: 

Приведите числовые результаты не только в виде производных (например, в процентах), но и в виде абсолютных чисел, из которых были рассчитаны производные, и укажите придаваемую им статистическую значимость, если таковая имеется. Ограничьте таблицы и рисунки теми, которые необходимы для объяснения аргументации статьи и оценки подтверждающих данных.Используйте графики как альтернативу таблицам с большим количеством записей; не дублировать данные в графиках и таблицах. Избегайте нетехнического использования технических терминов в статистике, таких как «случайный» (что подразумевает рандомизирующее устройство), «нормальный», «значимый», «корреляции» и «выборка».

Обсуждение

Обсуждение должно быть кратким и аргументированным. Его следует начать с краткого изложения основных выводов. Он должен включать параграфы об обобщении, клинической значимости, сильных сторонах и ограничениях вашего исследования.

Вы также можете обсудить следующие вопросы:

  • Как выводы влияют на существующие знания в данной области?
  • Как будущие исследования могут основываться на этих наблюдениях и какие ключевые эксперименты необходимо провести?

Благодарности

Те, кто внес свой вклад в работу, но не соответствует нашим критериям авторства, должны быть перечислены в Благодарности с описанием вклада.

Авторы несут ответственность за то, чтобы любой, кто упоминается в Благодарностях, соглашался быть названным.

Журналы PLOS ежегодно публично признают незаменимые усилия наших редакторов и рецензентов. Чтобы обеспечить справедливое признание и избежать любого проявления пристрастности, не включайте редакторов или рецензентов — по имени или без имени — в Благодарности.

Не указывайте источники финансирования в разделе «Благодарности» или где-либо еще в файле рукописи.Информацию о финансировании следует вводить только в разделе раскрытия финансовой информации системы подачи заявок.

Ссылки

Любые и все имеющиеся работы могут быть процитированы в списке литературы. Допустимые источники включают:

  • Опубликованные или принятые рукописи
  • Рукописи на серверах препринтов, при условии, что рукопись имеет доступный для цитирования URL-адрес DOI или arXiv.

Не указывать в списке литературы следующие источники:

  • Недоступная и неопубликованная работа, включая рукописи, которые были отправлены, но еще не приняты (например,г. , «неопубликованная работа», «данные не показаны»). Вместо этого включите эти данные в качестве дополнительных материалов или поместите данные в общедоступную базу данных.
  • Личные сообщения (они должны быть подкреплены письмом от соответствующих авторов, но не включены в список литературы)
  • Представленное исследование не должно основываться на отозванном исследовании. Вы должны избегать цитирования отозванных статей, если только вам не нужно обсуждать отозванные работы, чтобы обеспечить исторический контекст для вашего исследования.Если необходимо обсудить отозванную работу, укажите статус отозванной статьи в тексте вашей статьи и в списке литературы.

Убедитесь, что ваш список литературы включает полную и текущую библиографическую информацию для каждой цитируемой работы на момент подачи вашей статьи (и публикации, если она принята). Если цитируемая работа исправлена, отозвана или помечена выражением беспокойства до публикации вашей статьи, и если вы считаете уместным цитировать работу даже в свете уведомления после публикации, включите в свою рукопись цитаты и полные ссылки. как для затронутой статьи, так и для уведомления после публикации.Пишите в редакцию журнала, если у вас есть вопросы.

Ссылки перечислены в конце рукописи и пронумерованы в порядке их упоминания в тексте. В тексте укажите номер ссылки в квадратных скобках (например, «Мы использовали методы, разработанные нашими коллегами [19] для анализа данных»). В PLOS используется метод пронумерованных ссылок (последовательность цитирования), и первые шесть авторов и соавт.

Не включать цитаты в тезисы.

Убедитесь, что части рукописи расположены в правильном порядке перед  упорядочиванием цитат.

Ссылки на форматирование

Поскольку все ссылки будут в максимально возможной степени связаны электронными ссылками с документами, на которые они ссылаются, надлежащее форматирование ссылок имеет решающее значение.

PLOS использует справочный стиль, изложенный Международным комитетом редакторов медицинских журналов (ICMJE), также называемый «ванкуверским» стилем. Примеры форматов перечислены ниже. Дополнительные примеры приведены в справочниках образцов ICMJE.

Инструмент управления ссылками EndNote предлагает файл текущего стиля, который может помочь вам с форматированием ваших ссылок.Если у вас возникли проблемы с какой-либо программой управления ссылками, обратитесь в службу технической поддержки компании-источника.

Аббревиатуры названий журналов должны быть найдены в базах данных Национального центра биотехнологической информации (NCBI).

...
Источник Формат
Опубликованные статьи

Hou WR, Hou YL, Wu GF, Song Y, Su XL, Sun B и др. кДНК, клонирование геномной последовательности и сверхэкспрессия гена рибосомного белка L9 (rpL9) большой панды (Ailuropoda melanoleuca).Жене Мол Рез. 2011;10: 1576-1588.

Девараджу П., Гулати Р., Энтони П.Т., Митхун К.Б., Неги В.С. Восприимчивость к СКВ у тамилов Южной Индии может зависеть от давления генетической селекции на гены TLR2 и TLR9. Мол Иммунол. 22 ноября 2014 г. pii: S0161-5890(14)00313-7. doi: 10.1016/j.molimm.2014.11.005.


Примечание. Номер DOI для полнотекстовой статьи допускается в качестве альтернативы или в дополнение к традиционным номерам томов и страниц. При предоставлении DOI придерживайтесь формата, приведенного в приведенном выше примере, с указанием метки и полного DOI в конце ссылки (doi: 10.1016/j.molimm.2014.11.005). Не указывайте сокращенный DOI или URL.
Принятые неопубликованные статьи То же, что и опубликованные статьи, но вместо номеров страниц или DOI вместо «Ожидается».
Интернет-статьи

Huynen MMTE, Martens P, Hilderlink HBM. Влияние глобализации на здоровье: концептуальная основа. Глобальное здоровье. 2005;1: 14. Доступно по адресу: http://www.globalizationandhealth.com/content/1/1/14

Книги

Бейтс Б.Торг на жизнь: социальная история туберкулеза. 1-е изд. Филадельфия: Издательство Пенсильванского университета; 1992.

Главы книг Хансен Б. Эпидемии и история Нью-Йорка для общественности. В: Харден В.А., Риссе Г.Б., редакторы. СПИД и историк. Bethesda: Национальные институты здоровья; 1991. С. 21-28.
Депонированные статьи (препринты, электронные распечатки или arXiv)

Крик Т., Шуб Д.А., Верстраете Н., Феррейро Д.Ю., Алонсо Л.Г., Шуб М. и др.Метаболизм аминокислот противоречит разнообразию белков. arXiv:1403.3301v1 [Препринт]. 2014 [цитировано 17 марта 2014 г.]. Доступно по адресу: https://128.84.21.199/abs/1403.3301v1​

Кординг К.П., Меньш Б. Десять простых правил структурирования статей. BioRxiv [Препринт]. 2016 bioRxiv 088278 [опубликовано 28 ноября 2016 года; пересмотрено 14 декабря 2016 г .; пересмотрено 15 декабря 2016 г .; процитировано 9 февраля 2017 г.]: [12 стр.]. Доступно по адресу: https://www.biorxiv.org/content/10. 1101/088278v5 doi: 10.1101/088278

Публикации (печатные или интернет-газеты и журнальные статьи) Фонтан Х.Исследование показало, что для уже уязвимых пингвинов изменение климата представляет собой еще одну опасность. Нью-Йорк Таймс. 2014 г., 29 января [Процитировано 17 марта 2014 г.]. Доступно по адресу: http://www.nytimes.com/2014/01/30/science/earth/climate-change-taking-toll-on-penguins-study-finds.html
Новые средства массовой информации (блоги, веб-сайты или другие письменные работы) Аллен Л. Анонс блогов PLOS. 2010, 1 сентября [по состоянию на 17 марта 2014 г.]. В: Блоги PLOS [Интернет]. Сан-Франциско: PLOS 2006 — . [около 2 экранов].Доступно по адресу: http://blogs.plos.org/plos/2010/09/announcing-plos-blogs/.
Магистерские или докторские диссертации Уэллс А. Изучение развития независимого электронного научного журнала. Магистр наук Диссертация, Университет Шеффилда. 1999. Доступно по адресу: http://cumincad.scix.net/cgi-bin/works/Show?2e09
Базы данных и репозитории (Figshare, arXiv) Робертс С.Б. Функции браузера QPX Genome Browser; 2013 [цитировано 5 октября 2013 г.].База данных: figshare [Интернет]. Доступно по адресу: http://figshare.com/articles/QPX_Genome_Browser_Feature_Tracks/701214
Мультимедиа (видео, фильмы или телепередачи) Хичкок А., продюсер и режиссер. Заднее окно [Пленка]; 1954. Лос-Анджелес: MGM.

Дополнительная информация

Авторы могут присылать необходимые вспомогательные и мультимедийные файлы вместе со своими рукописями. Вся вспомогательная информация будет подвергаться экспертной оценке.Все типы файлов могут быть отправлены, но файлы должны быть меньше 20 МБ.

Авторы могут использовать практически любое описание в качестве имени элемента для файла со вспомогательной информацией, если оно содержит букву «S» и номер. Например, «Приложение S1» и «Приложение S2», «Таблица S1» и «Таблица S2» и т. д.

Вспомогательные информационные файлы публикуются в том виде, в каком они были предоставлены, и не редактируются.

Вспомогательные информационные подписи

Перечислите вспомогательные информационные подписи в конце файла рукописи.Не отправляйте подписи в отдельный файл.

В заголовке необходимо указать номер и имя файла, и мы настоятельно рекомендуем также включать однострочный заголовок. Вы также можете включить легенду в подпись, но это не обязательно.

Пример заголовка

S1 Text. Название настоятельно рекомендуется.

 Легенда необязательна.
Цитаты в тексте

Мы рекомендуем указывать вспомогательную информацию в тексте рукописи, но это не является обязательным требованием.Если вы цитируете вспомогательную информацию в тексте, цитаты не обязательно должны быть в порядке нумерации.

Рисунки и таблицы

Файлы рисунков

Если вы отправляете Исходное или Полное представление и предпочитаете вставлять каждый рисунок в рукопись, делайте это в порядке чтения, сразу после абзаца, в котором рисунок впервые упоминается, и над соответствующей подписью к рисунку.

После редакции подготовьте и отправьте каждый рисунок в виде отдельного файла, удалив все встроенные рисунки.

Ссылки на рисунки

Приводить цифры в порядке возрастания цифр при первом появлении в файле рукописи.

Подписи к рисункам

Вставьте подписи к рисункам в текст рукописи сразу после абзаца, в котором рисунок впервые цитируется (порядок чтения). Не включайте подписи в сами файлы рисунков и не отправляйте их в отдельный документ.

Как минимум, включите в подписи к рисункам следующее:

  • Ярлык рисунка с арабскими цифрами и сокращением «Рисунок» до «Рис» (напр.г. Рис 1, Рис 2, Рис 3 и т. д.). Сопоставьте метку вашего рисунка с именем файла, загруженного при отправке (например, ссылка на рисунок «Рис. 1» должна относиться к файлу рисунка с именем «Fig1.tif»).
  • Краткое описательное название

При необходимости заголовок может также включать легенду.

Предотвращение манипулирования изображениями

В рамках наших усилий по улучшению качества публикуемых рисунков мы регулярно и тщательно проверяем все основные и вспомогательные рисунки для всех статей, принятых редакцией для публикации в PLOS Medicine .При этом мы не только гарантируем, что все файлы рисунков соответствуют нашим требованиям к публикации и доступны для публикации по нашей лицензии CC BY, но также сохраняем бдительность в отношении манипуляций с фотографическими изображениями.

Файлы изображений нельзя изменять или настраивать каким-либо образом, который может привести к неправильной интерпретации информации, присутствующей в исходном изображении. Для получения полной информации о передовых методах работы с фигурами ознакомьтесь с нашими рекомендациями по фигурам.

Если будут обнаружены доказательства ненадлежащей манипуляции, мы оставляем за собой право запросить исходные данные, и, если они не будут удовлетворительными, мы можем принять решение не принимать рукопись, а также можем связаться с учреждениями авторов, чтобы попросить их помочь с изучение.

При проверке на манипуляции мы можем запросить версии ваших изображений с более высоким разрешением или исходные изображения, чтобы мы могли эффективно и точно проверить все цифры.

Если вам когда-нибудь понадобится отправить файлы по электронной почте в офис журнала, в нашей системе установлен лимит вложений размером 10 МБ, что означает, что мы не будем получать сообщения, превышающие этот размер. Если размер ваших файлов превышает 10 МБ, отправьте их по одному электронному письму за раз или попробуйте уменьшить размер файлов. Если у вас возникли проблемы с отправкой нам больших файлов, обратитесь в офис журнала для получения подробной информации о том, как мы можем помочь вам передать ваши файлы.

Таблицы

Цитировать таблицы в порядке возрастания номеров при первом появлении в файле рукописи.

Поместите каждую таблицу в свой файл рукописи сразу после абзаца, в котором она упоминается впервые (в порядке чтения). Не отправляйте свои таблицы в отдельные файлы.

Для таблиц требуется метка (например, «Таблица 1») и краткое описательное название, которое должно быть размещено над таблицей. Поместите легенды, сноски и другой текст под таблицей.

Отчет о данных

Все данные и связанные с ними метаданные, лежащие в основе выводов, изложенных в представленной рукописи, должны быть размещены в соответствующем общедоступном хранилище, если они уже не предоставлены как часть представленной статьи.

Репозитории могут быть либо предметно-ориентированными (если они существуют) и принимать определенные типы структурированных данных, либо универсальными репозиториями, которые принимают несколько типов данных. Мы рекомендуем авторам выбирать репозитории, соответствующие их области. Репозитории могут быть предметно-ориентированными (например, GenBank для последовательностей и PDB для структур), общими или институциональными, при условии, что предоставлены DOI или номера доступа, а данные не менее открыты, чем CC BY. Авторам рекомендуется выбирать репозитории, которые соответствуют принятым критериям в качестве надежных цифровых репозиториев, таким как критерии Центра исследовательских библиотек или Знак одобрения данных.Большие международные базы данных с большей вероятностью сохранятся, чем маленькие локальные.

Для поддержки совместного использования данных и соблюдения авторами политики данных PLOS мы интегрировали наш процесс отправки с выбранным набором репозиториев данных. Список не является ни репрезентативным, ни исчерпывающим для подходящих репозиториев, доступных авторам. Текущие партнеры по интеграции репозиториев включают Dryad и FlowRepository. Пожалуйста, свяжитесь с [email protected], чтобы дать рекомендации для дальнейшего партнерства.

Инструкции по отправке PLOS с данными, хранящимися в репозитории партнера по интеграции:

  • Поместить данные в интегрированное хранилище по выбору.
  • После того, как депонирование будет окончательным и завершенным, репозиторий предоставит вам набор данных DOI (предварительный) и частный URL-адрес, чтобы рецензенты могли получить доступ к данным.
  • Введите данные DOI в полное Заявление о доступности данных, которое запрашивается в разделе «Дополнительная информация» формы «Полное представление PLOS».Затем укажите пароль URL-адреса в разделе «Прикрепить файлы».

Если у вас есть какие-либо вопросы, пожалуйста, напишите нам.

Регистрационные номера

Все соответствующие наборы данных, изображения и информация должны храниться в соответствующем общедоступном хранилище. См. наш список рекомендуемых репозиториев.

Номера доступа (и номера версий, если применимо) должны быть указаны в Заявлении о доступности данных. Номера доступа или ссылка на DOI также должны быть предоставлены, когда набор данных упоминается в рукописи.

В некоторых случаях авторы не могут получить инвентарные номера DOI до тех пор, пока рукопись не будет принята; в этих случаях авторы должны предоставить эти номера при принятии. Во всех остальных случаях эти номера должны быть указаны при полной подаче.

Идентификаторы

По возможности укажите инвентарные номера или идентификаторы для всех объектов, таких как гены, белки, мутанты, заболевания и т. д., для которых есть запись в общедоступной базе данных, например:

Идентификаторы должны быть указаны в круглых скобках после объекта при первом использовании.

Дополнительная информация, запрашиваемая при отправке

Отчет о раскрытии финансовой информации

Эта информация должна содержать описание источников финансирования, поддерживающих работу. Если ваша рукопись будет опубликована, ваше заявление появится в разделе «Финансирование» статьи.

Включите свое заявление в раздел «Раскрытие финансовой информации» первоначальной формы подачи.

Заявление должно включать:

  • Специальные номера грантов
  • Инициалы авторов, получивших каждую награду
  • URL-адреса сайтов спонсоров

Также укажите, играли ли какие-либо спонсоры или спонсоры (кроме названных авторов) какую-либо роль в:

  • Дизайн исследования
  • Сбор и анализ данных
  • Решение о публикации
  • Подготовка рукописи

Если они не участвовали в исследовании, включите следующее предложение: «Спонсоры не участвовали в разработке исследования, сборе и анализе данных, принятии решения о публикации или подготовке рукописи.

Если исследование не финансировалось, включите это предложение в заявление о раскрытии финансовой информации: «Авторы не получали специального финансирования для этой работы».

Конкурирующие интересы

В этом разделе должны быть перечислены конкретные конкурирующие интересы, связанные с любым из авторов. Если авторы заявляют об отсутствии конкурирующих интересов, статья будет содержать соответствующее заявление.

Со всеми авторами свяжутся по электронной почте при подаче полного документа, чтобы сообщить, есть ли у них какие-либо финансовые, личные или профессиональные интересы, которые могут быть истолкованы как оказавшие влияние на их статью.Любые соответствующие конкурирующие интересы авторов должны быть доступны редакторам и рецензентам в процессе рецензирования и будут указаны в опубликованных статьях.

При подаче рукописи всех авторов просят указать, что у них нет связанной или дублирующей рукописи, рассматриваемой (или принятой) для публикации в другом месте. Если связанная работа была или будет представлена ​​в другом месте или находится в печати в другом месте, то копия должна быть загружена вместе со статьей, отправленной в PLOS.Рецензентам будет предложено прокомментировать дублирование между связанными представлениями.

Препринты

PLOS призывает авторов публиковать препринты, чтобы ускорить распространение исследований и поддержать авторов, которые хотят заранее поделиться своей работой и получить отзывы до официального рецензирования. Депонирование рукописей на серверах препринтов не влияет на рассмотрение рукописи в каком-либо журнале PLOS.

Авторы, размещающие публикации на bioRxiv или medRxiv, могут напрямую отправлять материалы в соответствующие журналы PLOS с помощью службы прямой передачи bioRxiv в журналы.

Руководство по конкретным типам исследований

Дизайн исследования, отчетность и анализ оцениваются по всем соответствующим стандартам исследований и методологических методов, принятым сообществом. Руководящие принципы для конкретных типов исследований изложены ниже.

Авторы должны проверять на сайте EQUATOR Network любые рекомендации по отчетности, применимые к конкретному дизайну исследования, и убедиться, что они включают всю необходимую вспомогательную информацию, рекомендованную соответствующими рекомендациями.

Документация по конкретным исследованиям должна быть загружена в качестве вспомогательной информации при подаче рукописи. При ссылке на части рукописи в этих документах указывайте номера разделов или абзацев, а не номера страниц, поскольку номера страниц в вашем представлении могут не совпадать с номерами страниц опубликованной рукописи.

Исследования на людях и животных

Все исследования с участием людей и животных должны быть одобрены экспертным советом авторов или эквивалентным комитетом (комитетами), и этот совет должен быть назван авторами в рукописи.

Для исследований с участием людей должно быть получено информированное согласие или объяснена причина отсутствия согласия, и все клинические исследования должны проводиться в соответствии с принципами, изложенными в Хельсинкской декларации. В разделе «Методы» документа должно быть указано, было ли информированное согласие письменным или устным. Если информированное согласие было устным, в документе должно быть указано: (а) почему письменное согласие не может быть получено, (б) что ЭСО одобрил использование устного согласия и (в) как было задокументировано устное согласие.

От авторов может потребоваться представить по запросу заявление комитета по этике исследований или институционального наблюдательного совета, подтверждающее одобрение исследования. Мы также рекомендуем авторам представить образец формы согласия пациента, и в некоторых случаях может потребоваться предоставление такой формы.

Для исследований с участием людей, классифицированных по расе/этнической принадлежности, возрасту, болезни/инвалидности, религии, полу/гендеру, сексуальной ориентации или другим социально сконструированным группам, авторы должны, насколько это возможно,

  • разъясняют свои методы классификации человеческих популяций;
  • определить категории настолько подробно, насколько позволяет протокол исследования;
  • обосновывают свой выбор определений и категорий, в том числе, например, требуются ли какие-либо правила категоризации людей их финансирующим агентством;
  • объясните, учитывались ли (и если да, то каким образом) смешанные переменные, такие как социально-экономический статус, питание, воздействие окружающей среды и т. д.

Кроме того, устаревшие термины и потенциально стигматизирующие ярлыки следует заменить на более современные и приемлемые термины. Например, следует использовать «белый», а не «европеоид», и «больные раком» следует использовать, а не «раковые больные» или «жертвы рака».

PLOS Medicine публикует несколько исследований на животных, но рассматривает исследования на животных двух видов:

  1. Трансляционные исследования, которые устанавливают новый объяснительный механизм для значимой клинической проблемы в такой степени, которая будет непосредственно информировать конкретные клинические подходы.Такие документы должны включать или ссылаться на данные о людях, которые достаточно убедительны, чтобы установить клиническую значимость модели на животных.
  2. Модели, относящиеся к лечению или профилактике серьезных проблем со здоровьем, в которых вмешательства не могут быть протестированы на людях по этическим причинам, но обеспечивают убедительное обоснование конкретных изменений в дизайне последующих клинических испытаний.

Все работы с животными должны проводиться в соответствии с соответствующими национальными и международными нормами.Кроме того, PLOS Medicine требует, чтобы исследования на животных проводились в соответствии с рекомендациями ARRIVE. В соответствии с рекомендациями отчета Weatherall Использование нечеловеческих приматов в исследовании  , мы особо требуем от авторов включать подробную информацию о благополучии животных и мерах, предпринятых для облегчения страданий, во всех работах с участием нечеловеческих приматов. Учреждение, одобрившее исследование, должно быть названо, и в документе должно быть указано, что исследование проводилось в соответствии с руководящими принципами учреждения для животноводства.

Конфиденциальность пациентов и информированное согласие на публикацию

Наша политика участия человека соответствует Единым требованиям Международного комитета редакторов медицинских журналов:

Пациенты имеют право на неприкосновенность частной жизни, которое не должно нарушаться без информированного согласия. Идентифицирующая информация не должна публиковаться в письменных описаниях, фотографиях и родословных, за исключением случаев, когда эта информация необходима для научных целей и пациент (или родитель, или опекун) дает письменное информированное согласие на публикацию.Информированное согласие для этой цели требует, чтобы пациенту показали рукопись, которая будет опубликована. Полной анонимности добиться трудно, и в случае сомнений следует получить информированное согласие на публикацию. Если данные изменяются для защиты анонимности, авторы должны гарантировать, что изменения данных не искажают научное значение. Получение информированного согласия должно быть указано в публикуемой статье.

Для документов, содержащих идентифицирующую или потенциально идентифицирующую информацию, авторы должны загрузить форму согласия на публикацию в журнале PLOS Journal (ниже), которую пациент, родитель или опекун должны подписать после прочтения статьи и получения проинформированы об условиях лицензии на контент PLOS.

После того, как авторы получили подписанную форму согласия, ее следует надежно хранить в истории болезни пациента, а рукопись, представленная в PLOS, должна включать следующее заявление, указывающее, что конкретное согласие на публикацию было получено: «Пациенты в этой рукописи дали письменные информированные согласие (как указано в форме согласия PLOS) на публикацию деталей их дела».

  Загрузите форму согласия PLOS (PDF):

Клинические испытания

PLOS соответствует определению клинического испытания Всемирной организации здравоохранения (ВОЗ):

.

Клиническое испытание — это любое научное исследование, в ходе которого участников или группы людей проспективно назначают для одного или нескольких вмешательств, связанных со здоровьем, для оценки их воздействия на исходы для здоровья […] Вмешательства включают, помимо прочего, лекарственные препараты, клетки и другие биологические продукты, хирургические процедуры, радиологические процедуры, устройства, поведенческие методы лечения, изменения в процессе оказания помощи, профилактику и т. д.

Регистрация клинических испытаний

Все клинические испытания, представляемые в журналы PLOS, должны быть внесены в общедоступный реестр, утвержденный ВОЗ или ICMJE. См. список утвержденных реестров.

Журналы PLOS

считают проспективную регистрацию испытаний (то есть регистрацию до начала регистрации участников) наилучшей практикой публикации в соответствии с рекомендациями ICMJE.Клинические испытания, в которые начали включать участников до вступления в силу рекомендаций ICMJE 1 июля 2005 г., могут быть зарегистрированы ретроспективно.

Дополнительную информацию о регистрации испытания, включая определение клинического испытания ВОЗ, можно найти в часто задаваемых вопросах ICMJE.

PLOS Medicine вряд ли будет публиковать клинические испытания, которые не зарегистрированы проспективно. Однако мы понимаем, что в редких случаях поздняя регистрация может происходить по исключительным причинам, которые заслуживают рассмотрения.Авторы, обращающиеся за оценкой незарегистрированного клинического исследования по номеру PLOS Medicine , должны предоставить убедительную причину отсутствия проспективной регистрации.

Кроме того, как и во всех журналах PLOS, авторы, желающие представить клиническое исследование, которое не было публично зарегистрировано до начала набора участников, должны зарегистрировать исследование задним числом в общедоступном реестре. Они также должны:

  • Зарегистрируйте все соответствующие клинические испытания и подтвердите их проведение в разделе «Методы»
  • Объясните в методах конкретные причины невозможности зарегистрироваться до регистрации участника
  • Подтверждение того, что будущие испытания будут регистрироваться проспективно

Редакторы журнала PLOS могут отказаться от дальнейшего рассмотрения любого клинического исследования, для которого, по мнению редактора, отсутствие проспективной регистрации вызывает опасения по поводу выборочной публикации или выборочного сообщения результатов исследования.

PLOS поддерживает публичное раскрытие всех результатов клинических испытаний, как это требуется, например, в Законе о поправках к FDA 2007 года. Предварительное раскрытие результатов на сайте реестра клинических испытаний не повлияет на рассмотрение.

Необходимая документация

Отчеты о клинических испытаниях должны соответствовать соответствующим руководящим принципам отчетности для их дизайна исследования, таким как CONSORT для рандомизированных контролируемых испытаний, TREND для нерандомизированных испытаний и другим специализированным руководствам по мере необходимости.

Для всех заявок на клинические испытания авторы должны включать следующее:

  • Регистрационные данные (указаны в разделе «Методы» и в форме отправки)
  • Контрольный список CONSORT или соответствующее руководство по отчетности (загружено в качестве вспомогательной информации)
  • Блок-схема CONSORT (загружена как рис. 1)
  • Пробный протокол (загружен как вспомогательная информация)
  • Сведения о предварительном одобрении исследований на людях институциональным наблюдательным советом (IRB) или эквивалентным комитетом (ами) по этике

Заявка не будет рассмотрена, если не предоставлена ​​документация.Контрольный список, блок-схема и протокол будут опубликованы вместе со статьей, если рукопись будет принята.

Файл рукописи должен содержать следующую информацию:

  • Объяснение любого отклонения от протокола исследования
  • Описание информированного согласия, полученного от участников
  • Любая информация о статистических методах или участниках, не указанная в документации CONSORT

Систематические обзоры и метаанализы

Отчеты о систематических обзорах и метаанализах должны соответствовать Заявлению PRISMA или альтернативным руководствам, соответствующим дизайну исследования, и включать заполненный контрольный список и блок-схему, сопровождающие основной текст.Авторы должны заполнить соответствующий контрольный список отчетов не только со ссылками на страницы, но и с достаточным количеством текста, выдернутого из рукописи, чтобы объяснить, как они выполнили все применимые пункты.

Загрузите пустые шаблоны контрольного списка и блок-схемы с веб-сайта EQUATOR.

Тезисы должны следовать PRISMA для тезисов, используя формат тезисов PLOS. Авторы также должны указать в разделе «Методы» своей статьи, существует ли протокол для их систематического обзора, и если да, предоставить копию протокола в качестве вспомогательной информации.

Журнал поддерживает проспективную регистрацию систематических обзоров. Авторы, чей систематический обзор был проспективно зарегистрирован (например, в реестре, таком как PROSPERO), должны указать регистрационный номер в своем реферате. Детали реестра и протоколы будут доступны редакторам и рецензентам и включены в документ, если отчет будет в конечном итоге опубликован.

PLOS Medicine  не публикует описательные обзоры, кроме как в рамках приглашенных коллекций

Диагностические исследования

Отчеты об исследованиях диагностической точности должны соответствовать требованиям STARD или альтернативным рекомендациям, соответствующим дизайну исследования (см. веб-сайт EQUATOR), и включать заполненный контрольный список в качестве вспомогательной информации.Авторы должны заполнить соответствующий контрольный список отчетов не только со ссылками на страницы, но и с достаточным количеством текста, выдернутого из рукописи, чтобы объяснить, как они рассмотрели все применимые элементы.

Наблюдательные исследования

Для обсервационных исследований, включая исследования случай-контроль, когортные и перекрестные исследования, авторы должны придерживаться Заявления STROBE или альтернативных руководств, соответствующих дизайну исследования (см. веб-сайт EQUATOR), и включать заполненный контрольный список в качестве вспомогательной информации.Авторы должны заполнить соответствующий контрольный список отчетов не только со ссылками на страницы, но и с достаточным количеством текста, выдернутого из рукописи, чтобы объяснить, как они рассмотрели все применимые элементы.

Для обсервационных исследований авторы должны четко указать (a) какие конкретные гипотезы исследователи намеревались проверить, и аналитические методы, с помощью которых они планировали их проверить; (б) Какие анализы они фактически выполнили; и (c) Когда опубликованные анализы отличаются от запланированных, авторы должны предоставить прозрачные объяснения различий, которые влияют на надежность результатов исследования.

Если план проспективного анализа (из предложения о финансировании исследования, представления IRB или другого комитета по этике, протокола исследования или другого документа по планированию, написанного до анализа данных) использовался при разработке обсервационного исследования, авторы должны включить соответствующий проспективный письменный документ с представление рукописи для доступа редакторов и рецензентов и возможная публикация вместе с принятой статьей. Если предполагаемого письменного документа не существует, авторы должны объяснить, как и когда они определили анализы, о которых сообщается.

Эксперименты с микроматрицами

Отчеты об экспериментах с микрочипами должны соответствовать рекомендациям MIAME, а данные экспериментов должны храниться в общедоступной базе данных.

Биологические и биомедицинские исследования

Мы рекомендуем авторам обратиться к порталу BioSharing за обязательными контрольными списками для сообщения о биологических и биомедицинских исследованиях, где это применимо.

Исследования на животных

Исследования, включающие животных, должны соответствовать рекомендациям по ПРИБЫТИЮ и включать заполненный Контрольный список ПРИБЫТИЯ в качестве вспомогательной информации.Авторы должны заполнить соответствующий контрольный список отчетов не только со ссылками на страницы, но и с достаточным количеством текста, выдернутого из рукописи, чтобы объяснить, как они рассмотрели все применимые элементы.

Данные о кристаллах малых и макромолекул

Рукописи, сообщающие о новых и неопубликованных трехмерных структурах, должны включать достаточные подтверждающие данные и подробные описания методологий, используемых для воспроизведения и проверки структур.Все новые структуры должны быть помещены в одобренную сообществом базу данных перед отправкой (см. наш список рекомендуемых репозиториев).

Данные монокристалла малых молекул

Авторы, сообщающие о рентгеновских кристаллографических структурах малых органических, металлоорганических и неорганических молекул, должны поместить свои данные в Кембриджский центр кристаллографических данных (CCDC), базу данных неорганической кристаллической структуры (ICSD) или аналогичные базы данных сообщества, обеспечивающие признанную проверку функциональность.Авторы также должны включать соответствующие справочные номера структур в основной текст (например, идентификационный номер CCDC), а также файлы кристаллографической информации (формат .cif) в качестве дополнительной информации вместе с отчетами о проверке checkCIF, которые можно получить через Международный союз кристаллографов (IUCr).

Макромолекулярные структуры

Авторы, сообщающие о новых макромолекулярных структурах, должны были депонировать свои данные до первоначальной подачи во Всемирный банк данных по белкам (wwPDB), Банк данных биологического магнитного резонанса (BMRB), Банк данных электронной микроскопии (EMDB) или другие базы данных сообщества, обеспечивающие признанная функция проверки.Авторы должны включить номера ссылок на структуру в основной текст и представить в качестве дополнительной информации официальные отчеты о проверке из этих баз данных.

PLOS Community Action Publishing (CAP) — поддержка без членских взносов

PLOS Medicine  больше не имеет APC, а вместо этого финансируется новой моделью коллективных действий под названием PLOS Community Action Publishing (CAP). Учреждения платят за то, чтобы стать членами сообщества, поэтому с их авторов не взимается плата.Авторы-корреспонденты и соавторы из учреждений, не являющихся членами, облагаются взносами, не являющимися членами.

Чтобы узнать, является ли ваше учреждение участником PLOS Medicine CAP, посетите страницу нашего институционального партнера и выполните поиск по названию вашего учреждения или по типу соглашения «Community Action Publishing».

Если соответствующее авторское учреждение является членом, они будут уведомлены при принятии, что сборы не требуются. Если соответствующее авторское учреждение не является членом, с него будет взиматься плата за нечленство.Если соавторов соответствующего автора, не являющегося членом, принадлежат организациям-членам , существует скидка 25% на взнос для нечленов. Обязательно проверьте, являются ли учреждения ваших авторов участниками, чтобы воспользоваться этой скидкой.

 

Коллекция Current Protocols включает более 24 000 пошаговых методов, процедур и практических обзоров, которые предоставляют исследователям надежные и эффективные методы, обеспечивающие воспроизводимость результатов и прокладывающие путь к важным научным открытиям.Текущие протоколы, акцентирующие внимание на тщательно отобранных, тщательно отредактированных методах, богатых деталями, практических советах и ​​устранении неполадок, позволяют исследователям продвигать свои исследования с эффективностью времени и ресурсов. Протоколы организованы и доступны по названиям, охватывающим основные дисциплины наук о жизни. Каждая коллекция стала золотым стандартом в своей области. Ежеквартальные выпуски включают самые лучшие новые и обновленные протоколы.

Наши статьи, основанные на протоколах, удобны для пользователя и предвосхищают любой вопрос, который может возникнуть.Мы создали стандартный формат протокола более тридцати лет назад, в том числе:

  • Краткое введение для ориентации исследователя

  • Полные списки заказанных материалов

  • Четкие, пронумерованные, пошаговые инструкции с полезными аннотациями — как если бы эксперт присматривал за вами через плечо!

  • Подробные рецепты

  • Исходная информация, описывающая приложения и связанные с ними методы

  • Критические параметры и устранение неполадок, чтобы вы могли быстро вернуться в нужное русло в случае возникновения проблем

  • Ожидаемые результаты

  • Соображения времени

  • Рисунки и видео для пояснения основных шагов

  • Таблицы ценной информации

 

Методы Текущих протоколов

важны для всех, кто занимается научными исследованиями.Студенты, технические специалисты и постдоки сочтут Current Protocols неоценимым помощником в своей работе. Руководители лабораторий и заведующие кафедрами найдут Current Protocols полезными для написания грантов и составления бюджета, а также для планирования долгосрочных исследовательских проектов.

Обширный процесс редактирования, встроенный в создание текущих протоколов, обеспечивает высочайшее качество лабораторных методов, эффективно защищая достоверность результатов исследователей. Существует три уровня редактирования содержимого Current Protocols.Каждая статья проходит тщательную многоуровневую проверку, оптимизированную для лабораторных протоколов. Он начинается с членов редакционной коллегии, которые рассматривают и приглашают потенциальный контент и авторов, а также оценивают опубликованный контент на его актуальность. После рецензирования и одобрения членами редколлегии, приглашенными редакторами и, при необходимости, другими рецензентами следующее рецензирование выполняется штатным редактором с ученой степенью в соответствующей области. Этот редактор предвосхищает вопросы, которые могут возникнуть при выполнении протокола, и учитывает тщательность и ясность.Наконец, редакторы с учеными степенями и опытом работы в лаборатории копируют и проверяют мельчайшие детали. Тщательный отбор контента, трехэтапный процесс редактирования и тщательное внимание к деталям делают Current Protocols важной публикацией, обеспечивающей воспроизводимость и успех исследований.

Издатель

Воспользуйтесь приведенными ниже ссылками, чтобы перейти непосредственно к руководству по стилю для определенного заголовка Current Protocols или связаться с редактором серии по электронной почте с комментариями, новыми методами или предложениями по новым темам.

Справочные стили и инструкции программного обеспечения для управления (.zip)

EndNote (en) | Зотеро (csl)

Отправить рукопись (только для зарегистрированных авторов)

Рукописи ScholarOne

Советы по поисковой оптимизации для авторов

Wiley делает все возможное, чтобы весь исследовательский контент был виден и занимал высокие позиции в результатах поиска Google и других поисковых систем. Пожалуйста, посетите наше руководство по SEO, чтобы узнать, как вы также можете сыграть решающую роль в оптимизации результатов поиска для вашей статьи.

Биоинформатика

Руководство по стилю | Образец статьи | Редактор: Кристофер Арнетт, доктор философии. [email protected]

Клеточная биология

Руководство по стилю | Образец статьи | Редактор: Нидхи Бансал, доктор философии. [email protected]

Химическая биология

Руководство по стилю | Образец статьи | Редактор: Джулиан Вастл, доктор философии. [email protected]

Цитометрия

Руководство по стилю | Образец статьи | Редактор: Кристофер Арнетт, доктор философии. [email protected]

Основные лабораторные методы

Руководство по стилю | Образец статьи | Редактор: Сара Белкин, Ph.Д. [email protected]

Генетика человека

Руководство по стилю | Образец статьи | Редактор: Кристофер Арнетт, доктор философии. [email protected]

Иммунология

Руководство по стилю | Образец статьи | Редактор: Джулиан Вастл, доктор философии. [email protected]

Микробиология

Руководство по стилю | Образец статьи | Редактор: Джессика Лоулер, доктор философии. [email protected]

Молекулярная биология

Руководство по стилю | Образец статьи | Редактор: А. Монтенегро, к.т.н. amonteneg@wiley.ком

Биология мышей

Руководство по стилю | Образец статьи | Редактор: Джереми Петрович, доктор философии. [email protected]

Неврология

Руководство по стилю | Образец статьи | Редактор: Джереми Петравич, доктор философии. [email protected]

Химия нуклеиновых кислот

Руководство по стилю | Образец статьи | Редактор: Джессика Лоулер, доктор философии. [email protected]

Фармакология

Руководство по стилю | Образец статьи | Редактор: Джулиан Вастл, доктор философии. [email protected]

Биология растений

Руководство по стилю | Образец статьи | Редактор: Кристофер Арнетт, к.Д. [email protected]

Наука о белках

Руководство по стилю | Образец статьи | Редактор: Джессика Лоулер, доктор философии. [email protected]

Биология стволовых клеток

Руководство по стилю | Образец статьи | Редактор: Нидхи Бансал, доктор философии. [email protected]

Токсикология

Руководство по стилю | Образец статьи | Редактор: А. Монтенегро, к.т.н. [email protected]

 

Авторы — BMJ Open

Все статьи, опубликованные в BMJ Open , будут отправлены на внешнее открытое рецензирование.Рецензентам не будет предложено оценить важность или широту привлекательности. Читатели смогут сделать эти суждения для себя. Мы рекомендуем вам использовать наши инструкции для рецензентов в качестве контрольного списка, чтобы убедиться, что ваша статья завершена. После публикации будут доступны все предыдущие версии рукописи, а также комментарии рецензентов и ответы авторов на эти комментарии.

Экспресс-рецензирование также возможно после публикации.

BMJ Open рассмотрит апелляции по отклоненным рукописям при условии, что авторы смогут продемонстрировать, что решение по их рукописи было ошибочным или не соответствовало политике журнала.Чтобы апелляция была рассмотрена, авторы должны предоставить подробный пошаговый ответ на все вопросы, высказанные рецензентами или редакторами, связанными с рукописью. Мы просим авторов не предоставлять исправленную рукопись во время апелляции. Все решения, принятые по апелляциям, являются окончательными, и процесс принятия решения может занять больше времени, чем в случае первоначальных представлений. Апелляции должны быть поданы в течение 30 дней с момента принятия решения об отказе.

Плагиат — это присвоение языка, идей или мыслей другого лица без указания их истинного источника и представление их как собственной оригинальной работы.BMJ является членом CrossCheck от CrossRef и iThenticate. iThenticate — это служба проверки на плагиат, которая проверяет оригинальность контента перед публикацией. BMJ пропускает рукописи через iThenticate в процессе рецензирования. Авторы, исследователи и фрилансеры также могут использовать iThenticate для проверки своей работы перед отправкой на веб-сайт www.ithenticate.com.

Независимая экспертиза протоколов исследования

BMJ Open рассмотрит возможность публикации без дальнейшего рецензирования. Протоколы экспертной оценки, получившие официальное этическое одобрение. .При загрузке протокола предоставьте подтверждение того, что эти критерии соблюдены. Нам нужны отчеты о рецензировании, которые ясно показывают, что методология протокола была тщательно оценена экспертами с соответствующей квалификацией. Любые протоколы, которые не соответствуют обоим этим критериям, будут отправлены на открытое внешнее рецензирование, а комментарии рецензентов будут опубликованы в Интернете после принятия, как и в случае исследовательских статей. Рецензенты будут проинструктированы о проверке на предмет ясности и достаточной детализации. Цель рецензирования не состоит в том, чтобы изменить дизайн исследования.Рецензенты будут проинструктированы проверить, что исследование является научно достоверным и этически обоснованным по своему охвату и методам, а также что имеется достаточно подробностей, чтобы вселить уверенность в том, что исследование будет проведено и проанализировано должным образом. Ускоренная публикация осуществляется на усмотрение редакции.

Как и исследовательские статьи, протоколы будут публиковаться под лицензией Creative Commons.

ОРЦИД

Рецензенты теперь могут делиться своими действиями, подключив свой отзыв к своей учетной записи ORCID.Поскольку BMJ Open является открытым рецензируемым журналом, информация о журнале, обзоре и статье будет загружена (название, DOI, URL-адрес и т. д.) в запись ORCID рецензента. Записи загружаются после принятия окончательного решения или пересмотра статьи. Дополнительную информацию о политике ORCID и BMJ можно найти в нашем Центре авторов.

Типы изделий и подготовка | БМЖ

Мы рекомендуем ознакомиться с этим шаблоном статьи об анализе и использовать его в качестве основы для своей работы, прежде чем рассматривать отправку.


Количество слов и стиль
BMJ имеет международную читательскую аудиторию, в которую входят политики, работники здравоохранения и врачи всех дисциплин. Авторам рекомендуется помнить об этой читательской аудитории и писать статьи для неспециалистов. Важно избегать жаргона. Необходимо разъяснить специальную терминологию и ссылки на организации или практики, характерные для одной страны. Важны четкий текст и привлекательная презентация.Аналитические работы должны состоять из 1800-2000 слов.

Общая структура
Рукопись должна содержать следующие элементы:

Заголовок и абзац
За коротким заголовком следует одно предложение, выделенное курсивом (первый абзац), которое заключает в себе основную мысль статьи.

Введение
Статьи должны начинаться с краткого абзаца, который привлекает внимание читателей и объясняет цель статьи.

Текст
Основная часть текста должна быть разбита на подзаголовки, которые обеспечивают логическую структуру повествования.Избегайте акронимов и аббревиатур, если они не являются общепризнанными, т.е. ДНК. Доказательства, на которых основаны ключевые утверждения, должны быть явными и иметь ссылки, а сила доказательств (опубликованные испытания, систематические обзоры, наблюдательные исследования, мнение экспертов и т. д.) должна быть ясной. Статьи должны представлять взвешенный, беспристрастный взгляд на доказательства, а не выборочно цитировать доказательства, поддерживающие ту или иную точку зрения.

Рамки, таблицы и рисунки
Они должны дополнять и подтверждать основные положения статьи.Слова в рамочках и таблицах исключаются из подсчета слов основного текста, но дополнительный материал должен быть кратким.

Блок ключевых сообщений
Он должен быть в конце статьи и включать от 2 до 4 пунктов, подводящих итог основным выводам. Отправляя статью на submit.bmj.com, введите ключевые сообщения, когда будет предложено ввести аннотацию.

Каталожные номера
Должны быть в ванкуверском стиле и сведены к минимуму; в идеале не более 20.

Авторы и источники
Мы просим дополнительный абзац на 100-150 слов (исключенный из подсчета слов), чтобы объяснить происхождение статьи. Он должен включать соответствующий опыт и знания каждого автора, его или ее вклад в документ и источники информации, использованные для его подготовки. В качестве поручителя статьи должен быть указан один автор. Вы можете пригласить соавторов для работы с вами над статьей. Мы предлагаем включить 2–3 соавторов из разных мест и точек зрения, чтобы обеспечить международный охват статей и их доступность широкому кругу читателей в Интернете и в печати.

Отчет об участии пациентов
Как BMJ стремится развивать партнерские отношения с пациентами, мы также просим авторов запрашивать их вклад в статьи, где это уместно, и документировать их участие в качестве пациентов или соавторов.

Конфликт интересов
Все авторы должны ознакомиться с нашей политикой в ​​отношении конкурирующих интересов и включить соответствующее заявление в свою рукопись. Если существует конкурирующий интерес, который может лишить автора возможности внести свой вклад, целесообразно обсудить это с редактором BMJ перед написанием статьи.

Лицензия
Мы требуем, чтобы рукопись включала следующее заявление:
«Соответствующий автор имеет право предоставлять от имени всех авторов и предоставляет от имени всех авторов исключительную лицензию (или неисключительную лицензию для государственных служащих). ) по всему миру BMJ Publishing Group Ltd («BMJ») и ее лицензиатам разрешить публикацию этой статьи (если она будет принята) в изданиях BMJ и любых других продуктах BMJ, а также использовать все дополнительные права , как указано в нашей лицензии.”

[>

Рецензирование
BMJ полностью открыто рецензирует аналитические статьи. Это означает, что каждая принятая аналитическая статья, представленная начиная с февраля 2016 года, будет иметь свою историю до публикации рядом с ней на thebmj.com. Эта предпубликационная история включает в себя все предыдущие версии рукописи, отчет о заседании комитета по рукописи, подписанные рецензентами комментарии и ответы авторов на все комментарии рецензентов и редакторов.Авторы могут предложить имена подходящих рецензентов, включая рецензентов пациентов.

Схема протокола — Центр биостатистики рака

Ниже приводится выдержка из раздела 4.6.3 книги «Клинические испытания: методологические исследования». Перспектива, написанная Стивеном Пиантадоси (Нью-Йорк, Нью-Йорк: John Wiley & Sons, Инк., 1997). В этом разделе описывается структура протоколов. было бы полезно чтобы все следователи просмотрели это, чтобы убедиться, что их протоколы составлены надлежащим образом. формата и содержать необходимые разделы, сводя к минимуму время, необходимое для редактирования протоколов перед подачей.

Краткое описание

  1. Титульный лист (необходим для всех протоколов).
  2. Содержание или предметный указатель (необязательно).
  3. Сводка протокола
  4. (необязательно).
  5. Схема
  6. (необходима для комплексной безопасности и эффективности и сравнительной эффективности лечения протоколы).
  7. Цели исследования (необходимо для всех протоколов).
  8. Введение и справочная информация (необходимы для всех протоколов).
  9. Информация о лекарствах (необходима для исследований с использованием лекарств).
  10. Критерии стадии (обязательны для всех исследований).
  11. Критерии приемлемости пациента (обязательны для всех протоколов).
  12. Процедуры регистрации или рандомизации и стратификация (обязательны для всех протоколов).
  13. Программа лечения (необходима для всех протоколов).
  14. Модификация дозировки/Побочные эффекты (необходимо для всех протоколов).
  15. Информация об агенте (необходима для всех агентов).
  16. Оценка лечения (необходимо для всех протоколов).
  17. Календарь серийных измерений/исследований (необходим для обеспечения безопасности и эффективности и исследования эффективности лечения).
  18. Статистические соображения (необходимы для определения дозы, безопасности и эффективности, а также для сравнения исследования эффективности лечения, необязательные для исследований механизма лечения).
  19. Внешнее сотрудничество или обзоры (обязательны для всех многоучрежденческих исследований).
  20. Запись данных, управление и мониторинг (необходим для всех протоколов).
  21. Специальные инструкции.
  22. Коммуникация и публикация данных (необходим для всех исследований, связанных с сотрудничеством, особенно управление данными, за пределами учреждения, особенно фармацевтическое исследования, спонсируемые компанией).
  23. Экспертная оценка (этот раздел необязателен).
  24. Согласие пациента (необходимо для всех протоколов).
  25. Ссылки (необходимы для всех протоколов).
  26. Формы данных (отчет о болезни) (необязательно).
  27. Поправки к протоколу (обязательны для всех протоколов, если существуют какие-либо поправки).
  28. Другие приложения (необязательно).
  29. Глоссарий (дополнительно)

Подробный план

Этот план и краткое обсуждение предназначены для того, чтобы помочь следователям в разработке, пересмотр и улучшение качества собственных клинических испытаний. Акцент этот план посвящен сравнительным испытаниям, проведенным в совместных условиях.Тем не мение, почти все исследования выиграли бы, если бы их протоколы касались большинства тем ниже. Заголовки предполагают фармакологическую терапию, но их должно быть немного. сложность адаптации к испытаниям с использованием других методов лечения. Общая длина протокола обычно составляет 20 или более машинописных страниц, написанных структурированным формальным стиль с номерами страниц и ссылками и содержащий большинство следующих разделов.

  • Титульный лист (необходим для всех протоколов). На титульном листе должны быть указаны: а) название исследования, б) дата последнего пересмотра, c) главный исследователь и номер телефона, d) другое исследование сотрудники, и e) административный офис и номер телефона. При разработке протоколов в условиях совместной работы дата пересмотра может предотвратить большую путаницу. Некоторые спонсоры, таких как фармацевтические компании, не указывайте главного исследователя.Это распространение ответственности недопустимо.
  • Содержание или индекс (необязательно).
  • Сводка протокола (опционально). Одностраничное описание сложных и длинных протоколов может быть большая помощь.
  • Схема (необходима для сложных протоколов безопасности и эффективности и сравнительной эффективности лечения).Поток пациентов с основными важными ориентирами, такими как запись в исследование, оценки и лечение, и рандомизация представлены в виде диаграммы. Базовая архитектура план исследования будет очевиден только из схемы. Дозы, графики и другие детали относительно терапии следует удалить из схемы, чтобы предотвратить ее использование для лечения без ознакомления с полным протоколом.
  • Цели исследования (необходимо для всех протоколов). Цели ставят важные научные вопросы решается судом. Цели должны быть сформулированы четко, кратко и количественно, и соответствуют гипотезам, подлежащим проверке в ходе исследования. Также полезно указать соответствующие конечные точки. Этот раздел обычно довольно краток и отформатирован как набросок с деталями.
  • Введение и справочная информация (необходим для всех протоколов). В этом разделе представлена ​​вводная и научная предыстория/обоснование исследования и должно быть адекватным введением в предмет для других исследователей и рецензентов. Резюме аналогичных или фоновых исследований будет обоснование заявленных целей.Если проводится новое лечение проверены в исследованиях безопасности и эффективности или сравнительных исследованиях эффективности лечения, пилотные данные может потребоваться для обоснования более крупного исследования. Имейте в виду, что некоторые читатели и потенциальные критики протокола не будут такими экспертами в науке, как авторы. использованная литература должны быть включены и должны быть написаны в повествовательном стиле. Поддерживающий или недавний необходимо включить исторические данные, которые оправдывают дизайн исследования.
  • Информация о лекарствах (необходим для исследований с использованием лекарств). Все препараты, используемые в исследовании, должны быть описаны в алфавитном порядке в отношении токсичности для человека, фармацевтических данных, введения, хранение и стабильность, и поставщик. Следователь должен перечислить национальную службу Номер центра (NSC), номер исследовательского нового препарата (IND), если применимо, и любой другой стандартные названия препаратов.
  • Критерии стадии (обязательны для всех исследований). В этом разделе перечислены критерии или система, по которым заболевания будет установлено. В исследованиях рака можно определить степень заболевания по стадиям, оценка которых часто стандартизирована. При некоторых других заболеваниях степень заболевания может быть менее стандартизированной или даже спорной.Следовательно критерии, используемые для установления степени, возможно, потребуется указать явно.
  • Критерии приемлемости пациента (обязательны для всех протоколов). Этот раздел представляет собой подробный, конкретный и количественный описание квалификационных требований и исключений. Например, критерии приемлемости может зависеть от подкатегории заболевания, предшествующей терапии, измеримости степени заболевания или ответ, состояние работоспособности или тяжесть заболевания и требуемая функция органа.Критерии исключения также должны быть изложены таким же образом. Критерии исключения должны быть названы на основе знаний, полученных до оценки ответа или результат исследования. Исключения не должны допускаться на основании информации, которая становится известно только после начала лечения. Любые конкурирующие исследования факторов которые будут мешать начислению, должны быть указаны здесь или в отдельном разделе.
  • Процедуры регистрации или рандомизации и стратификации (обязательны для всех протоколов). Телефоны и контакты для записи пациента на исследование предоставляется. Это должно включать информацию, необходимую для центрального права чеки. Во многих случаях лица, ответственные за механические части размещения пациенты в исследовании не являются врачами или лицами, иным образом осведомленными о тонкости исследования.Здесь могут потребоваться подробные процедурные спецификации. чтобы избежать путаницы или ввода неподходящих пациентов позже. Факторы стратификации могут влияют на рандомизированное назначение или лечение и должны быть доступны в то время запрашивается назначение лечения или регистрация.
  • Программа лечения (необходима для всех протоколов). Это включает в себя детали необходимой терапии, такие как дозы химиотерапии, биопсии и процедуры маскировки.Для изучения механизма лечения, эскалация дозы будет подробно описана. Для исследований, использующих более одного лечения модальности, детали каждой из них должны быть представлены в отдельных разделах. В рамках лечения должны быть указаны спецификация, вторичная регистрация или рандомизация. Этот В этом разделе также должны быть перечислены критерии прекращения лечения по протоколу, например, завершение лечения. терапии, прогрессирование заболевания, неприемлемые побочные эффекты или предпочтения пациента.
  • Модификация дозировки/Побочные эффекты (необходим для всех протоколов). Это включает в себя подробную информацию о необходимых модификациях дозы и снижение при возникновении токсичности или побочных эффектов. Побочные эффекты или следует перечислить токсичность, подлежащую мониторингу. Модификации дозы должны учитывать следующие опасения: исходные условия, требующие изменения начальной дозы; критерии многократных курсов лечения; применяемое уменьшение или увеличение дозы; критерии замены отсрочки лечения на снижение дозы; следователь контакт по вопросам изменения дозы; и требования к отчетности для неожиданных побочные эффекты.
  • Информация об агенте (необходима для всех агентов). В этом разделе разъясняются подробности приготовления, хранения и хранения лекарственных средств. растворение и стабильность. Для экспериментальных агентов, доступность и информация о конкретных препаратах данные должны быть приведены. Брошюра по исследуемым препаратам должна сопровождать протокол.
  • Оценка лечения (необходим для всех протоколов).В этом разделе содержится подробная информация о методах оценки и для определения конечных точек и токсичности. В таких исследованиях, как безопасность и испытания эффективности цитостатиков в онкологии, методов оценки опухолевого ответы имеют решающее значение для оценки и обобщаемости исследования. Подсчет очков, следует указать интенсивность или другие критерии оценки.
  • Календарь серийных измерений/исследований (необходим для безопасности и эффективности и сравнительных исследований эффективности лечения).Этот перечисляет параметры исследования и вехи, а также время, когда они должны быть определены пока пациент находится на протокольном лечении. Это должно включать в себя перечень базовых измерения. Кроме того, в этом разделе указаны действия, которые должны быть предприняты в ответ на к конкретным осложнениям исследования, таким как шаги по отстранению пациента от лечения протокол из-за побочных эффектов или токсичности.Этот раздел должен содержать перекрестные ссылки формы данных и график их подачи.
  • Статистические соображения (важно для определения дозы, безопасности и эффективности, а также сравнительной эффективности лечения исследования, необязательные для изучения механизма лечения). В этом разделе рассматриваются следующие важные моменты: краткое изложение целей исследования, требуемый размер выборки, мощность и способ было оценено, точность дизайна для определения основных конечных точек исследования, прогнозируемых скорость накопления и продолжительность исследования, а также методы анализа.Также планы на промежуточный анализы и рекомендации по раннему прекращению должны быть включены. Статистический раздел следует также наметить количественные свойства исследования по отношению к вторичным цели. Набросок окончательного анализа также полезен. В некоторых случаях анализ план может потребовать подробного описания.
  • Внешнее сотрудничество или обзоры (необходимо для всех многоучрежденческих исследований).В этом разделе описываются механизмы и процедуры со следователями за пределами головного учреждения. Например, должны быть даны подробности о том, как получить патологический образец или визуализацию. Имена, адреса и номера телефонов должны быть указаны для внешних следователей, если не указан на титульном листе. В случае, если обширные или критические участки исследование зависит от сотрудничества за пределами головного учреждения, дополнительных протоколов может потребоваться представить (т.г., обширный патологоанатомический обзор).
  • Запись данных, управление и мониторинг (необходим для всех протоколов). В этом разделе содержится подробная информация о сборе и просмотр данных в ходе исследования. Он включает в себя контактное лицо с имена и адреса для подачи форм данных или соответствующих инструментов сбора. Это будет включать адреса и номера телефонов для вопросов, чрезвычайных ситуаций и сообщения о фатальных, опасных для жизни или неожиданных реакциях.График подачи для данных формы должны быть изложены. Кроме того, членство в мониторинге безопасности должен быть обозначен комитет.
  • Специальные инструкции. В этом разделе содержатся инструкции для обучения менеджеров по получению и отправке образцов по почте. для специальных лабораторных тестов или анализов. Требуются любые специальные данные или формы данных спонсором исследования, должны быть перечислены с инструкциями о том, как с ними обращаться.
  • Коммуникация и публикация данных (необходим для всех исследований, связанных с сотрудничеством, особенно для управления данными, за пределами учреждения, особенно исследования, спонсируемые фармацевтической компанией). В этом разделе излагаются соглашения, касающиеся передачи и публикации результатов исследования. данные. Любое ограничение или ограничения доступа исследователя к данным исследования должны быть подробным.В этом разделе также должны быть указаны предварительные утверждения, если это требуется, для публикации. данные. Формат этого раздела — описательный.
  • Рецензирование (этот раздел необязателен). В этом разделе описываются процедуры экспертной оценки, которые протокол может быть уже принят. Например, для совместных групповых протоколов экспертная оценка может включать групповой механизм и NIH.
  • Согласие пациента (необходимо для всех протоколов). Этот раздел может быть представлен в качестве приложения с формы согласия пациента. Уровень чтения документа о согласии пациента должен быть восьмой класс или ниже. Следует использовать соответствующий язык, если есть план регистрировать пациентов, чей основной язык не английский, а также «обратный перевод» или другие следует использовать, чтобы убедиться, что важные понятия переведены правильно.
  • Ссылки (необходим для всех протоколов). Включите публикации, основанные на испытании (если есть) и копии важных справок из протокола.
  • Данные (отчет о болезни) Формы (необязательно). Исследователям предлагается представить предлагаемые формы данных для исследования. В идеале формы должны быть самокодирующими для ввода с компьютера.Формы будут проверены для захвата предметов, необходимых для достижения целей исследования. Формы данных могут быть представлены как приложение.
  • Поправки к протоколу (обязательно для всех протоколов, если существуют какие-либо поправки). Этот раздел включает в себя резюме всех модификаций протокола, влияющих на лечение пациента, расположенных в хронологическом порядке приказ.Также полезно краткое объяснение каждой поправки.
  • Другие приложения (необязательно). Они могут включать документацию по обзору этики, критерии токсичности, поток листы и т.д.
  • Глоссарий (дополнительно). Включите определения специальных или незнакомых терминов. Этот раздел может быть полезным для терминологии психосоциальных исследований, новых лекарств и т. д.
.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *